XML Schema Definition (XSD) for an Equipment Register.

For background information about XSD, please see the following overview provided by the World Wide Web Consortium

• XML Schema Part 0: Primer
• XML Schema Part 1: Structures
• XML Schema Part 2: Datatypes

and the XML Schema Tutorial provided by w3schools.

The documentation for the Equipment-Register schema is available here.

Contributing Guide

Python is required to run the tests and to build the documentation. Java is also required to build the documentation. Git is required to interact with the repository.

Prerequisites

If you know how to install Java, Git, Python and Python packages (pytest, lxml and GTC are required) you can skip this section entirely (or only install what you do not have).

The remainder of the Contributing Guide assumes that you have executed every command and did not deviate.

Running the following commands will:

1. Install Git
2. Install Java
3. Install Python
4. Install the Python requirements (If you are familiar with virtual environments, you should install the packages into one – otherwise ignore this virtual environment stuff.)

You could also manually install each program (links above) rather than running the following winget commands.

Open a terminal (i.e., PowerShell or Command Prompt – you may need to open an elevated terminal if you are using an ITS-managed computer) and run each command sequentially to install Git, Java and Python

> winget install --exact --id Git.Git
> winget install --exact --id Oracle.JDK.22
> winget install --exact --id Python.Python.3.12

You must now restart (close then re-open) your terminal so that the executable for these installed programs becomes available to use.

Next, install the Python requirement packages (pytest, lxml and GTC)

> py -m pip install pytest lxml GTC

Finally, clone the repository and change directory, cd, into the root directory of the repository

> git clone https://github.com/MSLNZ/equipment-register-schema.git
> cd equipment-register-schema

Testing

To run the tests, execute the following command from the root directory of the repository

> pytest

Documentation

To build the documentation, execute the following command from the root directory of the repository

> py build_docs.py

See docs/README for information about the build process.