Syntax

Syntax justification elements

• new lines
• empty lines
• line breaks
• tabulations
• thematic break

Justification

Escaped characters

Formatting text

Customizing the elements style

• By specifying a Custom StyleSheet and setting custom StyleClasses for some elements
• Or simply by adding a style attribute for the element for which you want to customize ther style. This way (which work exactly as in HTML) is much more simple but of course you will have to specify the style each time you need to

Starting elements

• " meta": specifies the text which should be written as an explanation for an article
• " altTitle": specify alternate titles for the article
• " seeAlso": allows to add a text at the beginning of the article (before the table of contents) which can refer to another article which can have a similar title or subject
• " infobox": a fixed-format table added to the top right-hand corner of articles to consistently present a summary of some unifying aspect that the articles share

Structure elements

Custom Styling

  <title title="the title" class="red" />

   h2.red {
   color: red;
   }

Paragraphs

Example

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

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

term

• "term": represent the term to define

Example

  <term term="term 1">The definition</term>
  <term term="faq">The <ref id="faq" desc="FAQ" /></term>

Term 1

The definition

Faq

The FAQ

word

• "word": represent the associated glossary word

Example

   <article desc="my article">
   This is the text which refer to the ontology<word /> concept.
   </article>

   <article desc="my article">
   This is the text which refer to the OWL<word word="ontology" /> concept.
   </article>

note

• A "Note" title will be added at the end of the article in the "Notes" Chapter if there is at least one note in the article
• Several portions of the text can reference the same note

• "id": represent the note identification, allowing to reference the same note in more than one portion of the article text

Notes tooltip

Examples

  Present a first note<note>the first note</note>

  Present a second note<note id="myID">the second note</note>

  Present the second note a second time<note id="myID"/>

cite

• A "Note" title will be added at the end of the article if there is at least one note (or cite) in the article
• Several portions of the text can reference the same note

• "id": represent the citation identification, allowing to reference the same note in more than one portion of the article text
• "href": the link to the external web page
• "desc": the optional text of the link
• "author": the optional author
• "publisher": the optional publisher
• "date": the optional date. The format should be year-month-day

Example

  Present a citation<cite href="http://docs.oracle.com/javase/8/docs/api/index.html"
  desc="the external link"
  publisher="Oracle">the citation note</cite>

code

• "background": specifies if the code has a default background. See code, pre and source background for more information

Example

  This a a piece of computer <code>code</code>
  This a <code><ref id="faq" desc="link" /> formatted as code</code>

pre

• "syntax": specifies the syntax of the source code highlighting. See syntax highlighting for more information
• "boxed" or "border": This attribute can have the following values^[2]
  It is not allowed to have both the "boxed" and "border" attributes on the "pre" element
  :
• "true" or "simple": the "pre" element will have a colored background bordered by a simple line
• "simple": the "pre" element will have a simple border with a background color
• "shadow" or "softShadow" : the "pre" element will have a soft shadowed border
• "strongShadow": the "pre" element will have a strong shadowed border
• "false" or "noBorder" : (the default) no border
• "background": specifies if the pre has a default background. See code, pre and source background for more information
• "color": the "pre" element will have a colored background with the specified color
• "shadow" or "softShadow": the "pre" element will have a colored background with a soft shadowed border
• "strongShadow": the "pre" element will have a colored background with a strong shadowed border
• "false" or "noBorder" : (the default) no border
• "invisibleChars": specifies if the usage of "invisible characters" is allowed. See syntax highlighting for more information

pre content

• Put the content as CDATA inside the pre element. Such as for example:

     <pre>
              my pre content
     </pre>
  

  In this case, you will need to escape the < and > characters if they appear in the content.
• Or specify an URL where the content of the pre will be defined. For example:

     <pre url="thePreFile" />
  

  Here the preFile is a file which is under the doc-files sub-directory and contain the same "my pre content" text. In this case, you don't need to escape the < and > characters if they appear in the content^[3]
  see doc-files
  .

Syntax hightlighting

   <pre syntax="java">
      public void toto(int i) {
      _ System.out.println(i);
      }
   </pre>

   public void toto(int i) {
     System.out.println(i);
   }

