DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:note

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:note [2016-03-22 09:15] 196.214.95.93plugin:note [2024-01-10 18:57] (current) – screenshot Aleksandr
Line 3: Line 3:
 ---- plugin ---- ---- plugin ----
 description: This plugin allows you to create nice “notes” like this in your DokuWiki pages description: This plugin allows you to create nice “notes” like this in your DokuWiki pages
-author     : Olivier Cortes et. al. + Aurélien Bompard+author     : Olivier Cortes et. al. + Aurélien Bompard, LarsDW223
 email      : aurelien@bompard.org email      : aurelien@bompard.org
 type       : syntax type       : syntax
-lastupdate : 2009-06-15 +lastupdate : 2020-06-28 
-compatible : 2009-02-14, Lemming, Anteater, Rincewind, Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus+compatible : 2016-06-26, 2009-02-14, Lemming, Anteater, Rincewind, Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, 2016-06-26 "Elenor Of Tsort", 2017-02-19 "Frusterick Manners", Greebo, Hogfather, Igor, Jack Jackrum
 depends    :  depends    : 
 conflicts  conflicts 
-similar    : bootswrapper, box, wrap+similar    : bootswrapper, box, wrap, admnote
 tags       : boxes, icons, toolbar tags       : boxes, icons, toolbar
  
-downloadurl: http://gauret.free.fr/fichiers/dokuwiki/dokuwiki-note-20090615.tgz+downloadurl: https://github.com/LarsGit223/dokuwiki_note/zipball/master 
 +bugtracker : https://github.com/LarsGit223/dokuwiki_note/issues 
 +sourcerepo : https://github.com/LarsGit223/dokuwiki_note 
 +donationurl :  
 +  
 +screenshot_img : https://trello.com/1/cards/659ed9c093bc8f60bf5251a9/attachments/659eda3333beaab793b64a14/download/note-plugin-screenshot.png
 ---- ----
