Template:UseCase: Difference between revisions
Jump to navigation
Jump to search
[checked revision] | [checked revision] |
m (Syntax) |
|||
(16 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<includeonly>{| class="wikitable" style="float:right; margin-left:10px; text-align:center" | <includeonly>{| class="wikitable" style="float:right; margin-left:10px; text-align:center" | ||
|bgcolor="white"|'''{{{title|{{PAGENAME}}}}}'''<br>Subschema: {{#switch:{{{1}}}|IS=[[Infrastructure]]|IL=[[Interlocking]]|TT=[[Timetable|Timetable and Rostering]]|RS=[[Rollingstock]]|CO=[[Common]]|#default=Subschema missing!}}{{#if:{{{IS|}}}{{{IL|}}}{{{TT|}}}{{{CO|}}}|<br> <br>Related subschemas: {{#if:{{{IS|}}}|[[Infrastructure|IS]] }}{{#if:{{{IL|}}}|[[Interlocking|IL]] }}{{#if:{{{TT|}}}|[[Timetable|TT]] }}{{#if:{{{RS|}}}|[[Rollingstock|RS]] }}{{#if:{{{CO|}}}|[[Common|CO]]}}}} | |bgcolor="white"|'''{{{title|{{PAGENAME}}}}}'''{{#if:{{{abbr|}}}|<br>({{{abbr}}})}}<br>Subschema: {{#switch:{{{1}}}|IS=[[Infrastructure]]|IL=[[Interlocking]]|TT=[[Timetable|Timetable and Rostering]]|RS=[[Rollingstock]]|CO=[[Common]]|#default=Subschema missing!}}{{#if:{{{IS|}}}{{{IL|}}}{{{TT|}}}{{{CO|}}}{{{RS|}}}|<br> <br>Related subschemas: {{#if:{{{IS|}}}|[[Infrastructure|IS]] }}{{#if:{{{IL|}}}|[[Interlocking|IL]] }}{{#if:{{{TT|}}}|[[Timetable|TT]] }}{{#if:{{{RS|}}}|[[Rollingstock|RS]] }}{{#if:{{{CO|}}}|[[Common|CO]]}}}}{{#if:{{{reporter|}}}|<br>Reported by: {{{reporter}}}[[category:UC reported by {{{reporter}}}]]|[[category:UC without specified reporter]]}} | ||
|- | |- | ||
{{ | {{{pdf|{{UCpdf|{{current}}|draft}}}}} | ||
|- | |- | ||
|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> | ||
== | ==Usage== | ||
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 | 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 | *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 {{rml}} version a page refers. It is handed further to [[Template:Version_hg]]. | *2: obligatory, unnamed argument, telling you, to which {{rml}} version a page refers. It is handed further to [[Template:Version_hg]]. | ||
*title: an optional argument for the page title. The standard value is <nowiki>{{PAGENAME}}</nowiki>. In this case the page name is inserted. | *title: an optional argument for the page title. The standard value is <nowiki>{{PAGENAME}}</nowiki>. In this case the page name is inserted. | ||
*abbr: an optional argument for the abbreviation of the use case title. | |||
*reporter: obligatory 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. | *IS, IL, TT, RS, CO: Give them any value if there is an interference with the subschema; otherwise ignore this argument. | ||
Line 19: | Line 21: | ||
==Example== | ==Example== | ||
<pre>{{UseCase|IS|2.3|title=This is an Example}}</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. | <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 18:39, 25 June 2021
Usage
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: obligatory 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®[[category:UC reported by railML®]] |
(version(s) 2.5) |
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 |
(version(s) 2.5) |
For general information on use cases see UC:Use cases