Help files

In addition to comment-based help, you can also author entire help files. These files are intended to be delivered with your modules, and can be hosted online, as well, so that Update-Help can be used to download current help data. Updating the help file usually requires internet access. However, you can download help content with Save-Help and provide these files on a network share, so that your non-connected machines can update their help content, as well. On Windows systems, this can be configured via Group Policy:

# No help content since PSv3
Update-Help # Only the first execution each day is processed

# Prestage help content for internal distribution
Save-Help -DestinationPath .HelpContent
Update-Help -SourcePath .HelpContent

# If really necessary, Update- and Save-Help support a UICulture
Save-Help -DestinationPath .HelpContent -UICulture de-de

The help content you have prepared in the previous code sample can be used in Group Policy, as the following screenshot illustrates. This setting can be enabled starting with Windows 7 / Server 2008 and is set to some highly-available file share in the screenshot:

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset