Todo

The "todo" element allows to add a "TODO" in the wiki. The "todolist" element allows to add a list of all TODOs found in the wiki (which is a list of all the "todo" elements found in the wiki with their associated article.

Adding todos and using the "todolist" element allows to show a comprehensive list of all things you still need to do in your wiki, in one place.

todo

The "todo" element allows to add a "TODO" in the wiki.

The only possible attribute is:

• "reason": the reason of the TODO

Example

The following example shows a simple TODO:

   <todo />

The following example shows a TODO with a reason:

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

progress messageBox

The messageBox element with the "progress" type allows to add a "TODO" in the wiki. Note that it will only be considered as a "TODO" if the "todo" attribute is present^[1]

If you use the "todo" attribute with other types of messageBox elements, it will not be taken into account

.

Example

    <messageBox type="progress" todo="this will be in TODOs">
      this a in-progress text
      <br/>
      the second line
   <messageBox>

Result:

todo property

The "todo" property shows the number of "todo" in the wiki and is always provided by default.

For example:

      The wiki has ${todo} TODOs.

Result: The wiki has 0 TODOs.

todolist

The "todolist" element allows to add a list of all TODOs found in the wiki (which is a list of all the todo elements found in the wiki with their associated article. This element has no attributes.

Example

For example:

   number of TODOs: ${todo}.
   
   number of errors: ${errors}.
   
   todolist:
   <todolist />

Result: