Installation

Installation des Documentize SDK

Documentize kann auf verschiedene Weise installiert werden, die jeweils auf unterschiedliche Entwicklungsumgebungen und Vorlieben zugeschnitten sind. Unten sind die empfohlenen Methoden zur Installation von Documentize aufgeführt:

1. NuGet (Bevorzugte Methode)

NuGet ist die einfachste und bevorzugte Methode zur Installation von Documentize, die sicherstellt, dass Sie immer die neueste Version und Updates direkt in Ihrer Entwicklungsumgebung haben. Weitere Details zu dieser Installationsmethode finden Sie unter Wie man Documentize SDKs mit NuGet installiert.

2. MSI-Installer

Der MSI-Installer ist eine praktische Option, wenn Sie die Documentize DLLs direkt auf Ihrem System installieren möchten. Diese Methode eignet sich ideal für Entwickler, die Documentize in mehreren Projekten verwenden möchten, ohne die DLL-Dateien manuell verwalten zu müssen. Weitere Details zu dieser Installationsmethode finden Sie unter Wie man Documentize SDKs mit MSI installiert.

3. ZIP-Archiv

Für Entwickler, die einen manuellen Ansatz bevorzugen, enthält das ZIP-Archiv die Documentize DLLs, die extrahiert und direkt zu Ihrem Projekt hinzugefügt werden können. Weitere Details zu dieser Installationsmethode finden Sie unter Wie man Documentize SDKs mit ZIP installiert.

28.12.2024

Unterabschnitte von Installation

Documentize über NuGet installieren


Tipp

NuGet ist ein kostenloser, Open-Source-Paketmanager für .NET, der das Hinzufügen, Entfernen und Aktualisieren von Bibliotheken in Visual Studio-Projekten vereinfacht. Er verwaltet automatisch Bibliotheksdateien, Referenzen und Konfigurationsänderungen.

So installieren Sie über die NuGet-Paket-Manager-Konsole

  1. Öffnen Sie Ihr Projekt:

    • Starten Sie Visual Studio und öffnen Sie Ihre .NET-Anwendung.
  2. Zugriff auf die Paket-Manager-Konsole:

    • Navigieren Sie zu Extras > NuGet-Paket-Manager > Paket-Manager-Konsole.
  3. Installieren Sie das Paket:

    • Um die neueste Vollversion zu installieren, geben Sie den Befehl Install-Package Documentize ein.
    • Um die neueste Version einschließlich Hotfixes zu installieren, verwenden Sie Install-Package Documentize -prerelease.
    • Drücken Sie Enter, um den Befehl auszuführen.

So aktualisieren Sie das Paket über die NuGet-Paket-Manager-Konsole

Wenn Sie Documentize bereits über NuGet installiert haben und auf die neueste Version aktualisieren möchten:

  1. Öffnen Sie Ihr Projekt:

    • Starten Sie Visual Studio und öffnen Sie Ihre .NET-Anwendung.
  2. Zugriff auf die Paket-Manager-Konsole:

    • Navigieren Sie zu Extras > NuGet-Paket-Manager > Paket-Manager-Konsole.
  3. Aktualisieren Sie das Paket:

    • Um auf die neueste Vollversion zu aktualisieren, geben Sie Update-Package Documentize ein.
    • Um auf die neueste Version einschließlich Hotfixes zu aktualisieren, verwenden Sie Update-Package Documentize -prerelease.
    • Drücken Sie Enter, um den Befehl auszuführen.

So installieren Sie über die GUI des NuGet-Paket-Managers

  1. Öffnen Sie Ihr Projekt:

    • Starten Sie Visual Studio und öffnen Sie Ihre .NET-Anwendung.
  2. Navigieren Sie zu NuGet-Pakete verwalten:

    • Wählen Sie im Projekt-Menü NuGet-Pakete verwalten.
  3. Suchen Sie nach Documentize:

    • Gehen Sie zum Tab Durchsuchen und geben Sie Documentize in das Suchfeld ein.
  4. Installieren Sie das Paket:

    • Klicken Sie auf Installieren/Aktualisieren neben der neuesten Version von Documentize.
    • Bestätigen Sie mit Akzeptieren im Popup-Fenster.

