Edit

Share via

New-ExternalHelpCab

Module:
platyPS Module

Generates a .cab file.

Syntax

Default (Default) 

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

Description

The New-ExternalHelpCab cmdlet generates a .cab file that contains all the non-recursive content in a folder. This cmdlet compresses the provided files.

Note

This cmdlet depends on the MakeCab.exe native command, which is only available on Windows. This cmdlet raises an error if used on non-Windows machines.

We recommend that you provide as content only about_ topics and the output from the New-ExternalHelp cmdlet to this cmdlet.

This cmdlet uses metadata stored in the module markdown file to name your .cab file. This naming matches the pattern that the PowerShell help system requires for use as updatable help. This metadata is part of the module file created using the New-MarkdownHelp cmdlet with the WithModulePage parameter.

This cmdlet also generates or updates an existing helpinfo.xml file. That file provides versioning and locale details to the PowerShell help system.

Examples

Example 1: Create a CAB file

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

The cmdlet creates a .cab file that contains the content folder files. The .cab file is named for updatable help based on metadata. The command places the .cab file in the output folder.

Parameters

-CabFilesFolder

Specifies the folder that contains the help content that this cmdlet packages into a .cab file.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IncrementHelpVersion

Automatically increment the help version in the module Markdown file.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LandingPagePath

Specifies the full path of the module Markdown file that contains all the metadata required to name the .cab file. For the required metadata, run New-MarkdownHelp with the WithLandingPage parameter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OutputFolder

Specifies the location of the .cab file and helpinfo.xml file that this cmdlet creates.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can't pipe values to this cmdlet.

Outputs

None

This cmdlet doesn't generate output. The cmdlet saves its results in the output folder that the OutputPath parameter specifies.