< Back
New-ExternalHelpCab
Post
NAME New-ExternalHelpCab
SYNOPSIS
Generates a .cab file.
SYNTAX
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.
We recommend that you provide as content only about_ topics and the output from the New-ExternalHelp
(New-ExternalHelp.md)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 Windows PowerShell help system requires for use as updatable help. This metadata is part of the
module file created by using the New-MarkdownHelp (New-MarkdownHelp.md)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 Windows PowerShell help system.
PARAMETERS
-CabFilesFolder <String>
Specifies the folder that contains the help content that this cmdlet packages into a .cab file.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LandingPagePath <String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OutputFolder <String>
Specifies the location of the .cab file and helpinfo.xml file that this cmdlet creates.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IncrementHelpVersion [<SwitchParameter>]
Automatically increment the help version in the module markdown file.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
You cannot pipe values to this cmdlet.
OUTPUTS
None
This cmdlet does not generate output. The cmldet saves its results in the output folder that the OutputPath
parameter specifies.
NOTES
----------------- Example 1: Create a CAB file -----------------
PS C:\\> New-ExternalHelpCab -CabFilesFolder 'C:\\Module\\ExternalHelpContent' -LandingPagePath
'C:\\Module\\ModuleName.md' -OutputPath 'C:\\Module\\Cab\\'
This commmand 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.
RELATED LINKS
Online Version: https://github.com/PowerShell/platyPS/b ... HelpCab.md
New-ExternalHelp
New-MarkdownAboutHelp
SYNOPSIS
Generates a .cab file.
SYNTAX
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.
We recommend that you provide as content only about_ topics and the output from the New-ExternalHelp
(New-ExternalHelp.md)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 Windows PowerShell help system requires for use as updatable help. This metadata is part of the
module file created by using the New-MarkdownHelp (New-MarkdownHelp.md)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 Windows PowerShell help system.
PARAMETERS
-CabFilesFolder <String>
Specifies the folder that contains the help content that this cmdlet packages into a .cab file.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LandingPagePath <String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OutputFolder <String>
Specifies the location of the .cab file and helpinfo.xml file that this cmdlet creates.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IncrementHelpVersion [<SwitchParameter>]
Automatically increment the help version in the module markdown file.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
You cannot pipe values to this cmdlet.
OUTPUTS
None
This cmdlet does not generate output. The cmldet saves its results in the output folder that the OutputPath
parameter specifies.
NOTES
----------------- Example 1: Create a CAB file -----------------
PS C:\\> New-ExternalHelpCab -CabFilesFolder 'C:\\Module\\ExternalHelpContent' -LandingPagePath
'C:\\Module\\ModuleName.md' -OutputPath 'C:\\Module\\Cab\\'
This commmand 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.
RELATED LINKS
Online Version: https://github.com/PowerShell/platyPS/b ... HelpCab.md
New-ExternalHelp
New-MarkdownAboutHelp