Differences

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

--- plugin:annotate [2019-03-28 15:44] – [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 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.
+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      : turnermm02@shaw.ca
 type       : syntax
-lastupdate : 2019-03-26
+lastupdate : 2019-03-28
-compatible : Detritus,"Elenor of Tsort",Frusterick Manners,Greebo
+compatible : Detritus, Elenor of Tsort, Frusterick Manners, Greebo,hogfather
 depends    :
 conflicts  :
 similar    :
-tags       : annotations, annotate, tooltip
+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>...</anno><@anno:num>...</@anno>
+    <anno:num>text</anno><@anno:num>annotation</@anno>
-    <anno:num>...</anno><@anno:[num;;class_name]>...</@anno>
+    <anno:num>text</anno><@anno:[num;;class_name]>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. ''class_name'' is the name of a class defined in the css file that can alter the characteristics of the annotation box. See 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]].
@@ Line 68: / Line 68: @@
     - ''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.
@@ Line 75: / Line 77: @@
 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 =====