New-ExternalHelpCab
Génère un fichier .cab.
Syntaxe
Default (Par défaut)
New-ExternalHelpCab
-CabFilesFolder <String>
-LandingPagePath <String>
-OutputFolder <String>
[-IncrementHelpVersion]
[<CommonParameters>]
Description
L’applet de commande New-ExternalHelpCab génère un fichier .cab qui contient tout le contenu non récursif dans un dossier. Cette applet de commande compresse les fichiers fournis.
Remarque
Cette applet de commande dépend de la commande native MakeCab.exe, disponible uniquement sur Windows. Cette applet de commande génère une erreur si elle est utilisée sur des ordinateurs non-Windows.
Nous vous recommandons de fournir en tant que contenu uniquement about_ rubriques et la sortie de l’applet de commande New-ExternalHelp à cette applet de commande.
Cette applet de commande utilise les métadonnées stockées dans le fichier markdown du module pour nommer votre fichier .cab. Ce nommage correspond au modèle requis par le système d’aide PowerShell pour une utilisation comme aide pouvant être mise à jour. Ces métadonnées font partie du fichier de module créé à l’aide de l’applet de commande New-MarkdownHelp avec le paramètre WithModulePage.
Cette applet de commande génère ou met également à jour un fichier de helpinfo.xml existant. Ce fichier fournit des détails de contrôle de version et de paramètres régionaux au système d’aide PowerShell.
Exemples
Exemple 1 : Créer un fichier CAB
$params = @{
CabFilesFolder = 'C:\Module\ExternalHelpContent'
LandingPagePath = 'C:\Module\ModuleName.md'
OutputFolder = 'C:\Module\Cab\'
}
New-ExternalHelpCab @params
L’applet de commande crée un fichier .cab qui contient les fichiers de dossier de contenu. Le fichier .cab est nommé pour une aide pouvant être mise à jour en fonction des métadonnées. La commande place le fichier .cab dans le dossier de sortie.
Paramètres
-CabFilesFolder
Spécifie le dossier qui contient le contenu d’aide que cette applet de commande empaquette dans un fichier .cab.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-IncrementHelpVersion
Incrémentez automatiquement la version d’aide dans le fichier Markdown du module.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-LandingPagePath
Spécifie le chemin d’accès complet du fichier Markdown du module qui contient toutes les métadonnées requises pour nommer le fichier .cab. Pour les métadonnées requises, exécutez New-MarkdownHelp avec le paramètre WithLandingPage.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-OutputFolder
Spécifie l’emplacement du fichier .cab et helpinfo.xml fichier créé par cette applet de commande.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Entrées
None
Vous ne pouvez pas diriger les valeurs vers cette applet de commande.
Sorties
None
Cette applet de commande ne génère pas de sortie. L’applet de commande enregistre ses résultats dans le dossier de sortie spécifié par le paramètre OutputPath.
