Sdílet prostřednictvím

New-ExternalHelp

  • Reference
Modul:
platyPS

Vytvoří externí soubor nápovědy na základě markdownu, který podporuje PlatyPS.

Syntaxe

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 na základě souborů nápovědy markdownu podporovaných aplikací PlatyPS. Můžete ho odeslat pomocí modulu, který vám pomůže s používáním rutiny Get-Help.

Pokud zadané soubory markdownu nedodržují schématu 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, který 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 vynutit parametr, 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, který 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 rutina obsahuje applicable v metadatech yaml a žádná z předaných značek tam není zmíněna, rutina by se vygenerované nápovědě ignorovala. Totéž platí pro úroveň parametru applicable metadata yaml. Pokud applicable vynecháte, bude vždy k dispozici rutina nebo parametr. Další podrobnosti najdete v problému s návrhem.

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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.

Typ:Encoding
Position:Named
Default value:UTF8 without BOM
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ErrorLogFile

Cesta, kam tato rutina ukládá 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, FilePatha Severity (Warning or Error).

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

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Force

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

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-MaxAboutWidth

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

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

Typ:Int32
Position:Named
Default value:80
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-OutputPath

Určuje cestu ke složce, kam 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\.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Path

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

Typ:String[]
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:True

-ShowProgress

Zobrazí indikátory průběhu při analýze existujících souborů Markdownu.

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

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

String[]

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

Výstupy

FileInfo[]

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