Format-Help4CodePlex
Synopsis
Transforms the intermediate help document into an index file and separate help files for use in CodePlex.
Syntax
Format-Help4CodePlex [-Path] <string> [-ContentPath] <string> [-Version <version>] [-PassThru] [<CommonParameters>]
Description
CodePlex (http://www.codeplex.com) uses a modified Wiki syntax that is supported directly by this command. A file for each command will be generated into the parent directory specified by the Path parameter, along with another file that will contain the index of all commands.
You can open each file and copy the contents, pasting them directly into the CodePlex Wiki editor.
Parameters
-ContentPath <String>
The path to the intermediate elp document.
Required? | true |
Position | 1 |
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 |
-Version <Version>
The version to use in the file name and links for CodePlex documentation.
Required? | false |
Position | named |
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