xref: /template/navigator/README.md (revision 0f9ccf4702859962b7225d236391acf593e7a35e)
1# Navigator Theme for DokuWiki
2
3Navigator is a clean, modern, and intentionally minimal theme for DokuWiki.
4It focuses on clarity, readability, and a calm visual rhythm—where content feels at home and navigation stays out of the way.
5
6The theme includes the **NavigatorLabels** plugin, providing a lightweight vocabulary layer that lets administrators rename UI elements without modifying core files.
7
8---
9
10## Features
11
12- **Calm layout:** Designed for long-form reading without visual noise
13- **Accessible typography:** Balanced spacing and legible fonts
14- **Responsive design:** Works on phones, tablets, and desktops
15- **Modular structure:** Easy to customize and extend
16- **Bundled plugin:** Built-in support for the NavigatorLabels plugin
17- **Clear separation:** Theme assets, configuration, and language files are neatly organized
18- **Mixed licensing:** MIT-licensed original work with bundled GPL components where required
19
20---
21
22## Installation
23
241. **Download** the latest release ZIP from the GitHub **Releases** page.
252. **Unzip** the archive.
263. **Upload** the `navigator/` folder to your DokuWiki installation:
27
28   ```text
29   lib/tpl/navigator/
30
314. In DokuWiki’s Configuration Manager, set the template to: **navigator**
32
33The NavigatorLabels plugin is included inside the theme and activates automatically.
34
35Included plugin: `NavigatorLabels`
36Navigator bundles a small companion plugin that allows administrators to redefine interface labels without editing core language files.
37
38It lives inside:  `navigator/navigatorlabels/`
39
40This plugin is optional but recommended—it helps keep the theme adaptable across languages and contexts.
41
42## Folder structure
43
44navigator/
45  css/              Theme stylesheets
46  conf/             Configuration defaults
47  fonts/            Bundled typefaces
48  images/           Theme images and icons
49  lang/             Language files
50  navigatorlabels/  Included plugin
51  LICENSE.txt       MIT license for original work
52  COPYING           GPL license for inherited components
53
54## Licensing
55
56Navigator is released under the MIT License for all original work.
57Some bundled components are licensed under the GNU General Public License (GPL) as required by DokuWiki’s inheritance model.
58
59See the included `LICENSE.txt` and `COPYING` files for full details.
60
61## Contributing
62
63Navigator is designed with clarity and maintainability in mind.
64Contributions, refinements, and accessibility improvements are welcome.
65
66## Releases
67
68Stable versions are available on the GitHub Releases page.
69Each release includes a ready-to-install ZIP package.
70
71
72
73