Navigator

A Theme for DokuWiki

User Tools

Site Tools


start

Navigator for DokuWiki — Official Demo

Navigator is a new, structured theme for DokuWiki, built on top of DokuWiki's current default front view template.
It has been tested with both the Librarian and Mort wiki engines.

This site showcases the Navigator theme and, specifically, its top‑bar navigation system for organizing documentation, knowledge bases, technical manuals, educational content, and personal wikis.
Further down the page you may also see a list of other sites using Navigator.

After installing DokuWiki in your server, you can then add Navigator through the Extensions Manager to provide an immediate organizational structure to your data. The theme automatically builds topic lists from DokuWiki namespaces and presents them in a clear, discoverable navigation menu.

Terminology examples:

doku.php?id=about:start
doku.php?id=about:how_navigator_displays_content

'about' is the namespace 
 and it will be listed alphabetically on the Topics menu
 as 'About'. 

'start' is the path to the first page on the topic. 
  It's the view page for the articles list.

'how_navigator_displays_content' is a page path. 
  It will be displayed chronologically in the list of articles.
  The list can be sorted by using the topbar buttons.
  The H1 title in the article is how it displays on the list.

The result is a predictable, book‑like experience where articles naturally group themselves by topic.
As content grows, navigation remains simple because the structure derives directly from the wiki's namespace hierarchy, avoiding erratic manual configurations.


What is the Navigator used for on DokuWiki?

The Navigator, a front view template, is especially useful for displaying:

  • Technical documentation
  • Knowledge bases
  • Educational wikis
  • Programming tutorials
  • Internal team documentation
  • Personal knowledge management systems

Because navigation is namespace‑driven, authors can focus on creating content while Navigator keeps related topics organized and easy to find.

For tutorial chapters, follow the “Tutorial” link at the end of this page.


Other wikis using Navigator

Each of the following wikis have their own customized colors and preferences.
All customizations are done via the offical DokuWiki's configuration menu.

  • PHP Primer — Modern PHP learning resources and tutorials (Mort + Navigator)
  • CSS Primer — CSS learning resources and tutorials

daisy flowers: a new beginning


How topics work in Navigator

Navigator uses DokuWiki namespaces to automatically create topic-oriented navigation menus.

Each topic in the top navigation bar corresponds to a namespace, making it easy to organize documentation, knowledge bases, tutorials, reference material, and personal wiki content into predictable categories.

This is an overview of the concept. The tutorial pages will get into more detail on how to create pages.

Key behavior:

  1. Topic categories are generated automatically from DokuWiki namespaces.
  2. Only namespaces with a valid start page are displayed in the Topics menu.
    start is DokuWiki's default pathname for each topic's first landing page.
  3. Selecting a topic from the menu opens the namespace start page.
  4. Topic start pages can act as introductions, landing pages, or documentation indexes.
  5. We can also have topics without a start page. Those topics will be excluded from the Topics menu.

Additionally, to enable automatic article listings within a topic, add the following marker to the namespace start page (just copy/paste):

~~AUTOINDEX~~

The marker instructs Navigator to automatically display a list of articles belonging to that namespace.

You can place the marker by itself or beneath your own introduction text.
The marker remains invisible when the page is rendered.

If you don't add this marker to the start page, you may still create your own list of pages or articles manually for that particular topic.

NOTE: The marker becomes invisible through the NavigatorLabels plugin, which is installed automatically when Navigator is installed through DokuWiki's Extension Manager.

The result is a self-maintaining documentation structure where articles are automatically grouped by topic and presented in easy-to-browse lists.


Tutorials

→ Tutorial.


How to navigate this demo site

  • Aside from the “Tutorial” link above,
    use the Topics menu at the top↑ to browse topic areas
    and discover how Navigator organizes content.
  • Click the site title at any time to return to this page.

Written, curated and maintained by
Tony de Araujo

—New York | Lisbon
a labor of love


start.txt · Last modified: by editor