Template:Site: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
Line 23: Line 23:
If the second argument is unnamed (example: <nowiki>{{site|https://example.ex|some example text}}</nowiki>), it will be interpreted as link text. If the second argument is named (example:<nowiki>{{site|https://example.ex|type=some file format}}</nowiki>), it will be interpreted according to the argument name.
If the second argument is unnamed (example: <nowiki>{{site|https://example.ex|some example text}}</nowiki>), it will be interpreted as link text. If the second argument is named (example:<nowiki>{{site|https://example.ex|type=some file format}}</nowiki>), it will be interpreted according to the argument name.
{{note|If the content of the unnamed arguments contains equality signs or spaces this can easily result in errors.
{{note|If the content of the unnamed arguments contains equality signs or spaces 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 />
;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 and spaces signs via {{wikipedia|url encoding}} in the first argument and with {{wikipedia|HTML entities}} in the second argument:
}}


==Examples==
==Examples==

Revision as of 13:35, 17 May 2023

Usage

Use this template, whenever you set links to the railml.org website (https://railml.org).

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

For Links to other websites, please use Template:External.

Arguments

The template has an obligatory and six optional argument:

  • Obligatory; unnamed
    • 1: the link target, e.g. https://railml.org
      Notice: the mediawiki software will misinterpret URLs containing the equality sign (=). Replace equality signs in URLs with the HTML-entity &#61;.
      Example: replace {{site|https://www.railml.org/forum/index.php?t=msg&th=469&start=0&}} with {{site|https://www.railml.org/forum/index.php?t&#61;msg&th&#61;469&start&#61;0&}} as to display https://www.railml.org/forum/index.php?t=msg&th=469&start=0& (railML® website)
  • 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.
    • 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
    • visited: the date when the file was visited
    • comment: a comment to be displayed within the brackets
    • domain: The domain of the site: e.g. schemas or forum
    • inlang: en (=default), de or fr for a notice in the language of the context (inlang=silent suppresses the notice)
    • comment: anything that does not fit into the other parameters; a string to be displayed directly

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

🗒️ If the content of the unnamed arguments contains equality signs or spaces 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 and spaces signs via url encoding (Wiki banner.png) in the first argument and with HTML entities (Wiki banner.png) in the second argument:

}}

Examples

Code Output
{{site|https://railml.org}} https://railml.org (link to the railML® website)
{{site|https://railml.org|inlang=silent}} https://railml.org
{{site|https://railml.org|Our homepage}} Our homepage (link to the railML® website)
{{site|https://railml.org|type=HTML}} https://railml.org (link to the railML® website, HTML)
{{site|https://railml.org|lang=EN|text=Our homepage}} Our homepage (link to the railML® website, 🇬🇧)
{{site|https://railml.org|Our homepage|type=HTML|lang=EN}} Our homepage (link to the railML® website, HTML, 🇬🇧)
{{site|https://de.wiki.railvivid.railml.org|type=HTML|lang=DE|comment=In Development}} https://de.wiki.railvivid.railml.org (link to the railML® website, HTML, 🇩🇪; In Development)
Retrieved from "https://wiki2.railml.org/index.php?title=Template:Site&oldid=14771"