Disambiguation articles

Disambiguation articles allow to specify an article which will point to several articles of approaching names.

Disambiguation articles content

The "disambArticle" article element has the following attribute:

• "desc": the disambiguation article description

It contains a list of "disambElt" elements, each pointing to articles in the same package or other packages.

Auto-generation of disambiguations

The generator will also generate automatically a disambiguation article if the generation is performed with more than one root and several articles of different packages have the same ID. In that case they will be accessed in the dictionary and the search box by their associated disambiguation article.

Note that disambiguation articles specified in the wiki will merge without problems with autogenerated ones. For example, if the wiki contains a disambiguation article named "theArticle", and one or several articles are named "theArticle", they will be added to the list for this disambiguation article^[1]

Rather than having two disambiguation articles with the same name

.

Disambiguation articles packages

The disambiguation are always general to all packages, and the tool will always generating only one disambiguation article for a specified name, even if there are several of the same name in different packages. Their content will be merged.

Example

   <disambArticle desc="clipping" >
      <disambElt id="clipping mask" />
      <disambElt id="clipping rectangle" package="thePackage" />
   </disambArticle>

Here the "clipping" disambiguation article will refer to a list of two articles:

• "clipping mask" in the same package as the disambiguation article origin^[2]
  Note that at the end the disambiguation article won't belong to any package, the package is just a way to know to which article it refers to
• "clipping rectangle" in the "thePackage" package