Examples

  <pre>
  first line
  second line
  </pre>

      first line
      second line

 <pre>
 first line in <font color="blue">blue</font>
 second line
 </pre>

      first line in blue
      second line

 <pre boxed="true">
 first line
 second line
 </pre>

      first line
      second line

 <pre boxed="shadow">
 first line
 second line
 </pre>

      first line
      second line

 <pre color="#FFFF00" boxed="true">
 first line
 second line
 </pre>

      first line
      second line

source

• the content will not begin on a new line
• the "boxed" attribute is not supported

• "syntax": specifies the syntax of the source code highlighting. See syntax highlighting for more information
• "background": specifies if the pre has a default background. See code, pre and source background for more information

Example

  <ul>
     <li>The XML file: <source syntax="xml"><root value="blue"/root></source></li>
  </ul>

• The XML file: <root value="blue"/>

blockquote

Example

    <blockquote>
      this is a text with two lines inside a blockquote
      <br/>
      the second line
   </block>

this is a text with two lines inside a blockquote
the second line

block

• "true" or "simple": the "pre" element will have bordered a simple line border
• "shadow": the "pre" element will have a a shadowed border
• "false" or "noBorder" : (the default) no border

Example

    <block border="shadow">
      this is a text with two lines inside a block
      <br/>
      the second line
   </block>

date

• "date": the date value
• "date2" (optional): the second date value, used for the dateAndTime type
• "type" (optional): the date type. Can be:
• "date": to show the formatted "date"
• "time": to show the time difference between "date" and "date2"
• "dateAndTime": to show the formatted "date2", and the time difference between "date" and "date2"

Examples

<date date="2015-08-08" />

<date date="2015-08-08" date2="2015-12-08" />

<date date="2015-08-08" date2="2015-12-08" type="dateAndTime" />

messageBox

• "id" (optional): The image id. See image files for the specification of image ids
• "imageHref" (optional): The relative path of the image, if the image do not refer to an Image definition
• "type" (optional): the message box type. Can be:
• "info": for an information message
• "success": for a "success" message
• "warning": for a warning message
• "error": for an error message
• "progress": for a "in progress" message
• "default" (the default value): for an undefined message type
• "caption" (optional): add a caption to the message box
• "captionPosition" (optional): specify the position of the message box caption. Can be:
• "inside": to put it inside the box
• "border": to put it on the message box border
• "todo" (optional): only useful for "progress" type message boxes, allow to include them in the todolist
• "color" (optional): the background color of the box, specified in HTML color codes
• "package": The optional package attribute allows to reference an image in another package

Example

    <messageBox type="warning">
      this a text with two lines inside a message box
      <br/>
      the second line
   <messageBox>

box

• "width" (optional): define tyhe type of width of this box. Can be:
• "limited": (the default) the box will fit to the text content
• "unlimited": the box will fill the width of the page
• a value in pixels or in %: a specified width for the box. The text content will fit in the box
• "position" or "align": (optional) the alignment of the box. Can be "left" (the default), or "center".

 <box>
  this is a boxed <code>text</code>
  </box>

  <box width="unlimited">
   this is a boxed <code>text</code>
  </box>

  <box width="80%" position="center" >
   this is a boxed <code>text</code>
  </box>

email

Example

  This is an <email mail="johndoe@gmail.org" desc="johndoe email"</a>

a

• "href": the URL of the link
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

archiveurl

• "href": the URL of the link
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

Example

  This is an <archiveurl archive="https://web.archive.org/web/20231215081820/https://www.marmottan.fr/expositions/morisot-sacriste/">morisot-sacriste</a>

   This is an <archiveurl href="https://www.marmottan.fr/expositions/morisot-sacriste/">morisot-sacriste</a>

wikipedia

• "lang": the optional language of the wikipedia to access. The default is "en" (English Wikipedia)
• "path": the wikipedia article. It has the same syntax as wikipedia internal links
• "desc": the optional alternate text to use for the link
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

Example

  This is an article about <wikipedia lang="fr" path="Java (langage)" />

mediawiki

• "wiki": the wiki ID reference. See Mediawikis
• "path": the wikipedia article. It has the same syntax as wikipedia internal links
• "desc": the optional alternate text to use for the link
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

