Template:ElementDocu: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
No edit summary
(2 intermediate revisions by the same user not shown)
Line 8: Line 8:


* Children: {{{childs|''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}''}}}
* Children: {{{childs|''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}''}}}
 
===Multiplicity / {{Deu|Anzahl}} / {{fra|Multiplicité}} ===
[{{{minocc|1}}}..{{{maxocc|1}}}]
=== Semantics / {{Deu|Bedeutung}} / {{Fra|Sémantique}} ===
=== Semantics / {{Deu|Bedeutung}} / {{Fra|Sémantique}} ===


Line 86: Line 87:
**example
**example
**openissues — comments on open issues
**openissues — comments on open issues
**intro – You can optionally enter the version when the element was introduced. It will produce a reminder at the top of the article
**depr – You can optionally enter the version when the element was deprecated. It will produce a reminder at the top of the article
**minocc – the minimum number of occurances – default=1
**maxocc – the maximum of occurances – default=1
*Arguments to be discontinued — '''Do not use them anymore'''
*Arguments to be discontinued — '''Do not use them anymore'''
**inheritedAttributes — inherited attributes from other data types — use ''ownAttributes'', as the distinction between own and inherited attributes will no longer be presented in this wiki.
**inheritedAttributes — inherited attributes from other data types — use ''ownAttributes'', as the distinction between own and inherited attributes will no longer be presented in this wiki.
**bestpractice — use ''example'', as the paragraphs ''Best Practice'' and ''Examples'' have been merged
**bestpractice — use ''example'', as the paragraphs ''Best Practice'' and ''Examples'' have been merged
**intro – You can optionally enter the version when the element was introduced. It will produce a reminder at the top of the article
**depr – You can optionally enter the version when the element was deprecated. It will produce a reminder at the top of the article
===Dependencies===
===Dependencies===
The template depends on [[Template:Deu]] and [[Template:Fra]]. There is abig number of templates building on Template:ElementDocu.
The template depends on [[Template:Deu]] and [[Template:Fra]]. There is abig number of templates building on Template:ElementDocu.

Revision as of 19:37, 25 November 2018

Usage

This template is the working horse of element documentation. It provides a standardized framework on which a number of ohter templates build upon.

Aricles employing the template have the following structure:

  • Scheme description
  • Position in the XML-Tree
    • Parent
    • Children: Not yet described. / Noch nicht beschrieben. /
  • Semantics
  • Attributes
  • Constraints
  • Best practice & Examples
  • Notes
  • Open issues

Arguments

  • Obligatory:
    • elementName — the name of the element
    • semantics — a human readable explanation of the function of the described element
  • Optional:
    • parent — the name of the parent node within the XML tree
    • childs — the children nodes
    • ownAttributes — specific, not inherited attributes of this element
    • constraints
    • notes — general notes
    • example
    • openissues — comments on open issues
    • intro – You can optionally enter the version when the element was introduced. It will produce a reminder at the top of the article
    • depr – You can optionally enter the version when the element was deprecated. It will produce a reminder at the top of the article
    • minocc – the minimum number of occurances – default=1
    • maxocc – the maximum of occurances – default=1
  • Arguments to be discontinued — Do not use them anymore
    • inheritedAttributes — inherited attributes from other data types — use ownAttributes, as the distinction between own and inherited attributes will no longer be presented in this wiki.
    • bestpractice — use example, as the paragraphs Best Practice and Examples have been merged

Dependencies

The template depends on Template:Deu and Template:Fra. There is abig number of templates building on Template:ElementDocu.

Example

{{Template:ElementDocu|ElementName=SomeSampleElement|semantics=''This is an example. For readability reasons it is boxed.''}}

delivers

Scheme description / Schemenbeschreibung /

Position of FIXME in the XML-Tree / Position von FIXME im XML-Baum /

  • Parent: Not yet described. / Noch nicht beschrieben. /
  • Children: Not yet described. / Noch nicht beschrieben. /

Semantics / Bedeutung /

This is an example. For readability reasons it is boxed.

Attributes of FIXME / Attribute von FIXME /

Not yet described. / Noch nicht beschrieben. /

Constraints / Beschränkungen /

Not yet described. / Noch nicht beschrieben. /

Best practice & Examples / Empfohlene Anwendung & Beispiele /

Not yet described. / Noch nicht beschrieben. /

Notes / Anmerkungen /

Not yet described. / Noch nicht beschrieben. / Not yet described. / Noch nicht beschrieben. /

Open issues / Offene Punkte/Pedenzen /

Not yet described. / Noch nicht beschrieben. /

An example of the application of this template afield is IS:signal.