Template:LinkText: Difference between revisions

From ChoralWiki
Jump to navigation Jump to search
(documentation for the sort key)
m (TextPageList)
Line 59: Line 59:


<h4>Sort key</h4>
<h4>Sort key</h4>
For automatically populated lists using {{tl|TextSettingsList}}, an optional sort key parameter can be informed using {{para|sort}} in any position:
For automatically populated lists using {{tl|TextPageList}}, an optional sort key parameter can be informed using {{para|sort}} in any position:
<pre>{{LinkText|O salutaris hostia|sort=La Rue}}</pre>
<pre>{{LinkText|O salutaris hostia|sort=La Rue}}</pre>
(the work will be sorted by the composer surname "La Rue" instead of the standard sort key which in this case would be "Rue, Pierre de La".
(the work will be sorted by the composer surname "La Rue" instead of the standard sort key which in this case would be "Rue, Pierre de La".

Revision as of 15:33, 12 May 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.

Sort key

For automatically populated lists using {{TextPageList}}, an optional sort key parameter can be informed using |sort= in any position:

{{LinkText|O salutaris hostia|sort=La Rue}}

(the work will be sorted by the composer surname "La Rue" instead of the standard sort key which in this case would be "Rue, Pierre de La".