Example

  This is an article about <mediawiki wiki="wikipediaFR" path="Java (langage)" />

video

• "path": the video ID. This is the path which appear when getting the "Share" content for the video on youtube
• "width": the width of the video. Exclusive with the "height" parameter
• "height": the height of the video. Exclusive with the "width" parameter
• "position" or "align": Optionally the alignment of the video
• "type": Optionally the type of the video. The video will be by default a youtube video, but it is possible to embed a dailymotion video by setting the "dailymotion" value to this attribute. Also MP4, OGG or WEBM videos can be embedded using the "mp4", "ogg", or "webm" tagsfor the type
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

Example with a youtube video

  <video path="jtluNyIzfQ4" position="left" width="200" />

Example with an mpeg4 video

  <video path="http://www.w3schools.com/tags/movie.mp4" position="left" width="200" type="mp4" />

audio

• "path": the audio link
• "type": the type of the video (for example: "audio/mpeg" or "audio/ogg")
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

Example

  <audio path="https://www.w3schools.com/html/horse.mp3" type="audio/mpeg" />

javadoc

• "api": the API, will point to the "JAVASE" API (The Java 8 API) if not present (and the location is not specified), else it will refer to the javadoc API defined in the configuration file. See also location of the javadoc API
• "location": the direct location of the API (alternative to the "api" attribute)
• "path": the path to the class, with package names separated by "." (dot) characters. To separate the name of the internal class from its parent class, use the "$" character
• "altPath": the optional alternate text to present for the path to the class^[5]
  The "altPath" attribute is an optional alternate text to present for the path to the class. It can be useful if the member is defined for a parent class but you want to show the API for a subclass. It will allow you to present the API on the class you choose and avoid any error emitted because the link is not found in the API
• "module": used to specify the module of the class. Note that the module path is required to get the documentation link beginning with Java 11, but are not up to Java 10
• "member": a field or method of the specified class or interface
• "full": there are several possible values for this attribute^[6]
  For packages, the package complete path will always be presented regardless of the value of this attribute
  :
• "false" or "class": (the default) only the class name must be presented in the link associated text
• "true": the complete classpath of the class must be presented in full in the link associated text
• "member": only the member name must be presented. Note that if the path represents a class, it will have the same result as "class"
• "type": the type of the link:
• "class" for a Class (the default value)
• "package" for a package
• "module" for a module
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

Java module

   <javadoc path="java.awt.Button" />
   <javadoc api="JAVASE9" path="java.awt.Button" />
   <javadoc api="JAVASE10" module="java.desktop" path="java.awt.Button" />
   <javadoc api="JAVASE11" module="java.desktop" path="java.awt.Button" />

   <javadoc api="JAVASE11" path="java.awt.Button" />

Java.lang classes

  This is a link to the <javadoc path="Float" /> class
  This is a link to the <javadoc path="java.awt.Button" member="setLabel(String)" /> method

Examples

  This is a link to <javadoc path="java.awt.Button" />
  This is a link to <javadoc path="java.awt.geom.Rectangle2D$Float" />
  This is a complete link to <javadoc path="java.awt.Button" full="true"/>
  This is a link to <javadoc path="java.awt.Button" member="setLabel(java.lang.String)" />
  This is a link to <javadoc path="java.awt.Button" member="setLabel(java.lang.String)" full="member"/>
  This is a link to the <javadoc path="java.awt.geom" type="package" /> package

dotnetdoc

• "api": the API, will point to the ".NET Core 3.1" API if not present (and the location is not specified), else it will refer to the .NET API defined in the configuration file. See also location of the .NET API
• "location": the direct location of the API (alternative to the "api" attribute)
• "path": the path to the class, with package names separated by "." (dot) characters
• "altPath": the optional alternate text to present for the path to the class^[5]
  The "altPath" attribute is an optional alternate text to present for the path to the class. It can be useful if the member is defined for a parent class but you want to show the API for a subclass. It will allow you to present the API on the class you choose and avoid any error emitted because the link is not found in the API
• "member": a field or method of the specified class or interface
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

Location of the .NET API

