README
1admnote Plugin for DokuWiki
2
3Adds Material-for-MkDocs Admonition notes to Dokuwiki
4
5All documentation for this plugin can be found at
6https://www.vormweg.online/dokuwiki:admnote
7
8If you install this plugin manually, make sure it is installed in
9lib/plugins/admnote/ - if the folder is called different it
10will not work!
11
12Please refer to https://www.dokuwiki.org/plugins for additional info
13on how to install plugins in DokuWiki.
14
15----
16Copyright © Klaus Vormweg <klaus.vormweg@gmx.de>
17
18Copyright CSS-Code: © 2016-2020 Martin Donath <martin.donath@squidfunk.com>
19Available under MIT License
20
21Copyright Material Icons: © Google Inc.
22Available under Apache license version 2.0
23
24This program is free software; you can redistribute it and/or modify
25it under the terms of the GNU General Public License as published by
26the Free Software Foundation; version 2 of the License
27
28This program is distributed in the hope that it will be useful,
29but WITHOUT ANY WARRANTY; without even the implied warranty of
30MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31GNU General Public License for more details.
32
33See the LICENSE file for details
34
README.md
1# Admnote plugin for DokuWiki
2
3## Description
4
5This plugin adds **Material-for-MkDocs Admonition notes** to Dokuwiki (<https://squidfunk.github.io/mkdocs-material/reference/admonitions/>).
6
7Not all features of the Material-for-MkDocs Admonition notes are supported. Notes are not collapsible and you cannot omit the header line.
8
9Some note styles had to be renamed to avoid conflicts with existing DokuWiki base styles.
10
11## License
12
13This plugin is published under the Gnu Public License (GPL) V2.
14
15CSS-Code: © 2016-2020 Martin Donath. Available under MIT License
16
17Material Icons: © Google Inc. Available under Apache license version 2.0
18
19## Installation
20
21Unpack the file in the `/lib/plugin` directory of your Dokuwiki installation. It will create a directory named admnote there. You can also use the extension manager.
22
23## Syntax
24
25This plugin uses the `<adm></adm>` tag pair to start and end a note. The first parameter of the opening tag chooses the note style.
26
27There are twelve styles available: 'abstract', 'bug', 'danger', 'example', 'failure', 'information', 'note', 'question', 'quote', 'achievement', 'tip', 'warning'
28
29### Custom heading
30
31You can replace the standard heading by adding your heading text as a third parameter in the `<adm>` tag:
32
33`<adm warning A very special warning>This is a warning</adm>`
34
35There is no need for quotes in your heading. You cannot use wiki styles in the heading.
36
37### Notes without body
38
39You can also omit the body of the note completely:
40
41`<adm danger Will initiate self destruction if you click this></adm>`
42
43### Default note style
44
45The default style is 'note', so `<adm></adm>` is a valid note although it does not make much sense.
46
47The default style will also be used if you mistype a style.
48
49### Note body
50
51You can use almost every DokuWiki element inside a note body except headers.
52
53## Dokuwiki compatibility
54
55This plugin was made for DokuWiki Release 2020-07-29 "Hogfather". It may work with earlier releases but that is untested.
56
57## ToDo
58
59* Support export into ODT format
60* Support more languages (help needed)
61