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### NOTE for Navigator updates: 27 28Please backup your tempstyles_navigator.css file if you have written style rules in there. <br> 29This file is normally empty. <br> 30You may override it after the update. 31 32### Install via Extension Manager (Recommended) 33 341. Go to **Admin → Extension Manager** 352. Search for **Navigator** 363. Click **Install** 37 38DokuWiki will automatically install: 39- the **Navigator** template 40- the bundled **NavigatorLabels** plugin 41 42No manual steps are required. 43 444. In **Admin → Configuration → Template**, select: 45 46 `navigator` 47 48--- 49 50### Manual Installation (Alternative) 51 521. Download the latest release ZIP from GitHub 532. Unzip it locally 543. Upload the internal `navigator/` folder to: 55 56 `<your_wiki>/lib/tpl/` 57 584. Upload the bundled `navigatorlabels/` plugin folder to: 59 60 `<your_wiki>/lib/plugins/` 61 625. In **Admin → Configuration → Template**, select: 63 64 `navigator` 65 66--- 67 68### Optional: Rebuild the index 69 70If you imported pages from another wiki, visit your bin folder and run the following command: 71 72`php indexer.php -c` 73 74 75### Activate the theme 76- Go to **Admin → Configuration → Template** 77- Select: `navigator` 78- Save the configuration. 79 80 81### About the NavigatorLabels Plugin 82 83The NavigatorLabels plugin is bundled with the theme <br> 84and installed automatically when using the Extension Manager. 85 86It provides: 87 88- multilingual sorting rules 89- customizable vocabulary for the top bar 90- helper functions used by the theme 91 92The authoritative version will also be listed as a standalone plugin on DokuWiki.org and available at GitHub. 93 94## Folder structure 95 96- navigator/ 97 - css/ Theme stylesheets 98 - conf/ Configuration defaults 99 - fonts/ Bundled typefaces 100 - images/ Theme images and icons 101 - lang/ Language files 102 - navigatorlabels/ Included plugin. Move it to the plugins folder. 103 - LICENSE.txt MIT license for original work 104 - COPYING GPL license for inherited components 105 106## Licensing 107 108Navigator is released under the MIT License for all original work. 109Some bundled components are licensed under the GNU General Public License (GPL) as required by DokuWiki’s inheritance model. 110 111See the included `LICENSE.txt` and `COPYING` files for full details. 112 113## Contributing 114 115Navigator is shaped by a single hand for now, to preserve its clarity and voice. 116Suggestions are welcome, and the project is open for anyone to fork and build upon. 117 118 119## Releases 120 121Stable versions are available on the GitHub Releases page, each with a ready‑to‑install ZIP package. 122 123The `NavigatorLabels` plugin is bundled with the theme but it will be published independently as well. 124The theme and plugin releases submissions to DokuWiki.org will follow later this week. 125 126 127 128 129