# Help Extension XML Reference

Describes a help extension through which you specify paths that should be added to the locations searched by the IDE when context-sensitive (F1) help is requested. Define this extension when your help must be provided from a location other than that described in Help Authoring Guide.

When the user presses F1 in the IDE, the context-sensitive help engine searches for a topic (an HTML file) that corresponds to the user's current context (such as Source View, with the cursor positioned in a class variable name). The <help-root> element specifies paths to root directories beneath which lie HTML files that may be appropriate topics to display for the user's request.

Note that you should not define a help extension and help-root if you are installing your help files in the <workshop_home>/help/doc/<language>/partners folder according to the guidelines described in Help Authoring Guide. See that topic for the best practice recommendations for help provided with extensions. You should use a help extension only in those cases where your help is provided from a location outside the "partners" folder. If you define both a help-root and copy your help files as described in Help Authoring Guide, you topics will appear multiple times in the table of contents and search results.

Note: The <extension-xml> element is the root for any extension descriptor. For this kind of extension, the <extension-xml> element's id attribute value must be "urn:com-bea-ide:help".

<extension-xml>
<help-root>

## <help-root> Element

Specifies the root to help files that should be integrated with the extension.

<extension-xml>
<help-root>

### Syntax

    <help-root
        dir="pathRelativeToParent"
        parent="parentForHelpPaths"
        url="urlToHelpRoot"
    >

### Attributes

Attribute | Description
--- | ---
dir | Optional string. The directory to search as a help root. This directory is relative to the value specified in the parent attribute.
parent | Optional string. A path to a directory relative to the WebLogic Workshop extensions directory. An absolute path may be used, but it is not recommended. If this attribute is omitted, the directory is assumed to be in the extension's own JAR file or directory.
url | Optional string. An absolute URL that specifies a new help root. This may be any URL, but will typically be HTTP or file based. Set this attribute's value as an alternative to setting the dir and parent attribute values. Note that non-file help URLs will not be indexed for search or included in the table of contents.

### Hierarchy

Parents: <extension-xml>.

Children: None.

Related Topics

Help Authoring Guide