Template:External: Difference between revisions

From railML 3 Wiki
Jump to navigation Jump to search
[unchecked revision][unchecked revision]
(→‎Arguments: documentation: mode=silent)
Line 18: Line 18:
The template has an obligatory and five optional argument:
The template has an obligatory and five optional argument:
*Obligatory; unnamed
*Obligatory; unnamed
**'''1''': the link target, e.g. {{external|https://uic.org|mode=silent}}<br>'''Notice:''' the mediawiki software will misinterpret URLs containing the equality sign (=). Replace equality signs in URLs with the HTML-entity &amp;#61;.<br>''Example:'' replace <nowiki>{{external|https://www.railml.org/forum/index.php?t=msg&th=469&start=0&}}</nowiki> with <nowiki>{{external|https://www.railml.org/forum/index.php?t&amp;#61;msg&th&amp;#61;469&start&amp;#61;0&}}</nowiki> as to display {{external|1=https://www.railml.org/forum/index.php?t&#61;msg&th&#61;469&start&#61;0&|2=https://www.railml.org/forum/index.php?t&#61;msg&th&#61;469&start&#61;0&}} ''(external link)''
**'''1''': the link target, e.g. https://uic.org. '''Please, recognize [[#note|the note below]].'''
{{note|{{anchor|note}}If the content of the unnamed arguments contains equality signs this can easily result in errors.
;example
<nowiki>{{site|https://www.railml.org/forum/index.php?t=msg&goto=71&|Heidrun Jost BaliseGroup and its attributes railML forum post}}<nowiki />}}</nowiki><br>results in:<br>{{site|https://www.railml.org/forum/index.php?t=msg&goto=71&|Heidrun Jost BaliseGroup and its attributes railML forum post}}<nowiki />
 
There are two remedies:
*Either make the argument number explicit:<br><nowiki>{{site|1=https://www.railml.org/forum/index.php?t=msg&goto=71&|2=Heidrun Jost BaliseGroup and its attributes railML forum post}}</nowiki>
*Or escape all equality signs via {{wikipedia|url encoding}} in the first argument and with {{wikipedia|HTML entities}} in the second argument:<br><nowiki>{{site|https://www.railml.org/forum/index.php?t%3Dmsg&goto%3D71&|Heidrun Jost BaliseGroup and its attributes railML forum post}}</nowiki>|reminder}}
*Optional
*Optional
**'''2''' or ''text'': the link text. If it is empty, the link target will be used as link text. This argument can be used both named or unnamed.
**'''2''' or ''text'': the link text. If it is empty, the link target will be used as link text. This argument can be used both named or unnamed. '''Please, recognize [[#note|the note above]].'''
**''date'': the publication date of the file
**''date'': the publication date of the file
**''type'': the file type, e.g. PDF
**''type'': the file type, e.g. PDF

Revision as of 13:09, 22 May 2023

Usage

The template can be used to mark external links.

This template grants that external links will be collected in category:External Link. So we keep an overview of external links and control their actuality routinely.

For Links to pages on the railML®-site (https://railml.org), please use Template:Site.

Please, consider, that the template contains an exception for links to the World Wide Web Consortium (W3C), as there are too many links to W3C data types — we want to avoid the reading flow being disturbed.

Dependencies

🗒️ The template requires the extension StringFunctions, comp. https://www.mediawiki.org/wiki/Extension:StringFunctions (external link).  

Arguments

The template has an obligatory and five optional argument:

💡 If the content of the unnamed arguments contains equality signs this can easily result in errors.
example

{{site|https://www.railml.org/forum/index.php?t=msg&goto=71&|Heidrun Jost BaliseGroup and its attributes railML forum post}}<nowiki />}}
results in:
[Heidrun Jost BaliseGroup and its attributes railML forum post Heidrun Jost BaliseGroup and its attributes railML forum post] (link to the railML® website)

There are two remedies:

  • Either make the argument number explicit:
    {{site|1=https://www.railml.org/forum/index.php?t=msg&goto=71&|2=Heidrun Jost BaliseGroup and its attributes railML forum post}}
  • Or escape all equality signs via url encoding (Wiki banner.png) in the first argument and with HTML entities (Wiki banner.png) in the second argument:
    {{site|https://www.railml.org/forum/index.php?t%3Dmsg&goto%3D71&|Heidrun Jost BaliseGroup and its attributes railML forum post}}
  
  • Optional
    • 2 or text: the link text. If it is empty, the link target will be used as link text. This argument can be used both named or unnamed. Please, recognize the note above.
    • date: the publication date of the file
    • type: the file type, e.g. PDF
    • lang: the language of the link target file, e.g. EN. For EN, FR, DE, NL, NO, CZ and ES a flag will be displayed. In all other cases the input string will be returned.
    • size: the file size — use only for very big files beyond 25 M!
    • visited: the date when the file was visited
    • inlang: en (=default), de or fr for a notice in the language of the context
    • comment: anything that does not fit into the other parameters; a string to be displayed directly
    • mode: if mode=silent, the link will not be commented.

If the second argument is unnamed (example: {{external|https://example.ex|some example text}}), it will be interpreted as link text. If the second argument is named (example:{{external|https://example.ex|type=some file format}}), it will be interpreted according to the argument name.

Examples

Code Output
{{external|https://www.uic.org}} https://www.uic.org (external link)
{{external|https://www.uic.org|International Union of Railways}} International Union of Railways (external link)
{{external|https://www.uic.org|type=HTML}} https://www.uic.org (external link, HTML)
{{external|https://www.uic.org|lang=EN|text=UIC}} UIC (external link, 🇬🇧)
{{external|https://www.uic.org|UIC|type=HTML|lang=EN}} UIC (external link, HTML, 🇬🇧)
{{external|https://www.w3.org/TR/xmlschema-2/#language}} https://www.w3.org/TR/xmlschema-2/#language
{{external|https://railml.org|mode=silent}} https://railml.org
{{external|https://railml.org|{{rml}} site|mode=silent}} railML® site
Retrieved from "https://wiki3.railml.org/index.php?title=Template:External&oldid=7367"