Learn about DokuWiki
Learn about DokuWiki
This is an old revision of the document!
Compatible with DokuWiki
Creates configurable annotation boxes that function like tooltips. The boxes, initially hidden, open in place, on mouseover, immediately beneath the text being annotated and close out-of-sight on the click of a button or mouseout.
This plugin creates scrollable information boxes that open when the mouse cursor moves over the text that requires explanation, which is marked like a DokuWiki tooltip, with double dotted underlining, as in “HTML”. The box stays open until the
close button is clicked or until the user double clicks inside the box itself, or until another box is opened.
The text for the annotation can be entered directly into the current page or imported from a DokuWiki page. The syntax for these techniques is described below.
num is a unique two digit number that identifies this annotation pair. The
text is what is explained by
annotation. In the browser this
text will be identified by a double dotted underline. Please note that the mark-up for the
text and the markup for the
annotation are side-by-side.
class_name is the name of a class defined in the css file that can alter the characteristics of the annotation box. See the following section on syntax.
1. <anno:10>text</anno><@anno:10>wiki text</@anno>
3. <anno:20>text</anno><@anno:20><top>ns:page</top>wiki text<bottom>ns:page</bottom></@anno>
4. <anno:25>text</anno><@anno:25>wiki text<bottom>ns:page</bottom></@anno>
5. <anno:30>text</anno><@anno:35><top>ns:page</top>wiki text</@anno>
6. <anno:30>text</anno><@anno:[40;;classname]><top>ns:page</top>wiki text<bottom>ns:page</bottom></@anno> (
bottom are discretionary)
text: text to be annotated
wiki text: the annotation entered directly into the current page
ns:page: wiki page (namespace:page) to be loaded into the annotation from a file in the wiki
top: marks off a header which will be loaded into the annotation from the specified wiki page
bottommarks off a footer which will be loaded into the annotation from the specified wiki page
annotation: the default container, 120px deep; this is the class used when no other class is specified (i.e. when not using format number 6)
anno_deep: 160px deep
All of the predefined classes are 620px wide. The
_r classes have the same dimensions as their namesakes but have rounded corners. These classes can be changed or your own classes can be defined.
Most DokuWiki syntax can be included in the annotations with the exception of block level elements. The latter includes code blocks, file blocks, geshi code blocks, and code snippets. When these are included, they end up outside the annotation block.
The annotations can include images, links, tables, ordered and unordered lists, headlines, and typographic markup, such as bold, italic, superscript, etc.
While tables, lists and headlines are block level elements, the plugin re-configures them for inclusion in the annotation field. This means that for these forms, there might be some differences from the styles of your template.
Leaving a blank line between lines does not automatically insert a newline. To sart a new line or paragraph, you must use the dokuwiki double backslash. So this:
line 1 line 2
will give you this
line 1 line2
line 2 on a new line, you must use instead:
line 1\\ line 2
line 2 the start of a new paragraph, you must use this:
line 1\\ \\ line 2
Use the DokuWiki forum or annotate's issues on github (see the Report Bugs link above).