Template:UseCase

From railML 2 Wiki
Revision as of 18:24, 30 June 2016 by RailML Coord Documentation (talk | contribs) (Layout)
Jump to navigation Jump to search

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 six named optional ones:

  • 1: obligatory, unnamed argument, telling you, to which subschema the use case belongs
  • 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.
  • 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}}

delivers

This is an Example
Subschema: Infrastructure
This page refers to version 2.3 of railML®.
Therefore the content is possibly outdated.
The current version is 2.5.
For general information on use cases see Dev:Use cases


{{UseCase|TT|2.3|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.
For general information on use cases see Dev:Use cases