1*fd53bf6eSDaniel Hofer# Fontello Plugin for DokuWiki 2*fd53bf6eSDaniel Hofer 3*fd53bf6eSDaniel HoferImport a local Fontello ZIP package and use its icons in DokuWiki pages with simple `<icon:name>` syntax. 4*fd53bf6eSDaniel Hofer 5*fd53bf6eSDaniel 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. 6*fd53bf6eSDaniel Hofer 7*fd53bf6eSDaniel Hofer## Features 8*fd53bf6eSDaniel Hofer 9*fd53bf6eSDaniel Hofer- Import a ZIP package downloaded from https://fontello.com 10*fd53bf6eSDaniel Hofer- Render icons in regular DokuWiki page content with `<icon:name>` 11*fd53bf6eSDaniel Hofer- Render icons in headings 12*fd53bf6eSDaniel Hofer- Show icons in the table of contents, with optional per-icon control 13*fd53bf6eSDaniel Hofer- Enable or disable icons for the editor toolbar picker in the admin panel 14*fd53bf6eSDaniel Hofer- Works with the Read the Dokus template 15*fd53bf6eSDaniel Hofer- Includes compatibility handling for the catlist plugin 16*fd53bf6eSDaniel Hofer 17*fd53bf6eSDaniel Hofer## Usage 18*fd53bf6eSDaniel Hofer 19*fd53bf6eSDaniel HoferUpload a Fontello ZIP package in the DokuWiki admin area. 20*fd53bf6eSDaniel Hofer 21*fd53bf6eSDaniel HoferAfter the import, use icons in page content like this: 22*fd53bf6eSDaniel Hofer 23*fd53bf6eSDaniel Hofer```text 24*fd53bf6eSDaniel Hofer<icon:ok> 25*fd53bf6eSDaniel Hofer<icon:download> 26*fd53bf6eSDaniel Hofer<icon:mail> 27*fd53bf6eSDaniel Hofer``` 28*fd53bf6eSDaniel Hofer 29*fd53bf6eSDaniel HoferFor headings and table-of-contents behavior: 30*fd53bf6eSDaniel Hofer 31*fd53bf6eSDaniel Hofer```text 32*fd53bf6eSDaniel Hofer<icon:ok|toc> 33*fd53bf6eSDaniel Hofer<icon:ok|notoc> 34*fd53bf6eSDaniel Hofer``` 35*fd53bf6eSDaniel Hofer 36*fd53bf6eSDaniel HoferUnknown icons are left visible as their original syntax so missing or mistyped icon names can be spotted easily. 37*fd53bf6eSDaniel Hofer 38*fd53bf6eSDaniel Hofer## Administration 39*fd53bf6eSDaniel Hofer 40*fd53bf6eSDaniel HoferThe admin page shows the currently imported Fontello package, its CSS prefix, the number of detected icons, and a preview of each icon. 41*fd53bf6eSDaniel Hofer 42*fd53bf6eSDaniel 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. 43*fd53bf6eSDaniel Hofer 44*fd53bf6eSDaniel Hofer## Compatibility 45*fd53bf6eSDaniel Hofer 46*fd53bf6eSDaniel HoferTested with: 47*fd53bf6eSDaniel Hofer 48*fd53bf6eSDaniel Hofer- regular DokuWiki page content 49*fd53bf6eSDaniel Hofer- headings 50*fd53bf6eSDaniel Hofer- the Read the Dokus template 51*fd53bf6eSDaniel Hofer- the catlist plugin 52