Partilhar via

New-ExternalHelpCab

  • Referência
Módulo:
platyPS

Gera um arquivo .cab.

Sintaxe

New-ExternalHelpCab
   -CabFilesFolder <String>
   -LandingPagePath <String>
   -OutputFolder <String>
   [-IncrementHelpVersion]
   [<CommonParameters>]

Description

O cmdlet New-ExternalHelpCab gera um arquivo .cab que contém todo o conteúdo não recursivo em uma pasta. Este cmdlet compacta os arquivos fornecidos.

Observação

Esse cmdlet depende do comando MakeCab.exe nativo, que só está disponível no Windows. Este cmdlet gera um erro se usado em máquinas que não sejam Windows.

Recomendamos que você forneça como conteúdo apenas about_ tópicos e a saída do cmdlet New-ExternalHelp para este cmdlet.

Este cmdlet usa metadados armazenados no arquivo de marcação do módulo para nomear seu arquivo .cab. Essa nomenclatura corresponde ao padrão que o sistema de ajuda do PowerShell requer para uso como ajuda atualizável. Esses metadados fazem parte do arquivo de módulo criado usando o cmdlet New-MarkdownHelp com o parâmetro WithModulePage.

Esse cmdlet também gera ou atualiza um arquivo helpinfo.xml existente. Esse arquivo fornece detalhes de controle de versão e localidade para o sistema de ajuda do PowerShell.

Exemplos

Exemplo 1: Criar um arquivo CAB

$params = @{
    CabFilesFolder  = 'C:\Module\ExternalHelpContent'
    LandingPagePath = 'C:\Module\ModuleName.md'
    OutputFolder    = 'C:\Module\Cab\'
}
New-ExternalHelpCab @params

O cmdlet cria um arquivo de .cab que contém os arquivos da pasta de conteúdo. O arquivo .cab é nomeado para ajuda atualizável com base em metadados. O comando coloca o arquivo .cab na pasta de saída.

Parâmetros

-CabFilesFolder

Especifica a pasta que contém o conteúdo de ajuda que este cmdlet empacota em um arquivo .cab.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-IncrementHelpVersion

Incremente automaticamente a versão de ajuda no arquivo Markdown do módulo.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-LandingPagePath

Especifica o caminho completo do arquivo Markdown do módulo que contém todos os metadados necessários para nomear o arquivo .cab. Para obter os metadados necessários, execute New-MarkdownHelp com o parâmetro WithLandingPage.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-OutputFolder

Especifica o local do arquivo .cab e helpinfo.xml arquivo que esse cmdlet cria.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

None

Não é possível canalizar valores para este cmdlet.

Saídas

None

Este cmdlet não gera saída. O cmdlet salva seus resultados na pasta de saída especificada pelo parâmetro OutputPath.