Template:UseCase: Difference between revisions
Jump to navigation
Jump to search
| [checked revision] | [checked revision] |
(→Arguments: + documentation) |
No edit summary |
||
| Line 4: | Line 4: | ||
{{version_hg|{{{2}}}}} | {{version_hg|{{{2}}}}} | ||
|- | |- | ||
|For general information on use cases see [[ | |For general information on use cases see [[UC:Use cases]] | ||
|}[[category:Use case ({{#switch:{{{1}}}|IS=IS|IL=IL|TT=TT|RS=RS|CO=CO|#default=unknown subschema}})]]<br clear="all"/></includeonly><noinclude> | |}[[category:Use case ({{#switch:{{{1}}}|IS=IS|IL=IL|TT=TT|RS=RS|CO=CO|#default=unknown subschema}})]]<br clear="all"/></includeonly><noinclude> | ||
==Application== | ==Application== | ||
This template is intended to help standardizing articles on [[ | This template is intended to help standardizing articles on [[UC:Use cases|use cases]]. It allows for a variable headline, integrates the comment on the version as returned from [[Template:Version_hg]] and shows the subschema for which the use case applies. Moreover, the page is categorized into a subcategory of [[:Category:Use case]]. | ||
===Arguments=== | ===Arguments=== | ||
This template has two unnamed obligatory arguments and eight named optional ones: | This template has two unnamed obligatory arguments and eight named optional ones: | ||
| Line 23: | Line 23: | ||
<pre>{{UseCase|IS|2.3|title=This is an Example|abbr=TiaE|reporter={{rml}}}}</pre> | <pre>{{UseCase|IS|2.3|title=This is an Example|abbr=TiaE|reporter={{rml}}}}</pre> | ||
delivers | delivers | ||
{ | {{UseCase|IS|2.3|title=This is an Example|abbr=TiaE|reporter={{rml}}}}<br clear="all"/> | ||
| | |||
| | |||
<pre>{{UseCase|TT|2.2|title=This is another Example|RS=1|IS=1}}</pre> | <pre>{{UseCase|TT|2.2|title=This is another Example|RS=1|IS=1}}</pre> | ||
delivers | delivers | ||
{{UseCase|TT|2.2|title=This is another Example|RS=1|IS=1}}<br clear="all"/> | |||
[[Category:Template for use cases]]</noinclude> | [[Category:Template for use cases]]</noinclude> | ||
Revision as of 17:16, 29 January 2018
Application
This template is intended to help standardizing articles on use cases. It allows for a variable headline, integrates the comment on the version as returned from Template:Version_hg and shows the subschema for which the use case applies. Moreover, the page is categorized into a subcategory of Category:Use case.
Arguments
This template has two unnamed obligatory arguments and eight named optional ones:
- 1: obligatory, unnamed argument, telling you, to which subschema the use case belongs. Use the abbreviation IS, IL, TT, RS or CO
- 2: obligatory, unnamed argument, telling you, to which railML® version a page refers. It is handed further to Template:Version_hg.
- title: an optional argument for the page title. The standard value is {{PAGENAME}}. In this case the page name is inserted.
- abbr: an optional argument for the abbreviation of the use case title.
- reporter: an optional argument for the name of the institution or person reporting the use case.
- IS, IL, TT, RS, CO: Give them any value if there is an interference with the subschema; otherwise ignore this argument.
Dependencies
This template employs Template:Version_hg. It is used by no other templates.
Example
{{UseCase|IS|2.3|title=This is an Example|abbr=TiaE|reporter={{rml}}}}
delivers
| This is an Example (TiaE) Subschema: Infrastructure Reported by: railML® |
| This page refers to version 2.3 of railML®. Therefore the content is possibly outdated. The current version is 2.5 or 3.2. |
| For general information on use cases see UC:Use cases |
{{UseCase|TT|2.2|title=This is another Example|RS=1|IS=1}}
delivers
| This is another Example Subschema: Timetable and Rostering Related subschemas: IS RS |
| This page refers to version 2.2 of railML®. Therefore the content is possibly outdated. The current version is 2.5 or 3.2. |
| For general information on use cases see UC:Use cases |