Skip to content

Revise README with SIRI schema and contribution info #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TuThoThai merged 2 commits into from
Oct 30, 2025
Merged

Revise README with SIRI schema and contribution info #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c16b8ee
Revise README with SIRI schema and contribution info
TuThoThai Oct 30, 2025
5b79511
Lint and update documentation tables
github-actions[bot] Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
# SIRI (Service interface for real-time information relating to public transport operations) XML schema
**(C) 2006-2025 NeTEx, CEN, Crown Copyright**

# Generating OJP Documentation
## Schemas for:

This document describes the generation of documentation for the OJP XML schemas. There are two goals:
- Core
- Part 1 (Context and Framework)
- Part 2 (Communications)
- Part 3 (Functional Service Interfaces: Production Timetable, Estimated Timetable, Stop Monitoring, Vehicle Monitoring, Connection Monitoring, General Message)
- Part 4 (Functional Service Interfaces: Facility Monitoring)
- Part 5 (Functional Service Interfaces: Situation Exchange)
- Part 6 (Functional Service Interfaces: Control Actions)

* Generate plain HTML documentation with a table of contents for reference purposes.
* Provide the HTML documentation in a format so it can be easily integrated into the associated CEN standards document which is maintained as an MS Word file.
## Overview

## Prerequisites
SIRI is a European standard and that enables real-time information about public transportation to be shared between different computer systems.
SIRI was established as European standard in October 2006. It is a CEN (Comité Européen de Normalisation) norm and Technical Specification.