• If the "api" attribute exists, the link will point to the .NET API defined in the configuration file
• Else if the "location" attribute exists, or there is a previously defined setAPIURL element in the current article, the link will point to the URL defined by this attribute
• Else the link will point to the .NET Core 3.1 API

   <dotnetdoc path="System.AppDomain"/>
   <dotnetdoc location="https://docs.microsoft.com/en-us/dotnet/api/?view=netcore-3.1" path="System.AppDomain"/>

Examples

  <dotnetdoc path="System.AppDomain"/>

  <dotnetdoc path="System.AppDomain" member="CreateDomain(System.String)"/>

qtdoc

• "api": the API, will point to the QT-5 API, if not present (and the location is not specified), else it will refer to the Qt API defined in the configuration file. See also location of the Qt API
• "location": the direct location of the API (alternative to the "api" attribute)
• "path": the path to the class
• "altPath": the optional alternate text to present for the path to the class^[5]
  The "altPath" attribute is an optional alternate text to present for the path to the class. It can be useful if the member is defined for a parent class but you want to show the API for a subclass. It will allow you to present the API on the class you choose and avoid any error emitted because the link is not found in the API
• "member": the method, property or enum of the specified class
• "type": the type of the link:
• "class": (the default) the documentation points to the class declaration
• "method": the documentation points to the method
• "property": the documentation points to the property
• "enum": the documentation points to the enum
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

Location of the Qt API

• If the "api" attribute exists, the link will point to the Qt API defined in the configuration file
• Else if the "location" attribute exists, or there is a previously defined setAPIURL element in the current article, the link will point to the URL defined by this attribute
• Else the link will point to the QT-5 API

   <qtdoc location="http://doc.qt.io/qt-5.12/" path="QAbstractAxis"/>

Examples

  This is a link to <qtdoc path="QAbstractAxis" />
  This is a link to <qtdoc path="QAbstractAxis" member="AxisType" type="enum" />
  This is a link to <qtdoc path="QAbstractAxis" member="alignment" type="property" />
  This is a link to <qtdoc path="QAbstractAxis" member="setRange" type="method" />

pydoc

• "api": the API, will point to the Python 3 API, if not present (and the location is not specified), else it will refer to the Python API defined in the configuration file. See also location of the Python API
• "location": the direct location of the API (alternative to the "api" attribute)
• "path" or "module" : the path to the module
• "class" : the class (optional)
• "member": the method of the specified class or the module (optional)
• "type": the type of the link:
• "module": (the default) the documentation points to the module declaration
• "class": (the default) the documentation points to a class declaration in the module
• "method": the documentation points to the method
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

Location of the Python API

• If the "api" attribute exists, the link will point to the Python API defined in the configuration file
• Else if the "location" attribute exists, or there is a previously defined setAPIURL element in the current article, the link will point to the URL defined by this attribute
• Else the link will point to the Python 3 API

   <pydoc module="array"/>

Examples

  This is a link to <pydoc module="array" />
  This is a link to <pydoc module="array" member="fromfile(f, n)" />
  This is a link to <pydoc module="textwrap" class="TextWrapper" member="width" />

doxygen

• "api": must be present and refer to the Doxygen API defined in the configuration file
• "location": the direct location of the API (alternative to the "api" attribute)
• "path" : the path to the API element
• "altPath": the optional alternate text to present for the path to the API element^[5]
  The "altPath" attribute is an optional alternate text to present for the path to the class. It can be useful if the member is defined for a parent class but you want to show the API for a subclass. It will allow you to present the API on the class you choose and avoid any error emitted because the link is not found in the API
• "member": the method of the specified element (optional)
• "type": the type of the link:
• "class": the documentation points to a class declaration
• "method": the documentation points to a method declaration
• "struct": the documentation points to a struxture declaration
• "attribute": the documentation points to an attribute declaration
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[4]
  See checking external links

ul

Example

 <ul>
   <li>first element</li>
   <li>second element</li>
 </ul>

• first element
• second element

ol

Example

 <ol>
   <li>first element</li>
   <li>second element</li>
 </ol>

1. first element
2. second element

Example with start and bullet style

 <ol bullet="alpha" start="c">
   <li>first element</li>
   <li>second element</li>
 </ol>

