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