New-MarkdownHelp

Reference

Modul:: platyPS

Vytvoří nápovědu ve formátu markdownu.

Syntax

New-MarkdownHelp
   -Module <String[]>
   [-Session <PSSession>]
   [-Force]
   [-AlphabeticParamsOrder]
   [-Metadata <Hashtable>]
   -OutputFolder <String>
   [-NoMetadata]
   [-UseFullTypeName]
   [-Encoding <Encoding>]
   [-WithModulePage]
   [-ModulePagePath <String>]
   [-Locale <String>]
   [-HelpVersion <String>]
   [-FwLink <String>]
   [-ExcludeDontShow]
   [<CommonParameters>]

New-MarkdownHelp
   -Command <String[]>
   [-Session <PSSession>]
   [-Force]
   [-AlphabeticParamsOrder]
   [-Metadata <Hashtable>]
   [-OnlineVersionUrl <String>]
   -OutputFolder <String>
   [-NoMetadata]
   [-UseFullTypeName]
   [-Encoding <Encoding>]
   [-ExcludeDontShow]
   [<CommonParameters>]

New-MarkdownHelp
   -MamlFile <String[]>
   [-ConvertNotesToList]
   [-ConvertDoubleDashLists]
   [-Force]
   [-AlphabeticParamsOrder]
   [-Metadata <Hashtable>]
   -OutputFolder <String>
   [-NoMetadata]
   [-UseFullTypeName]
   [-Encoding <Encoding>]
   [-WithModulePage]
   [-ModulePagePath <String>]
   [-Locale <String>]
   [-HelpVersion <String>]
   [-FwLink <String>]
   [-ModuleName <String>]
   [-ModuleGuid <String>]
   [-ExcludeDontShow]
   [<CommonParameters>]

Description

Rutina New-MarkdownHelp vytvoří nápovědu ve formátu Markdown na základě modulu, příkazu nebo souboru ve formátu MAML (Microsoft Assistance Markup Language).

Příklady

Příklad 1: Vytvoření nápovědy z příkazu

PS C:\> function Command03 {param([string]$Value)}
PS C:\> New-MarkdownHelp -Command "Command03" -OutputFolder ".\docs"


    Directory: D:\Working\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:53 PM            664 Command03.md

První příkaz vytvoří funkci s názvem Command03 pomocí standardní syntaxe Windows PowerShell.

Druhý příkaz vytvoří nápovědu pro funkci zástupných funkcí ve složce .\docs.

Příklad 2: Vytvoření nápovědy z modulu

PS C:\> Import-Module -Module "PlatyPS"
PS C:\> New-MarkdownHelp -Module "PlatyPS" -OutputFolder ".\docs" -Force


    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:54 PM           1496 Get-HelpPreview.md
-a----        5/22/2016   6:54 PM           3208 Get-MarkdownMetadata.md
-a----        5/22/2016   6:54 PM           3059 New-ExternalHelp.md
-a----        5/22/2016   6:54 PM           2702 New-ExternalHelpCab.md
-a----        5/22/2016   6:54 PM           6234 New-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           2346 Update-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           1633 Update-MarkdownHelpModule.md
-a----        5/22/2016   6:54 PM           1630 Update-MarkdownHelpSchema.md

První příkaz pomocí rutiny načte modul PlatyPS do aktuální relace Import-Module .

Druhý příkaz vytvoří nápovědu pro všechny rutiny v modulu PlatyPS. Uloží je do .\docs složky. Tento příkaz určuje parametr Force . Proto přepíše existující soubory markdownu nápovědy, které mají stejný název.

Příklad 3: Vytvoření nápovědy z existujícího souboru MAML

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml'

    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:56 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:56 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM          15320 Set-PSReadLineOption.md

Tento příkaz vytvoří nápovědu ve formátu markdownu pro zadaný soubor MAML nápovědy. Modul nemusíte načítat jako v předchozím příkladu. Pokud je modul již načtený, vytvoří tento příkaz nápovědu na základě souboru MAML, nikoli na aktuálně nainstalovaném modulu.

Příklad 4: Vytvoření nápovědy z existujícího souboru MAML pro použití v souboru CAB

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml' -WithModulePage  -Force -ModuleName "PSReadLine"


    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:59 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:59 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM          15320 Set-PSReadLineOption.md
-a----        5/22/2016   6:59 PM            942 PSReadLine.md

Tento příkaz vytvoří nápovědu ve formátu markdownu pro zadaný soubor MAML nápovědy jako v předchozím příkladu. Tento příkaz také určuje parametr WithModulePage a ModuleName parametr. Příkaz vytvoří soubor s názvem PSReadLine.md, který obsahuje odkazy na ostatní soubory Markdownu v tomto modulu a metadata, která lze použít k vytváření .cab souborů.

