Module:Annotated link/doc: Difference between revisions

Revision as of 05:37, 25 January 2023

Revision as of 05:51, 25 January 2023

Line 25:

As this module is responsible for the use of all features of Module:GetShortDescription; all the parameters for that module are available through this module; see [[#Module:GetShortDescription parameters]] (below).

:'''Markup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=JumpThe (Every Little Thing song) |display=Jump |quote=yesPartisan }}</nowiki></code>

:'''MarkupResult:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan }}</nowiki></code>

'''Result:''' {{#invoke:AnnotatedLink|main|name=The Partisan}}

This and the following example song titles should be double quoted per [[MOS:POPMUSIC]]; that will be handled by [[#quote]] (below), but you will see the parameters in use where appropriate from here on.

=== display ===

Providing a value for {{para|display}} will format the piped link with a display string:

:'''ResultMarkup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=Jump (Every Little Thing song) |display=Jump |quote=yes }}</nowiki></code>

:'''MarkupResult:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=Jump (Every Little Thing song) |display=Jump |quote=yes }}</nowiki></code>

'''Result:''' {{#invoke:AnnotatedLink|main|name=Jump (Every Little Thing song)|display=Jump|quote=yes}}

=== quote ===

Stating {{para|quote|yes}} will double quote the link:

:'''ResultMarkup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |quote=yes|only=wikidata }}</nowiki></code>

:'''MarkupResult:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |quote=yes }}</nowiki></code>

:'''ResultMarkup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=Jump (Every Little Thing song) |display=Jump |quote=yes }}</nowiki></code>

:'''Result:''' {{#invoke:AnnotatedLink|main|name=TheJump Partisan(Every Little Thing song)|display=Jump|quote=yes}}

'''Markup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=Jump (Every Little Thing song) |display=Jump |quote=yes }}</nowiki></code>

'''Result:''' {{#invoke:AnnotatedLink|main|name=Jump (Every Little Thing song)|display=Jump|quote=yes}}

=== abbr ===

Providing a value for {{para|abbr}} will append the link with the provided parenthesized abbreviation:

:'''ResultMarkup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=Confédération Mondiale des Activités Subaquatiques |display=World Underwater Federation |abbr=CMAS }}</nowiki></code>

:'''MarkupResult:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=Confédération Mondiale des Activités Subaquatiques |display=World Underwater Federation |abbr=CMAS }}</nowiki></code>

'''Result:''' {{#invoke:AnnotatedLink|main|name=Confédération Mondiale des Activités Subaquatiques|display=World Underwater Federation|abbr=CMAS}}

=== aka ===

Providing a value for {{para|aka}} will append the link (and {{para|abbr}} if provided) with a useful alternative name:

:'''ResultMarkup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |quote=yes|wedge=from the album ''[[Songs from a Room]]''|aka=La Complainte du partisan|aka_lang=fr }}</nowiki></code>

:'''MarkupResult:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |quote=yes |aka=La Complainte du partisan }}</nowiki></code>

:'''Markup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=Confédération Mondiale des Activités Subaquatiques |display=World Underwater Federation |abbr=CMAS |aka=Confédération Mondiale des Activités Subaquatiques }}</nowiki></code>

:'''Result:''' {{#invoke:AnnotatedLink|main|name=TheConfédération PartisanMondiale des Activités Subaquatiques|quotedisplay=yesWorld Underwater Federation|abbr=CMAS|aka=LaConfédération Mondiale Complaintedes duActivités partisanSubaquatiques}}

'''Markup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=Confédération Mondiale des Activités Subaquatiques |display=World Underwater Federation |abbr=CMAS |aka=Confédération Mondiale des Activités Subaquatiques }}</nowiki></code>

'''Result:''' {{#invoke:AnnotatedLink|main|name=Confédération Mondiale des Activités Subaquatiques|display=World Underwater Federation|abbr=CMAS|aka=Confédération Mondiale des Activités Subaquatiques}}

These and some following examples contain foreign language text that, per [[MOS:OTHERLANG]], should be appropriately displayed and declared via [[HTML]] markup as being of that language; this will be handled by various parameters; see [[#Foreign language text]] (below) for full details, but you will see the parameters in use where appropriate from here on.

=== wedge ===

Providing a value for {{para|wedge}} will append the link (and {{para|abbr}} and {{para|aka}} in that order if either or both is provided) with any extra details felt suitable:

:'''Markup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |quote=yes |wedge=from the album ''[[Songs from a Room]]'' |aka=La Complainte du partisan |aka_lang=fr }}</nowiki></code>

:'''MarkupResult:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |quote=yes |wedge=from the album ''[[Songs from a Room]]'' |aka=La Complainte du partisan |aka_lang=fr }}</nowiki></code>

'''Result:''' {{#invoke:AnnotatedLink|main|name=The Partisan|quote=yes|wedge=from the album ''[[Songs from a Room]]''|aka=La Complainte du partisan|aka_lang=fr}}

=== dash ===

For list consistency, per [[MOS:LISTFORMAT]]; by providing a value for {{para|dash}}; the dash between the short description and the preceding text may be exchanged for a suitable alternative:

:'''ResultMarkup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |dash=, }}</nowiki></code>

:'''MarkupResult:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |dash=, }}</nowiki></code>

'''Result:''' {{#invoke:AnnotatedLink|main|name=The Partisan|dash=,}}

=== desc_first_letter_case ===

Line 88 ⟶ 68:

Explicitly requesting the wikidata description for an entity (to be explained in [[#Module:GetShortDescription parameters]] (below)) will append an inappropriately formatted description:

:'''ResultMarkup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |quote=yes |only=wikidata|desc_first_letter_case=upper }}</nowiki></code>

:'''MarkupResult:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |quote=yes |only=wikidata }}</nowiki></code>

'''Result:''' {{#invoke:AnnotatedLink|main|name=The Partisan|quote=yes|only=wikidata}}

By stating {{para|desc_first_letter_case|upper}} the module resolves that issue:

:'''Markup:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |quote=yes |only=wikidata |desc_first_letter_case=upper }}</nowiki></code>

:'''MarkupResult:''' <code><nowiki>{{#invoke:AnnotatedLink|main |name=The Partisan |quote=yes |only=wikidata |desc_first_letter_case=upper }}</nowiki></code>

'''Result:''' {{#invoke:AnnotatedLink|main|name=The Partisan|quote=yes|only=wikidata|desc_first_letter_case=upper}}

=== Module:GetShortDescription parameters ===