Articles

Article files are XML files which define the articles in the wiki. There are several kinds or articles:

• Index articles: the index is the article which is the entry-point to the wiki. There can be only one index for the wiki
• Regular articles: these are the pages composing the wiki, similar to Wikipedia articles
• Hand-written html articles: these are articles which are not using the docGenerator syntax, but hand-written html
• Templates: these are similar to regular articles, but they are meant to be included in another articles, and as such won't be present in the dictionary or categories
• Redirect articles
• Disambiguation articles
• Fallback articles

Grammar

See The wiki articles Schema.

Index definition

An index has the top-level element "index" and has no name. Appart from that, it can contain exactly the same elements as a regular article.

Example

   <index>
   This is the index.
      <cat id="general" />
   </index>

Regular articles

Regular articles are the pages composing the wiki, similar to Wikipedia articles. A regular article has the top-level element "article". It can contain:

• An optional list of alternate titles for the article
• A meta element at the top of the article, specifies the text which should be written as an explanation for an article in the dictionary or categories
• An optional SeeAlso element allowing to reference another article which title or subject might be close ot this one
• Paragraphs, which in turn can contain various construction elements. See syntax
• Chapters and titles. See chapters and titles
• An optional "See Also" chapter. See see also
• Categories definition. See categories description

Examples

A basic example:

   <article desc="an article">
   This is a very simple article.
   </article>

Another simple example, using the see tag, and specifying a category for the article.

   <article desc="an article">
   This is a very simple article.
      <see id="anotherArticle" desc="the other linked article" text="example of a SeeAlso element" />
      <cat id="myCategory" />
   </article>

A more complex example, using the seeAlso, altTitle, and meta tags.

   <article desc="an article">
   <altTitle desc="second title" >
   <meta desc="A Very simple article example" >
   <seeAlso this="describing an article" other="specifying another type of article" id="another article" >
   This is a very simple article.
      <see id="anotherArticle" desc="the other linked article" text="example of a SeeAlso element" />
      <cat id="myCategory" />
   </article>

Raw html articles

These articles are not using the docGenerator syntax, but raw html. Their description has the top element "rawHTML". The attributes of this element point to an html file, which can be on the disk or accessible on the Web.

Example

   <rawHTML desc="article 2" url="Pablo Picasso - Wikipedia.html">
      <meta desc="the raw html article "/>
   </rawHTML>

Templates

A template is similar to a regular article but has the top-level element "template". It can contain:

• Paragraphs, which in turn can contain various construction elements. See syntax
• Chapters and titles. See chapters and titles

Contrary to regular articles, it can't contain an optional "See Also" chapter alternate titles, or Categories definition.

Example

   <template desc="my template">
   This is a very simple template.
      <title title="template title" />
   </template>

Redirect articles

Redirect articles allow to create an article with a redirection to another article or even a title or anchor in another article^[1]

This article must be in the same package as the "redirect" articles itself

. These articles can contain only one "redirect" element. See Redirect articles for more information.

Relationship with the altTitle element

Contrary to the altTitle element, "redirect" articles allow to perform a redirection to a title or anchor of an article. However one article must be created for any redirection.

Example

   <redirect desc="the redirect article" redirectTo="other article" />

This could have been performed with an "altTitle" element in the redirected article with:

   <article desc="other article">
     <altTitle desc="the redirect article" >
   </article>

In this other example, we redirect to a title in another article:

   <redirect desc="the redirect article" redirectTo="other article#title" >
     <meta desc="the redirect article title" >
   </redirect>

Disambiguation articles

Disambiguation articles allow to specify an article which will point to several articles of approaching names. It is similar to Wikipedia disambiguation articles.

Fallback articles

Fallback articles allow to specify articles which will be used where a reference to another article point to an article which does not exist.

Encoding

The escapeNonUTF8 option in the command-line or the equivalent configuration property allows to escape non UTF8 characters (such as accented letters)