Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 3.36 KB

UpdatableHelp.md

File metadata and controls

114 lines (78 loc) · 3.36 KB
Raw

Generating online help files

Brief explanation on how to make modules support updatable and online help

Table of Contents

Help info xml file

XML help file name syntax

<ModuleName>_<ModuleGUID>_HelpInfo.xml

Organize help files by UICulture into separate folders, ex. for en-US:

\ModulePath
    \ModuleName
        \ModuleName_ModuleGUID_HelpInfo.xml
        \en-US
            \about_ModuleName.help.txt
            \ModuleName.psm1-Help.xml

Table of Contents

XML file content syntax

HelpInfo XML Sample File

HelpInfo XML Schema

Module manifest

HelpInfoURI = "https://URL_TO/Manifest.Module_66e38822-834d-4a90-b9c6-9e600a472a0a_HelpInfo.xml"

Help info file location

  1. Put help info file into module root directory
  2. Push module online, and take URL
  3. Set HelpInfoUri key of the module manifest to URL

Table of Contents

Help content cab file

makecab.exe syntax

source         File to compress
destination    File name to give compressed file
/L dir         Location to place destination (default is current directory)
/V[n]          Verbosity level (1..3)

makecab source destination /L TargetDir /V3

Table of Contents

CAB file name syntax

<ModuleName>_<ModuleGUID>_<UICulture>_HelpContent.cab

Organize CAB files by module version into separate folders, ex:

  • 0.6.0/Manifest.Module_66e38822-834d-4a90-b9c6-9e600a472a0a_en-US_HelpContent.cab
  • 0.7.0/Manifest.Module_66e38822-834d-4a90-b9c6-9e600a472a0a_en-US_HelpContent.cab

Table of Contents

CAB file content syntax

File Types Permitted in an Updatable Help CAB File

Make CAB Example

cd $ProjectRoot
makecab.exe Templates\Manifest.Module\Manifest.Module.help.txt Manifest.Module_66e38822-834d-4a90-b9c6-9e600a472a0a_en-US_HelpContent.cab /V3 /L Config\HelpContent

Help content location

  1. Put cab file somewhere into repository outside module directory
  2. Push repository and take URL to online directory containing cab file
  3. Put URL into HelpContentUri element in the HelpInfo XML file

Table of Contents