New-ExternalHelp
Creates external help file based on markdown supported by PlatyPS.
语法
Default （默认值）
New-ExternalHelp
-Path <String[]>
-OutputPath <String>
[-ApplicableTag <String[]>]
[-Encoding <Encoding>]
[-MaxAboutWidth <Int32>]
[-ErrorLogFile <String>]
[-Force]
[-ShowProgress]
[<CommonParameters>]
说明
The New-ExternalHelp cmdlet creates an external help file based on markdown help files supported
by PlatyPS. You can ship this with a module to provide help using the Get-Help cmdlet.
If the markdown files that you specify don't follow the PlatyPS Schema, this cmdlet returns error messages.
示例
Example 1: Create external help based on the contents of a folder
PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US"
Directory: D:\Working\PlatyPS\out\platyPS\en-US
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/19/2016 12:32 PM 46776 platyPS-help.xml
This command creates an external help file in the specified location. This command uses the best practice that the foldername includes the locale.
Example 2: Create help that uses custom encoding
PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\PlatyPS\en-US" -Force -Encoding ([System.Text.Encoding]::Unicode)
Directory: D:\Working\PlatyPS\out\PlatyPS\en-US
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 6:34 PM 132942 platyPS-help.xml
This command creates an external help file in the specified location. This command specifies the Force parameter, therefore, it overwrites an existing file. The command specifies Unicode encoding for the created file.
Example 3: Write warnings and errors to file
PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US" -ErrorLogFile ".\WarningsAndErrors.json"
Directory: D:\Working\PlatyPS\out\platyPS\en-US
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/19/2016 12:32 PM 46776 platyPS-help.xml
This command creates an external help file in the specified location. This command uses the best
practice that the foldername includes the locale. This command writes the warnings and errors to the
WarningsAndErrors.json file.
参数
-ApplicableTag
Specify array of tags to use as a filter. If cmdlet has applicable in the yaml metadata and none
of the passed tags is mentioned there, cmdlet would be ignored in the generated help. Same applies
to the Parameter level applicable yaml metadata. If applicable is omitted, cmdlet or parameter
would be always present. See design issue for
more details.
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Encoding
Specifies the character encoding for your external help file. Specify a System.Text.Encoding object. For more information, see about_Character_Encoding.
参数属性
| 类型: | Encoding |
| 默认值: | UTF8 without BOM |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-ErrorLogFile
The path where this cmdlet saves formatted results log file.
The path must include the location and name of the folder and filename with the json extension. The JSON object contains three properties: Message, FilePath, and Severity (Warning or Error).
If this path isn't provided, no log is generated.
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Force
Indicates that this cmdlet overwrites an existing file that has the same name.
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-MaxAboutWidth
Specifies the maximum line length when generating "about" help text files. Other help file types are not affected by this parameter. For more information, see New-MarkdownAboutHelp.
Lines inside code blocks aren't wrapped and aren't affected by the MaxAboutWidth parameter.
参数属性
| 类型: | Int32 |
| 默认值: | 80 |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-OutputPath
Specifies the path of a folder where this cmdlet saves your external help file. The folder name
should end with a locale folder, as in the following example: .\out\PlatyPS\en-US\.
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Path
Specifies an array of paths of markdown files or folders. This cmdlet creates external help based on these files and folders.
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-ShowProgress
Display progress bars under parsing existing markdown files.
If this is used generating of help is much slower.
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | 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.
输入
String
You can pipe an array of paths to this cmdlet.
输出
FileInfo
This cmdlet returns a FileInfo[] object for created files.
