New-MarkdownHelp
Crea la Guida nel formato markdown.
Sintassi
New-MarkdownHelp
-Module <String[]>
[-Session <PSSession>]
[-Force]
[-AlphabeticParamsOrder]
[-Metadata <Hashtable>]
-OutputFolder <String>
[-NoMetadata]
[-UseFullTypeName]
[-Encoding <Encoding>]
[-WithModulePage]
[-ModulePagePath <String>]
[-Locale <String>]
[-HelpVersion <String>]
[-FwLink <String>]
[-ExcludeDontShow]
[<CommonParameters>] New-MarkdownHelp
-Command <String[]>
[-Session <PSSession>]
[-Force]
[-AlphabeticParamsOrder]
[-Metadata <Hashtable>]
[-OnlineVersionUrl <String>]
-OutputFolder <String>
[-NoMetadata]
[-UseFullTypeName]
[-Encoding <Encoding>]
[-ExcludeDontShow]
[<CommonParameters>] New-MarkdownHelp
-MamlFile <String[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[-Force]
[-AlphabeticParamsOrder]
[-Metadata <Hashtable>]
-OutputFolder <String>
[-NoMetadata]
[-UseFullTypeName]
[-Encoding <Encoding>]
[-WithModulePage]
[-ModulePagePath <String>]
[-Locale <String>]
[-HelpVersion <String>]
[-FwLink <String>]
[-ModuleName <String>]
[-ModuleGuid <String>]
[-ExcludeDontShow]
[<CommonParameters>] Descrizione
Il New-MarkdownHelp cmdlet crea la Guida in formato markdown in base a un modulo, a un comando o a un file in formato MAML (Microsoft Assistance Markup Language).
Esempio
Esempio 1: Creare la Guida da un comando
PS C:\> function Command03 {param([string]$Value)}
PS C:\> New-MarkdownHelp -Command "Command03" -OutputFolder ".\docs"
Directory: D:\Working\docs
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 6:53 PM 664 Command03.mdIl primo comando crea una funzione denominata Command03 usando la sintassi di Windows PowerShell standard.
Il secondo comando crea la Guida per la funzione stub nella cartella .\docs.
Esempio 2: Creare la Guida da un modulo
PS C:\> Import-Module -Module "PlatyPS"
PS C:\> New-MarkdownHelp -Module "PlatyPS" -OutputFolder ".\docs" -Force
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.mdIl primo comando carica il modulo PlatyPS nella sessione corrente usando il Import-Module cmdlet .
Il secondo comando crea la Guida per tutti i cmdlet nel modulo PlatyPS. Li archivia nella .\docs cartella . Questo comando specifica il parametro Force . Pertanto, sovrascrive i file markdown della Guida esistenti con lo stesso nome.
Esempio 3: Creare la Guida da un file MAML esistente
PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml'
Directory: D:\PSReadLine\docs
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 6:56 PM 7443 Get-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:56 PM 3586 Get-PSReadLineOption.md
-a---- 5/22/2016 6:56 PM 1549 Remove-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:56 PM 5947 Set-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:56 PM 15320 Set-PSReadLineOption.mdQuesto comando crea la Guida in formato markdown per il file MAML della Guida specificato. Non è necessario caricare il modulo, come nell'esempio precedente. Se il modulo è già caricato, questo comando crea la Guida in base al file MAML, non nel modulo attualmente installato.
Esempio 4: Creare la Guida da un file MAML esistente da usare in un file CAB
PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml' -WithModulePage -Force -ModuleName "PSReadLine"
Directory: D:\PSReadLine\docs
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 6:59 PM 7443 Get-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:59 PM 3586 Get-PSReadLineOption.md
-a---- 5/22/2016 6:59 PM 1549 Remove-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:59 PM 5947 Set-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:59 PM 15320 Set-PSReadLineOption.md
-a---- 5/22/2016 6:59 PM 942 PSReadLine.mdQuesto comando crea la Guida in formato markdown per il file MAML della Guida specificato, come nell'esempio precedente. Questo comando specifica anche il parametro WithModulePage e il parametro ModuleName . Il comando crea un file denominato PSReadLine.md che contiene collegamenti agli altri file markdown in questo modulo e metadati che possono essere usati per creare .cab file.
Parametri
-AlphabeticParamsOrder
Ordinare i parametri in ordine alfabetico in base al nome nella sezione PARAMETERS. Esistono 5 eccezioni: -Confirm, -WhatIf, -IncludeTotalCount, -Skipe -First i parametri saranno gli ultimi. Questi parametri sono comuni e quindi hanno un comportamento ben definito.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Command
Specifica il nome di un comando nella sessione corrente. Può trattarsi di qualsiasi comando supportato dalla Guida di PowerShell, ad esempio un cmdlet o una funzione.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConvertDoubleDashLists
Indica che questo cmdlet converte i punti elenco con trattini doppi in punti elenco con trattini singoli. Gli elenchi con trattini doppi sono comuni nella documentazione di Windows PowerShell. Markdown accetta trattini singoli per gli elenchi.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConvertNotesToList
Indica che questo cmdlet formatta più elementi di paragrafo nella sezione NOTES come voci di elenco singole.
| Type: | SwitchParameter |
| 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 |
-ExcludeDontShow
Escludere i parametri contrassegnati con DontShow nell'attributo del parametro dal contenuto della Guida.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Indica che questo cmdlet sovrascrive i file esistenti con gli stessi nomi.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FwLink
Specifica il collegamento di inoltro per la pagina del modulo. Questo valore è obbligatorio per .cab la creazione di file.
Questo valore viene usato come metadati di intestazione markdown nella pagina del modulo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HelpVersion
Specifica la versione della Guida. Questo valore è obbligatorio per .cab la creazione di file. Questo valore viene usato come metadati di intestazione markdown nella pagina del modulo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Locale
Specifica le impostazioni locali della Guida. Questo valore è necessario per la creazione di .cab file. Questo valore viene usato come metadati di intestazione markdown nella pagina del modulo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MamlFile
Specifica una matrice di percorsi dei file della Guida MAML .xml .
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Metadata
Specifica i metadati inclusi in questo cmdlet nei file markdown della Guida come tabella hash di coppie chiave-valore stringa-sting. Questo cmdlet scrive i metadati nell'intestazione di ogni file della Guida markdown.
Il New-ExternalHelp cmdlet non usa questi metadati. Gli strumenti esterni possono usare questi metadati.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Module
Specifica una matrice di nomi di moduli per cui questo cmdlet crea la Guida nel formato markdown.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ModuleGuid
Specifica il GUID del modulo della Guida. Questo valore è obbligatorio per .cab la creazione di file. Questo valore viene usato come metadati di intestazione markdown nella pagina del modulo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModuleName
Specifica il nome del modulo della Guida. Questo valore è obbligatorio per .cab la creazione di file. Questo valore viene usato come metadati di intestazione markdown nella pagina del modulo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModulePagePath
Quando il parametro WithModule viene usato per impostazione predefinita, inserisce il file md nella stessa posizione di tutti gli altri documenti. Con questo parametro è possibile specificare un nuovo nome/posizione che offre opzioni di posizionamento migliori.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoMetadata
Indica che questo cmdlet non scrive metadati nel markdown generato.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OnlineVersionUrl
Specifica l'indirizzo in cui la funzione della Guida aggiornabile scarica la Guida aggiornata. Se non si specifica un valore, il cmdlet usa una stringa vuota.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutputFolder
Specifica il percorso della cartella in cui questo cmdlet crea i file della Guida markdown.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Session
Fornisce il supporto per i comandi remoti. Passare la sessione usata per creare i comandi con Import-PSSession. Questa operazione è necessaria per ottenere metadati accurati dei parametri dalla sessione remota.
| Type: | PSSession |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseFullTypeName
Indica che il documento di destinazione userà un nome di tipo completo anziché un nome breve per i parametri.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WithModulePage
Indica che questo cmdlet crea una pagina del modulo nella cartella di output. Questo file ha il nome specificato dal parametro ModuleName . Se il parametro non è stato specificato, il cmdlet fornisce il nome MamlModulepredefinito . È possibile sovrascrivere questa impostazione usando ModulePagePath che consente di definire un percorso diverso per la pagina del modulo
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Input
String[]
È possibile inviare tramite pipe i nomi dei moduli a questo cmdlet. Questi sono i moduli da cui questo cmdlet crea la Guida markdown.
Output
FileInfo[]
Questo cmdlet restituisce un oggetto FileInfo[] per i file creati.
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per