Template:LinkText: Difference between revisions

From ChoralWiki
Jump to navigation Jump to search
(finishing update)
(returning to <pre> for more clarity)
Line 13: Line 13:
<h4>Default behavior</h4>
<h4>Default behavior</h4>
This template provides links for up to three text pages.  Its '''default behavior''' is to '''''italicize''''' all links ''except'' those that begin with '''Psalm''' as in:
This template provides links for up to three text pages.  Its '''default behavior''' is to '''''italicize''''' all links ''except'' those that begin with '''Psalm''' as in:
:{{tl|LinkText|Ave verum corpus}}
<pre>{{LinkText|Ave verum corpus}}</pre>
producing
producing
:Original text and translations may be found at '''''[[Ave verum corpus]]'''''.
:Original text and translations may be found at '''''[[Ave verum corpus]]'''''.
:{{tl|LinkText|2|Psalm 131|Wachet auf, ruft uns die Stimme}}
<pre>{{LinkText|2|Psalm 131|Wachet auf, ruft uns die Stimme}}</pre>
producing (for two pages)
producing (for two pages)
:Original text and translations may be found at '''[[Psalm 131]]''' and '''''[[Wachet auf, ruft uns die Stimme]]'''''.
:Original text and translations may be found at '''[[Psalm 131]]''' and '''''[[Wachet auf, ruft uns die Stimme]]'''''.
and
and
:{{tl|LinkText|3|O magnum mysterium|Ave Maria|Psalm 150}}
<pre>{{LinkText|3|O magnum mysterium|Ave Maria|Psalm 150}}</pre>
producing (for three pages)
producing (for three pages)
:Original text and translations may be found at '''''[[O magnum mysterium]]''''', '''''[[Ave Maria]]''''' and '''[[Psalm 150]]'''.
:Original text and translations may be found at '''''[[O magnum mysterium]]''''', '''''[[Ave Maria]]''''', and '''[[Psalm 150]]'''.


