plugin:note
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:note [2018-05-27 00:10] – [Download / Installation] Klap-in | plugin:note [2024-04-15 12:14] (current) – New maintener + old infos cleanup 2a01:cb15:8181:e000:992e:45b4:4097:76b4 | ||
---|---|---|---|
Line 3: | Line 3: | ||
---- plugin ---- | ---- plugin ---- | ||
description: | description: | ||
- | author | + | author |
- | email : aurelien@bompard.org | + | email : contrib@anael.eu |
type : syntax | type : syntax | ||
- | lastupdate : 2018-04-28 | + | lastupdate : 2024-04-15 |
- | compatible : 2016-06-26, 2009-02-14, Lemming, Anteater, Rincewind, Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, 2016-06-26 " | + | compatible : Hogfather, Igor, Jack Jackrum, Kaos |
depends | depends | ||
conflicts | conflicts | ||
- | similar | + | similar |
tags : boxes, icons, toolbar | tags : boxes, icons, toolbar | ||
- | downloadurl: | + | downloadurl: |
- | sourcerepo : https:// | + | bugtracker : https:// |
- | bugtracker | + | sourcerepo : https:// |
+ | donationurl : | ||
+ | |||
+ | screenshot_img | ||
---- | ---- | ||
- | |||
- | {{ http:// | ||
- | |||
===== Usage ===== | ===== Usage ===== | ||
- | When you have it installed, use this : | + | When you have it installed, use this: |
< | < | ||
< | < | ||
- | This is my note ! Remember it!! | + | This is my note! Remember it!! |
</ | </ | ||
<note important> | <note important> | ||
- | Warning ! You're about to lose your mind ;-) | + | Warning! You're about to lose your mind ;-) |
</ | </ | ||
Line 39: | Line 39: | ||
<note warning> | <note warning> | ||
- | Beware of the cat when you open the door !! | + | Beware of the cat when you open the door!! |
</ | </ | ||
</ | </ | ||
You can use the note keywords '' | You can use the note keywords '' | ||
- | |||
===== Limitations ===== | ===== Limitations ===== | ||
- | Plugin won't work inside numbered list\\ | + | Plugin won't work inside numbered list |
- | < | + | < |
Correction: The syntax is as follows: | Correction: The syntax is as follows: | ||
Line 57: | Line 56: | ||
< | < | ||
=== Note === | === Note === | ||
+ | |||
++++Note dans un Folded| | ++++Note dans un Folded| | ||
<note critique> | <note critique> | ||
Line 68: | Line 68: | ||
**General instructions** | **General instructions** | ||
- | - Download [[https:// | + | - Download [[https:// |
- Installing the plugin | - Installing the plugin | ||
* Go via the Admin page to the [[plugin: | * Go via the Admin page to the [[plugin: | ||
Line 75: | Line 75: | ||
**Notes** | **Notes** | ||
* With the ' | * With the ' | ||
- | * With the [[doku>template: | + | * With the [[template: |
+ | ===== Credits ===== | ||
- | ===== Development===== | + | **Many thanks to the DokuWiki developers and this plugin mainteners ! |
- | ** 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: | + | Thanks to (in any order) : |
- | * Fix in the ODT renderer (I'm the original maintainer of this code) | + | |
- | * Add toolbar buttons for the notes. | + | |
- | Please feel free to [[aurelien@bompard.org|send me mails]] if you find bugs, as I'm not going to be monitoring this page. Patches and contributions are most welcome. --- // | + | |
- | **2008-02-17: | + | |
- | + | * Carl-Christian Salvesen | |
- | **2006-03-29: | + | |
- | * allow note nesting, | + | |
- | * fix the trimmed space problem, | + | |
- | * fix the issue with protected modes (e.g. '' | + | |
- | * plug the security vulnerability which could allow malicious HTML or JavaScript to infiltrate your wiki, | + | |
- | * make note types case independent (e.g. important, IMPORTANT & Important will all given an " | + | |
- | * and better : | + | |
- | * code efficiency, | + | |
- | * code reading, | + | |
- | * conformance to DokuWiki' | + | |
- | ===== 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 | + | |
* [[alien@slackware.com|Eric Hameleers]] | * [[alien@slackware.com|Eric Hameleers]] | ||
* [[chris@jalakai.co.uk|Christopher Smith]] | * [[chris@jalakai.co.uk|Christopher Smith]] | ||
Line 111: | Line 97: | ||
* [[http:// | * [[http:// | ||
* [[zerohalo@gmail.com|zerohalo]] | * [[zerohalo@gmail.com|zerohalo]] | ||
- | For their interest in this plugin, their remarks, suggestions or patches. | + | * [[olivier.cortes@ryxeo.com|Olivier Cortes]] |
+ | * [[aurelien@bompard.org|Aurélien Bompard]] | ||
- | Feel free to [[olivier.cortes@ryxeo.com|mail me]] if you encounter problems or need help. And **don' | + | ==== Had to end the line ==== |
+ | Guys, how to make end of line marker into note? <br> didn' | ||
- | ===== Comments ===== | + | > Use an empty line. This works for me in greebo. --- [[user> |
- | 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// | ||
- | |||
- | I did it **AGAIN** | ||
- | |||
- | ==== XHTL-Compilant and small Modified 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:// | ||
- | |||
- | ==== XHTML Compliant ==== | ||
- | // | ||
- | |||
- | I changed this lines to be able to have an XHTML compliant document. | ||
- | <code php> | ||
- | function getPType(){ return ' | ||
- | $renderer-> | ||
- | $renderer-> | ||
- | </ | ||
- | * Ptype normal to block | ||
- | * Suppression of the < | ||
- | |||
- | ==== ODT plugin ==== | ||
- | |||
- | The ODT plugin lets you specify a styles template file with this syntax: < | ||
- | |||
- | >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 '' | ||
- | |||
- | ==== renders as plain text in 2008-05-05 -Fletch Oct 30, 2008 ==== | ||
- | |||
- | Olivier, | ||
- | |||
- | I don't think you should have a single entry pattern ''< | ||
- | * < | ||
- | * < | ||
- | |||
- | Your single pattern will match ''< | ||
- | |||
- | --- // | ||
- | |||
- | > I agree with this hint, but if would not match < | ||
- | > | ||
- | > --- // | ||
- | |||
- | ==== rendering in browsers ==== | ||
- | |||
- | Olivier, | ||
- | |||
- | Are you aware of any problems displaying the notes using Internet Explorer 6.0? I have a problem where the presentation of the boxes is poor compared to Firefox (which works perfectly on the same page). The problems are: | ||
- | - Boxes are not rounded | ||
- | - The icon (warning, important and note) are not allowing the background colour through (so I end up with a noticeable colour variation over the box. | ||
- | Do you know if this is a local implementation issue or something unique to IE? | ||
- | |||
- | --- // | ||
- | |||
- | > 1. Can't help with that.\\ | ||
- | > 2. Use transparent GIFs instead of the transparent PNGs, as IE has a buggy implementation for displaying the later. | ||
- | > Put them in ' | ||
- | > to replace PNGs with your GIFs. Make sure that the GIFs have the same permissions as the PNGs.\\ | ||
- | > --- // | ||
- | |||
- | --- // | ||
- | - Make sure you have 'Allow embedded HTML' turned on in your config or this will not work right! | ||
- | |||
- | --- // | ||
- | - It's clear why the boxes are rounded only in browsers using the Gecko rendering engine: there' | ||
- | |||
- | --- //[[alex]] 2006-12-16// | ||
- | - This is a real shame because rounded corners also don't show up in Safari. | ||
- | |||
- | > To get rounded corners in Safari, add this line: '' | ||
- | - //jmiller, 2008-10-28// | ||
- | |||
- | > I have managed to get rounded corners in IE7 without to much hacking using [[http:// | ||
- | >< | ||
- | <!--[if IE]> | ||
- | <script type=" | ||
- | <script type=" | ||
- | window.onload = function() { | ||
- | DD_roundies.addRule(' | ||
- | } | ||
- | </ | ||
- | < | ||
- | </ | ||
- | |||
- | ==== clean up the cache ==== | ||
- | |||
- | I needed to clean up the cache with [[plugin: | ||
- | |||
- | I had the same problem. Perhaps this hint should be included to the install-instructions. Thanks a lot for the plugin. | ||
- | |||
- | Same here - clean the cache and it all starts working. Great plugin, by the way. | ||
- | An other obvious method which worked for me was to delete the cache manually: | ||
- | \\ '' | ||
- | \\ --- // Alex 2007-05-29 // \\ | ||
- | |||
- | I had the same trouble, delete of *.css files in the cache did the trick | ||
- | \\ --- // Christian 2009-09-04 // \\ | ||
- | |||
- | ==== Flow around TOC ==== | ||
- | |||
- | If you have a long table of contents and a ''< | ||
- | |||
- | --- // | ||
- | |||
- | > I solved this by surrounding the note ''< | ||
- | > --- //dab 2006-11-02 13:54// | ||
- | |||
- | > I solved it by editing \lib\plugins\note\style.css Instead of " | ||
- | > --- // =AK= 2010-10-03 // | ||
- | |||
- | >> When you editing style.css, You could edit not only " | ||
- | >> --- // Ø 2012-12-08 // | ||
- | ==== print view of the notes ==== | ||
- | |||
- | > If you want the notes to have that nice layout also in the printout (currently, the notes are not marked in any | ||
- | > way in the printout), you have to copy the style.css over to print.css (which is the only style sheet used when | ||
- | > printing). | ||
- | > | ||
- | > --- // | ||
- | |||
- | This works for the formatting but I still can't get the icons to print. I have the option checked to print background colors & images. How can I get the icons to print? | ||
- | |||
- | --- // | ||
- | |||
- | > That is because you didn't alter the path for the images, in the style CSS there should be the line: " | ||
- | > This path won`t work in the print.css however, because you are in another root directory. There are two possible ways to change this: | ||
- | > 1. Copy the images folder to the directory your print.css is in (not the best way, but easy to do :D) | ||
- | > 2. Alter the path in your print.css, it should then look something like: " | ||
- | > | ||
- | > Hope that works for you | ||
- | > Scarecrow 2006-12-01 13:07 | ||
- | >> Actually, I believe that most templates serve-out the print CSS from plugins via lib/ | ||
- | >> Wouldn' | ||
- | ---- | ||
- | On at least one page i can a huge blank space... I don't understand what's going on... | ||
- | Any hint/help is appreciated. Weirdly enough, when logged on, that space disappears. | ||
- | * [[http:// | ||
- | |||
- | --- // | ||
- | |||
- | Hi, Solution is to edit the style.css in plugins/ | ||
- | |||
- | Thanks alot, works like a charm! --- // | ||
- | |||
- | This will not work for IE6! Other ideas? --- // | ||
- | |||
- | |||
- | ---- | ||
- | I'm not sure if anyone else had similar problems, but I noticed with the latest DokuWiki and Firefox (not sure which is more responsible) I had to change the style.css file so that the " | ||
- | |||
- | I had the same problem but only with the arctic skin. Your workaround works great! Thank you. | ||
- | |||
- | > Thanks !! That helped me out as well! --- // | ||
- | |||
- | ==== ==== | ||
- | |||
- | ---- | ||
- | ** Bug within the plugin ** 2007-04-02 17:32\\ | ||
- | There' | ||
- | [[gomes.vasco@neuf.fr|Philippe Gomes]] | ||
- | |||
- | ---- | ||
- | ** Unable to install //via// plugin manager (2007-04-05)** | ||
- | |||
- | I have to download it, and un-tar it. | ||
- | |||
- | Anyway, great plugin :) | ||
- | ---- | ||
- | |||
- | I've seen the same bug as Philippe. I can only get notes to display if I edit syntax.php as he states. | ||
- | |||
- | However, with the notes plugin enabled, I get the following error whenever editing a page:- | ||
- | Warning: Cannot modify header information - headers already sent by (output started at C: | ||
- | |||
- | Is this plugin incompatible with the latest DokuWiki, or is it perhaps incompatible with some other plugins ? | ||
- | |||
- | Sounds like a problem related to gzip | ||
- | |||
- | ---- | ||
- | |||
- | The notes leave a big space above when using the ach template... | ||
- | ---- | ||
- | |||
- | Yes, the plugin didn't work for me until I made the changes Philippe suggested in lines 113 and 121 of note/ | ||
- | <code php> | ||
- | $renderer-> | ||
- | ... | ||
- | $renderer-> | ||
- | </ | ||
- | ---- | ||
- | **Is there a way to continue 2nd level unordered list after < | ||
- | |||
- | If note is placed inside a second level bullet list, then the bullet following the note is reset to 1st level, e.g.: | ||
- | < | ||
- | * level 1 | ||
- | * level 2 | ||
- | < | ||
- | * this should be level 2 bullet, but it becomes level 1 | ||
- | </ | ||
- | |||
- | --This can be resolved by placing the < | ||
- | * Example < | ||
- | * level 1 | ||
- | * level 2 < | ||
- | * level 2 < | ||
- | a note | ||
- | </ | ||
- | * this should be level 2 bullet, but it becomes level 1 | ||
- | </ | ||
- | |||
- | ==== toolbar icon ==== | ||
- | |||
- | **SCRIPT.JS for Note Plugin** by --- // | ||
- | |||
- | I have created a script.js file for the note plugin which is used to create a note picker in the toolbar (when editing). It is based on the JavaScript function to create a highlight toolbar in DokuWiki. I hope this becomes standard with the plugin in the future. | ||
- | |||
- | The script.js file is available at: http:// | ||
- | |||
- | You will also need to find an image for the toolbar, the one I am using is probably copywritten, | ||
- | |||
- | There is one bug: When you click the image for the dropdown the options are blank, you must hover over the blank area to show the name in the tooltip. It isn't so much that it is a bug but that I don't know too much JavaScript so I cant fix it. I am sure there is a way to actually show the way the note looks in the picker. | ||
- | |||
- | ---- | ||
- | If you use this plugin a lot you might put the icons in the toolbar. Add following code to ''/ | ||
- | |||
- | < | ||
- | if(toolbar){ toolbar[toolbar.length] = {" | ||
- | if(toolbar){ toolbar[toolbar.length] = {" | ||
- | if(toolbar){ toolbar[toolbar.length] = {" | ||
- | if(toolbar){ toolbar[toolbar.length] = {" | ||
- | </ | ||
- | |||
- | You can use the icons that are distributed with this plugin (resized to 16x16 pixels) and put them in ''/ | ||
- | |||
- | ---- | ||
- | Did not work for me - the only plugin not to work so far - DokuWiki 2007-06-26b - http:// | ||
- | |||
- | ==== new note type ==== | ||
- | |||
- | it would be great if another type would be added - question | ||
- | very often i want to add a note containing a question, and a nice question mark icon would be great .... | ||
- | |||
- | I had the same problem, but I added the following line in syntax.php after the first require_once. Not the best solution, but a simpler solution. | ||
- | |||
- | < | ||
- | echo "< | ||
- | </ | ||
- | Flawless! Thank you! | ||
- | ---- | ||
- | I had to change the permissions from " | ||
- | |||
- | --- | ||
- | for me don't work in date 13/03/2008 and with the last version of DokuWiki... I tried some things you said here but it didn't work. | ||
- | an help?!?! | ||
- | ---- | ||
- | |||
- | __**How to extend the note plugin ?**__ \\ | ||
- | | ||
- | __image :__ store your note type image to the image folder of the plugin, e.g. **check.png** | ||
- | \\ \\ | ||
- | __style.css__ \\ | ||
- | 1.) add your note type to line 1 before the brackets and separate by comma, e.g **, .notecheck** | ||
- | \\ \\ | ||
- | 2.) Add your new style, e.g. | ||
- | .notecheck { | ||
- | /*border: 1px solid #9d9;*/ | ||
- | background-color: | ||
- | background-image: | ||
- | } | ||
- | |||
- | __syntax.php__ | ||
- | 1.) add new note type after line 48 and do not forget to end the line with comma, e.g. | ||
- | ' | ||
- | \\ \\ | ||
- | 2.) set the quantity of types into line 131 behind $data; e.g. for one add type increase from 4 to 5 | ||
- | | ||
- | 3.) define the color by extending the array in line 135 by related expression, e.g. | ||
- | " | ||
- | |||
- | Now you can use it as the other note types, e.g. \\ | ||
- | <note check> | ||
- | The procedure ends here successfully. | ||
- | </ | ||
- | |||
- | ===== Feature requests ===== | ||
- | |||
- | Feature request: It would be nice to be able to disable the display of the icons when you want - thus, this would just display the coloured boxes without the icons. Sometimes this is preferred/ | ||
- | ---- | ||
- | Hello, with the latest DokuWiki release you should be able to use the ' | ||
- | |||
- | ---- | ||
- | **Feature request**: Are there any plans to make the note types configurable by the central configuration? | ||
- | Regards, Sebastian < | ||
- | |||
- | ===== Compatibility with PHP7 ===== | ||
- | Open the file \lib\plugins\note\syntax.php, | ||
- | * Line 79 : replace "& | ||
- | * Line 101 : replace "& | ||
- | Editing those lines will avoid to get a warning on your pages. | ||
- | |||
- | ===== Bug reports ===== | ||
- | |||
- | ==== Compatibility with Dokuwiki syntax ==== | ||
- | **Note Plugin** __// | ||
- | |||
- | dokuwiki/ | ||
- | |||
- | '' | ||
- | |||
- | '' | ||
- | '' | ||
- | |||
- | 2016-06-13 12:36 | ||
- | ==== Broken in May 2008 release ==== | ||
- | |||
- | Testing this with the May 2008 release of DokuWiki the plugin appears broken. The tags display as lessthan TEXT greaterthan symbol without any CSS formatting. Is this a stylesheet problem as checking the source for a test page doesn' | ||
- | |||
- | To fix in the latest version, you should check the permissions of the files/ | ||
- | ---- | ||
- | Even after chmod 755, the plugin is still broken. I use the DokuBook template ... after switching back to the default template, the plugin works ! Something missing with DokuBook template? | ||
- | Thanks for this great plugin! | ||
- | ... Back to DokuBook template and it works now, I don't know why... cache problem? | ||
- | |||
- | ---- | ||
- | If there several paragraphs inside a note, there is no spacing after the first paragraph, but spacing is added as usual in DokuWiki after the 2nd and subsequent paragraphs. Does anyone know why? | ||
- | |||
- | ---- | ||
- | |||
- | I try to add an image. I go to CSS and add the image. Then, I got to the PHP and I insert it into the array. It isn't well? | ||
- | |||
- | ---- | ||
- | FIXME The version (date) which the plugin returns is incorrect. It returns 2006-03-29. Though AFAIK this is the 2008-02-17 release.\\ | ||
- | :!: Would it be useful / wanted if I supply an updated version only " | ||
- | :!: Would it be a great idea to clean this page a bit more? Removing (maybe create a summarized archived list {page|section}) the old, deprecated stuff and keep the necessary stuff in a clean, sectioned page... Let me know if it's okay... | ||
- | |||
- | --- // | ||
- | ---- | ||
- | |||
- | It's OK. ;-) | ||
- | |||
- | ---- | ||
- | |||
- | Does not seem to work out of the box on the 2008-05-05 release; two fixes were needed to make it function. | ||
- | * In " | ||
- | * In " | ||
- | If someone has better solutions I'd love to hear them, I was shooting in the dark on these and was surprised I finally got it to work. // | ||
- | |||
- | ---- | ||
- | |||
- | At first this didn't work for me. It just showed the text that I entered between the note tags. I had used the wiki admin plugin page to install the plugin by entering the URL and clicking install.\\ | ||
- | To fix the problem, I just SSHed into the server and chmod -R 755 the ...plugins/ | ||
- | |||
- | ---- | ||
- | I also installed the 2008-02-17 version via the Plugin Manager but it didn't work out of the box, I had to change the file permissions of the notes directory and everything below it to 755 to make it work, as suggested above. I didn't have shell access to the server but FileZilla 3.0.11 made this task easy as pie. | ||
- | |||
- | ---- | ||
- | |||
- | Doesn' | ||
- | |||
- | |||
- | |||
- | |||
- | ==== Plugin doesn' | ||
- | |||
- | Within DokuWiki tables, the plugin doesn' | ||
- | |||
- | |||
- | ==== Conflict with TOC ==== | ||
- | When a page has a long TOC and a note is placed at the top of the page, the page is rendered in a way that the note comes after the TOC. The area before the note remains empty! (see below) | ||
- | {{http:// | ||
- | |||
- | >Edit lib/ | ||
- | |||
- | >> Does it mean, I should remove the "/ | ||
- | ==== Works in 2009-01-30 (RC1) ==== | ||
- | Works without any modification in 2009-01-30 (RC1) -- John, 6 Febr. 2009 | ||
- | |||
- | ==== Works in DokuWiki-2009-02-14 ==== | ||
- | Works without any modification and ‘Allow embedded HTML’ and 'Allow PHP' turned **off** | ||
- | |||
- | |||
- | ---- | ||
- | I had to clean my DokuWiki cache as said above (delete the content of PathToWiki/ | ||
- | I also used the installation via the Admin> | ||
- | |||
- | == not working with latest DokuWiki == | ||
- | With my latest DokuWiki version, this plugin don't work correctly. Look at http:// | ||
- | > You are using an unsupported note attribute ('' | ||
- | --- // | ||
- | > Yes, I'm stupid ^^ \\ | ||
- | --- //Xarkam 2009/05/18 20:12// | ||
- | |||
- | ---- | ||
- | W3C CSS-Validator reports two errors:\\ | ||
- | .noteclassic, | ||
- | .noteclassic, | ||
- | => ok, these are pre-standard-properties like the upcoming (not yet available) CSS3 property **border-radius**.\\ | ||
- | If someone (like me) wants to have a green CSS validation, those two properties must be commented out.\\ | ||
- | --- // | ||
- | |||
- | ==== for Windows user ==== | ||
- | I'm using DokuWiki on a Stick 2008-05-05. The plugin manager just don't work. It says "The plugin manager was unable to decompress the downloaded file. This maybe as a result of a bad download, in which case you should try again; or the compression format may be unknown, in which case you will need to download and install the plugin manually." | ||
- | |||
- | Thank you Aurélien, please keep going on. This is one of the best plugin. | ||
- | --- // | ||
- | ==== Renders as plain text using " | ||
- | Hello, I am using the latest stable release of DokuWiki, but unfortunately this plugin only works when I'm using the default template, but not " | ||
- | |||
- | * Same here, with monobook the notes render as plain text | ||
- | * Delete / | ||
- | |||
- | [[th-suess@gmx.de|Thomas Süß]] - 2010/11/01 | ||
- | Eliminate problems with addons in Dokuwiki, disable on the Admin Page CSS and Javascript compression, | ||
- | |||
- | ==== Error installing ==== | ||
- | [[mhijkman@afsgroup.nl|Marcel Huijkman]] - 2016/02/18 | ||
- | Warning: Declaration of syntax_plugin_note:: | ||
- | |||
- | PHP7.0 signature errors for **handle()** and **render()**should be fixed now. | ||
- | --- //LarsDW223 2016/09/14 21:38// | ||
- | ==== Had to rename folder ==== | ||
- | After downloading the tar.gz file and uploading via admin page, it created a folder in plugins called dokuwikinote20090615/ | ||
- | |||
- | ==== Had to end the line ==== | ||
- | Guys, how to make end of line marker into note? <br> didn't work, for example |
plugin/note.1527372659.txt.gz · Last modified: by Klap-in