Vorteile der Verwendung von NuGet

  • Automatisches Abhängigkeitsmanagement:

    • NuGet verwaltet automatisch Abhängigkeiten und stellt sicher, dass alle erforderlichen Bibliotheken korrekt enthalten und aktualisiert werden. Dies reduziert das Risiko von fehlenden oder inkompatiblen Abhängigkeiten.
  • Vereinfachte Updates:

    • Das Aktualisieren von Paketen ist mit NuGet einfach, entweder über die Paket-Manager-Konsole oder die GUI. Dadurch ist es einfach, Ihre Bibliotheken mit den neuesten Funktionen und Fehlerbehebungen auf dem neuesten Stand zu halten.
  • In Visual Studio integriert:

    • NuGet ist nahtlos in Visual Studio integriert und bietet eine benutzerfreundliche Oberfläche zur Verwaltung von Paketen, ohne die Entwicklungsumgebung zu verlassen.
  • Versionierung:

    • NuGet ermöglicht es Ihnen, verschiedene Versionen von Bibliotheken anzugeben und zu verwalten, sodass Sie einfach zu vorherigen Versionen zurückkehren oder neue Releases testen können, ohne Ihre Entwicklung zu stören.

Nachteile der Verwendung von NuGet

  • Begrenzt auf Visual Studio:

    • NuGet ist hauptsächlich für die Verwendung innerhalb von Visual Studio konzipiert. Obwohl es in anderen Umgebungen verwendet werden kann, ist die Integration in Visual Studio am robustesten.
  • Möglichkeiten für Versionskonflikte:

    • In größeren Projekten mit vielen Abhängigkeiten kann das Verwalten von Versionen und das Lösen von Konflikten komplex werden. NuGet bietet Tools zur Verwaltung dessen, erfordert jedoch sorgfältige Aufmerksamkeit.
  • Netzwerkabhängigkeit:

    • Das Installieren und Aktualisieren von Paketen erfordert eine Internetverbindung. Wenn Sie in einer Umgebung mit eingeschränktem oder keinem Internetzugang arbeiten, müssen Sie möglicherweise Offline-Methoden verwenden oder Pakete im Voraus herunterladen.
  • Komplexität bei großen Projekten:

    • Bei sehr großen Projekten mit umfangreichen Abhängigkeitsbäumen kann der Aufwand für das paketverwaltung über NuGet umständlich werden. In solchen Fällen sind möglicherweise zusätzliche Tools oder Strategien erforderlich, um Abhängigkeiten effektiv zu verwalten.

Installation von Documentize über MSI

Tipp

Der MSI-Installer ist eine praktische und benutzerfreundliche Option zur Installation von Documentize, insbesondere wenn Sie die DLLs systemweit installiert haben möchten. Diese Methode vereinfacht den Installationsprozess, indem viele der erforderlichen Schritte automatisiert werden.

So installieren Sie über den MSI-Installer

  1. Laden Sie den MSI-Installer herunter:

    • Klicken Sie auf den v24.12 MSI, um den MSI-Installer für die neueste Version von Documentize herunterzuladen.
  2. Führen Sie den Installer aus:

    • Doppelklicken Sie auf die heruntergeladene MSI-Datei, um den Installationsassistenten zu starten.
  3. Folgen Sie dem Installationsassistenten:

    • Befolgen Sie die Anweisungen auf dem Bildschirm, die vom Installer bereitgestellt werden. Möglicherweise müssen Sie den Lizenzvertrag zustimmen und Installationsoptionen auswählen.
  4. Vervollständigen Sie die Installation:

    • Sobald die Installation abgeschlossen ist, werden die Documentize DLLs im Global Assembly Cache (GAC) Ihres Systems oder an einem anderen angegebenen Ort installiert.
  5. Überprüfen Sie die Installation:

    • Überprüfen Sie, ob die DLLs korrekt installiert sind, indem Sie deren Präsenz im vorgesehenen Installationsverzeichnis oder GAC überprüfen.

