ConvertTo-Help

Synopsis

Compiles the help source document to an intermediate format.

Syntax

ConvertTo-Help [-Module] <string> [-Path] <string> [-TemplatePath] <string> [-Encoding <string>] [-PassThru] [<CommonParameters>]

Description

Compiles the help source document into an intermediate format that contains all parameter details that are not necessary to author. This saves authoring time and provides a single intermediate document that can be transformed into different format.

Parameters

-Encoding <String>

The output encoding to use. The default is UTF-8.

Required?false
Positionnamed
Default value|
Accepts pipeline input?false
Accept wildcard charactrs?false

-Module <String>

The path to the PowerShell module that contains the commands you want to document.

Required?true
Position0
Default value|
Accepts pipeline input?false
Accept wildcard charactrs?false

-PassThru <SwitchParameter>

Returns the output path to the intermediate document to the pipeline.

Required?false
Positionnamed
Default value|
Accepts pipeline input?false
Accept wildcard charactrs?false

-Path <String>

The output path for the intermediate document.

Required?true
Position1
Default value|
Accepts pipeline input?false
Accept wildcard charactrs?false

-TemplatePath <String>

The path to the template exported by a previous step.

Required?true
Position2
Default value|
Accepts pipeline input?true (ByValue)
Accept wildcard charactrs?false

Outputs

Related Links