The documentation generation process requires an XSLT 1.0 processor like [Apache Xalan-J](http://xalan.apache.org/xalan-j/index.html) or (xsltproc](http://xmlsoft.org/XSLT/).
## Folder structure 📁

On Linux, install xsltproc running `apt-get install xsltproc` (or the required equivalent in non-Debian based distributions).
In each branch, we have:
- The folder `xsd` in which all the XML schemas can be found
- The folder `examples` in which all examples can be found
- At the root folder, `Siri.spp` which is the project for XMLSpy and `Siri.xpr` for Oxygen

For Windows, you'll find Windows binaries for xsltproc at http://xmlsoft.org/XSLT/.
## Branches 🌿
|**Branch**|**Description**|**Link**|
|----------|---------------|--------|
|master|The latest version of the XML Schema that matches the CEN documentation|[Direct link](https://github.com/SIRI-CEN/SIRI)|
|integration|All the upcoming work that goes with the revision of SIRI, matching the next round of CEN documentation|[Direct link](https://github.com/SIRI-CEN/SIRI/tree/integration)|

## Generation of HTML documentation
## How to contribute

### Instructions

On Linux and with the above prerequisites at hand, you can run `generate-tables.sh` to convert the XML schemas into a single HTML file [`index.html`](generated/index.html) in the `generated` subdirectory.

The generated HTML file requires the file `asciidoc.css` to be in the same directory. The above script makes sure it's there.

On Windows, please refer to the `generate-tables.sh` to figure out the necessary program invocations for your XSLT processor of choice.

### Inner workings

`generate-tables.sh` runs `xsltproc` twice. First the file `schema-collection.xml` is run against `ojp-to-prepdoc.xsl`. This combines all references XSD files to a single intermediate XML files which maps all information into a simplified structure that will make it easier in the second step to generate the final HTML documentation.

Once, you have the intermediate XML file (`generated/OJP-prep.xml`), you can run that against the `ojp-prep-to-html-with-toc.xsl` stylesheet. This will generate the final `index.html` (HTML with table of contents). Alternatively, if you don't want the table of contents, you can use the stylesheet `ojp-prep-to-html.xsl`.

## XML Schema Convention Check

There is an additional XSLT stylesheet `check-ojp-schemas.xsl` (invoked by `check-ojp-schemas.sh`) that can be used to check whether certain conventions for the design
of the XML schemas for OJP have been violated.
When you want to suggest a change to SIRI XSD, please target:
- Master for any bug fixes or typos
- Integration for any functional changes
40 changes: 20 additions & 20 deletions docs/generated/contab/acsb.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ <h3>1.3. The complex type <code>acsb:AccessibilityAssessmentStructure</code>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>+<a shape="rect" href="#local-type.typedef-24.1" title="local-type: typedef-24.1">local-type: typedef-24.1</a>
<em>+<a shape="rect" href="#local-type.typedef-47.1" title="local-type: typedef-47.1">local-type: typedef-47.1</a>
</em>
</p>
</td>
Expand All @@ -272,7 +272,7 @@ <h3>1.3. The complex type <code>acsb:AccessibilityAssessmentStructure</code>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>+<a shape="rect" href="#local-type.typedef-24.2" title="local-type: typedef-24.2">local-type: typedef-24.2</a>
<em>+<a shape="rect" href="#local-type.typedef-47.2" title="local-type: typedef-47.2">local-type: typedef-47.2</a>
</em>
</p>
</td>
Expand All @@ -297,7 +297,7 @@ <h3>1.3. The complex type <code>acsb:AccessibilityAssessmentStructure</code>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>+<a shape="rect" href="#local-type.typedef-60.1" title="local-type: typedef-60.1">local-type: typedef-60.1</a>
<em>+<a shape="rect" href="#local-type.typedef-39.1" title="local-type: typedef-39.1">local-type: typedef-39.1</a>
</em>
</p>
</td>
Expand Down Expand Up @@ -544,7 +544,7 @@ <h3>1.4. The complex type <code>acsb:AccessibilityLimitationStructure</code>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>+<a shape="rect" href="#local-type.typedef-60.1" title="local-type: typedef-60.1">local-type: typedef-60.1</a>
<em>+<a shape="rect" href="#local-type.typedef-39.1" title="local-type: typedef-39.1">local-type: typedef-39.1</a>
</em>
</p>
</td>
Expand Down Expand Up @@ -589,8 +589,8 @@ <h3>1.5. The complex type <code>acsb:LimitationRefStructure</code>
</table>
</div>
</div>
<div class="sect2" id="local-type.typedef-24.1">
<h3>1.6. The complex type <code>complexType[acsb:AccessibilityAssessmentStructure]/Limitations#complexType (typedef-24.1)</code>
<div class="sect2" id="local-type.typedef-47.1">
<h3>1.6. The complex type <code>complexType[acsb:AccessibilityAssessmentStructure]/Limitations#complexType (typedef-47.1)</code>
</h3>
<div class="sectionbody">
<table class="tableblock frame-all grid-all spread">
Expand All @@ -610,7 +610,7 @@ <h3>1.6. The complex type <code>complexType[acsb:AccessibilityAssessmentStructur
<br/>
<code>  /Limitations #complexType</code>
<br/>
<code>  (typedef-24.1)</code>
<code>  (typedef-47.1)</code>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
Expand Down Expand Up @@ -652,8 +652,8 @@ <h3>1.6. The complex type <code>complexType[acsb:AccessibilityAssessmentStructur
</table>
</div>
</div>
<div class="sect2" id="local-type.typedef-24.2">
<h3>1.7. The complex type <code>complexType[acsb:AccessibilityAssessmentStructure]/Suitabilities#complexType (typedef-24.2)</code>
<div class="sect2" id="local-type.typedef-47.2">
<h3>1.7. The complex type <code>complexType[acsb:AccessibilityAssessmentStructure]/Suitabilities#complexType (typedef-47.2)</code>
</h3>
<div class="sectionbody">
<table class="tableblock frame-all grid-all spread">
Expand All @@ -673,7 +673,7 @@ <h3>1.7. The complex type <code>complexType[acsb:AccessibilityAssessmentStructur
<br/>
<code>  /Suitabilities #complexType</code>
<br/>
<code>  (typedef-24.2)</code>
<code>  (typedef-47.2)</code>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
Expand Down Expand Up @@ -715,8 +715,8 @@ <h3>1.7. The complex type <code>complexType[acsb:AccessibilityAssessmentStructur
</table>
</div>
</div>
<div class="sect2" id="local-type.typedef-60.1">
<h3>1.8. The complex type <code>element[ifopt:Extensions]#complexType (typedef-60.1)</code>
<div class="sect2" id="local-type.typedef-39.1">
<h3>1.8. The complex type <code>element[ifopt:Extensions]#complexType (typedef-39.1)</code>
</h3>
<div class="sectionbody">
<table class="tableblock frame-all grid-all spread">
Expand All @@ -736,7 +736,7 @@ <h3>1.8. The complex type <code>element[ifopt:Extensions]#complexType (typedef-6
<br/>
<code>  #complexType</code>
<br/>
<code>  (typedef-60.1)</code>
<code>  (typedef-39.1)</code>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
Expand All @@ -752,8 +752,8 @@ <h3>1.8. The complex type <code>element[ifopt:Extensions]#complexType (typedef-6
</table>
</div>
</div>
<div class="sect2" id="local-type.typedef-60.1">
<h3>1.9. The complex type <code>element[ifopt:Extensions]#complexType (typedef-60.1)</code>
<div class="sect2" id="local-type.typedef-39.1">
<h3>1.9. The complex type <code>element[ifopt:Extensions]#complexType (typedef-39.1)</code>
</h3>
<div class="sectionbody">
<table class="tableblock frame-all grid-all spread">
Expand All @@ -773,7 +773,7 @@ <h3>1.9. The complex type <code>element[ifopt:Extensions]#complexType (typedef-6
<br/>
<code>  #complexType</code>
<br/>
<code>  (typedef-60.1)</code>
<code>  (typedef-39.1)</code>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
Expand Down Expand Up @@ -1672,12 +1672,12 @@ <h3>3.1. Simple type definitions</h3>
</tr>
<tr>
<td colspan="1" rowspan="2" class="tableblock halign-left valign-top">
<p id="local-type.typedef-27.1" class="tableblock">
<p id="local-type.typedef-48.1" class="tableblock">
<code>group[acsb:UserNeedGroup]</code>
<br/>
<code>  /MedicalNeed #simpleType</code>
<br/>
<code>  (typedef-27.1)</code>
<code>  (typedef-48.1)</code>
</p>
</td>
<td colspan="2" rowspan="1" class="tableblock halign-left valign-top">
Expand Down Expand Up @@ -1844,7 +1844,7 @@ <h3>3.7. The group <code>acsb:UserNeedGroup</code>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>
<a shape="rect" href="/home/runner/work/SIRI/SIRI/docs/generated/contab/acsb.enum-dict.html#local-enum.typedef-27.1" title="local-type: typedef-27.1">local-type: typedef-27.1</a>
<a shape="rect" href="/home/runner/work/SIRI/SIRI/docs/generated/contab/acsb.enum-dict.html#local-enum.typedef-48.1" title="local-type: typedef-48.1">local-type: typedef-48.1</a>
</em>
</p>
</td>
Expand Down Expand Up @@ -2173,7 +2173,7 @@ <h3>3.10. The complex type <code>acsb:UserNeedStructure</code>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>
<a shape="rect" href="/home/runner/work/SIRI/SIRI/docs/generated/contab/acsb.enum-dict.html#local-enum.typedef-27.1" title="local-type: typedef-27.1">local-type: typedef-27.1</a>
<a shape="rect" href="/home/runner/work/SIRI/SIRI/docs/generated/contab/acsb.enum-dict.html#local-enum.typedef-48.1" title="local-type: typedef-48.1">local-type: typedef-48.1</a>
</em>
</p>
</td>
Expand Down
32 changes: 16 additions & 16 deletions docs/generated/contab/datex2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107112,7 +107112,7 @@ <h3>2.204. The complex type <code>orc:Itinerary</code>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>+<a shape="rect" href="#local-type.typedef-17.1" title="local-type: typedef-17.1">local-type: typedef-17.1</a>
<em>+<a shape="rect" href="#local-type.typedef-49.1" title="local-type: typedef-49.1">local-type: typedef-49.1</a>
</em>
</p>
</td>
Expand Down Expand Up @@ -111020,7 +111020,7 @@ <h3>2.219. The complex type <code>orc:MeasurementSiteRecord</code>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>+<a shape="rect" href="#local-type.typedef-17.2" title="local-type: typedef-17.2">local-type: typedef-17.2</a>
<em>+<a shape="rect" href="#local-type.typedef-49.2" title="local-type: typedef-49.2">local-type: typedef-49.2</a>
</em>
</p>
</td>
Expand Down Expand Up @@ -111865,7 +111865,7 @@ <h3>2.224. The complex type <code>orc:MultilingualString</code>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>+<a shape="rect" href="#local-type.typedef-17.3" title="local-type: typedef-17.3">local-type: typedef-17.3</a>
<em>+<a shape="rect" href="#local-type.typedef-49.3" title="local-type: typedef-49.3">local-type: typedef-49.3</a>
</em>
</p>
</td>
Expand Down Expand Up @@ -127573,7 +127573,7 @@ <h3>2.266. The complex type <code>orc:SiteMeasurements</code>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>+<a shape="rect" href="#local-type.typedef-17.4" title="local-type: typedef-17.4">local-type: typedef-17.4</a>
<em>+<a shape="rect" href="#local-type.typedef-49.4" title="local-type: typedef-49.4">local-type: typedef-49.4</a>
</em>
</p>
</td>
Expand Down Expand Up @@ -145442,8 +145442,8 @@ <h3>2.326. The complex type <code>orc:WinterDrivingManagement</code>
</table>
</div>
</div>
<div class="sect2" id="local-type.typedef-17.1">
<h3>2.327. The complex type <code>complexType[Itinerary]/locationContainedInItinerary#complexType (typedef-17.1)</code>
<div class="sect2" id="local-type.typedef-49.1">
<h3>2.327. The complex type <code>complexType[Itinerary]/locationContainedInItinerary#complexType (typedef-49.1)</code>
</h3>
<div class="sectionbody">
<table class="tableblock frame-all grid-all spread">
Expand All @@ -145463,7 +145463,7 @@ <h3>2.327. The complex type <code>complexType[Itinerary]/locationContainedInItin
<br/>
<code>  /locationContainedInItinerary #complexType</code>
<br/>
<code>  (typedef-17.1)</code>
<code>  (typedef-49.1)</code>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
Expand Down Expand Up @@ -145588,8 +145588,8 @@ <h3>2.327. The complex type <code>complexType[Itinerary]/locationContainedInItin
</table>
</div>
</div>
<div class="sect2" id="local-type.typedef-17.2">
<h3>2.328. The complex type <code>complexType[MeasurementSiteRecord]/measurementSpecificCharacteristics#complexType (typedef-17.2)</code>
<div class="sect2" id="local-type.typedef-49.2">
<h3>2.328. The complex type <code>complexType[MeasurementSiteRecord]/measurementSpecificCharacteristics#complexType (typedef-49.2)</code>
</h3>
<div class="sectionbody">
<table class="tableblock frame-all grid-all spread">
Expand All @@ -145609,7 +145609,7 @@ <h3>2.328. The complex type <code>complexType[MeasurementSiteRecord]/measurement
<br/>
<code>  /measurementSpecificCharacteristics #complexType</code>
<br/>
<code>  (typedef-17.2)</code>
<code>  (typedef-49.2)</code>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
Expand Down Expand Up @@ -145839,8 +145839,8 @@ <h3>2.328. The complex type <code>complexType[MeasurementSiteRecord]/measurement
</table>
</div>
</div>
<div class="sect2" id="local-type.typedef-17.3">
<h3>2.329. The complex type <code>complexType[MultilingualString]/values#complexType (typedef-17.3)</code>
<div class="sect2" id="local-type.typedef-49.3">
<h3>2.329. The complex type <code>complexType[MultilingualString]/values#complexType (typedef-49.3)</code>
</h3>
<div class="sectionbody">
<table class="tableblock frame-all grid-all spread">
Expand All @@ -145860,7 +145860,7 @@ <h3>2.329. The complex type <code>complexType[MultilingualString]/values#complex
<br/>
<code>  /values #complexType</code>
<br/>
<code>  (typedef-17.3)</code>
<code>  (typedef-49.3)</code>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
Expand Down Expand Up @@ -145902,8 +145902,8 @@ <h3>2.329. The complex type <code>complexType[MultilingualString]/values#complex
</table>
</div>
</div>
<div class="sect2" id="local-type.typedef-17.4">
<h3>2.330. The complex type <code>complexType[SiteMeasurements]/measuredValue#complexType (typedef-17.4)</code>
<div class="sect2" id="local-type.typedef-49.4">
<h3>2.330. The complex type <code>complexType[SiteMeasurements]/measuredValue#complexType (typedef-49.4)</code>
</h3>
<div class="sectionbody">
<table class="tableblock frame-all grid-all spread">
Expand All @@ -145923,7 +145923,7 @@ <h3>2.330. The complex type <code>complexType[SiteMeasurements]/measuredValue#co
<br/>
<code>  /measuredValue #complexType</code>
<br/>
<code>  (typedef-17.4)</code>
<code>  (typedef-49.4)</code>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
Expand Down
Loading