Help Document Set Properties
Applies To: Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012
A Document Set is a collection of Help documentation associated with a Microsoft Dynamics AX workspace. When you publish a content element, you use metadata to add your content element or table of contents information to a document set.
To manage the relationship between a workspace and a document set, the Application Object Tree (AOT) includes a node named Help Document Sets. Each document set in the Help Document Sets node includes a collection of properties. You edit these properties when you add a new document set or change the relationship between a document set and a workspace.
Warning
A workspace can be associated with only a single document set. While the AOT lets you add a new document set and associate it with a workspace, you will no longer see documentation from the document set that you replaced. Typically, you use UserDocumentation as the document set for any content element or table of contents entries that you publish to the Help server.
The following table describes the properties for a document set in the Help Document Sets node of the AOT:
Property |
Type |
Description |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
DocumentSetName |
String |
A name that uniquely identifies the document set. The name is limited to 40 characters and must not contain whitespace. Use the value of this property when you set the value of the DocumentSets metadata element in a content element or table of contents file |
|||||||||
DocumentSetDescription |
String |
The text or label to display for the document set. This value appears in the Search content from list of the Options menu of the Help viewer. |
|||||||||
AddToApplicationHelpMenu |
Boolean |
Set to Yes when you want the document set to appear in the Help menu of the application workspace. |
|||||||||
AddToDeveloperHelpMenu |
Boolean |
Set to Yes when you want the document set to appear in the Help menu of the developer workspace. |
|||||||||
UserDocumentSet |
Boolean |
Set to Yes when you want to associate the document set with the application workspace. If you set this property to No, you will not be able to view the context-sensitive (F1) Help that was published by Microsoft. |
|||||||||
DeveloperDocumentSet |
Boolean |
Set to Yes when you want to associate the document set with the development workspace. If you set this property to No, you will not be able to view the context-sensitive (F1) Help that was published by Microsoft. |
|||||||||
ContentLocation |
Enumeration |
An enumeration value that specifies where to retrieve documentation. The following table describes the enumeration.
|