Zum Inhalt

Übersicht

Repository

Repository Issues

Allgemeine Informationen

[!important] Diese Erweiterung funktioniert nur mit dem Behörden-KlarText Backend.

Diese LibreOffice-Erweiterung stellt die Funktionalität von Behörden-KlarText in LibreOffice bereit. Aktuell wird jedoch sogenanntes Streaming, bei dem die Antwort nach und nach angezeigt wird, noch nicht unterstützt. Der angepasste Text wird also erst angezeigt, wenn er vollständig generiert worden ist.

Bauen

Installation

Laden Sie unter Releases die Datei Behoerden-KlarText.oxt herunter. Wenn Sie Ihre LibreOffice-Installation selbst verwalten, können Sie dann über Extras > Erweiterungsverwaltung mit einem Klick auf Hinzufügen... die Datei Behoerden-KlarText.oxt installieren. Oft genügt auch ein Doppelklick auf die Behoerden-KlarText.oxt-Datei, um die Installation anzustoßen. Nach einem Neustart von LibreOffice steht Ihnen die Erweiterung zur Verfügung.

Für alle anderen Installationsarten, befolgen Sie bitte die Anleitung in der LibreOffice-Dokumentation.

Konfiguration

Die Erweiterung verwendet das Behörden-KlarText Backend, um den Text zu optimieren. Um die Erweiterung nutzen zu können, muss dieses konfiguriert und gestartet werden. Bitte befolgen Sie dazu die Anleitung in der zugehörigen Dokumentation.

Die LibreOffice-Erweiterung spricht den /simplify-Endpunkt des Backends an. Standardmäßig wird eine lokale Installation angenommen, in der der Endpunkt unter http://localhost:8000/simplify zur Verfügung steht. Wird der Endpunkt unter einer anderen Adresse bereitgestellt, beispielsweise https://example.com/simplify, kann diese in LibreOffice unter Extras > Optionen im Reiter Behörden-KlarText > Server eingetragen werden.

Wollen Sie die Erweiterung für eine ganze Behörde ausrollen, bietet es sich an, in der Behoerden-KlarText.oxt-Datei den Standardwert für den Endpunkt zu ändern. Dazu kann diese mit unzip entpackt, die Adresse http://localhost:8000/simplify mit globalem Suchen und Ersetzen durch Ihren Endpunkt ersetzt werden, und die Datei mit zip wieder neu gepackt werden.

Nutzung

Behörden-KlarText soll dabei helfen, Texte verständlicher zu formulieren. Wählen Sie zunächst den Textabschnitt aus ("markieren"), den Sie optimieren wollen.

LibreOffice-Dokument mit einem langen Satz, der markiert ist.

Klicken Sie dann auf das neu hinzugekommene Symbol (neben PDF-Export, weißes Papier mit grünem Stift) oder nutzen Sie das Tastaturkürzel Strg+Umschalttaste+H. Es öffnet sich ein neues Fenster.

Das Behörden-Klartext-Fenster. Eine Beschreibung der Inhalte folgt unten im Text.

Links erscheint der ausgewählte Originaltext. Wenn die Konfiguration korrekt ist, erscheint rechts nach einiger Zeit der optimierte Text. Sie können in beiden Textfeldern Änderungen vornehmen. Ein Klick auf "Originaltext übernehmen" ersetzt den ausgewählten Text durch den Inhalt des linken Textfelds, ein Klick auf "Optimierten Text übernehmen" durch den des rechten Textfelds. Mit "Neu generieren" wird der Inhalt des linken Textfelds erneut optimiert, das Ergebnis erscheint dann im rechten Textfeld. Möchten Sie keinen der Texte übernehmen, klicken Sie auf "Abbrechen". Es findet dann keine Änderung statt.

Das LibreOffice-Dokument, in dem der optimierte Text übernommen wurde.

Entwicklung

Der eigentliche Python-Code findet sich unter pythonpath/behoerden_klartext/. Der Ordner pythonpath/ wird zum PYTHONPATH hinzugefügt, dadurch steht das Modul behoerden_klartext für Importe zur Verfügung.

Wichtig sind folgende Dateien:

  • addon.py: Die Haupt-Benutzeroberfläche für die Erweiterung.
  • listener.py: Klassen, um auf Events reagieren zu können.
  • config.py und options_handler.py: Bereitstellen und Ändern der Konfiguration.
  • transform.py: Kommunikation mit dem Backend.

In registration.py wird die Erweiterung bei LibreOffice registriert.

Hinzu kommen weitere Konfigurationsdateien, die meist auf .xcu, .xcs und .xml enden:

  • Accelerators.xcu: Registrieren des Tastaturkürzels.
  • Addons.xcu: Hinzufügen der Erweiterung zur Toolbar.
  • BehoerdenKlarTextConfig.xcu/xcs, OptionsDialog.xcu und dialogs/BehoerdenKlarTextSettings.xdl: Konfiguration der Erweiterung.
  • META-INF/manifest.xml: Listet alle Dateien auf, die LibreOffice kennen muss.

Packen der Anwendung

LibreOffice-Erweiterungen sind simple zip-Archive. Das heißt, der Code kann einfach mit zip zu einer .oxt-Datei gepackt werden, die dann installiert werden kann.

zip -r behoerden-klartext-libreoffice.oxt ./*

Weitere Informationen zur Entwicklung von LibreOffice-Erweiterung finden sich hier: https://wiki.documentfoundation.org/Documentation/DevGuide/Extensions.

Beitragen

Dieses Projekt ist offen für Beiträge. Öffnen Sie gerne ein Issue, wenn Sie Fehler finden oder einen Merge Request, wenn Sie etwas beitragen wollen.