ElementHook tree visit

This article explains how and when the ElementHook is called to modify the the wiki source tree content before the generation.

Articles visit

The ElementHook will be called for:

• All articles if no Wiki content specification is specified (it is the "wikiContent" or "chaptersContent" property on the command-line or configuration file
• Only articles which are included if there is a specified Wiki content specification

Elements visit

For all articles which are included in the visit:

• The ElementHook.startArticle(XMLArticle) is called
• For all the ParagraphElement in the article:
  • If the element is in the set returned by ElementHook.supportedElements() for the hook, then call ElementHook.handleElement(ParagraphElement) for this element^[1]
    The Strings in the set are the declarations of the supported elements
  • If the element is a parent, recurse to the children of this element (note that this will happen if the element is a parent even if it is not handled by itself)

Example

Suppose the following article content:

   The introductory text
   <title title="the title" />
   paragraph content with <code>theCode</code>.

It will have the following wiki source tree:

• The default starting paragraph (it is the default paragraph at the start of the article because no paragraph is defined).
  • The "The introductory text" sentence
  • A title
  • The "paragraph content with " sentence
  • The "theCode" code

Suppose that the ElementHook.supportedElements() only returns "title". Then the ElementHook will only be called for the title element.