Skip to content

Spezifikation für eine offene Schnittstelle für Ratsinformationssysteme

Notifications You must be signed in to change notification settings

codeforberlin/OParl-spec

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status

OParl Wortmarke

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

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

oparl.org/

Ä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.

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

  • src/: Enthält den gesammten 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 hauptsächlich die python-skripte, die die json-Dateien in Markdown umwandeln

Durch den Befehl make kann aus den Quelldateien die Spezifikation erstellt werden. Dazu müssen pandoc und latex installiert sein. Die fertigen Dokumente finden sich dann im Ornder out.

Die Spezifikation in verschiedenen Formaten

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

Languages

  • Python 37.5%
  • TeX 32.1%
  • Makefile 18.9%
  • CSS 8.0%
  • Shell 3.5%