Template:Site

From railML 2 Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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.

🗒️ An outline on Citations and References within the railML® wikis can be found here.

Arguments

The template has an obligatory and six 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 {{rml}} 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 {{rml}} 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 {{rml}} 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
    • 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
    • mode: if mode=silent, the link will not be commented.
    • inline: dummyargument. Set inline=1 whenever you employ the template outside <ref> tags to show that this is on purpose not in a footnote.

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.

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)