< Back
Get-HelpPreview
Post
NAME Get-HelpPreview
SYNOPSIS
Displays your generated external help as Get-Help output.
SYNTAX
Get-HelpPreview -Path <String[]> [-ConvertNotesToList] [-ConvertDoubleDashLists] [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-Path <String[]>
Specifies an array of paths of MAML external help files.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-ConvertNotesToList [<SwitchParameter>]
Indicates that this cmldet formats multiple paragraph items in the NOTES section as single list items. This
output follows TechNet formatting.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ConvertDoubleDashLists [<SwitchParameter>]
Indicates that this cmldet converts double-hyphen list bullets into single-hyphen bullets. Double-hyphen lists
are common in Windows PowerShell documentation. Markdown accepts single-hyphens for lists.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
String[]
You can pipe an array of paths to this cmdlet.
OUTPUTS
Help Object
This cmdlet returns a Help object, which is the same output as Get-Help .
NOTES
------------- 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.
RELATED LINKS
Online Version: https://github.com/PowerShell/platyPS/b ... Preview.md
SYNOPSIS
Displays your generated external help as Get-Help output.
SYNTAX
Get-HelpPreview -Path <String[]> [-ConvertNotesToList] [-ConvertDoubleDashLists] [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-Path <String[]>
Specifies an array of paths of MAML external help files.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-ConvertNotesToList [<SwitchParameter>]
Indicates that this cmldet formats multiple paragraph items in the NOTES section as single list items. This
output follows TechNet formatting.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ConvertDoubleDashLists [<SwitchParameter>]
Indicates that this cmldet converts double-hyphen list bullets into single-hyphen bullets. Double-hyphen lists
are common in Windows PowerShell documentation. Markdown accepts single-hyphens for lists.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
String[]
You can pipe an array of paths to this cmdlet.
OUTPUTS
Help Object
This cmdlet returns a Help object, which is the same output as Get-Help .
NOTES
------------- 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.
RELATED LINKS
Online Version: https://github.com/PowerShell/platyPS/b ... Preview.md