Partilhar via

Export-MamlCommandHelp

Módulo:
Microsoft.PowerShell.PlatyPS Module

Exporta objetos CommandHelp para um arquivo MAML.

Sintaxe

__AllParameterSets 

Export-MamlCommandHelp
    [-CommandHelp] <CommandHelp[]>
    [-OutputFolder] <string>
    [-Encoding <Encoding>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Descrição

Este comando converte objetos CommandHelp em um arquivo MAML. O arquivo MAML contém conteúdo de ajuda no formato usado pelo comando Get-Help.

Exemplos

Exemplo 1 - Criar o arquivo de ajuda MAML para um módulo

$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Export-MamlCommandHelp -OutputFolder .\maml

    Directory: D:\Git\PS-Src\platyPS\v2docs\maml

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/26/2024  3:18 PM         160928 Microsoft.PowerShell.PlatyPS-Help.xml

Parâmetros

-CommandHelp

Um ou mais CommandHelp objetos a serem exportados.

Propriedades dos parâmetros

Tipo:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor padrão:False
Suporta curingas:False
DontShow:False
Pseudónimos:Cf.

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-Encoding

A codificação a ser usada ao gravar o arquivo de markdown. Se nenhum valor for especificado, a codificação será padronizada para o valor da variável de preferência $OutputEncoding.

Propriedades dos parâmetros

Tipo:Encoding
Valor padrão:False
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-Force

Use o parâmetro Force para substituir o arquivo de saída, se ele já existir.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor padrão:False
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-OutputFolder

A pasta onde o arquivo de marcação é salvo. Se a pasta não existir, ela será criada.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Executa o comando em um modo que relata apenas o que aconteceria sem executar as ações.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor padrão:False
Suporta curingas:False
DontShow:False
Pseudónimos:Wi

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Saídas

FileInfo