Condividi tramite

New-ExternalHelp

  • Riferimento
Modulo:
platyPS

Crea un file della Guida esterna basato su markdown supportato da PlatyPS.

Sintassi

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

Descrizione

Il New-ExternalHelp cmdlet crea un file della Guida esterna basato sui file della Guida markdown supportati da PlatyPS. È possibile inviare questa operazione con un modulo per fornire assistenza usando il Get-Help cmdlet.

Se i file markdown specificati non seguono lo schema PlatyPS, questo cmdlet restituisce messaggi di errore.

Esempio

Esempio 1: Creare una Guida esterna in base al contenuto di una cartella

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

Questo comando crea un file della Guida esterna nel percorso specificato. Questo comando usa la procedura consigliata che il nome della cartella include le impostazioni locali.

Esempio 2: Creare una Guida che usa la codifica personalizzata

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

Questo comando crea un file della Guida esterna nel percorso specificato. Questo comando specifica il parametro Force , pertanto sovrascrive un file esistente. Il comando specifica la codifica Unicode per il file creato.

Esempio 3: Scrivere avvisi ed errori nel file

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

Questo comando crea un file della Guida esterna nel percorso specificato. Questo comando usa la procedura consigliata che il nome della cartella include le impostazioni locali. Questo comando scrive gli avvisi e gli errori nel file WarningsAndErrors.json.

Parametri

-ApplicableTag

Specificare la matrice di tag da usare come filtro. Se il cmdlet contiene applicable i metadati yaml e nessuno dei tag passati è presente, il cmdlet verrà ignorato nella Guida generata. Lo stesso vale per i metadati yaml a livello applicable di parametro. Se applicable viene omesso, il cmdlet o il parametro saranno sempre presenti. Per altre informazioni, vedere Problema di progettazione .

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

-Encoding

Specifica la codifica dei caratteri per il file della Guida esterna. Specificare un oggetto System.Text.Encoding . Per altre informazioni, vedere about_Character_Encoding.

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

-ErrorLogFile

Percorso in cui questo cmdlet salva il file di log dei risultati formattato.

Il percorso deve includere il percorso e il nome della cartella e del nome del file con l'estensione json. L'oggetto JSON contiene tre proprietà: Message, FilePath e Gravità (avviso o errore).

Se questo percorso non viene specificato, non viene generato alcun log.

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

-Force

Indica che questo cmdlet sovrascrive un file esistente con lo stesso nome.

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

-MaxAboutWidth

Specifica la lunghezza massima della riga durante la generazione di file di testo della Guida "about". Altri tipi di file della Guida non sono interessati da questo parametro. Per altre informazioni, vedere New-MarkdownAboutHelp.

Le righe all'interno dei blocchi di codice non vengono avvolte e non sono interessate dal parametro MaxAboutWidth .

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

-OutputPath

Specifica il percorso di una cartella in cui questo cmdlet salva il file della Guida esterna. Il nome della cartella deve terminare con una cartella delle impostazioni locali, come nell'esempio seguente: .\out\PlatyPS\en-US\.

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

-Path

Specifica una matrice di percorsi di file o cartelle markdown. Questo cmdlet crea una Guida esterna basata su questi file e cartelle.

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

-ShowProgress

Visualizzare le barre di stato sotto l'analisi dei file markdown esistenti.

Se viene usata la generazione della guida è molto più lenta.

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

Input

String[]

È possibile inviare una matrice di percorsi a questo cmdlet.

Output

FileInfo[]

Questo cmdlet restituisce un FileInfo[] oggetto per i file creati.