Share via


Windows Azure Pack Custom Help Overview

 

Applies To: Windows Azure Pack

Customized Windows Azure Pack for Windows Server Help Drawer content can be provided for management portal for administrators extensions and management portal for tenants extensions. You can modify existing help, add new help content and customize management portal left navigation links.

Content is stored in XHTML files with a Table of Content file to map Windows Azure Pack Management console left navigation links to the to the content files.

For information about customizing help content, see How to Customize the Windows Azure Pack Management Portal Help for an Extension.

File Locations

Two sets of folders contain the extension help files within a Windows Azure Pack management portal.

Table of Content Mapping Files

These are .xml files specific to each extension. They are responsible for rendering the left navigation links in the help drawer. Each link points to a file containing the help content. When user clicks on the link the content from the content files is rendered.

The path for the Table of Content Mapping files folder can found in the Microsoft.Azure.Portal.Configuration.HelpConfiguration.HelpContentUri key value in the AppSetting section of the site’s web.config file. For example:

<add key=”Microsoft.Azure.Portal.Configuration.HelpConfiguration.HelpContentUri”
value=”~/AppData/HelpContent” />

For the administrator website, the path would be similar \inetpub\MgmtSvc-AdminSite\AppData\HelpContent\<Extension Name>\Locale\TocMapping.xml.

Content Files

The help content is contained in XHTML files. The location of these files is stored in the Microsoft.Azure.Portal.Configuration.HelpConfiguration.HelpTocMapUri key value in the AppSetting section of the site’s web.config file. For the administrator website, the path would be similar to \inetpub\MgmtSvc-AdminSite\AppData\HelpContent\<Extension Name>\Locale\*.xhtml.

Image Files

Image files are normally of extension .PNG or .Gif. They are placed in the same folder as the content files.

See Also

Windows Azure Pack Extension Custom Help