New-MarkdownHelp

Odwołanie

Moduł:: platyPS

Tworzy pomoc w formacie markdown.

Składnia

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>]

Opis

Polecenie New-MarkdownHelp cmdlet tworzy pomoc w formacie markdown na podstawie modułu, polecenia lub pliku w formacie MAML (Microsoft Assistance Markup Language).

Przykłady

Przykład 1. Tworzenie pomocy na podstawie polecenia

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

Pierwsze polecenie tworzy funkcję o nazwie Command03 przy użyciu standardowej składni Windows PowerShell.

Drugie polecenie tworzy pomoc dla tej funkcji wycinka w folderze .\docs.

Przykład 2. Tworzenie pomocy na podstawie modułu

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

Pierwsze polecenie ładuje moduł PlatyPS do bieżącej sesji przy użyciu Import-Module polecenia cmdlet .

Drugie polecenie tworzy pomoc dla wszystkich poleceń cmdlet w module PlatyPS. Przechowuje je w folderze .\docs . To polecenie określa parametr Force . W związku z tym zastępuje istniejące pliki znaczników markdown pomocy, które mają taką samą nazwę.

Przykład 3. Tworzenie pomocy na podstawie istniejącego pliku 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

To polecenie tworzy pomoc w formacie markdown dla określonego pliku MAML pomocy. Nie trzeba ładować modułu, jak w poprzednim przykładzie. Jeśli moduł jest już załadowany, to polecenie tworzy pomoc na podstawie pliku MAML, a nie w aktualnie zainstalowanym module.

Przykład 4. Tworzenie pomocy na podstawie istniejącego pliku MAML do użycia w pliku 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

To polecenie tworzy pomoc w formacie markdown dla określonego pliku MAML pomocy, jak w poprzednim przykładzie. To polecenie określa również parametr WithModulePage i parametr ModuleName . Polecenie tworzy plik o nazwie PSReadLine.md zawierający linki do innych plików markdown w tym module i metadanych, których można użyć do tworzenia .cab plików.

Parametry

-AlphabeticParamsOrder

Parametry kolejności alfabetycznie według nazwy w sekcji PARAMETRY. Istnieją 5 wyjątków: -Confirm, , -WhatIf-IncludeTotalCount, -Skipi -First parametry będą ostatnimi parametrami. Te parametry są typowe i dlatego mają dobrze zdefiniowane zachowanie.

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

-Command

Określa nazwę polecenia w bieżącej sesji. Może to być dowolne polecenie obsługiwane przez pomoc programu PowerShell, takie jak polecenie cmdlet lub funkcja.

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

-ConvertDoubleDashLists

Wskazuje, że to polecenie cmdlet konwertuje punktory listy podwójnych łączników na punktory z jednym łącznikem. Listy podwójnego łącznika są wspólne w dokumentacji Windows PowerShell. Język Markdown akceptuje łączniki jednokrotne dla list.

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

-ConvertNotesToList

Wskazuje, że to polecenie cmdlet formatuje wiele elementów akapitu w sekcji UWAGI jako pojedyncze elementy listy.

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

-Encoding

Określa kodowanie znaków dla zewnętrznego pliku pomocy. Określ obiekt System.Text.Encoding . Aby uzyskać więcej informacji, zobacz about_Character_Encoding.

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

-ExcludeDontShow

Wyklucz parametry oznaczone za pomocą DontShow w atrybucie parametru z zawartości pomocy.

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

-Force

Wskazuje, że to polecenie cmdlet zastępuje istniejące pliki o takich samych nazwach.

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

-FwLink

Określa łącze do przodu dla strony modułu. Ta wartość jest wymagana do .cab utworzenia pliku. Ta wartość jest używana jako metadane nagłówka markdown na stronie modułu.

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

-HelpVersion

Określa wersję pomocy. Ta wartość jest wymagana do .cab utworzenia pliku. Ta wartość jest używana jako metadane nagłówka markdown na stronie modułu.

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

-Locale

Określa ustawienia regionalne pomocy. Ta wartość jest wymagana do utworzenia pliku .cab. Ta wartość jest używana jako metadane nagłówka markdown na stronie modułu.

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

-MamlFile

Określa tablicę ścieżek ścieżki plików pomocy MAML .xml .

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

-Metadata

Określa metadane, które to polecenie cmdlet zawiera w plikach znaczników markdown pomocy jako tabelę skrótów par klucz-wartość typu string-to-sting. To polecenie cmdlet zapisuje metadane w nagłówku każdego pliku pomocy markdown.

Polecenie New-ExternalHelp cmdlet nie używa tych metadanych. Narzędzia zewnętrzne mogą używać tych metadanych.

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

-Module

Określa tablicę nazw modułów, dla których to polecenie cmdlet tworzy pomoc w formacie markdown.

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

-ModuleGuid

Określa identyfikator GUID modułu pomocy. Ta wartość jest wymagana do .cab utworzenia pliku. Ta wartość jest używana jako metadane nagłówka markdown na stronie modułu.

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

-ModuleName

Określa nazwę modułu pomocy. Ta wartość jest wymagana do .cab utworzenia pliku. Ta wartość jest używana jako metadane nagłówka markdown na stronie modułu.

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

-ModulePagePath

Jeśli parametr WithModule jest używany domyślnie, umieszcza plik md w tej samej lokalizacji co wszystkie inne dokumenty. Za pomocą tego parametru można określić nową nazwę/lokalizację, zapewniając lepsze opcje umieszczania.

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

-NoMetadata

Wskazuje, że to polecenie cmdlet nie zapisuje żadnych metadanych w wygenerowanych znaczników markdown.

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

-OnlineVersionUrl

Określa adres, pod którym aktualizowana funkcja pomocy pobiera zaktualizowaną pomoc. Jeśli nie określisz wartości, polecenie cmdlet użyje pustego ciągu.

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

-OutputFolder

Określa ścieżkę folderu, w którym to polecenie cmdlet tworzy pliki pomocy markdown.

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

-Session

Zapewnia obsługę poleceń zdalnych. Przekaż sesję użytą do utworzenia poleceń za pomocą polecenia Import-PSSession. Jest to wymagane do uzyskania dokładnych metadanych parametrów z sesji zdalnej.

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

-UseFullTypeName

Wskazuje, że dokument docelowy będzie używać pełnej nazwy typu zamiast krótkiej nazwy parametrów.

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

-WithModulePage

Wskazuje, że to polecenie cmdlet tworzy stronę modułu w folderze wyjściowym. Ten plik ma nazwę określaną przez parametr ModuleName . Jeśli nie określono tego parametru, polecenie cmdlet dostarcza domyślną nazwę MamlModule. To ustawienie można zastąpić przy użyciu modułu ModulePagePath , co umożliwia zdefiniowanie innej ścieżki dla strony modułu

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

Dane wejściowe

String[]

Do tego polecenia cmdlet można przekazać potokowe nazwy modułów. Są to moduły, z których to polecenie cmdlet tworzy kod markdown pomocy.

Dane wyjściowe

FileInfo[]

To polecenie cmdlet zwraca obiekt FileInfo[] dla utworzonych plików.

Udostępnij za pośrednictwem