xref: /template/navigator/README.md (revision e5f5bfec4aee7e31ccf5bd738723d93c4cbeb043)
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.
27Use navigator.zip for installation. The auto‑generated source archives are not installable theme packages.
282. **Unzip** navigator.zip once it's in your system or server.
293. **Upload** the internal `navigator/` folder to your DokuWiki installation in :
30
31   `<your_wiki>/lib/tpl/     <navigator>`
32
334. In DokuWiki’s Configuration Manager, set the template to: **navigator**
34
355. **Included plugin**: `NavigatorLabels`
36
37For your convenience, the **NavigatorLabels** plugin is included inside the theme. You must move it to `<your_wiki>/lib/plugins/` to activate it.
38
39Alternatively, you can upload it via the extension manager from your local system Navigator copy.
40
41This plugin is a must for the top bar to work as intended. It helps keep the theme adaptable across languages and contexts.
42
43## Folder structure
44
45navigator/
46  css/              Theme stylesheets
47  conf/             Configuration defaults
48  fonts/            Bundled typefaces
49  images/           Theme images and icons
50  lang/             Language files
51  navigatorlabels/  Included plugin. Move it to the plugins folder.
52  LICENSE.txt       MIT license for original work
53  COPYING           GPL license for inherited components
54
55## Licensing
56
57Navigator is released under the MIT License for all original work.
58Some bundled components are licensed under the GNU General Public License (GPL) as required by DokuWiki’s inheritance model.
59
60See the included `LICENSE.txt` and `COPYING` files for full details.
61
62## Contributing
63
64Navigator is shaped by a single hand for now, to preserve its clarity and voice.
65Suggestions are welcome, and the project is open for anyone to fork and build upon.
66
67
68## Releases
69
70Stable versions are available on the GitHub Releases page, each with a ready‑to‑install ZIP package.
71
72The `NavigatorLabels` plugin is bundled with the theme but it will be published independently as well.
73The theme and plugin releases submissions to DokuWiki.org will follow later this week.
74
75
76
77
78