3. first element
4. second element

li

• A list item under an ordered or unordered list
• An element under a tree

tree

Example

  <tree fillColor="magenta" borderColor="black" boxed="true" >
     <li>parent
        <li>child 1</li>
        <li>child 2</li>
     </li>
  </tree>

• parent
  • child 1
  • child 2

setAPIURL

  <setAPIURL url="http://docs.oracle.com/javase/9/docs/api/" />
  <javadoc path="java.awt.Button"/>
  <javadoc path="java.lang.String"/>

   <javadoc location="http://docs.oracle.com/javase/9/docs/api/" path="java.awt.Button"/>
   <javadoc location="http://docs.oracle.com/javase/9/docs/api/" path="java.lang.String"/>

setBaseURL

   <setBaseURL path="href" />
   <a href="theFile.xml">The ref</a>

   <a href="href/theFile.xml">The ref</a>

Resetting the baseURL

   <setBaseURL />

   <setBaseURL path="href" />
   <a href="theFile.xml">The ref</a>
   <setBaseURL />
   <a href="theFile2.xml">The ref 2</a>

   <a href="href/theFile.xml">The ref</a>
   <a href="theFile2.xml">The ref</a>

javaAPI

• "api": (optional) the API. For the moment this attribute is not used
• "path": the path to the element (class, interface, or enum) with package names separated by "." (dot) characters
• "modifiers": (optional) the modifiers of the element (For example, "public final"). By default, it is considered as public
• "type": (optional) the type of the element, which can be class (the default), interface, or enum
• "hr": (optional) true if we should add a thematic break ("hr" element) before and after the API

• field elements, declaring the fields of the class
• method elements, declaring the methods of the class

• "member": the name of the field or the signature of the method, including the return type
• "modifiers": (optional) the modifiers of the element (For example, "public final"). By default, it is considered as public

Example

  <javaAPI path="JButton" modifiers="public">An implementation of a "push" button.
     <method member="AccessibleContext getAccessibleContext()">Gets the AccessibleContext associated with this JButton</method>
     <method member="setDefaultCapable(boolean defaultCapable)">Sets the defaultCapable property, which determines whether this button
  can be made the default button for its root pane.</method>
     <method member="setDefaultCapable(int defaultCapable)">Sets the defaultCapable property, which determines whether this button
  can be made the default button for its root pane.</method>
  </javaAPI>

pythonAPI

• "api": (optional) the API. For the moment this attribute is not used
• "path": the path to the element (class, interface, or enum) with package names separated by "." (dot) characters
• "type": (optional) the type of the element, for now can only be class (the default)
• "hr": (optional) true if we should add a thematic break ("hr" element) before and after the API

• field elements, declaring the variables of the class
• method elements, declaring the methods of the class

• "member": the name of the field or the signature of the method

Example

  <pythonAPI path="Class">Representation of a class documentation
     <field member="doc">A mapping from identifier name to a Doc objects</field>
     <method member="class_variables(self, include_inherited=True, sort=True)">
  Returns an optionally-sorted list of Variable objects that represent this class class variables.</method>
  </pythonAPI>

apidoc

• Java APIs
• Python APIs. It is a "pdoc-like" API (See pdoc3.github.io)
• C# APIs
• Doxygen APIs (for both C and C++ programs)

Example

  <apidoc lang="java" type="class" path="JButton" modifiers="public">An implementation of a "push" button.
     <element type="method" path="AccessibleContext getAccessibleContext()">Gets the AccessibleContext associated with this JButton</element>
     <element type="method" path="setDefaultCapable(boolean defaultCapable)">Sets the defaultCapable property, which determines whether this button
  can be made the default button for its root pane.</element>
     <element type="method" path="setDefaultCapable(int defaultCapable)">Sets the defaultCapable property, which determines whether this button
  can be made the default button for its root pane.element</element>
  </apidoc>

moreInfo

• Refer to a "Main Article"
• Refer to a list of "See also" articles

moreInfo main article

• "id": the identification of the main article
• "desc": the text to refer to the article
• "package": the optional package

Example

 <moreInfo id="faq" desc="the FAQ" />
  Text after the tag.

