Zum Inhalt

Übersicht

Repository

Repository Issues

Allgemeine Informationen

Kurzbeschreibung des Add-ins

Behörden-KlarText ermöglicht es, Texte mithilfe von Large Language Models (LLMs) zu optimieren. Bei diesem Add-In handelt es sich um eine Implementierung, die es ermöglicht, markierten Text durch eine Schnittstelle in besser verständlichen und klareren Text zu überführen.

Welche Probleme löst es?

Viele Dokumente des täglichen Bedarfes (Verträge, Kommunikation mit Behörden usw.) beinhalten oft schwer verständlichen Text. Diese Software ermöglicht die Vereinfachung solcher Textblöcke in verständliche Sprache.

Für welche Office-App ist es gedacht?

Dieses Add-in ist für Windows Installationen von Microsoft Office Word 2016 (und neuer) entwickelt worden.

Automatisiertes Branding

Das Script branding.ps1 konfiguriert:

  • Add-In-Name
  • Backend-URL
  • Abgeleitete Artefaktnamen (MSI, Assembly, Ressourcen)

Manuelles Branding

Das Branding-Script branding.ps1 ist dazu gedacht, möglichst einfach Namen und Backend-URL des Add-Ins zu konfigurieren. Dies soll als einmalige Aktion nach dem Klonen/Forken des Repositories geschehen. Basierend auf dem gewählten Add-In Namen werden Setup und andere Dateinamen erstellt. Sollte ein differenzierteres Einstellen der einzelnen Artefakte gewünscht sein, kann man entsprechend im Projekt nach den Variablen suchen, die in branding.properties.example gesetzt sind und diese manuell ersetzen. Ersetzt man alle, ist ein Ausführen des Skripts nicht notwendig.

Bauen

Build des Add-Ins

  1. branding.properties.example nach branding.properties kopieren.
  2. Add-In-Name und Backend-URL anpassen.

  3. Branding-Script ausführen. Wenn sich Fehler beim Ausführen im Hinblick auf Rechte ergeben, ist folgender Befehl auszuführen: Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

    powershell .\branding.ps1

  4. Lösung word-add-in.sln mit Visual Studio öffnen.

  5. Build-Konfiguration auf Release setzen.
  6. Build Solution ausführen.

MSI-Ausgabepfad:

.\installer\Release\[ADDIN_NAME].msi

Lokales Debugging

  1. Schritte 1--4 aus dem Build durchführen.
  2. Build-Konfiguration auf Debug setzen.
  3. Start klicken.
  4. Word startet automatisch.
  5. Add-In testen und debuggen.

Signieren der Installationsdatei (MSI)

Das Script signMsi.ps1:

  • sucht automatisch nach einer installierten signtool-Version
  • erwartet ein Zertifikat certificate.pfx ohne Passwort im gleichen Verzeichnis

Alternative Nutzung:

.\signMsi.ps1 -pfxPassword "IhrPasswort" -pfxFile "pfad/zu/zertifikat.pfx"

Das Zertifikat kann alternativ über die Projekteigenschaften in Visual Studio konfiguriert werden.

Hinweise & Best Practices

  • Branding vor Erst-Build durchführen
  • MSI für Produktivbetrieb signieren
  • Automatisierung via CI/CD empfohlen

Requirements

Voraussetzungen

Für Build und Entwicklung werden benötigt:

  • Windows Betriebssystem
  • Visual Studio (inkl. "Visual Studio Installer Projects")
  • .NET Framework 4.7.2
  • Office 2016 oder neuer
  • Windows SDK (für signtool, optional für MSI-Signierung)
  • PowerShell

Sprachen & Frameworks

Technologie Version Verwendung
C# 7.3 Hauptsprache für das Word-Add-in und Setup helper
.NET Framework 4.7.2 Ziel-Framework für das VSTO Add-in (word-add-in.csproj)
VSTO (Visual Studio Tools for Office) Office 2016+ Runtime Host-Framework für Integration in Microsoft Word
Windows Installer (VS Setup Project) Visual Studio Installer Projects Bereitstellung des MSI über Klartext.vdproj

Module und verwendete Sprachen

Modul Zweck Verwendete Sprachen / Artefakte
word-add-in Word VSTO Add-in, stellt UI (ComparePane, Dialog) und HTTP-Anbindung bereit C# (.cs), WinForms Designer-Dateien, RESX-Ressourcen, App-/JSON-Konfiguration
klartext-installer Visual Studio Installer Projekt, erzeugt MSI-Paket fuer die Verteilung Visual Studio Setup Script (.vdproj), MSI Packaging Artefakte

Weitere projektbezogene Technologien

  • .NET Framework / VSTO fuer Microsoft Word als Hostumgebung.
  • NuGet-Pakete lokal im Verzeichnis packages/ abgelegt (keine eigenen Quellcodes, nur Binaries).
Paket Version Lizenz
Microsoft.Bcl.AsyncInterfaces 9.0.8 MIT-Lizenz (Microsoft)
System.Buffers 4.5.1 MIT-Lizenz (Microsoft)
System.IO 4.3.0 MIT-Lizenz (Microsoft)
System.IO.Pipelines 9.0.8 MIT-Lizenz (Microsoft)
System.Memory 4.5.5 MIT-Lizenz (Microsoft)
System.Net.Http 4.3.4 MIT-Lizenz (Microsoft)
System.Net.Http.Json 9.0.8 MIT-Lizenz (Microsoft)
System.Numerics.Vectors 4.5.0 MIT-Lizenz (Microsoft)
System.Runtime 4.3.0 MIT-Lizenz (Microsoft)
System.Runtime.CompilerServices.Unsafe 6.0.0 MIT-Lizenz (Microsoft)
System.Security.Cryptography.Algorithms 4.3.0 MIT-Lizenz (Microsoft)
System.Security.Cryptography.Encoding 4.3.0 MIT-Lizenz (Microsoft)
System.Security.Cryptography.Primitives 4.3.0 MIT-Lizenz (Microsoft)
System.Security.Cryptography.X509Certificates 4.3.0 MIT-Lizenz (Microsoft)
System.Text.Encodings.Web 9.0.8 MIT-Lizenz (Microsoft)
System.Text.Json 9.0.8 MIT-Lizenz (Microsoft)
System.Threading.Tasks.Extensions 4.5.4 MIT-Lizenz (Microsoft)
System.ValueTuple 4.5.0 MIT-Lizenz (Microsoft)

Containerisierung

Es werden keine Docker-Container oder Images für dieses Projekt genutzt. Bereitstellung erfolgt über das MSI aus dem Setup-Projekt.