| Matthias Andreas Benkard | b291c36 | 2020-11-22 10:22:27 +0100 | [diff] [blame] | 1 | = ÄndGgner -- Programmbibliothek zur Konsolidierung von Änderungsgesetzen des Bundes und der Länder |
| 2 | Matthias Andreas Benkard |
| 3 | // Meta |
| 4 | :experimental: |
| 5 | :data-uri: |
| 6 | :sectnums: |
| 7 | :toc: |
| 8 | :stem: |
| 9 | :toclevels: 2 |
| 10 | :description: ÄndGgner Manual |
| 11 | :keywords: mulk |
| 12 | // Settings |
| 13 | :icons: font |
| 14 | :source-highlighter: pygments |
| 15 | |
| 16 | |
| 17 | == Resources |
| 18 | |
| 19 | |=== |
| 20 | |Resource |Links |
| 21 | |
| 22 | |Public Artifact |
| 23 | |https://bintray.com/mulk/maven/aendggner[Bintray] |
| 24 | |
| 25 | |Bug Tracker |
| 26 | |MantisBT |
| 27 | |=== |
| 28 | |
| 29 | |
| 30 | [[building]] |
| 31 | == Building a JAR |
| 32 | |
| Matthias Andreas Benkard | c7f1136 | 2020-11-22 15:01:07 +0100 | [diff] [blame] | 33 | To build an executable JAR at `target/aendggner-${REVISION}.jar`: |
| Matthias Andreas Benkard | b291c36 | 2020-11-22 10:22:27 +0100 | [diff] [blame] | 34 | |
| 35 | [source,shell script] |
| 36 | ---- |
| 37 | ./mvnw package |
| 38 | ---- |
| 39 | |
| 40 | `${REVISION}` defaults to `0.1.0-SNAPSHOT` unless you override it by |
| 41 | passing the `-Drevision` flag to `mvnw`. |
| 42 | |
| 43 | |
| 44 | == Running the Command Line Application |
| 45 | |
| 46 | To run the command line application after <<building,building>> it: |
| 47 | |
| 48 | [source,shell script] |
| 49 | ---- |
| 50 | ./mvnw exec:java |
| 51 | ---- |
| 52 | |
| 53 | |
| Matthias Andreas Benkard | 58e1998 | 2026-07-13 07:09:19 +0200 | [diff] [blame^] | 54 | [[usage]] |
| 55 | == Usage |
| 56 | |
| 57 | ÄndGgner erzeugt aus einem Stammgesetz und einem Änderungsgesetz eine |
| 58 | zweispaltige HTML-Synopse (alte Fassung links, neue rechts, Änderungen |
| 59 | wortweise hervorgehoben). |
| 60 | |
| 61 | Eingaben: |
| 62 | |
| 63 | * Stammgesetz: XML im gii-norm-Format von |
| 64 | https://www.gesetze-im-internet.de/[gesetze-im-internet.de] |
| 65 | * Änderungsgesetz: BGBl-PDF oder Klartext |
| 66 | |
| 67 | [source,shell script] |
| 68 | ---- |
| 69 | java -jar target/aendggner-0.1.0-SNAPSHOT.jar \ |
| 70 | stammgesetz.xml aenderungsgesetz.pdf -o synopse.html |
| 71 | ---- |
| 72 | |
| 73 | Wichtige Optionen: |
| 74 | |
| 75 | `-o, --output <file>`:: |
| 76 | Ausgabedatei (Default `synopse.html`; `-` = Standardausgabe). |
| 77 | `--vollstaendig`:: |
| 78 | Auch unveränderte Normen in die Synopse aufnehmen. |
| 79 | `--artikel <n>`:: |
| 80 | Nur diesen Artikel des Änderungsgesetzes anwenden (Default: alle |
| 81 | Artikel, deren Einleitung das Stammgesetz nennt). |
| 82 | `--extract-only`:: |
| 83 | Nur den bereinigten Lineartext des Änderungsgesetzes ausgeben. Nützlich, |
| 84 | wenn die PDF-Extraktion fehlerhaft ist: Text prüfen, von Hand |
| 85 | korrigieren und als Klartextdatei wieder einspeisen. |
| 86 | |
| 87 | Erkannt werden die gebräuchlichsten Änderungsbefehle des Handbuchs der |
| 88 | Rechtsförmlichkeit (Ersetzen, Neufassung, Einfügen, Anfügen, Aufheben, |
| 89 | Streichen, Umnummerierung). Alles andere — etwa Bereichsbefehle wie |
| 90 | „Die Absätze 2 bis 4 werden …“ — landet mit Begründung im Abschnitt |
| 91 | *Manuell prüfen* der Synopse und wird niemals stillschweigend verworfen. |
| 92 | |
| 93 | |
| Matthias Andreas Benkard | b291c36 | 2020-11-22 10:22:27 +0100 | [diff] [blame] | 94 | == Running the Tests |
| 95 | |
| 96 | To build and run the tests: |
| 97 | |
| 98 | [source,shell script] |
| 99 | ---- |
| 100 | ./mvnw verify |
| 101 | ---- |