インストール

Documentize SDKのインストール

Documentizeは、異なる開発環境や好みに応じた複数の方法でインストールできます。以下はDocumentizeをインストールするための推奨方法です。

1. NuGet(推奨方法)

NuGetは、Documentizeをインストールする最も簡単で推奨される方法であり、開発環境内で常に最新のバージョンと更新を利用できるようにします。このインストール方法の詳細についてはHow to install Documentize SDKs using NuGetをご覧ください。

2. MSIインストーラー

MSIインストーラーは、DocumentizeのDLLが直接システムにインストールされることを好む場合に便利なオプションです。この方法は、複数のプロジェクトでDocumentizeを使用したい開発者に最適で、DLLファイルを手動で管理する必要がありません。このインストール方法の詳細についてはHow to install Documentize SDKs using MSIをご覧ください。

3. ZIPアーカイブ

手動でのアプローチを好む開発者のために、ZIPアーカイブにはDocumentizeのDLLが含まれており、解凍してプロジェクトに直接追加できます。このインストール方法の詳細についてはHow to install Documentize SDKs using ZIPをご覧ください。

2024/12/28

インストールのサブセクション

NuGetを使用したDocumentizeのインストール


ヒント

NuGetは、Visual Studioプロジェクトにライブラリを追加、削除、更新することを簡素化する、無料のオープンソースパッケージマネージャーです。ライブラリファイル、参照、設定変更を自動的に管理します。

NuGetパッケージマネージャーコンソールを使用したインストール方法

  1. プロジェクトを開く:

    • Visual Studioを起動し、.NETアプリケーションを開きます。
  2. パッケージマネージャーコンソールにアクセスする:

    • ツール > NuGetパッケージマネージャー > パッケージマネージャーコンソールに移動します。
  3. パッケージをインストールする:

    • 最新のフルリリースをインストールするには、コマンドInstall-Package Documentizeを入力します。
    • ホットフィックスを含む最新のリリースをインストールするには、Install-Package Documentize -prereleaseを使用します。
    • コマンドを実行するにはEnterを押します。

NuGetパッケージマネージャーコンソールを使用したパッケージの更新方法

すでにNuGetを通じてDocumentizeをインストールしていて、最新バージョンに更新したい場合:

  1. プロジェクトを開く:

    • Visual Studioを起動し、.NETアプリケーションを開きます。
  2. パッケージマネージャーコンソールにアクセスする:

    • ツール > NuGetパッケージマネージャー > パッケージマネージャーコンソールに移動します。
  3. パッケージを更新する:

    • 最新のフルリリースに更新するには、Update-Package Documentizeを入力します。
    • ホットフィックスを含む最新のリリースに更新するには、Update-Package Documentize -prereleaseを使用します。
    • コマンドを実行するにはEnterを押します。

NuGetパッケージマネージャーGUIを使用したインストール方法

  1. プロジェクトを開く:

    • Visual Studioを起動し、.NETアプリケーションを開きます。
  2. NuGetパッケージの管理に移動する:

    • プロジェクトメニューからNuGetパッケージの管理を選択します。
  3. Documentizeを検索する:

    • ブラウズタブに移動し、検索ボックスにDocumentizeを入力します。
  4. パッケージをインストールする:

    • Documentizeの最新バージョンの隣にあるインストール/更新をクリックします。
    • ポップアップウィンドウで受け入れるをクリックして確認します。

NuGetを使用する利点

  • 自動依存関係管理:

    • NuGetは自動的に依存関係を管理し、必須のすべてのライブラリが正しく含まれ、更新されるようにしています。これにより、欠落や互換性のない依存関係のリスクが軽減されます。
  • 簡素化された更新:

    • パッケージの更新は、パッケージマネージャーコンソールやGUIを通じて簡単です。これにより、ライブラリを最新の機能やバグ修正で常に最新の状態に保つことができます。
  • Visual Studioとの統合:

    • NuGetはVisual Studioとシームレスに統合されており、開発環境を離れることなくパッケージを管理するためのユーザーフレンドリーなインターフェースを提供します。
  • バージョン管理:

    • NuGetを使用すると、ライブラリの異なるバージョンを指定して管理でき、以前のバージョンに簡単に戻したり、新しいリリースをテストしたりすることができます。

