Skip to content

Commit

Permalink
OParl 1.1 🏁
Browse files Browse the repository at this point in the history
  • Loading branch information
konstin committed Jun 20, 2018
1 parent fbdc221 commit f534c59
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 27 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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:

```
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions src/1-08-oparl-autoren.md
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
26 changes: 4 additions & 22 deletions src/4-01-oparl-1-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

2 comments on commit f534c59

@sterni24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wer ist grindhold?
Mir fehlt ein Datum auf dem Deckblatt der Spezifikation.
Gilt OParl 1.1 damit als veröffentlicht?
Wenn ja, bitte die News-Einträge unter OParl.org aktualisieren und eine Pressemitteilung (Kommune21 etc.) veröffentlichen..

@konstin
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wer ist grindhold?

Grindhold ist der Autor der liboparl und hat auch commits in diesem Repository gemacht. Er darf auch mit diesem Namen in der Spezifikation stehen.

Mir fehlt ein Datum auf dem Deckblatt der Spezifikation.

Ist hinzugefügt. Bei OParl ist aber die Versionsnummer und nicht das Datum relevant.

Gilt OParl 1.1 damit als veröffentlicht?
Wenn ja, bitte die News-Einträge unter OParl.org aktualisieren und eine Pressemitteilung (Kommune21 etc.) veröffentlichen..

Ja. Mit dem Blog-Post habe ich gewartet, bis der Rest passt (Github release geschrieben, Links aktualisiert, etc.).

Please sign in to comment.