From f534c5954e77512baf663a61122047ce3e6a0c87 Mon Sep 17 00:00:00 2001 From: konstin Date: Wed, 20 Jun 2018 22:20:01 +0200 Subject: [PATCH] OParl 1.1 :checkered_flag: --- README.md | 20 ++++++++++++++++++-- src/1-08-oparl-autoren.md | 6 +++--- src/4-01-oparl-1-1.md | 26 ++++---------------------- 3 files changed, 25 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 61d6930..18797d2 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,21 @@ maschinenlesbaren Informationen aus Ratsinformationssystemen. - Weitere Informationen für Entwickler: [https://dev.oparl.org][oparl-dev] Änderungsvorschläge können über Pull Requests eingebracht werden. -Hilfe im Umgang mit GitHub findest du [hier][github-help]. +Hilfe im Umgang mit GitHub findest du [hier][github-help]. ## Die Spezifikation herunterladen Die Spezifikation kann in verschiedenen Formaten heruntergeladen werden. +### Version 1.1 + +* [PDF][spec-1-1-pdf] +* [HTML][spec-1-1-html] +* [OpenOffice/LibreOffice][spec-1-1-odt] +* [Microsoft Word][spec-1-1-docx] +* [EPub][spec-1-1-epub] +* [Nur Text][spec-1-1-txt] + ### Version 1.0 * [PDF][spec-1-0-pdf] @@ -76,7 +85,7 @@ die enstprechenden Archivierungsprogramme vorhanden sein. ### Docker -Für den geneigten Containerfreund gibt es ein Container, der alle Tools enthält. +Für den geneigten Containerfreund gibt es ein Container, der alle Tools enthält. Auch hier ein Ausgabeformat an den Aufruf angehängt werden kann: ``` @@ -109,6 +118,13 @@ Die Dateien, aus denen die Spezifikation erstellt wird, sind auf mehrere Ordner [travis]: https://travis-ci.org/OParl/spec/ [zip]: http://www.info-zip.org/ +[spec-1-1-pdf]: https://dev.oparl.org/downloads/spezifikation-1.1.pdf +[spec-1-1-html]: https://dev.oparl.org/downloads/spezifikation-1.1.html +[spec-1-1-odt]: https://dev.oparl.org/downloads/spezifikation-1.1.odt +[spec-1-1-docx]: https://dev.oparl.org/downloads/spezifikation-1.1.docx +[spec-1-1-epub]: https://dev.oparl.org/downloads/spezifikation-1.1.epub +[spec-1-1-txt]: https://dev.oparl.org/downloads/spezifikation-1.1.txt + [spec-1-0-pdf]: https://dev.oparl.org/downloads/spezifikation-1.0.pdf [spec-1-0-html]: https://dev.oparl.org/downloads/spezifikation-1.0.html [spec-1-0-odt]: https://dev.oparl.org/downloads/spezifikation-1.0.odt diff --git a/src/1-08-oparl-autoren.md b/src/1-08-oparl-autoren.md index 09f4fc8..ad103c8 100644 --- a/src/1-08-oparl-autoren.md +++ b/src/1-08-oparl-autoren.md @@ -27,9 +27,9 @@ Marianne Wulff(\*) Folgende Personen haben an OParl 1.1 mitgewirkt: -grindhold -Simeon Maxein -Sami Mussbach +grindhold, +Simeon Maxein, +Sami Mussbach, Ralf Sternberg diff --git a/src/4-01-oparl-1-1.md b/src/4-01-oparl-1-1.md index 306a30e..0619e5c 100644 --- a/src/4-01-oparl-1-1.md +++ b/src/4-01-oparl-1-1.md @@ -3,32 +3,14 @@ In OParl 1.1 setzen wir die seit der Veröffentlichung von OParl 1.0 gewonnen Erfahrungen um. OParl 1.1 ist dabei im Sinne von semver kompatibel zu OParl 1.0. Das bedeutet, dass ein für OParl 1.0 entwickelter Client auch die Ausgabe von -OParl 1.1 versteht. Dadurch ist wird der Migrationsaufwand von OParl 1.0 zu +OParl 1.1 versteht. Dadurch wird der Migrationsaufwand von OParl 1.0 zu OParl 1.1 gering gehalten. -OParl 1.0 wurde in der Annahme geschrieben, dass für sechs Objekttypen -(LegislativeTerm, Membership, AgendaItem, Consultation, File, Location) - keine verlässlichen Werte für `created` und `modified` existieren. - Aus diesem Grund hatten wir uns für das Design mit eingebetteten Objekten - entschieden. Da sich nun jedoch herausgestellt hat, dass `created` und - `modified` bei allen Objekten existieren, können auch für alle Objekte - Listen angeboten werden. Das bringt bei große Vereinfachungen für Clients - bei der Synchronisation. +OParl 1.0 wurde in der Annahme geschrieben, dass für sechs Objekttypen (LegislativeTerm, Membership, AgendaItem, Consultation, File, Location) keine verlässlichen Werte für `created` und `modified` existieren. Aus diesem Grund hatten wir uns für das Design mit eingebetteten Objekten entschieden. Da sich nun jedoch herausgestellt hat, dass `created` und `modified` bei allen Objekten existieren, können auch für alle Objekte Listen angeboten werden. Das bringt bei große Vereinfachungen für Clients bei der Synchronisation. -Konkret sind `created` und `modified` in OParl 1.1 für alle Objekte zwingend -und es gibt sechs neue externe Objektlisten in Body: AgendaItem, Consultation, -File, LegislativeTerm, Location und Membership. Das Attribut für die -Location-Liste in Body heißt dabei `locationList`, um eine Kollision -mit dem bereits existierenden `location` zu vermeiden. Das gleiche gilt auch für -`legislativeTermList`. +Konkret sind `created` und `modified` in OParl 1.1 für alle Objekte zwingend und es gibt sechs neue externe Objektlisten in Body: AgendaItem, Consultation, File, LegislativeTerm, Location und Membership. Das Attribut für die Location-Liste in Body heißt dabei `locationList`, um eine Kollision mit dem bereits existierenden `location` zu vermeiden. Das gleiche gilt auch für `legislativeTermList`. -Es entsteht dabei Redundanz zwischen den bereits existierenden Objektlisten mit -eingebetteten Objekten (Body, Paper, Meeting, Person, Organization) und den -neuen externen Listen, die die bisher eingebetteten Objekte extern ausgeben. -Diese Redundanz lässt sich auf Grund der Semver-Regeln in Version 1.1 nicht -vermeiden und kann erst in einer Version 2 beseitigt werden. Um diese Redundanz -zumindest bei der Aktualisierung eines lokalen Datenbestands vermeiden zu können -wurde die URL-Parameter `omit_internal` eingeführt. +Es entsteht dabei Redundanz zwischen den bereits existierenden Objektlisten mit eingebetteten Objekten (Body, Paper, Meeting, Person, Organization) und den neuen externen Listen, die die bisher eingebetteten Objekte extern ausgeben. Diese Redundanz lässt sich auf Grund der Semver-Regeln in Version 1.1 nicht vermeiden und kann erst in einer Version 2 beseitigt werden. Um diese Redundanz zumindest bei der Aktualisierung eines lokalen Datenbestands vermeiden zu können wurde die URL-Parameter `omit_internal` eingeführt. ### Weitere Änderungen * Namespace-URLs werden durchgängig im Camel Case geschrieben