JOLux Ontology

This repository is used to document the JOLux ontology of the Fedlex platform of the Federal Chancellery.

How to Contribute

Please open issues on this repository or provide pull requests for contributions.

Tip

This documentation was produced during a project between the Official Publications Centre of the Federal Chancellery and the Institute for Public Sector Transformation of the Bern University of Applied Sciences. The content is mainly stable.

Maintainers Manual

The following instructions are for maintainers of this repository that may not be familiar with Sphinx and the related tools.

Change Pages

To change the content of the documentation, the *.md files in the doc folder can be directly edited.

Change Figures

All the figures are stored in the doc/img folder and can be edited with draw.io. After editing a figure, export it as PNG and replace the existing file in the doc/img folder. PNG was chosen because of the better rendering in the PDF version of the documentation.

Tip

Export the figures with a high resolution to ensure good quality in the PDF version.

Add New Pages

To add a new page to the documentation, create a new *.md file in the doc folder and add it to the doc/index.md file by including a link to it in the appropriate section. The title for the navigation will be taken from the first heading in the new *.md file.

Also add an entry for the new page in the doc/reference.md file in the section "Concepts".

Definitions

The idea is, to have the definitions of the classes and properties in the JOLux ontology in the continuous text of the documentation. To add a new definition, add a admonition with the name of the class or property as title and the definition as content directly in the markdown file. For example:

:::{admonition} jolux:parliamentDraftId
:class: note
:name: parliamentDraftId
The data property **jolux:parliamentDraftId** is used to connect a [jolux:Draft](#Draft) to the identifier of the parliamentary process that leads to the new legal resource.
:::

Afterwards, add this definition to the reference page in the appropriate section (classes, datatype properties, object properties) with a link to the definition in the continuous text. For example:

## JoLux Datatype Properties

Others:

- [parliamentDraftId](#parliamentDraftId)

Use this definition for linking occurences of the class or property in the continuous text. For example:

The data property [jolux:parliamentDraftId](#parliamentDraftId) is used in...

Build the Webpage

The webpage of this repository will be automatically built on every commit via GitHub Actions with the help of Sphinx and deployed to https://swiss.github.io/fedlex-jolux

Local Build Instructions

For building the JOLux ontology documentation locally, follow these instructions:

Clone the Repository

git clone https://github.com/swiss/fedlex-jolux.git
cd fedlex-jolux

Set Up the Virtual Environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install --upgrade pip
pip install -r requirements.txt

Build the Documentation

sphinx-build doc _build # build HTML in the _build folder
sphinx-build -b rinoh doc _build/pdf # build PDF