Differences

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

--- plugin:annotate [2019-01-09 15:21] – [Complete Syntax] turnermm
+++ plugin:annotate [2020-07-26 06:19] (current) – [Annotate Plugin] turnermm
@@ Line 1: / Line 1: @@
-====== annotate Plugin ======
+====== Annotate 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 configurable annotation boxes that function like tooltips. The boxes open in place on mouseover, beneath the text being annotated, and close out-of-sight on the click of a button or mouseout.
 author     : Myron Turner
-email      : turnermm03@shaw.ca
+email      : turnermm02@shaw.ca
 type       : syntax
-lastupdate : 2019-01-08
+lastupdate : 2019-03-28
-compatible : Greebo
+compatible : Detritus, Elenor of Tsort, Frusterick Manners, Greebo,hogfather
 depends    :
 conflicts  :
 similar    :
-tags       :
+tags       : annotation, annotate, tooltip
-downloadurl: https://github.com/turnermm/annotate/archive/master.zip
+downloadurl: https://github.com/turnermm/annotate/zipball/master
 bugtracker : https://github.com/turnermm/annotate/issues
 sourcerepo : https://github.com/turnermm/annotate
@@ Line 34: / Line 34: @@
 ==== 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>text</anno><@anno:[num;;class_name]>annotation</@anno>
-    <anno:num>...</anno><@anno:num>...</@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 the following section on  [[#syntax]].
-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 ====
 . <anno:10>text</anno><@anno:10>wiki text</@anno> \\
 . <anno:15>text</anno><@anno:15>%%{{ns:page}}%%</@anno> \\
 . <anno:20>text</anno><@anno:20><top>ns:page</top>wiki text<bottom>ns:page</bottom></@anno> \\
-. <anno:25>text</anno><@anno:25>wiki text<bottom>ns:pace:page</bottom></@anno> \\
+. <anno:25>text</anno><@anno:25>wiki text<bottom>ns:page</bottom></@anno> \\
 . <anno:30>text</anno><@anno:35><top>ns:page</top>wiki text</@anno> \\
+. <anno:30>text</anno><@anno:[40;;classname]><top>ns:page</top>wiki text<bottom>ns:page</bottom></@anno> (''top'' and ''bottom'' are discretionary) \\
   * ''text'': text to be annotated
   * ''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: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
+  * ''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 use a predefined class or to create user-defined annotation classes for your containers.  There are six pre-defined classes:
+    - ''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
+    - ''anno_narrow''  120px deep
+    - ''annotation_r''
+    - ''anno_narrow_r''
+    - ''anno_deep_r''
+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.
+The annotation blocks will have scrollbars if the content exceeds the dimensions of the block.  However, in the case of blocks with rounded corners, the rounded corners will be squared off for the scrollbars.
+===== 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.
+===== Lists =====
+Lists should be prefaced by ''[List]'' and ended with ''[tsiL]'':
+<code>
+    [List]
+    * item one
+    * item two
+    * etc. . .
+    [tsiL]
+</code>
+===== Newlines and Paragraphs=====
+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
+To start ''line 2'' on a new line, you must use instead:
+<code>line 1\\ line 2</code>
+To make ''line 2'' the start of a new paragraph, you must use this:
+<code>
+line 1\\
+\\
+line 2
+</code>
 ===== Development =====
@@ Line 58: / Line 113: @@
 === 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).