Template:UseCase

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

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.
  • 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.
  • pdf:Link to the consolidated pdf. Please, employ template:UCpdf!

Dependencies

This template employs Template:Version_hg. It is used by no other templates.

Example

{{UseCase|IS|2.3|title=This is an Example of a draft|abbr=TiaE|reporter={{rml|link=no|R=no}}}}

delivers

This is an Example of a draft
(TiaE)
Subschema: Infrastructure
Reported by: railML®[[category:UC reported by railML®]]
Stift.png (version(s) 2.3)
For general information on use cases see UC:Use cases



{{UseCase|TT|2.2|title=This is an Example of a consolidated Use Case|RS=1|IS=1|pdf={{UCpdf|2.2|consolidated}}}}

delivers

This is an Example of a consolidated Use Case
Subschema: Timetable and Rostering
 
Related subschemas: IS RS 
Finish.png (version(s) 2.2)
For general information on use cases see UC:Use cases



{{UseCase|IL|3.2|title=This is an Example of a finished Use Case|RS=1|IS=1|pdf={{UCpdf|3.2|https://upload.wikimedia.org/wikipedia/commons/3/39/Migrant_caravan.pdf}}}}

delivers

This is an Example of a finished Use Case
Subschema: Interlocking
 
Related subschemas: IS RS 
Pdf.png (version(s) 3.2)
For general information on use cases see UC:Use cases