更新可能なヘルプの概要

このドキュメントでは、PowerShell 更新可能ヘルプ機能の設計と操作の基本的な概要について説明します。 これは、モジュール作成者や、Windows PowerShell ヘルプ トピックをユーザーに提供する他のユーザー向けに設計されています。

はじめに

PowerShell のヘルプ トピックは、PowerShell エクスペリエンスの不可欠な部分です。 PowerShell モジュールと同様に、ヘルプ トピックは、作成者や PowerShell ユーザーのコミュニティの貢献によって継続的に更新および改善されています。

Windows PowerShell 3.0 で導入された 更新可能なヘルプ 機能により、新しいモジュールをダウンロードしたり Windows Update を実行したりしなくても、組み込みの PowerShell コマンドであっても、ユーザーはコマンド プロンプトで最新バージョンのヘルプ トピックを使用できます。 更新可能なヘルプでは、最新バージョンのヘルプ トピックをインターネットからダウンロードし、ユーザーのローカル コンピューター上の適切なサブディレクトリにインストールするコマンドレットを提供することで、更新が簡単になります。 ファイアウォールの背後にいるユーザーでも、新しいコマンドレットを使用して、内部ファイル共有から更新されたヘルプを取得できます。

更新可能なヘルプは、Windows 8 および Windows Server 2012 のすべての Windows PowerShell モジュールで完全にサポートされており、その機能はすべての Windows PowerShell モジュール作成者が利用できます。 更新可能なヘルプでは、XML ベースのヘルプ ファイルのみがサポートされます。 コメントベースのヘルプはサポートされていません。

更新可能なヘルプには、次の機能が含まれています。

• Update-Help コマンドレットは、ユーザーがモジュールの最新のヘルプ ファイルを持っているかどうかを判断し、そうでない場合は、最新のヘルプ ファイルをインターネットからダウンロードし、アンパックして、ユーザーのコンピューター上の適切なモジュール サブディレクトリにインストールします。 ユーザーは、Get-Help コマンドレットを使用して、新しくインストールされたヘルプ トピックをすぐに表示できます。 PowerShell を再起動する必要はありません。

• Save-Help コマンドレット。最新のヘルプ ファイルをインターネットからダウンロードし、ファイル システム ディレクトリに保存します。 ユーザーは、Update-Help コマンドレットを使用して、ファイル システム ディレクトリからヘルプ ファイルを取得し、ユーザーのコンピューターのモジュール サブディレクトリに展開してインストールできます。 Save-Help コマンドレットは、インターネット アクセスが制限されているユーザーまたはインターネット にアクセスできないユーザー、およびインターネット アクセスを制限する企業向けに設計されています。

• モジュール のヘルプをします。 モジュールのヘルプ ファイルは 1 つのユニットとして管理および配信されるため、ユーザーは使用するモジュールのすべてのヘルプ ファイルを取得できます。 更新可能なヘルプは、Windows PowerShell スナップインではなく、モジュールでのみサポートされます。

• バージョンでは、がサポートされます。 更新可能なヘルプでは、標準の 4 桁 (N1.N2。N3.N4) バージョン番号。 更新可能なヘルプは、ユーザーのコンピューター (または Save-Help ディレクトリ内) のヘルプ ファイルのバージョン番号が、インターネット上の場所にあるヘルプ ファイルのバージョン番号よりも小さい場合にヘルプ ファイルをダウンロードします。

• 多言語サポートの。 更新可能なヘルプは、複数の UI カルチャのモジュール ヘルプ ファイルをサポートします。 更新可能なヘルプ ファイル名には、"en-US" や "ja-JP" などの標準言語コードが含まれており、Update-Help コマンドレットと Save-Help コマンドレットは、ヘルプ ファイルをモジュール ディレクトリの言語固有のサブディレクトリに配置します。

• 自動生成されたヘルプ をします。 Get-Help コマンドレットには、ヘルプ ファイルがないコマンドの基本的なヘルプが表示されます。 自動生成されたヘルプには、コマンドの構文とエイリアス、オンライン ヘルプと更新可能なヘルプを使用するための手順が含まれています。

• 強化されたオンラインヘルプ. オンライン ヘルプに簡単にアクセスでき、ヘルプ ファイルは不要になりました。 Get-Help コマンドレットの Online パラメーターは、ヘルプ ファイルにオンライン ヘルプ URL が見つからない場合に、コマンドの HelpUri プロパティの値からオンライン ヘルプ トピックの URL を取得するようになりました。 コマンドレット、関数、CIM コマンドのコードに HelpUri 属性を追加するか、ワークフローとスクリプトでコメント ベースのヘルプ キーワードを .LINK 使用して、HelpUri プロパティを設定できます。

  ヘルプ ファイルを更新可能にするために、Windows の Windows PowerShell モジュールにはヘルプ ファイルが付属していません。 ユーザーは、更新可能なヘルプを使用してヘルプ ファイルをインストールし、更新できます。 他のモジュールの作成者は、ヘルプ ファイルをモジュールに含めたり、省略したりできます。 更新可能なヘルプのサポートは省略可能ですが、推奨されます。