|
| 1 | +# SIRI (Service interface for real-time information relating to public transport operations) XML schema |
| 2 | +**(C) 2006-2025 NeTEx, CEN, Crown Copyright** |
1 | 3 |
|
2 | | -# Generating OJP Documentation |
| 4 | +## Schemas for: |
3 | 5 |
|
4 | | -This document describes the generation of documentation for the OJP XML schemas. There are two goals: |
| 6 | +- Core |
| 7 | +- Part 1 (Context and Framework) |
| 8 | +- Part 2 (Communications) |
| 9 | +- Part 3 (Functional Service Interfaces: Production Timetable, Estimated Timetable, Stop Monitoring, Vehicle Monitoring, Connection Monitoring, General Message) |
| 10 | +- Part 4 (Functional Service Interfaces: Facility Monitoring) |
| 11 | +- Part 5 (Functional Service Interfaces: Situation Exchange) |
| 12 | +- Part 6 (Functional Service Interfaces: Control Actions) |
5 | 13 |
|
6 | | -* Generate plain HTML documentation with a table of contents for reference purposes. |
7 | | -* 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. |
| 14 | +## Overview |
8 | 15 |
|
9 | | -## Prerequisites |
| 16 | +SIRI is a European standard and that enables real-time information about public transportation to be shared between different computer systems. |
| 17 | +SIRI was established as European standard in October 2006. It is a CEN (Comité Européen de Normalisation) norm and Technical Specification. |
10 | 18 |
|
11 | | -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/). |
| 19 | +## Folder structure 📁 |
12 | 20 |
|
13 | | -On Linux, install xsltproc running `apt-get install xsltproc` (or the required equivalent in non-Debian based distributions). |
| 21 | +In each branch, we have: |
| 22 | +- The folder `xsd` in which all the XML schemas can be found |
| 23 | +- The folder `examples` in which all examples can be found |
| 24 | +- At the root folder, `Siri.spp` which is the project for XMLSpy and `Siri.xpr` for Oxygen |
14 | 25 |
|
15 | | -For Windows, you'll find Windows binaries for xsltproc at http://xmlsoft.org/XSLT/. |
| 26 | +## Branches 🌿 |
| 27 | +|**Branch**|**Description**|**Link**| |
| 28 | +|----------|---------------|--------| |
| 29 | +|master|The latest version of the XML Schema that matches the CEN documentation|[Direct link](https://github.com/SIRI-CEN/SIRI)| |
| 30 | +|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)| |
16 | 31 |
|
17 | | -## Generation of HTML documentation |
| 32 | +## How to contribute |
18 | 33 |
|
19 | | -### Instructions |
20 | | - |
21 | | -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. |
22 | | - |
23 | | -The generated HTML file requires the file `asciidoc.css` to be in the same directory. The above script makes sure it's there. |
24 | | - |
25 | | -On Windows, please refer to the `generate-tables.sh` to figure out the necessary program invocations for your XSLT processor of choice. |
26 | | - |
27 | | -### Inner workings |
28 | | - |
29 | | -`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. |
30 | | - |
31 | | -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`. |
32 | | - |
33 | | -## XML Schema Convention Check |
34 | | - |
35 | | -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 |
36 | | -of the XML schemas for OJP have been violated. |
| 34 | +When you want to suggest a change to SIRI XSD, please target: |
| 35 | +- Master for any bug fixes or typos |
| 36 | +- Integration for any functional changes |
0 commit comments