xref: /template/navigator/README.md (revision 3725eb1061367cacaa78e363cfba208f7a1ca8f5)
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.
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
261. **Download** the latest release ZIP from the GitHub **Releases** page.
272. **Unzip** the archive.
283. **Upload** the `navigator/` folder to your DokuWiki installation:
29
30   ```text
31   lib/tpl/navigator/
32
334. In DokuWiki’s Configuration Manager, set the template to: **navigator**
34
35The **NavigatorLabels** plugin is included inside the theme and activates automatically once you move it to lib/plugins/.
36
37Included plugin: `NavigatorLabels`
38Navigator bundles a small companion plugin that allows administrators to redefine interface labels without editing core language files.
39
40It lives inside:  `navigator/navigatorlabels/`
41
42This plugin is a must for the top bar to work as intended. It helps keep the theme adaptable across languages and contexts.
43
44## Folder structure
45
46navigator/
47  css/              Theme stylesheets
48  conf/             Configuration defaults
49  fonts/            Bundled typefaces
50  images/           Theme images and icons
51  lang/             Language files
52  navigatorlabels/  Included plugin
53  LICENSE.txt       MIT license for original work
54  COPYING           GPL license for inherited components
55
56## Licensing
57
58Navigator is released under the MIT License for all original work.
59Some bundled components are licensed under the GNU General Public License (GPL) as required by DokuWiki’s inheritance model.
60
61See the included `LICENSE.txt` and `COPYING` files for full details.
62
63## Contributing
64
65Navigator is designed with clarity and maintainability in mind.
66Contributions, refinements, and accessibility improvements are welcome.
67
68## Releases
69
70Stable versions are available on the GitHub Releases page.
71Each release includes a ready-to-install ZIP package.
72
73
74
75