Vorteile der Verwendung des MSI-Installers

  • Benutzerfreundlichkeit:

    • Der MSI-Installer bietet einen einfachen und geführten Installationsprozess. Er kümmert sich um alle notwendigen Konfigurationen und platziert die DLLs an einem zentralen Ort, was die Verwendung von Documentize in mehreren Projekten erleichtert.
  • Systemweite Installation:

    • Die MSI-Methode installiert Documentize im Global Assembly Cache (GAC) des Systems oder an einem anderen zentralen Ort. Dadurch kann jede Anwendung auf dem System auf die DLLs zugreifen, ohne sie in jedem Projekt einzeln referenzieren zu müssen.
  • Automatisierte Updates:

    • Wenn Documentize einen aktualisierten Installer bereitstellt, können Sie Ihre Installation einfach aktualisieren, indem Sie die neue MSI-Datei ausführen, die normalerweise den Aktualisierungsprozess reibungslos abwickelt.
  • Konsistenz:

    • Die Verwendung des MSI-Installers stellt sicher, dass alle benötigten Dateien korrekt und konsistent in unterschiedlichen Umgebungen installiert werden, wodurch das Risiko fehlender oder falsch platzierter DLLs verringert wird.

Nachteile der Verwendung des MSI-Installers

  • Eingeschränkte Flexibilität:

    • Der MSI-Installer installiert Documentize an einem systemweiten Ort, was möglicherweise nicht für alle Entwicklungsumgebungen geeignet ist. Es kann an Flexibilität fehlen, um projektspezifische Konfigurationen oder Versionen zu berücksichtigen.
  • Möglicher Overhead:

    • Die Installation von DLLs im GAC kann zusätzlichen Overhead und Komplexität mit sich bringen, insbesondere in Szenarien, in denen mehrere Versionen von Documentize gleichzeitig benötigt werden.
  • Manuelle Deinstallation:

    • Wenn Sie Documentize deinstallieren müssen, müssen Sie den vom MSI bereitgestellten Deinstaller verwenden, der möglicherweise zurückgelassene Dateien oder Konfigurationen hinterlässt, wenn er nicht ordnungsgemäß verwaltet wird.
  • Versionskonflikte:

    • Systemweite Installationen können zu Versionskonflikten führen, wenn verschiedene Projekte unterschiedliche Versionen von Documentize benötigen. Die Verwaltung dieser Konflikte kann zusätzliche Konfigurationen oder Bereinigungen erfordern.

Installation von Documentize über ZIP

Tipp

Das ZIP-Archiv ist ideal für Entwickler, die einen manuellen Ansatz zur Verwaltung von Bibliotheken bevorzugen. Diese Methode ermöglicht es Ihnen, die benötigten DLL-Dateien direkt herunterzuladen und zu extrahieren, ohne auf einen Paketmanager oder Installer angewiesen zu sein.

So installieren Sie über das ZIP-Archiv

  1. Laden Sie das ZIP-Archiv herunter:

    • Klicken Sie auf den v24.12 ZIP, um die neueste Version von Documentize im Archivformat herunterzuladen.
  2. Entpacken Sie die Inhalte:

    • Entpacken Sie nach dem Herunterladen die Inhalte der ZIP-Datei in ein Verzeichnis Ihrer Wahl. Sie können wählen, ob Sie diese Dateien in einem gemeinsamen Verzeichnis oder innerhalb Ihrer Projektstruktur aufbewahren möchten.
  3. Fügen Sie Referenzen zu Ihrem Projekt hinzu:

    • Öffnen Sie Ihr Projekt in Ihrer IDE (z. B. Visual Studio).
    • Gehen Sie zu Projekt > Verweis hinzufügen > Durchsuchen und navigieren Sie zu dem Verzeichnis, in dem Sie die DLLs extrahiert haben.
    • Wählen Sie die entsprechenden DLL-Dateien aus und fügen Sie sie als Verweise zu Ihrem Projekt hinzu.
  4. Manuelle Updates:

    • Wenn eine neue Version von Documentize veröffentlicht wird, müssen Sie das aktualisierte ZIP-Archiv manuell herunterladen und die alten DLL-Dateien in Ihrem Projekt durch die neuen ersetzen.

