SignalTodoTags

parent nodes: Intro5Indexing | PageSignalling | SignalPageNodes | WpAttributes

Signal Todo Tags

Contents:

Back

General

Todo tags are a type of user tags and have roughly the same goal and possibilities. The main difference is, that they don't need square brackets and consist of a limited number of predevined key words. Furthermore they are aimed at adding a descriptive text to the tag. Todo tags do not support global attributes.

As with user tags, todo tags show up as nodes in the views section. A page can have multiple todo tags and a todo tag can be on multiple pages.

Top

Format

The general format is: "keyword: free text". The keywords are restricted to the following list:

todo	something that has to be done.
done	something that has been done.
action	something that needs action.
track	something that needs to be tracked.
issue	an issue that needs to be solved.
question	a question that needs to be answered&nbsp.;
project	something that is part of a project.

Todo tags can be anywhere on a page and anywhere within a line; they can be on a line of there own or in the middle of a line of text. The tags are case sensitive and have to be written as in the list; Todo: will not result in a tag. The todo text - the text following the tag - ends either with a newline or with a vertical bar "|". The escape character can be used to escape either the tag or the bar.

Examples
Todo tags like this:

	* todo: Help: write a page on todo tags.
	* done: Help: written a page on user tags
	* Wikidpad is Vista compatible todo: Help: check if vista compatible is true | and also runs on Linux and Mac.
	* question: Help: how is todo exported? | possibly already answered in wikidpadhelp.wiki
	* The song is on \track: 5 of the Beatles collection cd.

result in:

todo: Help: write a page on todo tags.
done: Help: written a page on user tags
Wikidpad is Vista compatible todo: Help: check if vista compatible is true and also runs on Linux and Mac.
question: Help: how is todo exported? possibly already answered in wikidpadhelp.wiki
The song is on track: 5 of the Beatles collection cd.

and in the views tree in:

Top

Structured tags

Like user tags, todo tags support nested subcategories in the form of structured todo keywords. Example:

todo.help.system.bugs.urgent: Bug in wikidpad "rename link".
todo.help.system.software.update: Update wikidpad to new beta release.

Top

Todo node signalling

The appearance of a single todo item in the views section can be controled by using the formatting attributes: icon, color and bold in the tag's text. Example:

todo.help.format.icon: Show the exclamation icon. [icon:exclamation]
todo.help.format.color: Show the text in bold orange. [bold:true][color: coral]

For the format of the attributes see: Signalling page nodes.

As can be seen in the example, the format attributes do not get removed from the text; this behaviour is deliberate. In practice it is therefore best, to put the attributes at the end of the todo text.

Top

Page signalling

Todo tags did at one point have global attributes, that allowed to have nodes of pages, that have certain tags or belong to certain tag groups, to stand out and/or be signalled in some way. This facility has been deactivated quite some time ago and will not be reactivated.

Top

previous: Back
parents: Intro5Indexing, PageSignalling, SignalPageNodes, WpAttributes
[help.status: done]