Dev:Wiki Structuring Guidelines

From railML 3 Wiki
Jump to navigation Jump to search

Structuring Guidelines for Element Pages
 

Focus

This page explains, how to structure an element documentation page within this wiki.

A General outline for contibuting to this wiki can be found here.

If you want to start contributing to this wiki, please begin with this outline

Purpose

Element pages in the railML® wikis are being created with templates: Template:DocBase and Template:Schemaexport in the railML® 3 wiki and Template:ElementDocu in the railML® 2 wiki. Employing this template grants for a standardized design. The template specifies the paragraphs of element pages. Please, enter the relevant information for the element in the designated paragraphs according to the rules set below. This clearcut structure serves two aims:

  • It helps users to find relevant information
  • This structure sets a frame for the certification

Paragraphs (railML® 2 Wiki)

In the railML® 2 wiki, Template:ElementDocu creates the following paragraphs:
(But some of them only, if used)

  • Position of XYZ in the XML-Tree:
    • Shall contain the position of the element in the XML tree
    • Generated manually by the coordinator straightforward from the schema; no manual additions
    • Generally speaking, an application must conform to this structure to get certified successfully.
  • Multiplicity:
    • Shall contain the element multiplicity
    • Generated manually by the coordinator straightforward from the schema
    • Generally speaking, an application must conform to this structure to get certified successfully.
  • Semantics:
    • Shall contain the element semantics
    • This paragraph is developed by the railML® community
    • Should only state the intention of the element.
    • No rules or explanations should be presented here. Concise remarks like “not to be confused with” are allowed, if they explain the intention
    • Generally speaking, this information is irrelevant for certification. It is intended to help the user to understand railML®
  • Attributes:
    • Shall contain the element semantics
    • This paragraph is developed by the railML® community
    • Do not place rules or explanations here. Concise remarks like “not to be confused with” are allowed, if they explain the intention
    • Generally speaking, this information is irrelevant for certification. It is intended to help the user to understand railML®
  • Syntactic constraints:
    • Shall contain syntactic constraints set within the schema
    • Generated manually by the coordinator straightforward from the schema
    • Generally speaking, an application must conform to this structure to get certified successfully.
  • Semantic constraints:
    • Shall contain semantic constraints
    • Semantic constraints should be added only by the subschema coordinator or in reconcilement with him
    • Generally speaking, an application must conform to this structure to get certified successfully.
  • Best Practice Examples:
    • Shall contain best practice; national rules and peculiarities; Code examples
    • This paragraph is developed by the railML® community
    • Generally speaking, this information is irrelevant for certification. It is intended to help the user to understand railML®
  • Open Issues:
    • Shall contain open discussions and unsolved problems
    • This paragraph can be edited by the railML® community
    • Generally speaking, this information is irrelevant for certification. It is intended to help the user to understand railML®
  • Notes:
    • Shall contain Anything that does not fit into other paragraphs
    • This paragraph is developed by the railML® community
    • Generally speaking, this information is irrelevant for certification. It is intended to help the user to understand railML®

Structure railML® 3 Wiki

In the railML® 3 wiki, The pages are created via GWPS[1]. GWPS will for each element create a hand page that is supposed for content created by the wiki authors (best practice, notes etc) and a robot page that contains information directly retrieved from the schema and that the wiki authors should generally not touch. The robot page will be framed within the hand page.

Paragraphs Hand Pages

Hand pages are created by GWPS[1] with Template:DocBase (which will be expanded by creation). Template:DocBase creates the following paragraphs:

  • Introduction:
    • Shall contain a short introduction
    • This paragraph is developed by the railML® community
    • Generally speaking, this information is irrelevant for certification. It is intended to help the user to understand railML®
  • Documentation:
    • Container for subchapters Syntax, Semantics and (possibly) Semantic Constraints
    • This paragraph should not be edited manually, except within the subparagraphs Semantics and Semantic Constraints
  • Syntax:
    • Here the robot pages are being framed
    • Never edit manually!
  • Semantics:
    • Shall contain the semantics of and attributes
    • This paragraph is developed by the railML® community
    • Should only state the intention of the element respectively attribute.
    • No rules or explanations should be presented here. Concise remarks like “not to be confused with” are allowed, if they explain the intention
    • Generally speaking, this information is irrelevant for certification. It is intended to help the user to understand railML®
  • Best Practice / Examples:
    • Shall contain best practice; national rules and peculiarities; Code examples
    • This paragraph is developed by the railML® community
    • Generally speaking, this information is irrelevant for certification. It is intended to help the user to understand railML®
  • Additional Information:
    • Container for subchapters Notes and Open Issues
    • This paragraph should not be edited manually, except within the subparagraphs Notes and Open Issues
  • Notes:
    • Shall contain Anything that does not fit into other paragraphs
    • This paragraph is developed by the railML® community
    • Generally speaking, this information is irrelevant for certification. It is intended to help the user to understand railML®
  • Open Issues:
    • Shall contain open discussions and unsolved problems
    • This paragraph can be edited by the railML® community
    • Generally speaking, this information is irrelevant for certification. It is intended to help the user to understand railML®

Paragraphs Robot Pages

Robot pages are created by GWPS[1] with Template:Schemaexport.

Generally speaking, an application must conform to the structure depicted here to get certified successfully.

  1. 1.0 1.1 1.2 GWPS = Gruschwitz' Wonderful Python Script