Navigator

A Theme for DokuWiki

User Tools

Site Tools


wiki:custom_link_demo

Custom Link Button

The Custom Link button in the Navigator top bar is an optional slot you can use to point visitors to an important destination. It appears to the right of the sorting controls:

Topics • Sort • Custom Link

This button is fully customizable. You can rename it, change its destination, choose whether it opens in a new tab, or disable it entirely.


What This Button Is For

Every wiki has a place that deserves special attention:

  • a forum or community space
  • a main website or project hub
  • a documentation portal
  • a “Start Here” or onboarding page
  • a support or contact page
  • any internal or external page you want to highlight

The Custom Link button gives you a simple way to direct users there.


How to Change the Label

You can rename the button directly in the Navigator Labels configuration:

Admin → Configuration Settings → Navigator Labels

Look for:

Custom Link label

Change it to anything you like:

  • Forum
  • Portal
  • Docs
  • Dashboard
  • Help
  • Start Here
  • Leave it blank to disable

How to Change the Destination

The Custom Link destination is also configured in the same place:

Admin → Configuration Settings → Navigator Labels

Look for:

Custom Link URL

You may use:

  • internal pages (e.g., `wiki:welcome`)
  • external URLs (e.g., `https://example.com`)
  • relative wiki IDs

Navigator automatically detects whether the value is an internal page or an external link.


If you want the Custom Link to open in a new browser tab, enable:

Open Custom Link in new tab

This option is also found in the Navigator Labels configuration.


Disabling the Button

To hide the Custom Link button entirely, simply clear the label field in the Navigator Labels configuration. When the label is empty, the button will not appear.


About This Demo

This landing page exists only in this demonstration. When you first download your theme and click on the Custom Link, it will prompt you to create a new page. Of course, you can always visit the Admin Settings to add a custom URL to redirect the link somewhere else. You can also remove the button by leaving its label blank in the Admin Settings panel.

wiki/custom_link_demo.txt · Last modified: by editor