Muokkaa

Jaa

How to create and upload CAB files

  • Artikkeli

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.

This topic explains how to create Updatable Help CAB files and upload them to the location where the Updatable Help cmdlets can find them.

How to create and upload updatable help CAB files

You can use the Updatable Help feature to deliver new or updated help files for a module in multiple languages and cultures. An Updatable Help package for a module consists of one HelpInfo XML file and one or more cabinet (.CAB) files. Each CAB file contains help files for the module in one UI culture. Use the following procedure to create CAB files for Updatable Help.

  1. Organize the help files for the module by UI culture. Each Updatable Help CAB file contains the help files for one module in one UI culture. You can deliver multiple help CAB files for the module, each for a different UI culture.

  2. Verify that help files include only the file types permitted for Updatable Help and validate them against a help file schema. 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. For a list of permitted file types, see File Types Permitted in an Updatable Help CAB File.

  3. Include all the help files for the module in the UI culture, not only files that are new or have changed. If the CAB file is incomplete, users who download help files for the first time or do not download every update, won't have all the help files.

  4. Use a utility that creates cabinet files, such as MakeCab.exe. PowerShell doesn't include cmdlets that create CAB files.

  5. Name the CAB files. For more information, see How to Name an Updatable Help CAB File.

  6. Upload the CAB files for the module to the location that's specified by the HelpContentUri element in the HelpInfo XML file for the module. Then upload the HelpInfo XML file to the location that's specified by the HelpInfoUri key of the module manifest. The HelpContentUri and HelpInfoUri can point to the same location.

Caution

The value of the HelpInfoUri key and the HelpContentUri element must begin with http or https. The value must a URL path pointing to the location (folder) containing the updateable help. The URL must end with /. The URL must not include a filename.