#vimperator.
+Help tags
+
+
+ The following is a list of the more common XML tags used in help pages,
+ along with their highlight groups.
+
+
+
+ - Layout
+ - p
- A paragraph (HelpParagraph)
+ - h1
- A first-level heading (HelpHead)
+ - h2
- A second-level heading (HelpSubhead)
+ - h3
- A third-level heading (HelpSubsubhead)
+ - code
- A pre-formatted code block. (HelpCode)
+ - note
- A note paragraph. (HelpNote)
+ - warning
- A warning paragraph. (HelpWarning)
+
+
+ - Generic
+ - link
- A generic link. (HelpLink)
+ - &tab;@topic
- The topic of the link. Either a help topic or a fully-qualified URI.
+ - em
- Emphasized text. (HelpEm)
+ - str
- A string, with its contents wrapped in quotes. (HelpString)
+ - logo
- &liberator.appname;'s logo. (Logo)
+
+
+ - Items
+ - item
- A help entry (HelpItem)
+ - &tab;tags
- See the 'Tagging' section (HelpTags)
+ - &tab;spec
- The specification for this item, such as an example command-line. (HelpSpec)
+ - &tab;type
- For options, the type of the option.
+ number, boolean, string, string, stringlist, or charlist.
+ (HelpType)
+
+ - &tab;default
- For options, the default value. (HelpDefault)
+ - &tab;description
- The description of this help item. (HelpDescription)
+ - a
- Required argument. (HelpArg)
+ - oa
- Optional argument. (HelpOptionalArg)
+
+
+ - Tagging
+ - tags
- Space-separated list of strings to tag. Displayed right-aligned, and used for cross-linking. (HelpTags)
+ - @tag
- The tag attribute. Applied to any element, generates a <tags> element with its value for its contents. (HelpTag)
+
+
+ - Linking
+ - o
- Link to an option. (HelpOpt)
+ - ex
- Link to an ex command. (HelpEx)
+ - k
- Link to a key. (HelpKey)
+ - &tab;@name
- The name attribute to <k>. When provided, <value> is prepended to
+ the element's contents, i.e., <k name="lt"/> becomes .
+
+ - t
- Links to an arbitrary help topic. (HelpTopic)
+
+
+ - Plugins
+ - plugin
- The container tag used for describing a plugin.
+ - &tab;@name
- The name of the plugin. Used as the plugin's help tag.
+ - &tab;@version
- The plugin's version number.
+ - &tab;@href
- The plugin's home page.
+ - &tab;@summary
- A short description of the plugin, shown in its section head.
+
+ - project
- The project for which this plugin was intended.
+ - &tab;@name
- The name of the project (i.e., &liberator.name;)
+ - &tab;@minVersion
- The minimum version of the project for which this plugin is intended to work.
+ - &tab;@maxVersion
- The maximum version of the project for which this plugin is intended to work.
+
+ - author
- The plugin's author. May appear more than once.
+ - &tab;@href
- The author's home page.
+ - &tab;@email
- The author's email address.
+
+ - license
- The plugin's license. May appear more than once.
+ - &tab;@href
- The URI of a page which shows or explains the license.
+
+
Generating documentation