New-ExternalHelp

  • Reference
Modul:
platyPS

Vytvoří externí soubor nápovědy založený na markdownu podporovaném platyPS.

Syntax

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

Description

Rutina New-ExternalHelp vytvoří externí soubor nápovědy založený na souborech nápovědy markdownu podporovaných platformou PlatyPS. Můžete ho odeslat pomocí modulu, který vám poskytne pomoc pomocí rutiny Get-Help .

Pokud zadané soubory markdownu nedodržují schéma PlatyPS, vrátí tato rutina chybové zprávy.

Příklady

Příklad 1: Vytvoření externí nápovědy na základě obsahu složky

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

Tento příkaz vytvoří externí soubor nápovědy v zadaném umístění. Tento příkaz používá osvědčený postup, že název složky obsahuje národní prostředí.

Příklad 2: Vytvoření nápovědy, která používá vlastní kódování

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

Tento příkaz vytvoří externí soubor nápovědy v zadaném umístění. Tento příkaz určuje parametr Force , proto přepíše existující soubor. Příkaz určuje kódování Unicode pro vytvořený soubor.

Příklad 3: Zápis upozornění a chyb do souboru

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

Tento příkaz vytvoří externí soubor nápovědy v zadaném umístění. Tento příkaz používá osvědčený postup, že název složky obsahuje národní prostředí. Tento příkaz zapíše upozornění a chyby do souboru WarningsAndErrors.json.

Parametry

-ApplicableTag

Zadejte pole značek, které se mají použít jako filtr. Pokud má rutina applicable metadata yaml a žádná z předaných značek tam není zmíněna, rutina se ve vygenerované nápovědě ignoruje. Totéž platí pro metadata yaml úrovně applicable parametru. Pokud applicable je vynechán, rutina nebo parametr budou vždy k dispozici. Další podrobnosti najdete v tématu Problém s návrhem .

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encoding

Určuje kódování znaků pro externí soubor nápovědy. Zadejte objekt System.Text.Encoding . Další informace najdete v tématu about_Character_Encoding.

Type:Encoding
Position:Named
Default value:UTF8 without BOM
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorLogFile

Cesta, kam tato rutina uloží formátovaný soubor protokolu výsledků.

Cesta musí obsahovat umístění a název složky a názvu souboru s příponou JSON. Objekt JSON obsahuje tři vlastnosti: Message, FilePath a Severity (Upozornění nebo Chyba).

Pokud tato cesta není k dispozici, negeneruje se žádný protokol.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Označuje, že tato rutina přepíše existující soubor se stejným názvem.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaxAboutWidth

Určuje maximální délku řádku při generování textových souborů nápovědy "o". Tento parametr nemá vliv na jiné typy souborů nápovědy. Další informace najdete v tématu New-MarkdownAboutHelp.

Řádky uvnitř bloků kódu nejsou zabalené a nejsou ovlivněny parametrem MaxAboutWidth .

Type:Int32
Position:Named
Default value:80
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputPath

Určuje cestu ke složce, do které tato rutina ukládá váš externí soubor nápovědy. Název složky by měl končit složkou národního prostředí, jako v následujícím příkladu: .\out\PlatyPS\en-US\.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Path

Určuje pole cest k souborům nebo složkám markdownu. Tato rutina vytvoří externí nápovědu na základě těchto souborů a složek.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-ShowProgress

Zobrazit indikátory průběhu pod parsováním existujících souborů markdownu

Pokud se použije, generování nápovědy je mnohem pomalejší.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Vstupy

String[]

K této rutině můžete připojit pole cest.

Výstupy

FileInfo[]

Tato rutina FileInfo[] vrátí objekt pro vytvořené soubory.