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