moreInfo list of See also articles

• "id": the identification of the referred article
• "desc": the text to refer to the article
• "package": the optional package

Example

 <moreInfo>
   <info id="faq" />
   <info id="justification" />
 </moreInfo>

seeArticle

• "id": the identification of the main article
• "desc": the text to refer to the article
• "package": the optional package

Example

 <seeArticle id="faq" desc="the FAQ" />
  Text after the tag.

img

• "id": The image id. See image files for the specification of image ids
• "href": The relative path of the image, if the image do not refer to an Image definition
• "width": The optional image width: can be specified in pixels or in % of the HTML page width
• "maxWidth": Same as "width", but the width can not exceed the native image reference width
• "height": The optional image heigh: can be specified in pixels or in % of the HTML page width
• "maxHeight": Same as "height", but the width can not exceed the native image reference height
• "caption": The optional image caption
• "border": Optionally, the property specifying that we should add a border around the image. This attribute can have the following values:
• "true" or "simple": the image will be bordered by simple line
• "shadow": the image will have a shadowed border
• "false" or "noBorder" : (the default) no border
• "margin": Optionally, the property specifying the margin around the image. See also image margins for more information
• "package": The optional package attribute allows to reference an image in another package
• "position" or "align": Optionally the alignment of the image. Can be "left", "right", or "center"
• "valign": Optionally the vertical alignment of the image relative to the text. Can be "middle", or "baseline". THis can be useful if you want to add an icon in a line of text
• "float": Optional, true if the image should have the "float" attribute (which means that there will be text around the image)

Examples

  An image:<img id="image1" valign="middle" width="40" />

  The same image but bigger:
  <img id="image1" width="20%" />

  The same image image with a border:
  <img id="image1" width="20%" border="true" />

  The same image image with a border and a caption:
  <img id="image1" width="20%" border="true" caption="the caption" />

  The same image image with a shadowed border:
  <img id="image1" width="20%" border="shadow" />

  The image aligned on the left:
  <img id="image1" width="40" position="left"/>

  An SVG image:<img id="svgLogo" width="40" />

Linking on images

resource

• Directly pointing to a resource file in a "doc-files" directory which is under the directory in which the article is present. Such as <resource href="myResource.xml">Example</resource>
• Referencing a resource file (which can be in this case anywhere in the wiki) by its ID. Such as <resource id="resource1">Example</resource>

Example

 <resource id="resource1">Example resource</resource>

chapter

title

div

• "justify": the justification of the element. See the Justification article
• "style": the style classes of the element. See the Custom StyleSheet article

ref

• "id": the id of the referenced article (and optionnally chapter or title). See the chapters and title article for how the id must be specified
• "path": the absolute or relative path of the referenced article input file
• "desc": the optional text to show for the link
• The optional "package" attribute allows to reference an article in another package

• a chapter
• a title
• an anchor

References to the index article

  The <ref id="_index_" />

Derived names

   The <ref id="the reference" desc="the references"/>

   The <ref id="the reference" />s

Example

<article id="thisArticle" desc="my article">
<title title="first chapter"/>
   ...
</article>

   <ref id="thisArticle" />
   <ref id="my article" />
   <ref id="my_article" />

   <ref id="thisArticle#first chapter" />
   <ref id="thisArticle#first_chapter" />
   <ref id="my article#first chapter" />
   <ref id="my_article#first_chapter" />

catRef

• "id": the id of the referenced category
• "desc": the optional text to show for the link

Example

  <catRef id="mycategory" desc="the category" />

glossaryRef

