New-MarkdownHelp
Cria ajuda no formato markdown.
Syntax
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>] Description
O New-MarkdownHelp cmdlet cria ajuda no formato markdown com base num módulo, num comando ou num ficheiro no formato MAML (Microsoft Assistance Markup Language).
Exemplos
Exemplo 1: Criar ajuda a partir de um 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.mdO primeiro comando cria uma função denominada Command03 com sintaxe padrão Windows PowerShell.
O segundo comando cria ajuda para essa função stub na pasta .\docs.
Exemplo 2: Criar ajuda a partir de um módulo
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.mdO primeiro comando carrega o módulo PlatyPS para a sessão atual com o Import-Module cmdlet.
O segundo comando cria ajuda para todos os cmdlets no módulo PlatyPS. Armazena-os na .\docs pasta. Este comando especifica o parâmetro Forçar . Por conseguinte, substitui os ficheiros de markdown de ajuda existentes que têm o mesmo nome.
Exemplo 3: Criar ajuda a partir de um ficheiro MAML existente
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.mdEste comando cria ajuda no formato markdown para o ficheiro MAML de ajuda especificado. Não tem de carregar o módulo, como no exemplo anterior. Se o módulo já estiver carregado, este comando cria ajuda com base no ficheiro MAML e não no módulo atualmente instalado.
Exemplo 4: Criar ajuda a partir de um ficheiro MAML existente para utilização num ficheiro 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.mdEste comando cria ajuda no formato markdown para o ficheiro MAML de ajuda especificado, tal como no exemplo anterior. Este comando também especifica o parâmetro WithModulePage e o parâmetro ModuleName . O comando cria um ficheiro com o nome PSReadLine.md que contém ligações para os outros ficheiros markdown neste módulo e metadados que podem ser utilizados para criar .cab ficheiros.
Parâmetros
-AlphabeticParamsOrder
Ordenar parâmetros alfabeticamente por nome na secção PARAMETERS. Existem 5 exceções: -Confirm, -WhatIf, -IncludeTotalCount, -Skip, e -First os parâmetros serão os últimos. Estes parâmetros são comuns e, por conseguinte, têm um comportamento bem definido.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Command
Especifica o nome de um comando na sessão atual. Pode ser qualquer comando suportado pela ajuda do PowerShell, como um cmdlet ou uma função.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConvertDoubleDashLists
Indica que este cmdlet converte marcas de lista de hífen duplo em marcas de hífen único. As listas de hífen duplo são comuns na documentação Windows PowerShell. Markdown aceita hífenes únicos para listas.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConvertNotesToList
Indica que este cmdlet formata vários itens de parágrafo na secção NOTAS como itens de lista única.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Encoding
Especifica a codificação de carateres para o ficheiro de ajuda externo. Especifique um objeto System.Text.Encoding . Para obter mais informações, veja about_Character_Encoding.
| Type: | Encoding |
| Position: | Named |
| Default value: | UTF8 without BOM |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludeDontShow
Exclua os parâmetros marcados com DontShow no atributo de parâmetro do conteúdo da ajuda.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Indica que este cmdlet substitui ficheiros existentes que têm os mesmos nomes.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FwLink
Especifica a ligação de reencaminhamento para a página do módulo. Este valor é necessário para a .cab criação de ficheiros.
Este valor é utilizado como metadados de cabeçalho markdown na página do módulo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HelpVersion
Especifica a versão da sua ajuda. Este valor é necessário para a .cab criação de ficheiros. Este valor é utilizado como metadados de cabeçalho markdown na página do módulo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Locale
Especifica a região da sua ajuda. Este valor é necessário para .cab criação de ficheiros. Este valor é utilizado como metadados de cabeçalho markdown na página do módulo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MamlFile
Especifica uma matriz do caminho dos caminhos dos ficheiros de ajuda MAML .xml .
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Metadata
Especifica os metadados que este cmdlet inclui nos ficheiros de markdown de ajuda como uma tabela hash de pares chave-valor de cadeia a picada. Este cmdlet escreve os metadados no cabeçalho de cada ficheiro de ajuda markdown.
O New-ExternalHelp cmdlet não utiliza estes metadados. As ferramentas externas podem utilizar estes metadados.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Module
Especifica uma matriz de nomes de módulos para os quais este cmdlet cria ajuda no formato markdown.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ModuleGuid
Especifica o GUID do módulo da sua ajuda. Este valor é necessário para a .cab criação de ficheiros. Este valor é utilizado como metadados de cabeçalho markdown na página do módulo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModuleName
Especifica o nome do módulo da sua ajuda. Este valor é necessário para a .cab criação de ficheiros. Este valor é utilizado como metadados de cabeçalho markdown na página do módulo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModulePagePath
Quando o parâmetro WithModule é utilizado por predefinição, coloca o ficheiro .md na mesma localização que todos os outros documentos. Com este parâmetro, pode especificar o novo nome/localização, proporcionando melhores opções de colocação.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoMetadata
Indica que este cmdlet não escreve metadados no markdown gerado.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OnlineVersionUrl
Especifica o endereço onde a função de ajuda atual transfere a ajuda atualizada. Se não especificar um valor, o cmdlet utiliza uma cadeia vazia.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutputFolder
Especifica o caminho da pasta onde este cmdlet cria os ficheiros de ajuda markdown.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Session
Fornece suporte para comandos remotos. Passe a sessão que utilizou para criar os comandos com Import-PSSession. Isto é necessário para obter metadados de parâmetros precisos da sessão remota.
| Type: | PSSession |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseFullTypeName
Indica que o documento de destino utilizará um nome de tipo completo em vez de um nome abreviado para parâmetros.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WithModulePage
Indica que este cmdlet cria uma página de módulo na pasta de saída. Este ficheiro tem o nome especificado pelo parâmetro ModuleName . Se não especificou esse parâmetro, o cmdlet fornece o nome MamlModulepredefinido . Pode substituir esta definição com o ModulePagePath , que lhe permite definir um caminho diferente para a página do módulo
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Entradas
String[]
Pode encaminhar os nomes dos módulos para este cmdlet. Estes são os módulos a partir dos quais este cmdlet cria markdown de ajuda.
Saídas
FileInfo[]
Este cmdlet devolve um objeto FileInfo[] para ficheiros criados.
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários