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 alltägliche Korrespondenzen (Mails, 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 Outlook 2016 (und neuer) entwickelt worden.

Automatisiertes Branding

Das Script branding.ps1 konfiguriert:

  • Add-In-Name
  • Backend-URL
  • Backend-Token
  • 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 KlarText-VSTO-AddIn.sln mit Visual Studio öffnen.

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

MSI-Ausgabepfad:

.\VSTO Setup\Release\Gewählter-Name.msi

Lokales Debugging

  1. Schritte 1--4 aus dem Build durchführen.
  2. Build-Konfiguration auf Debug setzen.
  3. Start klicken.
  4. Outlook 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

Standardaufruf:

powershell .\signMsi.ps1

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 10 oder neuer (64-Bit)
  • Visual Studio 2022 (empfohlen) mit Workload .NET desktop development
  • Erweiterung Visual Studio Installer Projects
  • .NET Framework 4.7.2 Developer Pack
  • Microsoft Office Outlook 2016 oder neuer (Windows-Desktop)
  • PowerShell 5.1 oder neuer (für branding.ps1 und signMsi.ps1)
  • Optional für MSI-Signierung: Windows SDK (signtool.exe) und ein Code-Signing-Zertifikat (.pfx)

Sprachen und Frameworks

Technologie Version Verwendung
C# 7.3 Hauptsprache für das Outlook-Add-in
.NET Framework 4.7.2 Ziel-Framework des Add-ins (KlarText-VSTO-AddIn/KlarText-VSTO-AddIn.csproj)
VSTO (Visual Studio Tools for Office) Office 2016+ Runtime Host-Framework für die Integration in Microsoft Outlook
Windows Installer (VS Setup Project) Visual Studio Installer Projects Erzeugung des MSI über VSTO Setup/VSTO Setup.vdproj
PowerShell 5.1+ Branding (branding.ps1) und MSI-Signierung (signMsi.ps1)

Module und Artefakte

Modul / Pfad Zweck Verwendete Sprachen / Artefakte
KlarText-VSTO-AddIn Outlook VSTO Add-in (UI, Dialoge, HTTP-Anbindung an das Backend) C# (.cs), WinForms-Designer, .resx, App.config, JSON
VSTO Setup Installer-Projekt zur Erstellung des MSI-Pakets Visual Studio Setup Script (.vdproj), MSI-/Setup-Artefakte
Repository Root Build- und Konfigurationsskripte PowerShell (branding.ps1, signMsi.ps1)
scripts Unterstützende Prüfskripte für Qualitätssicherung Python

NuGet-Abhängigkeiten

Die produktiven NuGet-Pakete sind in KlarText-VSTO-AddIn/packages.config definiert.

Paket Version
Microsoft.Bcl.AsyncInterfaces 10.0.5
Newtonsoft.Json 13.0.4
System.Buffers 4.6.1
System.Configuration.ConfigurationManager 10.0.3
System.IO.Pipelines 10.0.5
System.Memory 4.6.3
System.Numerics.Vectors 4.6.1
System.Runtime.CompilerServices.Unsafe 6.1.2
System.Text.Encodings.Web 10.0.5
System.Text.Json 10.0.5
System.Threading.Tasks.Extensions 4.6.3
System.ValueTuple 4.6.1

Lizenzhinweise zu den Drittanbieterpaketen stehen in docs/credits.md.

Containerisierung

Für das Add-in selbst werden keine Container-Artefakte ausgeliefert. Die Auslieferung erfolgt als MSI aus dem Setup-Projekt.