Template:UseCase

From wiki.railML.org
Jump to: navigation, search

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: 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®[[category:UC reported by railML®]]
Stift.png                   (version(s) 2.4)
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 
Stift.png                   (version(s) 2.4)
For general information on use cases see UC:Use cases