更新可能なヘルプのしくみ

このトピックでは、更新可能ヘルプが各モジュールの HelpInfo XML ファイルと CAB ファイルを処理し、更新されたヘルプをユーザーにインストールする方法について説明します。

Update-Help プロセス

次の一覧では、ユーザーが特定の UI カルチャのモジュールのヘルプ ファイルを更新するコマンドを実行したときの Update-Help コマンドレットのアクションについて説明します。

1. Update-Help は、モジュール マニフェストの HelpInfoURI キーの値で指定された場所からリモート HelpInfo XML ファイルを取得し、スキーマに対してファイルを検証します。 (スキーマを表示するには、 HelpInfo XML スキーマを参照してください)。次 Update-Help 、ユーザーのコンピューター上のモジュール ディレクトリで、モジュールのローカル HelpInfo XML ファイルを検索します。

2. Update-Help は、モジュールのリモートおよびローカルの HelpInfo XML ファイル内の指定された UI カルチャのヘルプ ファイルのバージョン番号を比較します。 リモート ファイルのバージョン番号がローカル ファイルのバージョン番号より大きい場合、またはモジュールのローカル HelpInfo XML ファイルがない場合は、 Update-Help は新しいヘルプ ファイルのダウンロードを準備します。

3. Update-Help は、リモート HelpInfo XML ファイルの HelpContentUri 要素で指定された場所からモジュールの CAB ファイルを選択します。 モジュール名、モジュール GUID、UI カルチャを使用して CAB ファイルを識別します。

4. Update-Help CAB ファイルをダウンロードし、開梱し、ヘルプ コンテンツ ファイルを検証し、ヘルプ コンテンツ ファイルをユーザーのコンピューターのモジュール ディレクトリの言語固有のサブディレクトリに保存します。

5. Update-Help は、リモートの HelpInfo XML ファイルをコピーして、ローカルの HelpInfo XML ファイルを作成します。 ローカル HelpInfo XML ファイルを編集して、インストールした CAB ファイルの要素のみが含まれるようにします。 次に、ローカルの HelpInfo XML ファイルをモジュール ディレクトリに保存し、更新を終了します。

Save-Help プロセス

次の一覧では、ユーザーがファイル共有内のヘルプ ファイルを更新するコマンドを実行し、それらのファイルを使用してユーザーのコンピューター上のヘルプ ファイルを更新する場合の Save-Help コマンドレットと Update-Help コマンドレットのアクションについて説明します。

Save-Help コマンドレットは、DestinationPath パラメーターで指定されたファイル共有にモジュールのヘルプ ファイルを保存するコマンドに応答して、次のアクションを実行します。

1. Save-Help は、モジュール マニフェストの HelpInfoURI キーの値で指定された場所からリモート HelpInfo XML ファイルを取得し、スキーマに対してファイルを検証します。 (スキーマを表示するには、HelpInfo XML スキーマを参照してください)。次Save-Help、Save-Help コマンドで DestinationPath パラメーターで指定されたディレクトリ内のローカル HelpInfo XML ファイルを検索します。

2. Save-Help は、モジュールのリモートおよびローカルの HelpInfo XML ファイル内の指定された UI カルチャのヘルプ ファイルのバージョン番号を比較します。 リモート ファイルのバージョン番号がローカル ファイルのバージョン番号より大きい場合、または DestinationPath ディレクトリにモジュールのローカル HelpInfo XML ファイルがない場合は、 Save-Help は新しいヘルプ ファイルをダウンロードする準備をします。

3. Save-Help は、リモート HelpInfo XML ファイルの HelpContentUri 要素で指定された場所からモジュールの CAB ファイルを選択します。 モジュール名、モジュール GUID、UI カルチャを使用して CAB ファイルを識別します。

4. Save-Help CAB ファイルをダウンロードし、 DestinationPath ディレクトリに保存します。 (言語固有のサブディレクトリは作成されません)。

5. Save-Help は、リモートの HelpInfo XML ファイルをコピーして、ローカルの HelpInfo XML ファイルを作成します。 ローカル HelpInfo XML ファイルを編集して、保存した CAB ファイルの要素のみが含まれるようにします。 次に、ローカルの HelpInfo XML ファイルを DestinationPath ディレクトリに保存し、更新を終了します。

   Update-Help コマンドレットは、SourcePath パラメーターで指定されたファイル共有内のファイルからユーザーのコンピューター上のヘルプ ファイルを更新するコマンドに応答して、次のアクションを実行します。

6. Update-Help は、 SourcePath ディレクトリからリモート HelpInfo XML ファイルを取得します。 次に、ユーザーのコンピューター上のモジュール ディレクトリでローカルの HelpInfo XML ファイルを検索します。

7. Update-Help は、モジュールのリモートおよびローカルの HelpInfo XML ファイル内の指定された UI カルチャのヘルプ ファイルのバージョン番号を比較します。 リモート ファイルのバージョン番号がローカル ファイルのバージョン番号より大きい場合、またはローカルの HelpInfo XML ファイルがない場合は、 Update-Help は新しいヘルプ ファイルのインストールを準備します。

8. Update-Help は、SourcePath ディレクトリからモジュールの CAB ファイルを選択します。 モジュール名、モジュール GUID、UI カルチャを使用して CAB ファイルを識別します。

9. Update-Help CAB ファイルをアンパックし、ヘルプ コンテンツ ファイルを検証し、ユーザーのコンピューター上のモジュール ディレクトリの言語固有のサブディレクトリにヘルプ コンテンツ ファイルを保存します。

10. Update-Help は、リモートの HelpInfo XML ファイルをコピーして、ローカルの HelpInfo XML ファイルを作成します。 ローカル HelpInfo XML ファイルを編集して、インストールした CAB ファイルの要素のみが含まれるようにします。 次に、ローカルの HelpInfo XML ファイルをモジュール ディレクトリに保存し、更新を終了します。