Skip to content

Commit f534c59

Browse files
committed
OParl 1.1 🏁
1 parent fbdc221 commit f534c59

File tree

3 files changed

+25
-27
lines changed

3 files changed

+25
-27
lines changed

README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,21 @@ maschinenlesbaren Informationen aus Ratsinformationssystemen.
1111
- Weitere Informationen für Entwickler: [https://dev.oparl.org][oparl-dev]
1212

1313
Änderungsvorschläge können über Pull Requests eingebracht werden.
14-
Hilfe im Umgang mit GitHub findest du [hier][github-help].
14+
Hilfe im Umgang mit GitHub findest du [hier][github-help].
1515

1616
## Die Spezifikation herunterladen
1717

1818
Die Spezifikation kann in verschiedenen Formaten heruntergeladen werden.
1919

20+
### Version 1.1
21+
22+
* [PDF][spec-1-1-pdf]
23+
* [HTML][spec-1-1-html]
24+
* [OpenOffice/LibreOffice][spec-1-1-odt]
25+
* [Microsoft Word][spec-1-1-docx]
26+
* [EPub][spec-1-1-epub]
27+
* [Nur Text][spec-1-1-txt]
28+
2029
### Version 1.0
2130

2231
* [PDF][spec-1-0-pdf]
@@ -76,7 +85,7 @@ die enstprechenden Archivierungsprogramme vorhanden sein.
7685

7786
### Docker
7887

79-
Für den geneigten Containerfreund gibt es ein Container, der alle Tools enthält.
88+
Für den geneigten Containerfreund gibt es ein Container, der alle Tools enthält.
8089
Auch hier ein Ausgabeformat an den Aufruf angehängt werden kann:
8190

8291
```
@@ -109,6 +118,13 @@ Die Dateien, aus denen die Spezifikation erstellt wird, sind auf mehrere Ordner
109118
[travis]: https://travis-ci.org/OParl/spec/
110119
[zip]: http://www.info-zip.org/
111120

121+
[spec-1-1-pdf]: https://dev.oparl.org/downloads/spezifikation-1.1.pdf
122+
[spec-1-1-html]: https://dev.oparl.org/downloads/spezifikation-1.1.html
123+
[spec-1-1-odt]: https://dev.oparl.org/downloads/spezifikation-1.1.odt
124+
[spec-1-1-docx]: https://dev.oparl.org/downloads/spezifikation-1.1.docx
125+
[spec-1-1-epub]: https://dev.oparl.org/downloads/spezifikation-1.1.epub
126+
[spec-1-1-txt]: https://dev.oparl.org/downloads/spezifikation-1.1.txt
127+
112128
[spec-1-0-pdf]: https://dev.oparl.org/downloads/spezifikation-1.0.pdf
113129
[spec-1-0-html]: https://dev.oparl.org/downloads/spezifikation-1.0.html
114130
[spec-1-0-odt]: https://dev.oparl.org/downloads/spezifikation-1.0.odt

src/1-08-oparl-autoren.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Marianne Wulff(\*)
2727

2828
Folgende Personen haben an OParl 1.1 mitgewirkt:
2929

30-
grindhold
31-
Simeon Maxein
32-
Sami Mussbach
30+
grindhold,
31+
Simeon Maxein,
32+
Sami Mussbach,
3333
Ralf Sternberg
3434

3535

src/4-01-oparl-1-1.md

+4-22
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,14 @@
33
In OParl 1.1 setzen wir die seit der Veröffentlichung von OParl 1.0 gewonnen
44
Erfahrungen um. OParl 1.1 ist dabei im Sinne von semver kompatibel zu OParl 1.0.
55
Das bedeutet, dass ein für OParl 1.0 entwickelter Client auch die Ausgabe von
6-
OParl 1.1 versteht. Dadurch ist wird der Migrationsaufwand von OParl 1.0 zu
6+
OParl 1.1 versteht. Dadurch wird der Migrationsaufwand von OParl 1.0 zu
77
OParl 1.1 gering gehalten.
88

9-
OParl 1.0 wurde in der Annahme geschrieben, dass für sechs Objekttypen
10-
(LegislativeTerm, Membership, AgendaItem, Consultation, File, Location)
11-
keine verlässlichen Werte für `created` und `modified` existieren.
12-
Aus diesem Grund hatten wir uns für das Design mit eingebetteten Objekten
13-
entschieden. Da sich nun jedoch herausgestellt hat, dass `created` und
14-
`modified` bei allen Objekten existieren, können auch für alle Objekte
15-
Listen angeboten werden. Das bringt bei große Vereinfachungen für Clients
16-
bei der Synchronisation.
9+
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.
1710

18-
Konkret sind `created` und `modified` in OParl 1.1 für alle Objekte zwingend
19-
und es gibt sechs neue externe Objektlisten in Body: AgendaItem, Consultation,
20-
File, LegislativeTerm, Location und Membership. Das Attribut für die
21-
Location-Liste in Body heißt dabei `locationList`, um eine Kollision
22-
mit dem bereits existierenden `location` zu vermeiden. Das gleiche gilt auch für
23-
`legislativeTermList`.
11+
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`.
2412

25-
Es entsteht dabei Redundanz zwischen den bereits existierenden Objektlisten mit
26-
eingebetteten Objekten (Body, Paper, Meeting, Person, Organization) und den
27-
neuen externen Listen, die die bisher eingebetteten Objekte extern ausgeben.
28-
Diese Redundanz lässt sich auf Grund der Semver-Regeln in Version 1.1 nicht
29-
vermeiden und kann erst in einer Version 2 beseitigt werden. Um diese Redundanz
30-
zumindest bei der Aktualisierung eines lokalen Datenbestands vermeiden zu können
31-
wurde die URL-Parameter `omit_internal` eingeführt.
13+
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.
3214

3315
### Weitere Änderungen
3416
* Namespace-URLs werden durchgängig im Camel Case geschrieben

0 commit comments

Comments
 (0)