Dev:Registers: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
({{under construction|user=~~~~}})
(Streamlined)
Line 1: Line 1:
{{under construction|user=[[User:Ferri Leberl|Ferri Leberl]] ([[User talk:Ferri Leberl|talk]]) 15:04, 9 January 2018 (CET)}}
{{under construction|user=[[User:Ferri Leberl|Ferri Leberl]] ([[User talk:Ferri Leberl|talk]]) 15:04, 9 January 2018 (CET)}}
{{rml}} provides a number of XML '''codelists'''. From version 2.3 onwards, they are organized and actualized separately from the schema. Your [[Dev:Downloading and using railML|{{rml}} download]] will usually contain the codelists in a directory ''codelists'', next to documentation and schema. These codelists reflect the state of the codelists at the time of the publication of the respective {{rml}} version.
The [[codelist]] '''Registers''' contains registers, databases, handbooks etc. Your [[Dev:Downloading and using railML|{{rml}} download]] will usually contain the codelist in a directory ''codelists'', next to documentation and schema. As As the codelists have shorter cycles than railML® versions have you might want to get the current list from [https://svn.railml.org/railML2/trunk/codelists https://svn.railml.org/railML2/trunk/codelists/Registers.xml].


For the current codelist see [https://svn.railml.org/railML2/trunk/codelists https://svn.railml.org/railML2/trunk/codelists].
The code lists are intended to address certain frequently used entities with a single code, as to avoid repetitious work as well as ambiguity errors. Moreover, the separation of schema and codelists allows actualizing the codelists in very short cycles. The concept of codelists is explained [[codelists|here]].
==Concept==
The code lists are intended to address certain frequently used entities with a single code, as to avoid repetitious work as well as ambiguity errors. For instance, using {{CO:Tag|infrastructureManager}}, you can address the [https://en.wikipedia.org/wiki/Austrian_Federal_Railways Austrian Federal Railways] (ÖBB) with their code ''ÖBB'': <infrastructureManager code=ÖBB>. In this way, you inherit all information that is collected about the ÖBB in the code list, in this case name, country code and company code:
<syntaxhighlight lang="xml">
<infrastructureManager code="ÖBB">
  <name>ÖBB Infra</name>
  <isoCountryCode>AT</isoCountryCode>
  <companyCode>0081</companyCode>
</infrastructureManager>
</syntaxhighlight>
Moreover, the separation of schema and codelists allows actualizing the codelists in very short cycles.
==Missing entries==
==Missing entries==
Are you missing an entry? Did you find a mistake? We try to serve you with current, comprehensive and correct codelists and will try to add necessary entries as soon as possible. The actualization of the codelists does not follow the usual {{rml}} actualization cycles but happens in short terms.
Are you missing an entry? Did you find a mistake? We try to serve you with current, comprehensive and correct codelists and will try to add necessary entries as soon as possible. The actualization of the codelists does not follow the usual {{rml}} actualization cycles but happens in short terms.
Line 32: Line 22:


For an example entry see [[#Concept]].
For an example entry see [[#Concept]].
 
===Structure===
===Registers===
The items are named <register> with the following specification:
A list of registers, databases, handbooks etc. The items are named <register> with the following specification:
*Attributes
*Attributes
**{{attr|code}}: A code, that should be referred to from within an {{rml}} file
**{{attr|code}}: A code, that should be referred to from within an {{rml}} file
Line 50: Line 39:
</register>
</register>
</syntaxhighlight>
</syntaxhighlight>
==Affected Elements==
Currently the codelist InfrastructureManagers.XML can be called from three elements:
{{missing information|topic=the elements calling this codelist|user=[[User:Ferri Leberl|Ferri Leberl]] ([[User talk:Ferri Leberl|talk]]) 18:19, 9 January 2018 (CET)}}
==Current entries==
As of January 2018, the following companies are listed:
{|class="wikitable sortable"
!{{rml}} Code
!Name
!Organization
!Remarks
!Scope
!URL
!Contact
|-


===TrainClearanceGauges===
|}
A list of [https://en.wikipedia.org/wiki/Loading_gauge clearance gauge] standards. It provides data related to a particular train clearance gauge class. The items are named <trainClearanceGauge> with the following specification:
Are you missing an entry? The procedure to extend the list is explained [[CO:Codelists#Missing_entries|here]].
*Attributes
**{{attr|code}}: A code, that should be referred to from within a railML file, typically a short name for the train clearance gauges in latin letters
*Children
**<description>: Internationalized name of the clearance gauge.
**<validFor>: Gives indication, whether the clearance gauge is valid for only a national, several national or all TSI-compliant networks.
;Example entry
<syntaxhighlight lang=xml>
<trainClearanceGauge code="GA">
<description>stucture gauge GA according European standard</description>
<validFor>interoperable</validFor>
</trainClearanceGauge>
</syntaxhighlight>
 
===TrainProtectionSystems===
List of [https://en.wikipedia.org/wiki/Train_protection_system train protection systems]. It provides two container elements for track bound systems and train bound systems respectively:
====At track====
*<trainProtectionSystemsAtTrack>: Container for train protection systems, installed "at the track"
**<trainProtectionSystem>: Single entries for each train protection system, installed "at track"
***{{attr|code}}: A code that should be referred to from within an railML file, typically a short name for the train protection system in latin letters.
***<name>: Name of the system.
***<validFor>: If the code for the system differs between vehicle and track installation, put the mapping in this container element.
****<vehicleSystem>: Train protection system code of the according vehicle system.
;Example entry
<syntaxhighlight lang=xml>
<trainProtectionSystem code="Crocodile">
<name/>
<validFor>
  <vehicleSystem>Crocodile</vehicleSystem>
  <vehicleSystem>Memor</vehicleSystem>
  <vehicleSystem>Memor2</vehicleSystem>
</validFor>
</trainProtectionSystem>
</syntaxhighlight>
====On Vehicle====
*<trainProtectionSystemsOnVehicle>: Container for train protection systems, installed "on the vehicle"
**<trainProtectionSystem>: Single entries for each train protection system, installed "on vehicle"
***{{attr|code}}: A code, that should be referred to from within an railML file, typically a short name for the train protection system in latin letters.
***<name>: Name of the system.
***<validFor>: If the code for the system differs between vehicle and track installation, put the mapping in this container element.
****<trackSystem>: Train protection system code of the according track system.
;Example entry
<syntaxhighlight lang=xml>
<trainProtectionSystem code="CIR-ELKE2">
<name/>
<validFor>
  <trackSystem>LZB</trackSystem>
  <trackSystem>CIR-ELKE</trackSystem>
  <trackSystem>CIR-ELKE2</trackSystem>
</validFor>
</trainProtectionSystem>
</syntaxhighlight>
 
[[category:Common Concept]]
[[category:Common Concept]]

Revision as of 19:19, 9 January 2018

UnderConstruction.png This page is under construction. Sorry for temporary problems. See the discussion page to find a summary of the tasks and to coordinate the work on this page. Recognize that the content of this page may change quickly. Ferri Leberl (talk) 15:04, 9 January 2018 (CET)

The codelist Registers contains registers, databases, handbooks etc. Your railML® download will usually contain the codelist in a directory codelists, next to documentation and schema. As As the codelists have shorter cycles than railML® versions have you might want to get the current list from https://svn.railml.org/railML2/trunk/codelists/Registers.xml.

The code lists are intended to address certain frequently used entities with a single code, as to avoid repetitious work as well as ambiguity errors. Moreover, the separation of schema and codelists allows actualizing the codelists in very short cycles. The concept of codelists is explained here.

Missing entries

Are you missing an entry? Did you find a mistake? We try to serve you with current, comprehensive and correct codelists and will try to add necessary entries as soon as possible. The actualization of the codelists does not follow the usual railML® actualization cycles but happens in short terms.

Current codelists

The current codelists are:

InfrastructureManagers

The list contains infrastructure managing companies. The items are named <infrastructureManager> with the following specification:

  • Attributes
    • code: a code, that should be referred to from within an railML file, typically a short name for the infrastructure manager in latin letters. It links the railML® element <infrastructureManager> with the code list.
  • Children
    • <name>: The company name, with attribute
    • <isoCountryCode>: The two-digit country code of the company according to ISO 3166-1 alpha-2.
    • <companyCode>: Company codes according TAF TAP TSI B.8 or UIC IRS/leaflet 920-1:2006.

For an example entry see #Concept.

Structure

The items are named <register> with the following specification:

  • Attributes
    • code: A code, that should be referred to from within an railML® file
  • Children
    • <name>: Internationalized name of the operation or control point register
    • <organization>: Organization name that is responsible for the register
    • <remarks>: Internationalized remarks for the operation or control point register
Example entry
<register code="RL100">
 <name xml:lang="de-DE">Betriebsstellenverzeichnis</name>
 <organization xml:lang="de-DE">DB</organization>
 <remarks xml:lang="de-DE">auch/früher als DS100 oder Ril100 bezeichnet</remarks>
 <remarks xml:lang="en">also/former known as DS100 or Ril100</remarks>
</register>

Affected Elements

Currently the codelist InfrastructureManagers.XML can be called from three elements:

Missinginformation.png In this article there is information missing with respect to the elements calling this codelist. Please help improving the railML® wiki by filling the gaps. Possibly, you will find further details on the discussion page. Ferri Leberl (talk) 18:19, 9 January 2018 (CET)

Current entries

As of January 2018, the following companies are listed:

railML® Code Name Organization Remarks Scope URL Contact

Are you missing an entry? The procedure to extend the list is explained here.

Retrieved from "https://wiki2.railml.org/index.php?title=Dev:Registers&oldid=7301"