Get-HelpPreview

リファレンス

モジュール:: platyPS

生成された外部ヘルプを Get-Help 出力として表示します。

構文

Get-HelpPreview
   -Path <String[]>
   [-ConvertNotesToList]
   [-ConvertDoubleDashLists]
   [<CommonParameters>]

説明

Get-HelpPreview コマンドレットは、生成された外部ヘルプを Get-Help 出力として表示します。 Microsoft Assistance Markup Language (MAML) 形式で 1 つ以上のファイルを指定します。

例

例 1: PlatyPS ヘルプをプレビューする

PS C:\> $Help = Get-HelpPreview -Path ".\out\platyPS\en-US\PlatyPS-help.xml"
PS C:\> $Help.Name

Get-HelpPreview
Get-MarkdownMetadata
New-ExternalHelp
New-ExternalHelpCab
New-MarkdownHelp
Update-MarkdownHelp
Update-MarkdownHelpModule
Update-MarkdownHelpSchema

最初のコマンドは、指定した MAML ファイルの ヘルプ オブジェクトを作成します。コマンドは、$Help変数に格納します。

2 つ目のコマンドは、$Help内の各オブジェクトの Name プロパティを表示します。

パラメーター

-ConvertDoubleDashLists

このコマンドレットは、二重ハイフンの箇条書きを 1 つのハイフンの行頭文字に変換することを示します。二重ハイフンリストは、Windows PowerShell ドキュメントで一般的です。 Markdown では、リストに対して単一ハイフンを使用できます。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ConvertNotesToList

このコマンドレットは、NOTES セクションの複数の段落項目を 1 つのリストアイテムとして書式設定することを示します。この出力は、TechNet の書式設定に従います。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Path

MAML 外部ヘルプファイルのパスの配列を指定します。

型:	String[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

入力

String[]

パスの配列をこのコマンドレットにパイプできます。

出力

Help Object

このコマンドレットは、と同じ出力である Get-Help オブジェクトを返します。