Vorteile der Verwendung des ZIP-Archivs

  • Vollständige Kontrolle:

    • Sie haben die volle Kontrolle darüber, wo und wie die DLLs in Ihrem Projekt gespeichert und referenziert werden. Dies kann vorteilhaft sein, wenn Sie eine benutzerdefinierte Einrichtung bevorzugen oder Abhängigkeiten manuell verwalten müssen.
  • Keine Abhängigkeit von Paketmanagern:

    • Im Gegensatz zu NuGet sind Sie nicht auf einen Paketmanager angewiesen, um Installationen zu verwalten. Dies kann in Umgebungen vorteilhaft sein, in denen Paketmanager nicht verfügbar oder nicht gewünscht sind.
  • Portabilität:

    • Das ZIP-Archiv kann leicht geteilt und auf verschiedene Systeme übertragen werden, was es ideal für Projekte macht, die portabel oder verteilt werden müssen, ohne auf externe Tools angewiesen zu sein.

Nachteile der Verwendung des ZIP-Archivs

  • Manuelle Verwaltung:

    • Im Gegensatz zu NuGet, wo Updates und die Verwaltung von Abhängigkeiten automatisiert sind, müssen Sie bei dem ZIP-Archiv Updates manuell verwalten und sicherstellen, dass alle erforderlichen DLLs korrekt referenziert sind.
  • Risiko von Versionskonflikten:

    • Wenn Sie mehrere Projekte verwalten oder im Team arbeiten, besteht das Risiko von Versionskonflikten, wenn verschiedene Projekte unterschiedliche Versionen der DLLs verwenden. Dies erfordert eine sorgfältige Verfolgung der Versionen über die Projekte hinweg.
  • Keine automatischen Updates:

    • Sie erhalten keine automatischen Updates oder Benachrichtigungen, wenn eine neue Version verfügbar ist. Dies kann dazu führen, dass Sie veraltete Bibliotheken verwenden, es sei denn, Sie überprüfen regelmäßig auf Updates.

Nicht-Windows-Umgebung

Arbeiten mit .NET Core DLLs in einer Nicht-Windows-Umgebung

Da Documentize für .NET .NET Standard 2.0 (.NET Core 2.0) Unterstützung bietet, kann es in Core-Anwendungen verwendet werden, die auf linuxähnlichen Betriebssystemen laufen. Wir arbeiten ständig daran, die .NET Core-Unterstützung in unserer API zu verbessern. Es gibt jedoch einige Operationen, die wir unseren Kunden empfehlen, um bessere Ergebnisse bei der Nutzung der Funktionen von Documentize für .NET zu erzielen. Bitte installieren Sie:

  • libgdiplus-Paket
  • Paket mit Microsoft-kompatiblen Schriftarten: ttf-mscorefonts-installer (z. B. sudo apt-get install ttf-mscorefonts-installer). Diese Schriftarten sollten im Verzeichnis /usr/share/fonts/truetype/msttcorefonts abgelegt werden, da Documentize für .NET diesen Ordner auf linuxähnlichen Betriebssystemen durchsucht. Falls das Betriebssystem einen anderen Standardordner/-verzeichnis für Schriftarten hat, sollten Sie die folgende Codezeile verwenden, bevor Sie irgendeine Operation mit Documentize durchführen:
    Documentize.Pdf.Text.FontRepository.Sources.Add(new FolderFontSource("<Pfad des Benutzers zu den ms-Schriftarten>"));
 Deutsch