NuGetを使用する欠点

  • Visual Studioに限定:

    • NuGetは主にVisual Studioでの使用を目的としています。他の環境でも使用することはできますが、Visual Studioでの統合が最も強力です。
  • バージョンの競合の可能性:

    • 多くの依存関係を持つ大規模プロジェクトでは、バージョンの管理や競合の解決が複雑になることがあります。NuGetはこれを管理するためのツールを提供しますが、注意深い対応が必要です。
  • ネットワーク依存:

    • パッケージのインストールや更新にはインターネット接続が必要です。制限された環境やインターネットアクセスがない環境で作業している場合、オフラインの方法や事前にパッケージをダウンロードする必要があるかもしれません。
  • 大規模プロジェクトの複雑さ:

    • 非常に大規模なプロジェクトで広範な依存関係ツリーを持つ場合、NuGetを通じてパッケージを管理するオーバーヘッドが煩雑になることがあります。そのような場合、依存関係を効果的に管理するための追加のツールや戦略が必要になることがあります。

MSIを介してDocumentizeをインストールする

ヒント

MSIインストーラーは、特にDLLをシステム全体にインストールすることを好む場合、Documentizeをインストールするための便利で使いやすいオプションです。この方法は、関与する多くの手順を自動化することにより、インストールプロセスを簡素化します。

MSIインストーラーを介してインストールする方法

  1. MSIインストーラーをダウンロード:

    • v24.12 MSIをクリックして、最新バージョンのDocumentize用のMSIインストーラーをダウンロードします。
  2. インストーラーを実行:

    • ダウンロードしたMSIファイルをダブルクリックして、インストールウィザードを起動します。
  3. インストールウィザードに従う:

    • インストーラーから提供される画面の指示に従います。ライセンス契約に同意し、インストールオプションを選択する必要があるかもしれません。
  4. インストールを完了:

    • インストールが完了すると、DocumentizeのDLLがシステムのグローバルアセンブリキャッシュ(GAC)または指定された別の場所にインストールされます。
  5. インストールを確認:

    • 指定されたインストールディレクトリまたはGACにDLLが正しくインストールされているか確認します。

MSIインストーラーを使用する利点

  • 使いやすさ:

    • MSIインストーラーは、シンプルでガイド付きのインストールプロセスを提供します。必要なすべての設定を処理し、DLLを中央の場所に配置するため、複数のプロジェクトでDocumentizeを簡単に使用できます。
  • システム全体のインストール:

    • MSIメソッドはDocumentizeをシステムのグローバルアセンブリキャッシュ(GAC)または他の中央の場所にインストールします。これにより、システム上の任意のアプリケーションがDLLに個別に参照することなくアクセスできるようになります。
  • 自動更新:

    • Documentizeが更新されたインストーラーを提供する場合、新しいMSIファイルを実行することで簡単にインストールを更新できます。通常、更新プロセスはスムーズに処理されます。
  • 一貫性:

    • MSIインストーラーを使用することで、必要なすべてのファイルが異なる環境全体で正しく一貫してインストールされることが保証され、DLLの不足や配置ミスのリスクが減ります。

MSIインストーラーを使用する欠点

  • 柔軟性の制限:

    • MSIインストーラーはDocumentizeをシステム全体の場所にインストールするため、すべての開発環境に適しているわけではありません。プロジェクト固有の設定やバージョンに対応できる柔軟性が欠けている場合があります。
  • 潜在的なオーバーヘッド:

    • DLLをGACにインストールすると、オーバーヘッドや複雑さが生じる可能性があります。特に、複数のバージョンのDocumentizeが同時に必要とされるシナリオでは顕著です。
  • 手動削除:

    • Documentizeをアンインストールする必要がある場合、MSIによって提供されるアンインストーラーを使用する必要があります。適切に管理されないと、残存ファイルや設定が残る可能性があります。
  • バージョンの競合:

    • システム全体のインストールでは、異なるプロジェクトが異なるバージョンのDocumentizeを要求する場合にバージョンの競合を引き起こす可能性があります。これらの競合を管理するには、追加の設定やクリーンアップが必要になる場合があります。

