• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..Today-

images/H29-Jun-2020-

lang/H29-Jun-2020-3618

CHANGES.mdH A D28-Jun-20201.2 KiB3130

COPYINGH A D28-Jun-202017.6 KiB341281

README.mdH A D28-Jun-20202.5 KiB7753

action.phpH A D28-Jun-20202.1 KiB6146

odt.cssH A D28-Jun-2020772 3833

plugin.info.txtH A D28-Jun-2020272 87

style.cssH A D28-Jun-2020901 4539

syntax.phpH A D28-Jun-20209.7 KiB281180

README.md

1# DokuWiki Note plugin
2
3A plugin for [DokuWiki](https://www.dokuwiki.org/) which allows users to easily insert four kinds of notes into the wiki pages.
4
5## Usage
6
7When you have it installed, use the following syntax `<note>message</note>`:
8
9    <note>note</note>
10![note](images/doc/note.png)
11
12You can use the note keywords `important`, `warning` and `tip` to change the look of note as well
13
14    <note important>important</note>
15![note](images/doc/note_important.png)
16
17    <note tip>tip</note>
18![note](images/doc/note_tip.png)
19
20    <note warning>warning</note>
21![note](images/doc/note_warning.png)
22
23## Notes
24
25It is regularly reported that the cache needs to be cleaned after installing the plugin before the notes do showup. At least a full page-reload (CTRL-F5) is required.
26
27## Limitations
28
29Currently this plugin has some limitations:
30
31 * Plugin won't work inside numbered lists
32 * Plugin won't work inside tables
33
34## Download / Installation
35
36 See [DokuWiki's plugin page](https://www.dokuwiki.org/plugin:note)
37
38Alternatively
39 1. Download plugin/repo archive
40 2. Installing the plugin:
41    * You can either extract the archive into the <tt>lib/plugins</tt> directory or
42    * Load the admin page and go to Manage Plugins and enter the URL of the plugin under Download and install the new plugin.-
43 3. Update the `Configuration Settings` under the DokuWiki's admin page.
44
45## Authors
46
47 The plugin has been written from scratch by Olivier Cortéz. After the initial release it has been maintained
48 by Olivier while he integrated several patches provided by the DokuWiki-community. Somewhere around the end
49 of 2008 / start of 2009 Olivier started to became too busy with other (real-life) activities and occupations
50 that active development and support halted. On 2009/06/15 Aurélien Bompard decided, after contacting
51 Olivier Cortéz about it, to (temporarily) take-over maintenance and support for the plugin. On the
52 same date Mischa The Evil opened a [GitHub-repository for the plugin](https://github.com/MischaTheEvil/dokuwiki_note)
53 to make it a "real" community plugin. On the 16th a re-packaged release is available
54 which "completed" the plugin (doc, license etc.).
55
56## Credits
57
58Many thanks to the following DokuWiki developers (in random order):
59
60* Stephane Chamberland
61* Carl-Christian Salvesen
62* Eric Hameleers
63* Christopher Smith
64* Chris Lale
65* Pixote
66* Yves Bergeron
67* Taylor Jones
68* Luke
69* Frédéric
70* Kmosak
71* foosel
72* zerohalo
73
74## License
75
76This plugin is open-source and licensed under the GNU GPL v.2.
77