• "desc": the optional text to show for the link (if this attribute is not present, the localization for the glossary will be used

Example

  <glossaryRef desc="the Glossary" />

anchor

• "id": the id of the anchor
• "desc": the optional text to show for the anchor
• "format": the optional text style, which can be "regular", "italic", "bold", "underline", "crossed" or "strikethrough", "sub" or "subscript" (for subscript), or "sup" or "superscript" (for superscript), or a combination of these tags. See also font format.

Example

  <anchor id="theAnchor" desc="anchor" />

include

• "id": the id of the included article or template
• "keepNumbering" or "keepLevels": a boolean specifying if the levels of the titles in the template must be kept (true by default). See also keepLevels attribute for more information

Example

<template desc="my template">
<title title="first template chapter"/>
   some text in the template.
</template>

   <include id="my template" />

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

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

esc

• "text": the text to escape

Example

  this is a line with a <esc text=\"<\" />

      this is a line with a <![CDATA[<]]>

todo

Example

   <todo />

   <todo reason="this is the reason"/>

todolist

Example

   number of TODOs: ${todo}.

   number of errors: ${errors}.

   todolist:
   <todolist />

comment

• The command-line includeComments or the configuration file includeComments property is true

Example

   This is the previous text<comment comment="the word could be different"/>

   This is the previous text<comment comment="the word could be different" date="2022-03-28" user="Herve"/>

commentlist

Example

   commentlist:
   <commentlist: />

table

• "tableHeader" which will define the columns in the table.
• The header will have one "column" child for each column
• The header can be defined to be vertical
• several "row" elements which will define the rows in the table
• The row will have one "cell" child for each cell in the row. Each cell contains its content, and can have a background color if using the "color" attribute

Example

   <table caption="table caption">
      <tableHeader>
         <column>first column</column>
         <column>second column</column>
      </tableHeader>
      <row>
         <cell>name</cell>
         <cell>value</cell>
      </row>
      <row>
         <cell color="#00FF00">name2</cell>
         <cell>value2</cell>
      </row>
   </table>

<table>
   <tableHeader>
      <column width="200">first column</column>
      <column width="300">second column</column>
   </tableHeader>
   <row>
      <cell>name</cell>
      <cell>value</cell>
   </row>
   <row>
      <cell>name2</cell>
      <cell>value2</cell>
   </row>
</table>

math

• "size": the size of the text for the formulas^[10]
  If not present, a default size will be used

Example

  <math>
     <mi>a</mi>
     <msup>
        <mi>x</mi>
        <mn>2</mn>
     </msup>
  </math>

html

Example

  <html>
     <font style="color:blue">Embedded html content</font>
  </html>

map

• "width": The map width: can be specified in pixels or in % of the HTML page width
• "height": The map heigh"
• "position" or "align": Optionally the alignment of the map
• "float": Optional, true if the map should have the "float" attribute (which means that there will be text around the map)
• "projection": Optional, defines the projection to use. The default will be "EPSG:4326". See also World Geodetic System

• "latCenter": The map center latitude
• "lonCenter": The map center longitude"
• "zoomLevel": The map zoom level

Example

  <map width="200" height="200">
     <mapBounds latCenter="34.070" lonCenter="-118.73" zoomLevel="5" />
  </map>

condition

• "condition": The name or names of the packages (separated by commas) which must all be present for the condition to be evaluated as true, or the condition type for a property^[11]
  For example "myPack1, myPack2" is a valid value for the condition
• "property": The name or the property which must be present for the condition to be evaluated as true. If the "value" attribute is not present, the condition will be evaluated as true if the property is present
• "value": The value or the property which must be present for the condition to be evaluated as true. If the "value" attribute is present, the condition will be evaluated as true if the property is present and its value is equal to "value"

• The "if" child element defines the content which will be added if the condition is true
• The "else" child element defines the content which will be added if the condition is false

Examples

   <article desc="an article">
     <condition condition="myPack">
        <if>
   The text inside the if for myPack (will be added if "myPack" is present).
        </if>
        <else>
   The text inside the else for myPack (will be added if "myPack" is absent).
        </else>
     </condition>
   </article>

   <article desc="an article">
     <condition property="myProperty">
        <if>
   The text inside the if, will be added if "myProperty" exists.
        </if>
        <else>
   The text inside the else, will be added if "myProperty" does not exist.
        </else>
     </condition>
   </article>

   <article desc="an article">
     <condition property="myProperty" value="true">
        <if>
   The text inside the if, will be added if "myProperty" exists and its value is "true".
        </if>
        <else>
   The text inside the else, will be added if "myProperty" does not exist or its value is not "true".
        </else>
     </condition>
   </article>

End elements

• "see": allows to add a "See Also" chapter at the end of the article with wiki links to other articles
• "cat": define that an article belongs to one category