<h4>Specifying ''italics'' or plain display explicitly</h4>
<h4>Specifying ''italics'' or plain display explicitly</h4>
'''However,''' one may '''override''' this default behavior by setting the '''parameter''' {{para|st}} (for no italics) or {{para|st|&#39;&#39;}} (for italics) as in the following example:
'''However,''' one may '''override''' this default behavior by setting the '''parameter''' {{para|st}} (for no italics) or {{para|st|&#39;&#39;}} (for italics) as in the following example:
:{{tl|LinkText|Messiah|st{{=}}}}
<pre>{{LinkText|Messiah|st=}}</pre>
producing (the preferred)
producing (the preferred)
:Original text and translations may be found at '''[[Messiah]]'''.
:Original text and translations may be found at '''[[Messiah]]'''.
When linking to more than one text, the parameter {{para|st}} applies to each link display, and this can produce undesired results, such as:
When linking to more than one text, the parameter {{para|st}} applies to each link display, and this can produce undesired results, such as:
:{{tl|LinkText|3|Messiah|Pie Jesu|Psalm 118|st{{=}}&#39;&#39;}}
<pre>{{LinkText|3|Messiah|Pie Jesu|Psalm 118|st=''}}</pre>
producing (not good)
producing (not good)
:Original text and translations may be found at '''''[[Messiah]]''''', '''''[[Pie Jesu]]''''', and '''''[[Psalm 118]]'''''.
:Original text and translations may be found at '''''[[Messiah]]''''', '''''[[Pie Jesu]]''''', and '''''[[Psalm 118]]'''''.
or
<pre>{{LinkText|3|Messiah|Pie Jesu|Psalm 118|st=}}</pre>
:{{tl|LinkText|3|Messiah|Pie Jesu|Psalm 118|st{{=}}}}
producing (not good)
producing (not good)
:Original text and translations may be found at '''[[Messiah]]''', '''[[Pie Jesu]]''', and '''[[Psalm 118]]'''.
:Original text and translations may be found at '''[[Messiah]]''', '''[[Pie Jesu]]''', and '''[[Psalm 118]]'''.
'''For linking to 2 or 3 text pages:''' Instead of using the "blanket" parameter {{para|st}}, one can specify whether to italicize or not with the parameters {{para|st1}} (for the first parameter), {{para|st2}} (for the second parameter), and {{para|st3}} (for the third parameter).  For example,
'''For linking to 2 or 3 text pages:''' Instead of using the "blanket" parameter {{para|st}}, one can specify whether to italicize or not with the parameters {{para|st1}} (for the first parameter), {{para|st2}} (for the second parameter), and {{para|st3}} (for the third parameter).  For example,
:<tt><nowiki>{{LinkText|3|Hallelujah|Lamentations of Jeremiah|Paulus|st1=''|st2=|st3=''}}</nowiki></tt>
<pre>{{LinkText|3|Hallelujah|Lamentations of Jeremiah|Paulus|st1=''|st2=|st3=''}}</pre>
produces
produces
:Original text and translations may be found at '''''[[Hallelujah]]''''', '''[[Lamentations of Jeremiah]]''', and '''''[[Paulus]]'''''.
:Original text and translations may be found at '''''[[Hallelujah]]''''', '''[[Lamentations of Jeremiah]]''', and '''''[[Paulus]]'''''.
The same result could be obtained with  
The same result could be obtained with  
:{{tl|LinkText|3|Hallelujah|Lamentations of Jeremiah|Paulus|st2{{=}}}}
<pre>{{LinkText|3|Hallelujah|Lamentations of Jeremiah|Paulus|st2=}}</pre>
since "Hallelujah" and "Paulus" would be italicized by default.
since "Hallelujah" and "Paulus" would be italicized by default.


<h4>Extended syntax examples</h4>
<h4>Extended syntax examples</h4>
'''To add more information after a link''', when there is just one link, use the following scheme:
'''To add more information after a link''', when there is just one link, use the following scheme:
:<tt><nowiki>{{LinkText|Ave Maria|{{sp}}- ''Virgo serena''.}}</nowiki></tt>
<pre>{{LinkText|Ave Maria|{{sp}}- ''Virgo serena''}}</pre>
produces
produces
:Original text and translations may be found at '''''[[Ave Maria]]''' - Virgo serena''.
:Original text and translations may be found at '''''[[Ave Maria]]''' - Virgo serena''.
and
and
:<tt><nowiki>{{LinkText|Lamentations of Jeremiah|{{sp}}'''1:1-5'''.|st=}}</nowiki></tt>
<pre>{{LinkText|Lamentations of Jeremiah|{{sp}}'''1:1-5'''.|st=}}</pre>
(note the default italics have been overridden with "{{para|st}}") produces
(note the default italics have been overridden with "{{para|st}}") produces
:Original text and translations may be found at '''[[Lamentations of Jeremiah]] 1:1-5'''.
:Original text and translations may be found at '''[[Lamentations of Jeremiah]] 1:1-5'''.
'''For 2 or 3 links,''' use the following example:
'''For 2 or 3 links,''' use the following example:
:<tt><nowiki>{{LinkText|3|Psalm 126|Lamentations of Jeremiah|Psalm 95|st2=|add1=:1-9|add2={{sp}}'''1:1-5'''|add3=:3-6.}}</nowiki></tt>
<pre>{{LinkText|3|Psalm 126|Lamentations of Jeremiah|Psalm 95|st2=|add1=:1-9|add2={{sp}}'''1:1-5'''|add3=:3-6.}}</pre>
produces
produces
:Original text and translations may be found at '''[[Psalm 126]]''':1-9, '''[[Lamentations of Jeremiah]] 1:1-5''', and '''[[Psalm 95]]''':3-6.
:Original text and translations may be found at '''[[Psalm 126]]''':1-9, '''[[Lamentations of Jeremiah]] 1:1-5''', and '''[[Psalm 95]]''':3-6.

Revision as of 22:53, 20 April 2013

Original text and translations may be found at [[{{{1}}}]].[[Category:{{{1}}}| LinkTex]]


Documentation

Default behavior

This template provides links for up to three text pages. Its default behavior is to italicize all links except those that begin with Psalm as in:

{{LinkText|Ave verum corpus}}

producing

Original text and translations may be found at Ave verum corpus.
{{LinkText|2|Psalm 131|Wachet auf, ruft uns die Stimme}}

producing (for two pages)

Original text and translations may be found at Psalm 131 and Wachet auf, ruft uns die Stimme.

and

{{LinkText|3|O magnum mysterium|Ave Maria|Psalm 150}}

producing (for three pages)

Original text and translations may be found at O magnum mysterium, Ave Maria, and Psalm 150.

Specifying italics or plain display explicitly

However, one may override this default behavior by setting the parameter |st= (for no italics) or |st='' (for italics) as in the following example:

{{LinkText|Messiah|st=}}

producing (the preferred)

Original text and translations may be found at Messiah.

When linking to more than one text, the parameter |st= applies to each link display, and this can produce undesired results, such as:

{{LinkText|3|Messiah|Pie Jesu|Psalm 118|st=''}}

producing (not good)

Original text and translations may be found at Messiah, Pie Jesu, and Psalm 118.
{{LinkText|3|Messiah|Pie Jesu|Psalm 118|st=}}

producing (not good)

Original text and translations may be found at Messiah, Pie Jesu, and Psalm 118.

For linking to 2 or 3 text pages: Instead of using the "blanket" parameter |st=, one can specify whether to italicize or not with the parameters |st1= (for the first parameter), |st2= (for the second parameter), and |st3= (for the third parameter). For example,

{{LinkText|3|Hallelujah|Lamentations of Jeremiah|Paulus|st1=''|st2=|st3=''}}

produces

Original text and translations may be found at Hallelujah, Lamentations of Jeremiah, and Paulus.

The same result could be obtained with

{{LinkText|3|Hallelujah|Lamentations of Jeremiah|Paulus|st2=}}

since "Hallelujah" and "Paulus" would be italicized by default.

Extended syntax examples

To add more information after a link, when there is just one link, use the following scheme:

{{LinkText|Ave Maria|{{sp}}- ''Virgo serena''}}

produces

Original text and translations may be found at Ave Maria - Virgo serena.

and

{{LinkText|Lamentations of Jeremiah|{{sp}}'''1:1-5'''.|st=}}

(note the default italics have been overridden with "|st=") produces

Original text and translations may be found at Lamentations of Jeremiah 1:1-5.

For 2 or 3 links, use the following example:

{{LinkText|3|Psalm 126|Lamentations of Jeremiah|Psalm 95|st2=|add1=:1-9|add2={{sp}}'''1:1-5'''|add3=:3-6.}}

produces

Original text and translations may be found at Psalm 126:1-9, Lamentations of Jeremiah 1:1-5, and Psalm 95:3-6.