New-ExternalHelp
根據 PlatyPS 支援的 Markdown 建立外部說明檔。
Syntax
New-ExternalHelp
-Path <String[]>
-OutputPath <String>
[-ApplicableTag <String[]>]
[-Encoding <Encoding>]
[-MaxAboutWidth <Int32>]
[-ErrorLogFile <String>]
[-Force]
[-ShowProgress]
[<CommonParameters>] Description
Cmdlet 會 New-ExternalHelp 根據 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此命令會在指定的位置建立外部說明檔。 此命令會使用資料夾名稱包含地區設定的最佳做法。
範例 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此命令會在指定的位置建立外部說明檔。 此命令會使用資料夾名稱包含地區設定的最佳做法。 此命令會將警告和錯誤寫入 WarningsAndErrors.json 檔案。
參數
-ApplicableTag
指定要作為篩選的標籤陣列。 如果 Cmdlet 在 applicable yaml 中繼資料中沒有提及任何傳遞的標記，則產生的說明中會忽略 Cmdlet。 同樣適用于參數層級 applicable yaml 中繼資料。 如果 applicable 省略 ，Cmdlet 或 參數一律會存在。 如需詳細資訊 ，請參閱設計問題 。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Encoding
指定外部說明檔的字元編碼。 指定 System.Text.Encoding 物件。 如需詳細資訊，請參閱 about_Character_Encoding。
| Type: | Encoding |
| Position: | Named |
| Default value: | UTF8 without BOM |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorLogFile
此 Cmdlet 將儲存格式化結果記錄檔的路徑。
路徑必須包含具有 json 副檔名的資料夾和檔案名的位置和名稱。 JSON 物件包含三個屬性： Message、 FilePath和 Severity (Warning 或 Error) 。
如果未提供此路徑，則不會產生任何記錄檔。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
指出此 Cmdlet 會覆寫具有相同名稱的現有檔案。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxAboutWidth
指定產生「關於」說明文本檔時的最大行長度。 其他說明檔案類型不受此參數影響。 如需詳細資訊，請參閱 New-MarkdownAboutHelp。
程式碼區塊內的程式程式碼不會包裝，而且不受 MaxAboutWidth 參數影響。
| Type: | Int32 |
| Position: | Named |
| Default value: | 80 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutputPath
指定此 Cmdlet 儲存外部說明檔的資料夾路徑。
資料夾名稱應該以地區設定資料夾結尾，如下列範例所示： .\out\PlatyPS\en-US\ 。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
指定 Markdown 檔案或資料夾的路徑陣列。 此 Cmdlet 會根據這些檔案和資料夾建立外部說明。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-ShowProgress
顯示剖析現有 Markdown 檔案下的進度列。
如果這是用來產生協助的速度會比較慢。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
輸入
String[]
您可以使用管線將路徑陣列傳送至此 Cmdlet。
輸出
FileInfo[]
此 Cmdlet 會 FileInfo[] 傳回已建立檔案的 物件。
