DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:annotate

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
plugin:annotate [2019-01-09 15:21]
turnermm [Complete Syntax]
plugin:annotate [2019-01-20 22:46] (current)
turnermm [annotate Plugin]
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description:​ 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.+description:​ Creates 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.
 author ​    : Myron Turner ​ author ​    : Myron Turner ​
-email      : turnermm03@shaw.ca ​+email      : turnermm02@shaw.ca ​
 type       : syntax type       : syntax
-lastupdate : 2019-01-08 +lastupdate : 2019-01-17 
-compatible : Greebo+compatible : Detritus,"​Elenor of Tsort",​Frusterick Manners,Greebo
 depends ​   :  depends ​   : 
 conflicts ​ :  conflicts ​ : 
 similar ​   :  similar ​   : 
-tags       : ​+tags       : ​annotations,​ annotate, tooltip
  
 downloadurl:​ https://​github.com/​turnermm/​annotate/​archive/​master.zip downloadurl:​ https://​github.com/​turnermm/​annotate/​archive/​master.zip
Line 34: Line 34:
 ==== The basic 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> ​   ​     <​anno:​num>​...</​anno><​@anno:​num>​...</​@anno> ​   ​
 +    <​anno:​num>​...</​anno><​@anno:​[num;;​class_name]>​...</​@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. ''​class_name''​ is the name of a class defined in the css file that can alter the characteristics of the annotation box. See below.
 +
  
-For the full syntax,​temporarily use the README.md file that comes with the distributon:​ https://​github.com/​turnermm/​annotate/​blob/​master/​README.md 
 ==== Complete Syntax ==== ==== Complete Syntax ====
 1. <​anno:​10>​text</​anno><​@anno:​10>​wiki text</​@anno>​ \\ 1. <​anno:​10>​text</​anno><​@anno:​10>​wiki text</​@anno>​ \\
Line 45: Line 46:
 4. <​anno:​25>​text</​anno><​@anno:​25>​wiki text<​bottom>​ns:​pace:​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>​ \\ 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</​@anno>​ \\
  
   * ''​text'':​ text to be annotated   * ''​text'':​ text to be annotated
   * ''​wiki text'': ​ the annotation entered directly into the current page      * ''​wiki text'': ​ the annotation entered directly into the current page   
-  * ''​ns:​page'':​ namespace:​page to be loaded into the annotation from a file in the wiki +  * ''​ns:​page'': ​wiki page (namespace:​pageto 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 
 +  * ''​bottom''​ 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 
 +  - In this form,there is the opportunity to create user-defined annotation containers. ​ There are two pre-defined classes: ''​anno_deep''​ and ''​anno_narrow''​. ​ The standard annotation container is 120px deep.  The narrow is 60px and the deep is 160px. ​ These can easily be changed or your own class can easily be defined. 
 + 
 +===== What can and cannot be included in the annotations ===== 
 +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. 
 ===== Development ===== ===== Development =====
  
Line 58: Line 78:
 === Bugs and Issues === === Bugs and Issues ===
  
-Use the DokuWiki forum or annotate'​s issues on github (see the **Report Bugs** link above).+Use the DokuWiki forum or annotate'​s issues on github (see the ** [[#​annotate_plugin|Report Bugs]] ** link above).
  
  
plugin/annotate.1547043718.txt.gz · Last modified: 2019-01-09 15:21 by turnermm