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### Method 1. Manual installation (unzip + upload) 27 28Use this method if you prefer to install extensions manually. 29 301. Download the latest release ZIP from GitHub: 31(https://github.com/iContemp/navigator-theme/releases) 32 332. Unzip the file on your system. 34 353. Upload the internal `navigator/` folder to: 36 37 <your_wiki>/lib/tpl/ 38 394. In DokuWiki’s Configuration Manager, set the template to: 40 41 `navigator` 425. The bundled NavigatorLabels plugin will be installed automatically <br> 43when you install Navigator theme via the Extension Manager.<br> 44If you are installing the theme manually, move the included plugin folder to: 45 `<your_wiki>/lib/plugins/` 46 47### Method 2. Install via Extension Manager (Recommended) 48 49This is the simplest and cleanest method. 50 511. Go to Admin → Extension Manager → Manual Install 522. Copy the direct URL of the release ZIP from GitHub 533. Paste it into the Install from URL field 544. Click Install 55 56DokuWiki will automatically install: 57- the Navigator theme 58- the NavigatorLabels plugin 59 60No manual steps are required. 61 62### Activate the theme 63- Go to **Admin → Configuration → Template** 64- Select: `navigator` 65- Save the configuration. 66 67### (Optional) Rebuild the index after copying content 68 69If you imported pages from another wiki, rebuild the index:<br> 70`php bin/indexer.php -c`<br> 71This ensures autolists and sorting work correctly. 72 73### About the NavigatorLabels Plugin 74 75The NavigatorLabels plugin is bundled with the theme <br> 76and installed automatically when using the Extension Manager. 77 78It provides: 79 80- multilingual sorting rules 81- customizable vocabulary for the top bar 82- helper functions used by the theme 83 84The authoritative version will also be available as a standalone plugin on DokuWiki.org once published. 85 86## Folder structure 87 88- navigator/ 89 - css/ Theme stylesheets 90 - conf/ Configuration defaults 91 - fonts/ Bundled typefaces 92 - images/ Theme images and icons 93 - lang/ Language files 94 - navigatorlabels/ Included plugin. Move it to the plugins folder. 95 - LICENSE.txt MIT license for original work 96 - COPYING GPL license for inherited components 97 98## Licensing 99 100Navigator is released under the MIT License for all original work. 101Some bundled components are licensed under the GNU General Public License (GPL) as required by DokuWiki’s inheritance model. 102 103See the included `LICENSE.txt` and `COPYING` files for full details. 104 105## Contributing 106 107Navigator is shaped by a single hand for now, to preserve its clarity and voice. 108Suggestions are welcome, and the project is open for anyone to fork and build upon. 109 110 111## Releases 112 113Stable versions are available on the GitHub Releases page, each with a ready‑to‑install ZIP package. 114 115The `NavigatorLabels` plugin is bundled with the theme but it will be published independently as well. 116The theme and plugin releases submissions to DokuWiki.org will follow later this week. 117 118 119 120 121