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-18 05:28]
turnermm
plugin:annotate [2019-03-29 12:28] (current)
turnermm [Complete Syntax]
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description:​ Creates annotation boxes that function like tooltips. The boxes, initially hidden, ​open in placeon 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 annotatedand close out-of-sight on the click of a button ​or mouseout.
 author ​    : Myron Turner ​ author ​    : Myron Turner ​
-email      : turnermm03@shaw.ca ​+email      : turnermm02@shaw.ca ​
 type       : syntax type       : syntax
-lastupdate : 2019-01-17 +lastupdate : 2019-03-28 
-compatible : Detritus,"​Eleanor ​of Tsort",​Frusterick Manners,​Greebo+compatible : Detritus,"​Elenor ​of Tsort",​Frusterick Manners,​Greebo
 depends ​   :  depends ​   : 
 conflicts ​ :  conflicts ​ : 
 similar ​   :  similar ​   : 
-tags       : ​annotations, annotate, tooltip+tags       : ​annotation, 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>​ +    <​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> ​    +  ​ 
-    <​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 boxSee the following section on  ​[[#syntax]].
  
  
Line 44: Line 44:
 2. <​anno:​15>​text</​anno><​@anno:​15>​%%{{ns:​page}}%%</​@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>​ \\ 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>​ \\+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>​ \\ 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>​ \\+6. <​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   * ''​text'':​ text to be annotated
Line 60: Line 60:
   - In this form the annotation will consist of the wiki text 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 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.+  - 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 ===== ===== 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, code snippets, and quoting: ''​%%>>​%%''​. When these are inclluded, they end up outside the  annotation block.+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. The annotations can include images, links, tables, ordered and unordered lists, headlines, and typographic markup, such as bold, italic, superscript,​ etc.
Line 69: 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. 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.
  
 +===== 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 ===== ===== Development =====
  
plugin/annotate.1547785714.txt.gz · Last modified: 2019-01-18 05:28 by turnermm