New-MarkdownHelp
Cria ajuda em formato de marcação.
Sintaxe
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 cmdlet New-MarkdownHelp cria ajuda em formato de marcação com base em um módulo, um comando ou um arquivo 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 chamada Command03 usando a sintaxe padrão do Windows PowerShell.
O segundo comando cria ajuda para essa função de 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 na sessão atual usando o cmdlet Import-Module.
O segundo comando cria ajuda para todos os cmdlets no módulo PlatyPS. Ele os armazena na pasta .\docs. Este comando especifica o parâmetro Force. Portanto, ele substitui arquivos de marcação de ajuda existentes que têm o mesmo nome.
Exemplo 3: Criar ajuda a partir de um arquivo 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 em formato de marcação para o arquivo MAML de ajuda especificado. Não é necessário carregar o módulo, como no exemplo anterior. Se o módulo já estiver carregado, este comando criará ajuda com base no arquivo MAML, não no módulo atualmente instalado.
Exemplo 4: Criar ajuda a partir de um arquivo MAML existente para uso em um arquivo 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 em formato de marcação para o arquivo MAML de ajuda especificado, como no exemplo anterior. Este comando também especifica o parâmetro WithModulePage e o parâmetro ModuleName. O comando cria um arquivo chamado PSReadLine.md que contém links para os outros arquivos de marcação neste módulo e metadados que podem ser usados para criar arquivos .cab.
Parâmetros
-AlphabeticParamsOrder
Ordene os parâmetros alfabeticamente por nome na seção PARÂMETROS. Existem 5 exceções: -Confirm, -WhatIf, -IncludeTotalCount, -Skipe -First parâmetros serão os últimos. Estes parâmetros são comuns e, portanto, têm um comportamento bem definido.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | 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.
| Tipo: | String[] |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-ConvertDoubleDashLists
Indica que esse cmdlet converte marcadores de lista de hífen duplo em marcadores de hífen único. Listas de hífen duplo são comuns na documentação do Windows PowerShell. Markdown aceita hífenes único para listas.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-ConvertNotesToList
Indica que esse cmdlet formata vários itens de parágrafo na seção NOTAS como itens de lista únicos.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Encoding
Especifica a codificação de caracteres para o arquivo de ajuda externo. Especifique um objeto System.Text.Encoding. Para obter mais informações, consulte about_Character_Encoding.
| Tipo: | Encoding |
| Position: | Named |
| Default value: | UTF8 without BOM |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-ExcludeDontShow
Exclua os parâmetros marcados com DontShow no atributo parameter do conteúdo da ajuda.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Force
Indica que esse cmdlet substitui arquivos existentes com os mesmos nomes.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-FwLink
Especifica o link de encaminhamento para a página do módulo. Esse valor é necessário para .cab criação de arquivo.
Esse valor é usado como metadados de cabeçalho de marcação na página do módulo.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-HelpVersion
Especifica a versão da sua ajuda. Esse valor é necessário para .cab criação de arquivo. Esse valor é usado como metadados de cabeçalho de marcação na página do módulo.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Locale
Especifica a localidade da sua ajuda. Esse valor é necessário para .cab criação de arquivo. Esse valor é usado como metadados de cabeçalho de marcação na página do módulo.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-MamlFile
Especifica uma matriz de caminhos caminho de MAML .xml arquivos de ajuda.
| Tipo: | String[] |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Metadata
Especifica os metadados que esse cmdlet inclui nos arquivos de marcação da ajuda como uma tabela de hash de pares chave-valor de cadeia de caracteres para picada. Este cmdlet grava os metadados no cabeçalho de cada arquivo de ajuda de marcação.
O cmdlet New-ExternalHelp não usa esses metadados. Ferramentas externas podem usar esses metadados.
| Tipo: | Hashtable |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Module
Especifica uma matriz de nomes de módulos para os quais esse cmdlet cria ajuda no formato de marcação.
| Tipo: | String[] |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-ModuleGuid
Especifica o GUID do módulo da sua ajuda. Esse valor é necessário para .cab criação de arquivo. Esse valor é usado como metadados de cabeçalho de marcação na página do módulo.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-ModuleName
Especifica o nome do módulo da sua ajuda. Esse valor é necessário para .cab criação de arquivo. Esse valor é usado como metadados de cabeçalho de marcação na página do módulo.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-ModulePagePath
Quando parâmetro WithModule é usado por padrão, ele coloca o arquivo .md no mesmo local que todos os outros documentos. Com este parâmetro, você pode especificar um novo nome/local, fornecendo melhores opções de posicionamento.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-NoMetadata
Indica que esse cmdlet não grava metadados na marcação gerada.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-OnlineVersionUrl
Especifica o endereço onde a função de ajuda atualizável baixa a ajuda atualizada. Se você não especificar um valor, o cmdlet usará uma cadeia de caracteres vazia.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-OutputFolder
Especifica o caminho da pasta onde esse cmdlet cria os arquivos de ajuda de marcação.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Session
Fornece suporte para comandos remotos. Passe a sessão que você usou para criar os comandos com Import-PSSession. Isso é necessário para obter metadados de parâmetros precisos da sessão remota.
| Tipo: | PSSession |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-UseFullTypeName
Indica que o documento de destino usará um nome de tipo completo em vez de um nome curto para parâmetros.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-WithModulePage
Indica que esse cmdlet cria uma página de módulo na pasta de saída. Esse arquivo tem o nome que o parâmetro ModuleName especifica. Se você não especificou esse parâmetro, o cmdlet fornecerá o nome padrão MamlModule. Você pode substituir essa configuração usando ModulePagePath que permite definir um caminho diferente para a página do módulo
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
Entradas
String[]
Você pode canalizar nomes de módulo para este cmdlet. Estes são os módulos a partir dos quais este cmdlet cria a marcação de ajuda.
Saídas
FileInfo[]
Este cmdlet retorna um objeto FileInfo[] para arquivos criados.
