New-ExternalHelp

  • Odwołanie
Moduł:
platyPS

Tworzy zewnętrzny plik pomocy na podstawie znaczników markdown obsługiwanych przez platformę PlatyPS.

Składnia

New-ExternalHelp
   -Path <String[]>
   -OutputPath <String>
   [-ApplicableTag <String[]>]
   [-Encoding <Encoding>]
   [-MaxAboutWidth <Int32>]
   [-ErrorLogFile <String>]
   [-Force]
   [-ShowProgress]
   [<CommonParameters>]

Opis

Polecenie New-ExternalHelp cmdlet tworzy zewnętrzny plik pomocy na podstawie plików pomocy markdown obsługiwanych przez platformę PlatyPS. Możesz wysłać go z modułem, aby zapewnić pomoc przy użyciu Get-Help polecenia cmdlet .

Jeśli określone pliki markdown nie są zgodne ze schematem PlatyPS, to polecenie cmdlet zwraca komunikaty o błędach.

Przykłady

Przykład 1: Tworzenie pomocy zewnętrznej na podstawie zawartości folderu

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

To polecenie tworzy zewnętrzny plik pomocy w określonej lokalizacji. To polecenie używa najlepszego rozwiązania, które nazwa folderu zawiera ustawienia regionalne.

Przykład 2. Tworzenie pomocy korzystającej z kodowania niestandardowego

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

To polecenie tworzy zewnętrzny plik pomocy w określonej lokalizacji. To polecenie określa parametr Force , dlatego zastępuje istniejący plik. Polecenie określa kodowanie Unicode dla utworzonego pliku.

Przykład 3: Zapisywanie ostrzeżeń i błędów do pliku

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

To polecenie tworzy zewnętrzny plik pomocy w określonej lokalizacji. To polecenie używa najlepszego rozwiązania, które nazwa folderu zawiera ustawienia regionalne. To polecenie zapisuje ostrzeżenia i błędy w pliku WarningsAndErrors.json.

Parametry

-ApplicableTag

Określ tablicę tagów do użycia jako filtr. Jeśli polecenie cmdlet ma applicable metadane yaml i żaden z przekazanych tagów nie zostanie tam wymieniony, polecenie cmdlet zostanie zignorowane w wygenerowanej pomocy. To samo dotyczy metadanych yaml na poziomie applicable parametru. Jeśli applicable zostanie pominięty, polecenie cmdlet lub parametr będzie zawsze obecny. Zobacz problem z projektem , aby uzyskać więcej szczegółów.

Type:String[]
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

-ErrorLogFile

Ścieżka, w której to polecenie cmdlet zapisze sformatowany plik dziennika wyników.

Ścieżka musi zawierać lokalizację i nazwę folderu oraz nazwę pliku z rozszerzeniem JSON. Obiekt JSON zawiera trzy właściwości: Message, FilePath i Severity (Ostrzeżenie lub Błąd).

Jeśli ta ścieżka nie zostanie podana, dziennik nie zostanie wygenerowany.

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

-Force

Wskazuje, że to polecenie cmdlet zastępuje istniejący plik o tej samej nazwie.

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

-MaxAboutWidth

Określa maksymalną długość wiersza podczas generowania "about" plików tekstowych pomocy. Ten parametr nie ma wpływu na inne typy plików pomocy. Aby uzyskać więcej informacji, zobacz New-MarkdownAboutHelp.

Wiersze wewnątrz bloków kodu nie są opakowane i nie mają wpływu na parametr MaxAboutWidth .

Type:Int32
Position:Named
Default value:80
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputPath

Określa ścieżkę folderu, w którym to polecenie cmdlet zapisuje zewnętrzny plik pomocy. Nazwa folderu powinna kończyć się folderem ustawień regionalnych, jak w poniższym przykładzie: .\out\PlatyPS\en-US\.

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

-Path

Określa tablicę ścieżek plików lub folderów markdown. To polecenie cmdlet tworzy pomoc zewnętrzną na podstawie tych plików i folderów.

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

-ShowProgress

Wyświetl paski postępu w obszarze analizowania istniejących plików markdown.

Jeśli jest to używane generowanie pomocy jest znacznie wolniejsze.

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ć tablicę ścieżek.

Dane wyjściowe

FileInfo[]

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