Update-MarkdownHelp

Odwołanie

Moduł:: platyPS

Aktualizowanie plików pomocy platformy PlatyPS markdown.

Składnia

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

Opis

Polecenie Update-MarkdownHelp cmdlet aktualizuje pliki pomocnika PlatyPS markdown bez całkowitej wymiany zawartości plików.

Niektóre atrybuty parametrów zmieniają się w czasie. Na przykład zestawy parametrów, typy, wartość domyślna i wymagane. To polecenie cmdlet aktualizuje znaczniki markdown, aby odzwierciedlić te zmiany. Dodaje również tekst zastępczy do pliku markdown dla dowolnego nowego parametru.

Aby propagować zmiany do plików pomocy markdown, wykonaj następujące czynności:

Załaduj nową wersję modułu do sesji Windows PowerShell.
Uruchom polecenie cmdlet, Update-MarkdownHelp aby zaktualizować pliki.
Sprawdź nowe metadane parametrów w plikach markdown.

Przykłady

Przykład 1. Aktualizowanie wszystkich plików w folderze

PS C:\> Update-MarkdownHelp -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 pomocy markdown w określonej ścieżce, aby pasować do bieżących poleceń cmdlet.

Przykład 2. Aktualizowanie jednego pliku i przechwytywanie dziennika

PS C:\> Update-MarkdownHelp -Path ".\docs\Update-MarkdownHelp.md" -LogPath ".\markdown.log"

    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   8:20 PM           9993 New-MarkdownHelp.md

To polecenie aktualizuje plik pomocy markdown. Zapisuje informacje dziennika w markdown.log pliku.

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

-Path

Określa tablicę ścieżek plików i folderów markdown do zaktualizowania.

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

-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 sekcję 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 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.

Udostępnij za pośrednictwem