xref: /template/navigator/README.md (revision e5f5bfec4aee7e31ccf5bd738723d93c4cbeb043)
10f9ccf47Stony-de-araujo# Navigator Theme for DokuWiki
20f9ccf47Stony-de-araujo
3977efacaStony-de-araujo**Live Demo:** https://icontemp.com/wiki/navigator/
4977efacaStony-de-araujo
50f9ccf47Stony-de-araujoNavigator is a clean, modern, and intentionally minimal theme for DokuWiki.
60f9ccf47Stony-de-araujoIt focuses on clarity, readability, and a calm visual rhythm—where content feels at home and navigation stays out of the way.
70f9ccf47Stony-de-araujo
80f9ccf47Stony-de-araujoThe theme includes the **NavigatorLabels** plugin, providing a lightweight vocabulary layer that lets administrators rename UI elements without modifying core files.
90f9ccf47Stony-de-araujo
100f9ccf47Stony-de-araujo---
110f9ccf47Stony-de-araujo
120f9ccf47Stony-de-araujo## Features
130f9ccf47Stony-de-araujo
140f9ccf47Stony-de-araujo- **Calm layout:** Designed for long-form reading without visual noise
150f9ccf47Stony-de-araujo- **Accessible typography:** Balanced spacing and legible fonts
160f9ccf47Stony-de-araujo- **Responsive design:** Works on phones, tablets, and desktops
170f9ccf47Stony-de-araujo- **Modular structure:** Easy to customize and extend
180f9ccf47Stony-de-araujo- **Bundled plugin:** Built-in support for the NavigatorLabels plugin
190f9ccf47Stony-de-araujo- **Clear separation:** Theme assets, configuration, and language files are neatly organized
200f9ccf47Stony-de-araujo- **Mixed licensing:** MIT-licensed original work with bundled GPL components where required
210f9ccf47Stony-de-araujo
220f9ccf47Stony-de-araujo---
230f9ccf47Stony-de-araujo
240f9ccf47Stony-de-araujo## Installation
250f9ccf47Stony-de-araujo
260f9ccf47Stony-de-araujo1. **Download** the latest release ZIP from the GitHub **Releases** page.
27*e5f5bfecSTony de AraujoUse navigator.zip for installation. The auto‑generated source archives are not installable theme packages.
28*e5f5bfecSTony de Araujo2. **Unzip** navigator.zip once it's in your system or server.
29*e5f5bfecSTony de Araujo3. **Upload** the internal `navigator/` folder to your DokuWiki installation in :
300f9ccf47Stony-de-araujo
31*e5f5bfecSTony de Araujo   `<your_wiki>/lib/tpl/     <navigator>`
320f9ccf47Stony-de-araujo
330f9ccf47Stony-de-araujo4. In DokuWiki’s Configuration Manager, set the template to: **navigator**
340f9ccf47Stony-de-araujo
35278320eeStony-de-araujo5. **Included plugin**: `NavigatorLabels`
360f9ccf47Stony-de-araujo
37*e5f5bfecSTony de AraujoFor your convenience, the **NavigatorLabels** plugin is included inside the theme. You must move it to `<your_wiki>/lib/plugins/` to activate it.
38278320eeStony-de-araujo
39*e5f5bfecSTony de AraujoAlternatively, you can upload it via the extension manager from your local system Navigator copy.
400f9ccf47Stony-de-araujo
413725eb10Stony-de-araujoThis plugin is a must for the top bar to work as intended. It helps keep the theme adaptable across languages and contexts.
420f9ccf47Stony-de-araujo
430f9ccf47Stony-de-araujo## Folder structure
440f9ccf47Stony-de-araujo
450f9ccf47Stony-de-araujonavigator/
460f9ccf47Stony-de-araujo  css/              Theme stylesheets
470f9ccf47Stony-de-araujo  conf/             Configuration defaults
480f9ccf47Stony-de-araujo  fonts/            Bundled typefaces
490f9ccf47Stony-de-araujo  images/           Theme images and icons
500f9ccf47Stony-de-araujo  lang/             Language files
51*e5f5bfecSTony de Araujo  navigatorlabels/  Included plugin. Move it to the plugins folder.
520f9ccf47Stony-de-araujo  LICENSE.txt       MIT license for original work
530f9ccf47Stony-de-araujo  COPYING           GPL license for inherited components
540f9ccf47Stony-de-araujo
550f9ccf47Stony-de-araujo## Licensing
560f9ccf47Stony-de-araujo
570f9ccf47Stony-de-araujoNavigator is released under the MIT License for all original work.
580f9ccf47Stony-de-araujoSome bundled components are licensed under the GNU General Public License (GPL) as required by DokuWiki’s inheritance model.
590f9ccf47Stony-de-araujo
600f9ccf47Stony-de-araujoSee the included `LICENSE.txt` and `COPYING` files for full details.
610f9ccf47Stony-de-araujo
620f9ccf47Stony-de-araujo## Contributing
630f9ccf47Stony-de-araujo
64a630278bStony-de-araujoNavigator is shaped by a single hand for now, to preserve its clarity and voice.
65a630278bStony-de-araujoSuggestions are welcome, and the project is open for anyone to fork and build upon.
66a630278bStony-de-araujo
670f9ccf47Stony-de-araujo
680f9ccf47Stony-de-araujo## Releases
690f9ccf47Stony-de-araujo
70bf422972Stony-de-araujoStable versions are available on the GitHub Releases page, each with a ready‑to‑install ZIP package.
71bf422972Stony-de-araujo
72c019285bSTony de AraujoThe `NavigatorLabels` plugin is bundled with the theme but it will be published independently as well.
73*e5f5bfecSTony de AraujoThe theme and plugin releases submissions to DokuWiki.org will follow later this week.
74bf422972Stony-de-araujo
750f9ccf47Stony-de-araujo
760f9ccf47Stony-de-araujo
770f9ccf47Stony-de-araujo
78