Format-Help
Synopsis
Transforms the intermediate help document into its final format.
Syntax
Format-Help [-Path] <string> [-ContentPath] <string> [-Transform] <string> [-Encoding <string>] [-Property <hashtable>] [-PassThru] [<CommonParameters>]
Format-Help [-Split] <scriptblock> [-ContentPath] <string> [-Transform] <string> [-Encoding <string>] [-Property <hashtable>] [-PassThru] [<CommonParameters>]
Description
Transforms the intermediate document into its final format given a specified XML transform.
Parameters
-ContentPath <String>
The path to the intermediate elp document.
Required? | true |
Position | 1 |
Default value| | |
Accepts pipeline input? | true (ByValue) |
Accept wildcard charactrs? | false |
-Encoding <String>
The output encoding to use. The default is UTF-8.
Required? | false |
Position | named |
Default value| | |
Accepts pipeline input? | false |
Accept wildcard charactrs? | false |
-PassThru <SwitchParameter>
Returns the output path to the formatted document to the pipeline.
Required? | false |
Position | named |
Default value| | |
Accepts pipeline input? | false |
Accept wildcard charactrs? | false |
-Path <String>
The output path for the formatted document.
Required? | true |
Position | 0 |
Default value| | |
Accepts pipeline input? | false |
Accept wildcard charactrs? | false |
-Property <System.Collections.Hashtable>
Additional property/value pairs to pass to the XML transform.
Required? | false |
Position | named |
Default value| | |
Accepts pipeline input? | false |
Accept wildcard charactrs? | false |
-Split <System.Management.Automation.ScriptBlock>
A script block that runs for each command and is passed the Verb, Noun, Name, Path, and Property values.
Required? | true |
Position | 0 |
Default value| | |
Accepts pipeline input? | false |
Accept wildcard charactrs? | false |
-Transform <String>
The path to the XML transform to use for formatting.
Required? | true |
Position | 2 |
Default value| | |
Accepts pipeline input? | false |
Accept wildcard charactrs? | false |
Outputs
- System.IO.FileInfo: When the PassThru parameter is set, the object representing the output Path parameter.
Related Links