File Types Permitted in an Updatable Help CAB File
Uncompressed CAB file content is limited to 1 GB by default. To bypass this limit, users have to use the Force parameter of the Update-Help and Save-Help cmdlets.
To assure the security of help files that are downloaded from the internet, an Updatable Help CAB
file can include only the file types listed below. The Update-Help cmdlet validates all files
against the help topic schemas. If the Update-Help
cmdlet encounters a file that's invalid or is
not a permitted type, it doesn't install the invalid file and stops installing files from the CAB on
the user's computer.
- XML-based help topics for cmdlets.
- XML-based help topics for scripts and functions.
- XML-based help topics for PowerShell providers.
- Text-based help topics, such as About topics.
The Update-Help verifies the CAB contents when it unpacks the CAB. If Update-Help
finds
non-compliant file types in an Updatable Help CAB file, it generates a terminating error and stops
the operation. It doesn't install any help files from the CAB, even those of compliant file types.
Note
Manual authoring of XML-based help is very difficult. The PlatyPS module allows you to write help in Markdown and then convert it to XML-based help. This makes it much easier to write and maintain help. PlatyPS can also create the Updateable Help packages for you. For more information, see Create XML-based help using PlatyPS.
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour