Get-HelpPreview
Displays your generated external help as Get-Help
output.
構文
Default (既定)
Get-HelpPreview
-Path <String[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[<CommonParameters>]
説明
The Get-HelpPreview
cmdlet displays your generated external help as Get-Help
output.
Specify one or more files in Microsoft Assistance Markup Language (MAML) format.
例
Example 1: Preview the PlatyPS help
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
The first command creates a Help object for the the specified MAML file. The command stores it in the $Help variable.
The second command displays the Name property for each of the objects in $Help.
パラメーター
-ConvertDoubleDashLists
Indicates that this cmdlet converts double-hyphen list bullets into single-hyphen bullets. Double-hyphen lists are common in Windows PowerShell documentation. Markdown accepts single-hyphens for lists.
パラメーターのプロパティ
型: | SwitchParameter |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-ConvertNotesToList
Indicates that this cmdlet formats multiple paragraph items in the NOTES section as single list items. This output follows TechNet formatting.
パラメーターのプロパティ
型: | SwitchParameter |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Path
Specifies an array of paths of MAML external help files.
パラメーターのプロパティ
型: | String[] |
規定値: | None |
ワイルドカードのサポート: | True |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | True |
パイプラインからの値: | True |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
入力
String
You can pipe an array of paths to this cmdlet.
出力
Help Object
This cmdlet returns a Help object, which is the same output as Get-Help
.