- 
-{{ http://www.deep-ocean.net/captures/capture-dokuwiki-note-20060323.png }} 
- 
  
 ===== Usage ===== ===== Usage =====
  
-When you have it installed, use this :+When you have it installed, use this:
  
 <code> <code>
 <note> <note>
-This is my note ! Remember it!!+This is my note! Remember it!!
 </note> </note>
  
 <note important> <note important>
-Warning ! You're about to lose your mind ;-)+Warning! You're about to lose your mind ;-)
 </note> </note>
  
Line 37: Line 39:
  
 <note warning> <note warning>
-Beware of the cat when you open the door !!+Beware of the cat when you open the door!!
 </note> </note>
 </code> </code>
  
 You can use the note keywords ''important'', ''warning'' and ''tip''. Or some French synonyms: ''importante''(important), ''bloquante'', ''critique'' (warning), ''tuyau'', ''idée'' (tip), ''classique'' (classic). It is quite easy to add new types of notes if you know a bit of PHP and CSS. You can use the note keywords ''important'', ''warning'' and ''tip''. Or some French synonyms: ''importante''(important), ''bloquante'', ''critique'' (warning), ''tuyau'', ''idée'' (tip), ''classique'' (classic). It is quite easy to add new types of notes if you know a bit of PHP and CSS.
- 
  
  
 ===== Limitations ===== ===== Limitations =====
  
-Plugin won't work inside numbered list\\+Plugin won't work inside numbered list
  
-<del>It also doesn't appear to work within a folded section using the "[[plugin:folded|Folded]]" plugin.</del>\\+<del>It also doesn't appear to work within a folded section using the "[[plugin:folded|Folded]]" plugin.</del>
  
 Correction: The syntax is as follows: Correction: The syntax is as follows:
Line 55: Line 56:
 <code> <code>
 === Note === === Note ===
 +
 ++++Note dans un Folded| ++++Note dans un Folded|
 <note critique> <note critique>
Line 66: Line 68:
  
 **General instructions** **General instructions**
-  - Download [[http://gauret.free.fr/fichiers/dokuwiki/dokuwiki-note-20090615.tgz|the latest version]] or [[http://gauret.free.fr/fichiers/dokuwiki/dokuwiki-note-20080217.tgz|the original version]] (Mirror: The tar.gz package of the original release can be found at [[http://www.mediafire.com/evildev]].)+  - Download [[https://github.com/LarsGit223/dokuwiki_note/archive/2019-04-18.zip|the latest version]] or [[http://gauret.free.fr/fichiers/dokuwiki/dokuwiki-note-20080217.tgz|the original version]] (Mirror: The tar.gz package of the original release can be found at [[http://www.mediafire.com/evildev]].)
   - Installing the plugin   - Installing the plugin
-    * You can either extract the archive into the ''lib/plugins'' directory **and** update the timestamp on the extracted files. (probably because of ssme Dokuwiki caching feature)  +    * Go via the Admin page to the [[plugin:extension|Extension Manager]] and search and install this plugin. Or enter the URL for the plugin under ''Manual Install''
-    * load the admin page and go to Manage Plugins and enter the URL for the plugin under ''Download and install a new plugin''+    * Or you can either extract the archive into the ''lib/plugins'' directory **and** update the timestamp on the extracted files. (probably because of ssme Dokuwiki caching feature) 
  
 **Notes** **Notes**
-  * It is also **reported to work with plug-in manager** (thanks to [[http://live.naplesplus.us|Kenneth Udut]], [[david.mcneill@ge.com|DGM2]]). 
-    * However, in Ricewind I can't use plugin manager again. 
-  * The plugin is self contained and should work "out of the box" (without any CSS alteration, thanks to [[alien@slackware.com|Eric Hameleers]]). 
-  * <del>If after using the <note> </note> tag, it doesn't work: Open note/syntax.php and change lines 113 and 121.</del> (fixed in 2008-02-17 version) 
   * With the 'usable' template there is excessive spacing above the note, I was able to remedy this problem by commenting out 'clear: both;' in 'style.css'. Your mileage may vary.   * With the 'usable' template there is excessive spacing above the note, I was able to remedy this problem by commenting out 'clear: both;' in 'style.css'. Your mileage may vary.
-  * With the [[doku>template:dokucms|'DokuCMS']] template and with the 'clear: both;' in 'style.css', notes are "pushed down" by the TOC box instead of overlapping with it [frank] +  * With the [[template:dokucms|'DokuCMS']] template and with the 'clear: both;' in 'style.css', notes are "pushed down" by the TOC box instead of overlapping with it [frank]
  
  
 ===== Development===== ===== Development=====
  
-** 2009-06-15: New (temporary) maintainer !** I've contacted Olivier, and he has real-life occupations which do not leave him time to maintain the plugin. I've agreed to maintain it in the meantime, but I don't use it a lot, so I'd be happy to have help. I've added a link to the last original version of the plugin, and a link to my improved version. The improvements are:+**2009-06-15: New (temporary) maintainer!** I've contacted Olivier, and he has real-life occupations which do not leave him time to maintain the plugin. I've agreed to maintain it in the meantime, but I don't use it a lot, so I'd be happy to have help. I've added a link to the last original version of the plugin, and a link to my improved version. The improvements are:
   * Fix in the ODT renderer (I'm the original maintainer of this code)   * Fix in the ODT renderer (I'm the original maintainer of this code)
   * Add toolbar buttons for the notes.   * Add toolbar buttons for the notes.
Line 101: Line 97:
     * code reading,     * code reading,
     * conformance to DokuWiki's changes in plugin classes.     * conformance to DokuWiki's changes in plugin classes.
 +
 ===== Credits ===== ===== Credits =====
 +
 **Many thanks to the DokuWiki developers!!!** I really enjoy using and hacking this wiki, since 2005-07. I love DokuWiki! :) Thanks to Stephane Chamberland and Carl-Christian Salvesen for their respective Side Notes and Graphviz plugins, i used them as great inspiration. Thanks to (in any order) : **Many thanks to the DokuWiki developers!!!** I really enjoy using and hacking this wiki, since 2005-07. I love DokuWiki! :) Thanks to Stephane Chamberland and Carl-Christian Salvesen for their respective Side Notes and Graphviz plugins, i used them as great inspiration. Thanks to (in any order) :
   * [[alien@slackware.com|Eric Hameleers]]   * [[alien@slackware.com|Eric Hameleers]]
Line 122: Line 120:
 I deleted all users comments because they addressed old issues that are not present anymore in the last version of the plugin. You can still see them if you browse the «//Old revisions//» of this page. I deleted all users comments because they addressed old issues that are not present anymore in the last version of the plugin. You can still see them if you browse the «//Old revisions//» of this page.
  
- I did it **AGAIN**+I did it **AGAIN** 
  
 ==== XHTL-Compilant and small Modified Version ==== ==== XHTL-Compilant and small Modified Version ====
 +
 //[[th-suess@gmx.de|Thomas Süß]] 2009-10-08// //[[th-suess@gmx.de|Thomas Süß]] 2009-10-08//
   
 Hi, I installed the patch from Nicolas and made minor changes. Warning - this is not an official version.\\ Hi, I installed the patch from Nicolas and made minor changes. Warning - this is not an official version.\\
 More information and Download at: [[http://tokeek.de/doku.php?id=wiki:dokuwiki-plugins|Tokeek.de]], please test and feedback to me. More information and Download at: [[http://tokeek.de/doku.php?id=wiki:dokuwiki-plugins|Tokeek.de]], please test and feedback to me.
 +
  
 ==== XHTML Compliant ==== ==== XHTML Compliant ====
 +
 //[[gerardnico@gmail.com|Nicolas GERARD]] 2009-04-08 23:31// //[[gerardnico@gmail.com|Nicolas GERARD]] 2009-04-08 23:31//
  
Line 141: Line 143:
   * Ptype normal to block   * Ptype normal to block
   * Suppression of the <p></p> elements in the render instructions.   * Suppression of the <p></p> elements in the render instructions.
 +
  
 ==== ODT plugin ==== ==== ODT plugin ====
Line 147: Line 150:
  
 >Got a temporary workaround. First create a dummy wiki page with all four types of notes on it. Export to ODT. Now insert the string ''DOKUWIKI-ODT-INSERT'' on its own line at the top of the file (make sure it has the "Default" paragraph and character styles!). If you want, add a page break after it, but you have to preserve the dummy notes--don't delete them. Adjust other styles to your needs. Now upload and use this file as your export template. You will have to delete the extra page after you export each time, which is the only downside. Still, it will help until someone finds a better fix. (UPDATE: try putting the dummy notes in a hidden section in the template file to avoid having to delete them from every export.) //-jmiller, 2008-10-28// >Got a temporary workaround. First create a dummy wiki page with all four types of notes on it. Export to ODT. Now insert the string ''DOKUWIKI-ODT-INSERT'' on its own line at the top of the file (make sure it has the "Default" paragraph and character styles!). If you want, add a page break after it, but you have to preserve the dummy notes--don't delete them. Adjust other styles to your needs. Now upload and use this file as your export template. You will have to delete the extra page after you export each time, which is the only downside. Still, it will help until someone finds a better fix. (UPDATE: try putting the dummy notes in a hidden section in the template file to avoid having to delete them from every export.) //-jmiller, 2008-10-28//
 +
  
 ==== renders as plain text in 2008-05-05 -Fletch Oct 30, 2008 ==== ==== renders as plain text in 2008-05-05 -Fletch Oct 30, 2008 ====
Line 423: Line 427:
 ===== Bug reports ===== ===== Bug reports =====
  
 +==== Compatibility with Dokuwiki syntax ====
 +**Note Plugin** __//Release: 2009-06-15//__
 +
 +dokuwiki/lib/plugins/note/syntax.php line 79 and line 102, respectively, should be changed/updated as follows:
 +
 +''PHP Warning:  Declaration of syntax_plugin_note::handle($match, $state, $pos, &$handler) should be compatible with DokuWiki_Syntax_Plugin::handle($match, $state, $pos, Doku_Handler $handler)''
 +
 + ''PHP Warning:  Declaration of syntax_plugin_note::render($mode, &$renderer, $indata) should be compatible with DokuWiki_Syntax_Plugin::render($format, Doku_Renderer $renderer, $data)
 +''
 +
 +2016-06-13 12:36
 ==== Broken in May 2008 release ==== ==== Broken in May 2008 release ====
  
Line 528: Line 543:
 Warning: Declaration of syntax_plugin_note::handle($match, $state, $pos, &$handler) should be compatible with DokuWiki_Syntax_Plugin::handle($match, $state, $pos, Doku_Handler $handler) in C:\Data\www\dokuwiki\lib\plugins\note\syntax.php on line 0 Warning: Declaration of syntax_plugin_note::handle($match, $state, $pos, &$handler) should be compatible with DokuWiki_Syntax_Plugin::handle($match, $state, $pos, Doku_Handler $handler) in C:\Data\www\dokuwiki\lib\plugins\note\syntax.php on line 0
  
 +PHP7.0 signature errors for **handle()** and **render()**should be fixed now.
 + --- //LarsDW223 2016/09/14 21:38//
 ==== Had to rename folder ==== ==== Had to rename folder ====
 After downloading the tar.gz file and uploading via admin page, it created a folder in plugins called dokuwikinote20090615/ DokuWiki could not pick up the plugin until I renamed the folder to simply note/ After downloading the tar.gz file and uploading via admin page, it created a folder in plugins called dokuwikinote20090615/ DokuWiki could not pick up the plugin until I renamed the folder to simply note/
 +
 +==== Had to end the line ====
 +Guys, how to make end of line marker into note? <br> didn't work, for example
 +
 +> Use an empty line. This works for me in greebo. --- [[user>KaiMartin|KaiMartin]] //2019-11-20 01:10// 
 +
 +==== Warning: Undefined array key 1 in \wiki\lib\plugins\note\syntax.php on line 103 ====
 +
 +Error message after upgrading to DokuWiki version: Release 2023-04-04a "Jack Jackrum" (under PHP 8.2.7).
 +
 +  Warning: Undefined array key 1 in \wiki\lib\plugins\note\syntax.php on line 103
 +
 +The plugin has been updated with latest version and worked perfectly with PHP 7.2
 +
plugin/note.1458634536.txt.gz · Last modified: 2016-03-22 09:15 by 196.214.95.93

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki