This is an old revision of the document!
Table of Contents
annotate Plugin
Compatible with DokuWiki
Greebo
Creates annotation boxes that function like toolipts. 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.
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
Installation
Install the plugin using the Extension Manager or the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.
Examples/Usage
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.
Syntax
The basic syntax
<anno:num>text</anno><@anno:num>annotation</@anno>
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:
<anno:num>...</anno><@anno:num>...</@anno>
Complete Syntax
1. <anno:10>text</anno><@anno:10>wiki text</@anno>
2. <anno:15>text</anno><@anno:15>{{ns:page}}</@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:pace:page</bottom></@anno>
5. <anno:30>text</anno><@anno:35><top>ns:page</top>wiki text</@anno>
text
: text to be annotatedwiki text
: the annotation entered directly into the current pagens:page
: wiki page (namespace:page) to be loaded into the annotation from a file in the wikitop
: marks off a header which will be loaded into the annotation from the specified wiki pagebottom
marks off a footer which will be loaded into the annotation from the specified wiki page
- In this form, the entire annotation will consist of the wiki text
- In this form the entire annotation will consist of the page loaded into the annotation field from
ns:page
- In this form the wiki text will be preceded by a header and followed by a footer
- In this form the annotation will consist of the wiki text followed by a footer
- In this form the annotation will consist of a header and the wiki text
What can and cannot be included in the annotations
Development
Change Log
- adds newline after top insertion (2019-03-28 15:53)
- adds inline-block to annotation css def (2019-03-27 04:07)
- updates info.txt (2019-03-27 02:04)
- Merge pull request #2 from turnermm/absolute (2019-03-27 01:13)
- adds jQuery tests for anno-dclk-over for mouseout and doubleclick (2019-03-27 00:21)
- create unique ids for anno_close (2019-03-26 18:41)
- converted from display to position visibility (2019-03-26 18:03)
- support for hr element (2019-03-17 02:47)
- Adds support for DowkuWiki Quoting (2019-01-18 21:49)
- updated info.txt (2019-01-18 02:08)
Discussion
Bugs and Issues
Use the DokuWiki forum or annotate's issues on github (see the Report Bugs link above).