Get-HelpPreview

Module:

platyPS Module

Displays your generated external help as Get-Help output.

Syntax

Default (Default)

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.

Examples

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.

Parameters

-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.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ConvertNotesToList

Indicates that this cmdlet formats multiple paragraph items in the NOTES section as single list items. This output follows TechNet formatting.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Path

Specifies an array of paths of MAML external help files.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	True
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	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.

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.