1# Navigator Theme for DokuWiki 2 3**Live Demo:** https://icontemp.com/wiki/navigator/ 4 5Navigator is a clean, modern, and intentionally minimal theme for DokuWiki based on the current default unit. 6It focuses on clarity, readability, and a calm visual rhythm—where content feels at home and navigation stays out of the way. 7 8The theme includes the **NavigatorLabels** plugin, providing a lightweight vocabulary layer that lets administrators rename UI elements without modifying core files. 9 10--- 11 12## Features 13 14- **Calm layout:** Designed for long-form reading without visual noise 15- **Accessible typography:** Balanced spacing and legible fonts 16- **Responsive design:** Works on phones, tablets, and desktops 17- **Modular structure:** Easy to customize and extend 18- **Bundled plugin:** Built-in support for the NavigatorLabels plugin 19- **Clear separation:** Theme assets, configuration, and language files are neatly organized 20- **Mixed licensing:** MIT-licensed original work with bundled GPL components where required 21 22--- 23 24## Installation 25 26### Install via Extension Manager (Recommended) 27 281. Go to **Admin → Extension Manager** 292. Search for **Navigator** 303. Click **Install** 31 32DokuWiki will automatically install: 33- the **Navigator** template 34- the bundled **NavigatorLabels** plugin 35 36No manual steps are required. 37 384. In **Admin → Configuration → Template**, select: 39 40 `navigator` 41 42--- 43 44### Manual Installation (Alternative) 45 461. Download the latest release ZIP from GitHub 472. Unzip it locally 483. Upload the internal `navigator/` folder to: 49 50 `<your_wiki>/lib/tpl/` 51 524. Upload the bundled `navigatorlabels/` plugin folder to: 53 54 `<your_wiki>/lib/plugins/` 55 565. In **Admin → Configuration → Template**, select: 57 58 `navigator` 59 60--- 61 62### Optional: Rebuild the index 63 64If you imported pages from another wiki, visit your bin folder and run the following command: 65 66`php indexer.php -c` 67 68 69### Activate the theme 70- Go to **Admin → Configuration → Template** 71- Select: `navigator` 72- Save the configuration. 73 74 75### About the NavigatorLabels Plugin 76 77The NavigatorLabels plugin is bundled with the theme <br> 78and installed automatically when using the Extension Manager. 79 80It provides: 81 82- multilingual sorting rules 83- customizable vocabulary for the top bar 84- helper functions used by the theme 85 86The authoritative version will also be listed as a standalone plugin on DokuWiki.org and available at GitHub. 87 88## Folder structure 89 90- navigator/ 91 - css/ Theme stylesheets 92 - conf/ Configuration defaults 93 - fonts/ Bundled typefaces 94 - images/ Theme images and icons 95 - lang/ Language files 96 - navigatorlabels/ Included plugin. Move it to the plugins folder. 97 - LICENSE.txt MIT license for original work 98 - COPYING GPL license for inherited components 99 100## Licensing 101 102Navigator is released under the MIT License for all original work. 103Some bundled components are licensed under the GNU General Public License (GPL) as required by DokuWiki’s inheritance model. 104 105See the included `LICENSE.txt` and `COPYING` files for full details. 106 107## Contributing 108 109Navigator is shaped by a single hand for now, to preserve its clarity and voice. 110Suggestions are welcome, and the project is open for anyone to fork and build upon. 111 112 113## Releases 114 115Stable versions are available on the GitHub Releases page, each with a ready‑to‑install ZIP package. 116 117The `NavigatorLabels` plugin is bundled with the theme but it will be published independently as well. 118The theme and plugin releases submissions to DokuWiki.org will follow later this week. 119 120 121 122 123