(C) 2009-2022 NeTEx, CEN, Crown Copyright
See the NeTEx UML Physical and Conceptual models for an UML view of the packages. (This is available in electronic format).
The individual XML files are arranged hierarchically in folders, in a similar arrangement to that of the UML model and documentation. Thus there is a main folder for each part, and subfolders for each NeTEx functional area.
There are two main root schemas:
- netex_publication : Embeds NeTEx XML model elements in a bulk output file format for use in asynchronous publication. The intended content scope can be indicated by a filter object.
- netex_siri.xsd : Embeds NeTEx XML model elements in the SIRI protocol for dynamic exchange of elements between servers. Both Request/response or publish / subscribe is supported
In addition:
- nx.xsd : Embeds NeTeX XML model elements within a simple thematic organisation to facilitate browsing and inspection of NeTEx. The NX schema is not intended for actual use.
There are XML examples of the use of both protocols, see /examples subdirectory.
There is an Altova XMLSpy project file in the root directory that provides an organised view of the schema and examples:
- NeTEx.spp
There is also an Oxygen project file:
- NeTEx.xpr
The schema is broken down systematically into small modular files; generally for each functional package in the design model (See UML Model) there are two xml schema files
- netex_xxxx_suppport.xsd - containing data type and ref structure definitions.
- netex_xxxx_version.xsd - containing the element definitions.
Any changes to the content must be formatted according to a set of rules. The formatting rules are described using Eclipse WTP configuration files. These may be imported into an Eclipse based editor or configured manually in your preferred editor. The configuration file is somewhat self-explanatory, but the important rules are:
- Character encoding must be
UTF-8 - Line width is max 200 characters
- Indentation is done using
space(opposed totabs) - Indentation level is 2 spaces
- Prerequisite: A working Maven installation
Note: Format checks take quite a bit of time for the examples folder (1 hour+), and you may limit the reformatting/checks to a set of files by specifying
-DspotlessFiles=xsd/path/to/changed/file.xsd,examples/path/to/changed/file.xml
Note2: You may also specify that only files changed since latest commit on your base branch be formatted by specifying
-DratchetFrom=<your origin>/<branch_you_are_based_on>, ie if you are creating a PR branch based on the current master: -DratchetFrom=origin/master
To verify that the code is according to standard, run from the project root folder
mvn spotless:check <see notes above>
To actually format any discrepancies, run
mvn spotless:apply <see notes above>
Reference https://github.com/diffplug/spotless/blob/main/plugin-maven/README.md#eclipse-web-tools-platform
=======
See CHANGELOG