Delen via

New-ExternalHelp

  • Referentie
Module:
platyPS

Hiermee maakt u een extern Help-bestand op basis van Markdown die wordt ondersteund door PlatyPS.

Syntaxis

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

Description

De cmdlet New-ExternalHelp maakt een extern Help-bestand op basis van Markdown Help-bestanden die worden ondersteund door PlatyPS. U kunt dit verzenden met een module om hulp te bieden met behulp van de Get-Help cmdlet.

Als de Markdown-bestanden die u opgeeft, niet voldoen aan de PlatyPS-Schema-, retourneert deze cmdlet foutberichten.

Voorbeelden

Voorbeeld 1: Externe Help maken op basis van de inhoud van een map

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

Met deze opdracht maakt u een extern Help-bestand op de opgegeven locatie. Deze opdracht maakt gebruik van de best practice dat de mapnaam de landinstelling bevat.

Voorbeeld 2: Help maken die gebruikmaakt van aangepaste codering

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

Met deze opdracht maakt u een extern Help-bestand op de opgegeven locatie. Met deze opdracht wordt de parameter Force opgegeven, waardoor een bestaand bestand wordt overschreven. Met de opdracht geeft u Unicode-codering voor het gemaakte bestand op.

Voorbeeld 3: Waarschuwingen en fouten naar bestand schrijven

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

Met deze opdracht maakt u een extern Help-bestand op de opgegeven locatie. Deze opdracht maakt gebruik van de best practice dat de mapnaam de landinstelling bevat. Met deze opdracht worden de waarschuwingen en fouten naar het WarningsAndErrors.json-bestand geschreven.

Parameters

-ApplicableTag

Geef een matrix van tags op die u als filter wilt gebruiken. Als de cmdlet applicable bevat in de yaml-metagegevens en daar geen van de doorgegeven tags wordt vermeld, wordt de cmdlet genegeerd in de gegenereerde Help. Hetzelfde geldt voor het parameterniveau applicable yaml-metagegevens. Als applicable wordt weggelaten, is de cmdlet of parameter altijd aanwezig. Zie ontwerpprobleem voor meer informatie.

Type:String[]
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Encoding

Hiermee geeft u de tekencodering voor uw externe Help-bestand. Geef een System.Text.Encoding--object op. Zie about_Character_Encodingvoor meer informatie.

Type:Encoding
Position:Named
Default value:UTF8 without BOM
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ErrorLogFile

Het pad waar deze cmdlet opgemaakte resultatenlogboekbestand opslaat.

Het pad moet de locatie en naam van de map en bestandsnaam met de json-extensie bevatten. Het JSON-object bevat drie eigenschappen: Message, FilePathen Ernst (waarschuwing of fout).

Als dit pad niet is opgegeven, wordt er geen logboek gegenereerd.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Force

Hiermee wordt aangegeven dat met deze cmdlet een bestaand bestand met dezelfde naam wordt overschreven.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-MaxAboutWidth

Hiermee geeft u de maximale regellengte op bij het genereren van help-tekstbestanden met 'about'. Andere Help-bestandstypen worden niet beïnvloed door deze parameter. Zie New-MarkdownAboutHelpvoor meer informatie.

Regels in codeblokken worden niet verpakt en worden niet beïnvloed door de parameter MaxAboutWidth.

Type:Int32
Position:Named
Default value:80
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-OutputPath

Hiermee geeft u het pad op van een map waarin deze cmdlet uw externe Help-bestand opslaat. De mapnaam moet eindigen op een landinstellingsmap, zoals in het volgende voorbeeld: .\out\PlatyPS\en-US\.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Path

Hiermee geeft u een matrix van paden van Markdown-bestanden of -mappen. Met deze cmdlet maakt u externe help op basis van deze bestanden en mappen.

Type:String[]
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:True

-ShowProgress

Voortgangsbalken weergeven onder het parseren van bestaande Markdown-bestanden.

Als dit wordt gebruikt om hulp te genereren, is veel langzamer.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

String[]

U kunt een matrix met paden naar deze cmdlet doorsluisen.

Uitvoerwaarden

FileInfo[]

Deze cmdlet retourneert een FileInfo[]-object voor gemaakte bestanden.