1fd53bf6eSDaniel Hofer# Fontello Plugin for DokuWiki 2fd53bf6eSDaniel Hofer 3fd53bf6eSDaniel HoferImport a local Fontello ZIP package and use its icons in DokuWiki pages with simple `<icon:name>` syntax. 4fd53bf6eSDaniel Hofer 5fd53bf6eSDaniel HoferThe plugin stores the imported Fontello CSS and font files locally inside the DokuWiki installation. It does not load fonts from a CDN or any other remote source. 6fd53bf6eSDaniel Hofer 7fd53bf6eSDaniel Hofer## Features 8fd53bf6eSDaniel Hofer 9fd53bf6eSDaniel Hofer- Import a ZIP package downloaded from https://fontello.com 10fd53bf6eSDaniel Hofer- Render icons in regular DokuWiki page content with `<icon:name>` 11fd53bf6eSDaniel Hofer- Render icons in headings 12fd53bf6eSDaniel Hofer- Show icons in the table of contents, with optional per-icon control 13fd53bf6eSDaniel Hofer- Enable or disable icons for the editor toolbar picker in the admin panel 14fd53bf6eSDaniel Hofer- Works with the Read the Dokus template 15fd53bf6eSDaniel Hofer- Includes compatibility handling for the catlist plugin 16fd53bf6eSDaniel Hofer 17fd53bf6eSDaniel Hofer## Usage 18fd53bf6eSDaniel Hofer 19fd53bf6eSDaniel HoferUpload a Fontello ZIP package in the DokuWiki admin area. 20fd53bf6eSDaniel Hofer 21fd53bf6eSDaniel HoferAfter the import, use icons in page content like this: 22fd53bf6eSDaniel Hofer 23fd53bf6eSDaniel Hofer```text 24fd53bf6eSDaniel Hofer<icon:ok> 25fd53bf6eSDaniel Hofer<icon:download> 26fd53bf6eSDaniel Hofer<icon:mail> 27fd53bf6eSDaniel Hofer``` 28fd53bf6eSDaniel Hofer 29fd53bf6eSDaniel HoferFor headings and table-of-contents behavior: 30fd53bf6eSDaniel Hofer 31fd53bf6eSDaniel Hofer```text 32fd53bf6eSDaniel Hofer<icon:ok|toc> 33fd53bf6eSDaniel Hofer<icon:ok|notoc> 34fd53bf6eSDaniel Hofer``` 35fd53bf6eSDaniel Hofer 36fd53bf6eSDaniel HoferUnknown icons are left visible as their original syntax so missing or mistyped icon names can be spotted easily. 37fd53bf6eSDaniel Hofer 38fd53bf6eSDaniel Hofer## Administration 39fd53bf6eSDaniel Hofer 40fd53bf6eSDaniel HoferThe admin page shows the currently imported Fontello package, its CSS prefix, the number of detected icons, and a preview of each icon. 41fd53bf6eSDaniel Hofer 42fd53bf6eSDaniel HoferIcons can be enabled or disabled for the toolbar picker. This only controls which icons are offered in the editor picker; imported icons can still be rendered with `<icon:name>` syntax. 43fd53bf6eSDaniel Hofer 44fd53bf6eSDaniel Hofer## Compatibility 45fd53bf6eSDaniel Hofer 46fd53bf6eSDaniel HoferTested with: 47fd53bf6eSDaniel Hofer 48fd53bf6eSDaniel Hofer- regular DokuWiki page content 49fd53bf6eSDaniel Hofer- headings 50fd53bf6eSDaniel Hofer- the Read the Dokus template 51fd53bf6eSDaniel Hofer- the catlist plugin 52*d4dd808bSDaniel Hofer 53*d4dd808bSDaniel Hofer## Copyright and License 54*d4dd808bSDaniel Hofer 55*d4dd808bSDaniel HoferCopyright (C) 2026 Daniel Hofer <dev@dhtraining.ch> 56*d4dd808bSDaniel Hofer 57*d4dd808bSDaniel HoferThis program is free software; you can redistribute it and/or modify 58*d4dd808bSDaniel Hoferit under the terms of the GNU General Public License as published by 59*d4dd808bSDaniel Hoferthe Free Software Foundation; version 2 of the License. 60*d4dd808bSDaniel Hofer 61*d4dd808bSDaniel HoferThis program is distributed in the hope that it will be useful, 62*d4dd808bSDaniel Hoferbut WITHOUT ANY WARRANTY; without even the implied warranty of 63*d4dd808bSDaniel HoferMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 64*d4dd808bSDaniel Hofer 65*d4dd808bSDaniel HoferSee the LICENSE file for details.