ZIPを使用したDocumentizeのインストール

ヒント

ZIPアーカイブは、ライブラリの管理に手動アプローチを好む開発者に最適です。この方法を使用すると、パッケージマネージャーやインストーラーに依存することなく、必要なDLLファイルを直接ダウンロードして抽出できます。

ZIPアーカイブを使用したインストール方法

  1. ZIPアーカイブのダウンロード:

    • 最新バージョンのDocumentizeをアーカイブ形式でダウンロードするには、 v24.12 ZIPをクリックします。
  2. コンテンツの抽出:

    • ダウンロード後、ZIPファイルの内容を任意のディレクトリに抽出します。これらのファイルを共有ディレクトリに保存するか、プロジェクト構造内に保持することができます。
  3. プロジェクトに参照を追加:

    • IDE(例: Visual Studio)でプロジェクトを開きます。
    • プロジェクト > 参照の追加 > 参照に移動し、DLLを抽出したディレクトリに移動します。
    • 関連するDLLファイルを選択し、プロジェクトへの参照として追加します。
  4. 手動更新:

    • Documentizeの新しいバージョンがリリースされた場合、更新されたZIPアーカイブを手動でダウンロードし、プロジェクト内の古いDLLファイルを新しいものと置き換える必要があります。

ZIPアーカイブの利点

  • 完全な制御:

    • DLLがどこにどのように保存され、プロジェクトで参照されるかを完全に制御できます。カスタム設定を好む場合や、依存関係を手動で管理する必要がある場合に有利です。
  • パッケージマネージャーへの依存なし:

    • NuGetとは異なり、インストールの管理にパッケージマネージャーに依存しません。これは、パッケージマネージャーが利用できない環境や好まれない環境で有利です。
  • ポータビリティ:

    • ZIPアーカイブは容易に共有や移動ができ、外部ツールに依存せずにプロジェクトをポータブルまたは配布可能にするのに適しています。

ZIPアーカイブの欠点

  • 手動管理:

    • 更新や依存関係の管理が自動化されているNuGetとは異なり、ZIPアーカイブでは手動で更新を管理し、必要なDLLが正しく参照されることを確認する必要があります。
  • バージョンの競合のリスク:

    • 複数のプロジェクトを管理している場合やチームで作業している場合、異なるプロジェクトが異なるバージョンのDLLを使用している場合に、バージョンの競合のリスクがあります。これには、プロジェクト間でのバージョンの慎重な追跡が必要です。
  • 自動更新なし:

    • 新しいバージョンが利用可能になった際に自動更新や通知は受け取れません。定期的に更新を確認しない限り、古いライブラリを使用するリスクがあります。

非Windows環境

非Windows環境での .NET Core DLL の取り扱い

Documentize for .NET は .NET Standard 2.0 (.NET Core 2.0) をサポートしているため、Linux系のオペレーティングシステムで動作する Core アプリケーションで使用できます。私たちは常に API の .NET Core サポートを改善するために取り組んでいます。しかし、Documentize for .NET の機能を使用する際に、より良い結果を得るためにお客様に実行をお勧めする操作があります。以下をインストールしてください:

  • libgdiplus パッケージ
  • Microsoft 互換フォントのパッケージ: ttf-mscorefonts-installer(例: sudo apt-get install ttf-mscorefonts-installer)。これらのフォントは /usr/share/fonts/truetype/msttcorefonts ディレクトリに配置する必要があります。Documentize for .NET は、Linux系オペレーティングシステムでこのフォルダーをスキャンします。オペレーティングシステムにフォント用の別のデフォルトフォルダー/ディレクトリがある場合、Documentize を使用して操作を行う前に以下のコード行を使用する必要があります:
    Documentize.Pdf.Text.FontRepository.Sources.Add(new FolderFontSource("<ユーザーのフォントへのパス>"));
 日本語