Update-MarkdownHelpModule

Odwołanie

Moduł:: platyPS

Zaktualizuj wszystkie pliki w folderze modułu pomocy języka Markdown.

Składnia

Update-MarkdownHelpModule
      [-Path] <String[]>
      [[-Encoding] <Encoding>]
      [-RefreshModulePage]
      [-ModulePagePath <String>]
      [[-LogPath] <String>]
      [-LogAppend]
      [-AlphabeticParamsOrder]
      [-UseFullTypeName]
      [-UpdateInputOutput]
      [-Force]
      [-Session <PSSession>]
      [-ExcludeDontShow]
      [<CommonParameters>]

Opis

Polecenie Update-MarkdownHelpModule cmdlet aktualizuje istniejące pliki języka markdown pomocy i tworzy pliki markdown dla nowych poleceń cmdlet w module. To polecenie cmdlet łączy funkcje poleceń cmdlet Update-MarkdownHelp i New-MarkdownHelp w celu przeprowadzenia aktualizacji zbiorczej.

Przykłady

Przykład 1. Aktualizowanie modułu pomocy języka Markdown

PS C:\> Update-MarkdownHelpModule -Path ".\docs"

    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

To polecenie aktualizuje wszystkie pliki w określonym folderze na podstawie poleceń cmdlet załadowanych do bieżącej sesji. Polecenie tworzy tematy pomocy języka Markdown dla wszystkich poleceń cmdlet, które nie zostały jeszcze uwzględnione w folderze .\docs.

Parametry

-AlphabeticParamsOrder

Kolejność parametrów 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ą wspólne i dlatego mają dobrze zdefiniowane zachowanie.

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

-Encoding

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

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

-ExcludeDontShow

Wyklucz parametry oznaczone 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

Usuń pliki pomocy, które nie istnieją już w ramach sesji (na przykład jeśli funkcja została usunięta).

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

-LogAppend

Wskazuje, że to polecenie cmdlet dołącza informacje do dziennika zamiast zastępowania go.

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

-LogPath

Określa ścieżkę pliku do informacji dziennika. Polecenie cmdlet zapisuje strumień VERBOSE w dzienniku. Jeśli określisz parametr Verbose , to polecenie cmdlet również zapisuje te informacje w konsoli programu .

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

-ModulePagePath

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

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

-Path

Określa tablicę ścieżek folderów markdown do aktualizacji. Folder musi zawierać stronę modułu, z której to polecenie cmdlet może uzyskać nazwę modułu.

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

-RefreshModulePage

Zaktualizuj stronę modułu podczas aktualizowania modułu pomocy.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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, aby uzyskać dokładne metadane parametrów z sesji zdalnej.

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

-UpdateInputOutput

Odświeża sekcje Dane wejściowe i wyjściowe, aby odzwierciedlić bieżący stan polecenia cmdlet. OSTRZEŻENIE: ten parametr usunie wszelkie ręczne dodatki do tych sekcji.

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

Dane wejściowe

String[]

Możesz przekazać tablicę ścieżek do tego polecenia cmdlet.

Dane wyjściowe

FileInfo[]

To polecenie cmdlet zwraca obiekt FileInfo[] dla zaktualizowanych i nowych plików.

Uwagi

Moduł, dla którego chcesz zaktualizować pomoc, należy najpierw zaimportować z lokalizacji zawierającej poprzednią wersję pomocy. Jeśli ten warunek nie zostanie spełniony, kolejność parametrów będzie alfabetyczna w zaktualizowanej pomocy, nawet jeśli parametr AlphabeticParamsOrder nie został użyty.