Spezifikation für eine offene Schnittstelle für Ratsinformationssysteme
Python TeX Makefile CSS Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
resources
schema
scripts Schema im Validierungsscript cachen Jan 5, 2017
src
.editorconfig
.gitignore
.travis.yml
LICENCE
Makefile
README.md
changelog.md

README.md

OParl Wortmarke

Build Status

In diesem Repository wird die Spezifikation zum OParl-Standard erarbeitet.

Der OParl-Standard dient der Definition einer einheitlichen Schnittstelle zum Abruf von maschienlesbaren Informationen aus Ratsinformationssystemen. Mehr über OParl:

Änderungen an OParl vornehmen

OParl wird hauptsächlich auf GitHub entwickelt. Hilfe im Umgang mit GitHub findest du hier. Änderungsvorschläge können über Pull Requests eingebracht werden.

Durch den Befehl make kann aus den Quelldateien die Spezifikation erstellt werden. Dazu müssen pandoc und latex installiert sein.

Die Dateien, aus denen die Spezifikation erstellt wird, sind auf mehrere Ordner aufgeteilt:

  • src/: Enthält den gesamten Fließtext als Markdown-Dateien.
  • schema/: Enthält das Datenmodell, d.h. den Aufbau der von OParl genutzten json-Objekte, als json-Dateien in einem eigenen Format.
  • examples/: Die im Text eingebundenen Beispiele
  • scripts/: Enthält Skripte, die u.a. die json-Dateien in Markdown umwandeln und die Beispiele validieren
  • out/: Die von make erstellten Dokumente

Die Spezifikation in verschiedenen Formaten

Es stehen Versionen des Dokuments in verschiedenen Formaten zur Verfügung:

Version 1.0

Aktuelle Entwicklungsversion