Parametry

-AlphabeticParamsOrder

Seřaďte parametry abecedně podle názvu v části PARAMETRY. Existuje 5 výjimek: -Confirm, -WhatIf, -IncludeTotalCount, -Skipa -First parametry budou poslední. Tyto parametry jsou běžné, a proto mají dobře definované chování.

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

-Command

Určuje název příkazu v aktuální relaci. Může to být jakýkoli příkaz podporovaný nápovědou PowerShellu, například rutina nebo funkce.

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

-ConvertDoubleDashLists

Označuje, že tato rutina převede odrážky seznamu se dvěma spojovníky na odrážky s jedním spojovníkem. Seznamy dvojitých spojovníků jsou v dokumentaci Windows PowerShell běžné. Markdown přijímá jednoduché spojovníky pro seznamy.

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

-ConvertNotesToList

Označuje, že tato rutina formátuje více položek odstavce v oddílu POZNÁMKY jako položky jednoho seznamu.

Type:	SwitchParameter
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

-ExcludeDontShow

Vylučte parametry označené parametrem DontShow v atributu parameter z obsahu nápovědy.

Type:	SwitchParameter
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í soubory se stejnými názvy.

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

-FwLink

Určuje dopředný odkaz na stránku modulu. Tato hodnota se vyžaduje pro .cab vytvoření souboru. Tato hodnota se používá jako metadata záhlaví markdownu na stránce modulu.

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

-HelpVersion

Určuje verzi nápovědy. Tato hodnota se vyžaduje pro .cab vytvoření souboru. Tato hodnota se používá jako metadata záhlaví markdownu na stránce modulu.

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

-Locale

Určuje národní prostředí nápovědy. Tato hodnota je vyžadována pro .cab vytvoření souboru. Tato hodnota se používá jako metadata záhlaví markdownu na stránce modulu.

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

-MamlFile

Určuje pole cest k souborům nápovědy MAML .xml .

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

-Metadata

Určuje metadata, která tato rutina zahrne do souborů markdownu nápovědy jako tabulku hash párů klíč-hodnota typu řetězec-sting. Tato rutina zapíše metadata do záhlaví každého souboru nápovědy markdownu.

Rutina New-ExternalHelp tato metadata nepoužívá. Tato metadata můžou používat externí nástroje.

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

-Module

Určuje pole názvů modulů, pro které tato rutina vytvoří nápovědu ve formátu markdownu.

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

-ModuleGuid

Určuje identifikátor GUID modulu nápovědy. Tato hodnota se vyžaduje pro .cab vytvoření souboru. Tato hodnota se používá jako metadata záhlaví markdownu na stránce modulu.

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

-ModuleName

Určuje název modulu nápovědy. Tato hodnota se vyžaduje pro .cab vytvoření souboru. Tato hodnota se používá jako metadata záhlaví markdownu na stránce modulu.

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

-ModulePagePath

Když se ve výchozím nastavení používá parametr WithModule , umístí soubor .md do stejného umístění jako všechny ostatní dokumenty. Pomocí tohoto parametru můžete zadat nový název nebo umístění, které poskytuje lepší možnosti umístění.

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

-NoMetadata

Označuje, že tato rutina nepíše žádná metadata ve vygenerovaném markdownu.

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

-OnlineVersionUrl

Určuje adresu, na kterou aktualizovatelná funkce nápovědy stáhne aktualizovanou nápovědu. Pokud hodnotu nezadáte, rutina použije prázdný řetězec.

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

-OutputFolder

Určuje cestu ke složce, ve které tato rutina vytváří soubory nápovědy markdownu.

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

-Session

Poskytuje podporu pro vzdálené příkazy. Předejte relaci, kterou jste použili k vytvoření příkazů, pomocí Import-PSSession. To je potřeba k získání přesných metadat parametrů ze vzdálené relace.

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

-UseFullTypeName

Označuje, že cílový dokument bude místo krátkého názvu parametrů používat úplný název typu.

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

-WithModulePage

Označuje, že tato rutina vytvoří stránku modulu ve výstupní složce. Tento soubor má název, který určuje parametr ModuleName . Pokud jste tento parametr nezadali, rutina zadá výchozí název MamlModule. Toto nastavení můžete přepsat pomocí rutiny ModulePagePath , která umožňuje definovat jinou cestu pro stránku modulu.

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

Vstupy

String[]

Do této rutiny můžete předvést názvy modulů. Toto jsou moduly, ze kterých tato rutina vytváří markdown nápovědy.

Výstupy

FileInfo[]

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

Sdílet prostřednictvím