Compartir a través de

New-ExternalHelpCab

  • Referencia
Módulo:
platyPS

Genera un .cab archivo.

Syntax

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

Description

El New-ExternalHelpCab cmdlet genera un .cab archivo que contiene todo el contenido no recursivo de una carpeta. Este cmdlet comprime los archivos proporcionados.

Nota

Este cmdlet depende del MakeCab.exe comando nativo, que solo está disponible en Windows. Este cmdlet genera un error si se usa en máquinas que no son Windows.

Se recomienda proporcionar como contenido solo about_ temas y la salida del cmdlet New-ExternalHelp a este cmdlet.

Este cmdlet usa metadatos almacenados en el archivo markdown del módulo para asignar un nombre .cab al archivo. Esta nomenclatura coincide con el patrón que requiere el sistema de ayuda de PowerShell para su uso como ayuda actualizable. Estos metadatos forman parte del archivo de módulo creado mediante el cmdlet New-MarkdownHelp con el parámetro WithModulePage .

Este cmdlet también genera o actualiza un archivo existente helpinfo.xml . Ese archivo proporciona detalles de control de versiones y configuración regional al sistema de ayuda de PowerShell.

Ejemplos

Ejemplo 1: Crear un archivo CAB

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

El cmdlet crea un .cab archivo que contiene los archivos de carpeta de contenido. El .cab archivo se denomina para obtener ayuda actualizable en función de los metadatos. El comando coloca el .cab archivo en la carpeta de salida.

Parámetros

-CabFilesFolder

Especifica la carpeta que contiene el contenido de ayuda que este cmdlet empaqueta en un .cab archivo.

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

-IncrementHelpVersion

Incremente automáticamente la versión de ayuda en el archivo Markdown del módulo.

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

-LandingPagePath

Especifica la ruta de acceso completa del archivo Markdown del módulo que contiene todos los metadatos necesarios para asignar un nombre al .cab archivo. Para los metadatos necesarios, ejecute New-MarkdownHelp con el parámetro WithLandingPage .

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

-OutputFolder

Especifica la ubicación del archivo y helpinfo.xml el .cab archivo que crea este cmdlet.

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

Entradas

None

No se pueden canalizar valores a este cmdlet.

Salidas

None

Este cmdlet no genera la salida. El cmdlet guarda sus resultados en la carpeta de salida que especifica el parámetro OutputPath .