Partilhar via

New-ExternalHelpCab

  • Referência
Módulo:
platyPS

Gera um .cab ficheiro.

Syntax

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

Description

O New-ExternalHelpCab cmdlet gera um .cab ficheiro que contém todo o conteúdo não recursivo numa pasta. Este cmdlet comprime os ficheiros fornecidos.

Nota

Este cmdlet depende do MakeCab.exe comando nativo, que só está disponível no Windows. Este cmdlet gera um erro se for utilizado em computadores não Windows.

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

Este cmdlet utiliza metadados armazenados no ficheiro markdown do módulo para dar um nome ao ficheiro .cab . Esta nomenclatura corresponde ao padrão de que o sistema de ajuda do PowerShell necessita para utilização como ajuda atual. Estes metadados fazem parte do ficheiro de módulo criado com o cmdlet New-MarkdownHelp com o parâmetro WithModulePage .

Este cmdlet também gera ou atualiza um ficheiro existente helpinfo.xml . Esse ficheiro fornece detalhes de controlo de versões e localização ao sistema de ajuda do PowerShell.

Exemplos

Exemplo 1: Criar um ficheiro CAB

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

O cmdlet cria um .cab ficheiro que contém os ficheiros da pasta de conteúdos. O .cab ficheiro tem o nome de ajuda atual com base em metadados. O comando coloca o .cab ficheiro na pasta de saída.

Parâmetros

-CabFilesFolder

Especifica a pasta que contém o conteúdo de ajuda que este cmdlet empacota num .cab ficheiro.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IncrementHelpVersion

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LandingPagePath

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OutputFolder

Especifica a localização do .cab ficheiro e helpinfo.xml do ficheiro que este cmdlet cria.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Entradas

None

Não pode encaminhar valores para este cmdlet.

Saídas

None

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