The Help element is the root element of the help file. It may contain zero or one Project element, and any number of Section, Function, AdditionalFile and ResourceFile elements. The element has four optional attributes: Language, CopyFileExtensions, HideArgumentSyntax and ArgumentSyntax.
The Language attribute, if provided, defines the language of the help project. A list of supported languages can be found in the XSL transform file, Localized.xsl, located in the bin\xsl directory of the XLL+ installation. If the attibute is omitted, then the default value of "en" (English) is used.
The CopyFileExtensions attribute, if provided, contains a list of file extensions, separated by semi-colons, e.g. "jpg;gif;png". Any file with this extension found in the help directory will be copied to the help project. If omitted, a standard list of graphics file extensions weill be used. Single files can also be copied using the ResourceFile element.
The HideArgumentSyntax attribute, if true, hides the standard argument syntax-based text, such as "X should be a vector of numbers...". Setting the attribute at Project level applies it to all arguments of all functions. If omitted, it is assumed to be false.
The ArgumentSyntax attribute controls the position of the standard argument syntax-based text, such as "X should be a vector of numbers...". The text may be positioned as a continuation of the argument's description (Continuation), as a paragraph following the argument's description (Paragraph), or omitted (None). Setting the attribute at Project level applies it to all arguments of all functions. If omitted, it is assumed to be Continuation.
|
Number of occurrences |
Unlimited |
|
Parent elements |
(No parent elements) |
|
Child elements |