New-ExternalHelp

参考

模块:: platyPS

基于 PlatyPS 支持的 Markdown 创建外部帮助文件。

语法

New-ExternalHelp
   -Path <String[]>
   -OutputPath <String>
   [-ApplicableTag <String[]>]
   [-Encoding <Encoding>]
   [-MaxAboutWidth <Int32>]
   [-ErrorLogFile <String>]
   [-Force]
   [-ShowProgress]
   [<CommonParameters>]

说明

New-ExternalHelp cmdlet 基于 PlatyPS 支持的 markdown 帮助文件创建外部帮助文件。可以使用模块提供此信息，以帮助使用 Get-Help cmdlet。

如果指定的 markdown 文件不遵循 PlatyPS 架构，则此 cmdlet 将返回错误消息。

示例

示例 1：基于文件夹的内容创建外部帮助

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

此命令在指定位置创建外部帮助文件。此命令使用 foldername 包含区域设置的最佳做法。

示例 2：创建使用自定义编码的帮助

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

此命令在指定位置创建外部帮助文件。此命令指定 Force 参数，因此会覆盖现有文件。该命令指定所创建文件的 Unicode 编码。

示例 3：将警告和错误写入文件

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

此命令在指定位置创建外部帮助文件。此命令使用 foldername 包含区域设置的最佳做法。此命令将警告和错误写入 WarningsAndErrors.json 文件。

参数

-ApplicableTag

指定要用作筛选器的标记数组。如果 cmdlet 在 yaml 元数据中 applicable，并且其中未提及任何传递的标记，则会在生成的帮助中忽略 cmdlet。同样适用于 yaml 元数据 applicable 参数级别。如果省略 applicable，则 cmdlet 或参数将始终存在。有关更多详细信息，请参阅设计问题。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Encoding

指定外部帮助文件的字符编码。指定 System.Text.Encoding 对象。有关详细信息，请参阅 about_Character_Encoding。

类型:	Encoding
Position:	Named
默认值:	UTF8 without BOM
必需:	False
接受管道输入:	False
接受通配符:	False

-ErrorLogFile

此 cmdlet 保存格式化的结果日志文件的路径。

路径必须包含带有 json 扩展名的文件夹和文件名的位置和名称。 JSON 对象包含三个属性：Message、FilePath，以及 严重性（警告或错误）。

如果未提供此路径，则不会生成任何日志。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Force

指示此 cmdlet 覆盖具有相同名称的现有文件。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-MaxAboutWidth

指定生成“about”帮助文本文件时的最大行长度。其他帮助文件类型不受此参数影响。有关详细信息，请参阅 New-MarkdownAboutHelp。

代码块内的行不会包装，不受 MaxAboutWidth 参数的影响。

类型:	Int32
Position:	Named
默认值:	80
必需:	False
接受管道输入:	False
接受通配符:	False

-OutputPath

指定此 cmdlet 保存外部帮助文件的文件夹的路径。文件夹名称应以区域设置文件夹结尾，如以下示例所示：.\out\PlatyPS\en-US\。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-Path

指定 markdown 文件或文件夹的路径数组。此 cmdlet 基于这些文件和文件夹创建外部帮助。

类型:	String[]
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	True

-ShowProgress

在分析现有 Markdown 文件下显示进度栏。

如果使用了生成帮助的速度要慢得多。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输入

String[]

可以通过管道将路径数组传递给此 cmdlet。

输出

FileInfo[]

此 cmdlet 返回已创建文件的 FileInfo[] 对象。

通过