====== Settings ====== The template has its own section in your wiki’s configuration page (direct link). The different settings are described on this page. ===== Toolbar Menu Style ===== This setting allows you to configure how the toolbar menu (on the right-hand side of the toolbar) should appear: * **Automatic** – The menu uses as much of the toolbar as is available, items that don't fit on screen will be shown in the overflow popup menu. * **Menu only** – All menu items will always appear in the popup menu only. ===== Toolbar Option ===== This setting configures what should be shown in the left-hand side of the toolbar: * **User information** – The name of the current user, which opens a popup menu with user profile options. If no user is logged in, it shows the “Log in” button only. * **Languages menu** – The language of the current page, opens a popup menu of all available languages (requires the [[doku>plugin:translation|Translation plugin]]). * **Nothing** – The left-hand side of the toolbar will be empty. FIXME Future plan is that that the third option will be replaced with an option use an include hook for static content on this spot. This is not implemented yet, though. ===== Site logo ===== The site logo that is shown on the left-hand side of the searchbar can be configured here (see [[components:searchbar:index|Searchbar]] for more information): * **Logo image** – Use a logo image file (e.g. ''logo.svg'') in this place. * **Static file** – Include a static HTML snippet (named ''sitelogo.html'') instead of a logo. ===== Searchbar option ===== Configures the tools that are added to the right of the search field. This complements the “Toolbar option” setting, and it should typically be set to the opposite of the above: * **User information** – The name of the current user (including a popup menu with account options), or a “Log in” button, if no user is currently logged in. * **Languages menu** – The language of the current page, opens a popup menu of all available languages (requires the [[doku>plugin:translation|Translation plugin]]). * **Nothing** – Don’t show any tool here. FIXME Future plan is that that the third option will be replaced with an option use an include hook for static content on this spot. This is not implemented yet, though. ===== Page headline ===== The main headline of each page (in the titlebar) can be configured here: * **Site name** – the site name, as configured in the DokuWiki “[[doku>config:title|title]]” setting. * **Page name** – The page title of the current page. Typically taken the first headline in the page content (make sure to set the DokuWiki “[[doku>config:useheading|useheading]]” setting to “Always”). * **Static file** – Include a static HTML snippet (named “''title.html''”), in this place. ===== Site menu ===== Configure a site-wide menu? * Name of the menu configuration. Leave empty to disable the menu. FIXME The menu feature is not fully implemented yet. ===== Menu place ===== Where should the site-wide menu be shown? * **None** – * **Before** – * **Between** – * **After** – FIXME The menu feature is not fully implemented yet. ===== You-are-here position ===== Where should the “hierarchical breadcrumbs” navigation be shown? * **Menu** – On top of the Menu-bar. * **Banner** – Overlaying the site banner. * **Content** – On top of the content block. Note that this navigation will only be generated if the DokuWiki [[doku>config:youarehere|youarehere]] setting is activated. ===== Banner image ===== Name of the image file to be used as banner image. * Name of the image file (e.g. “''banner''”), or leave empty to disable banner image. For more information on the banner configuration, please see: [[customisation:banner|Banners]]. ===== TOC default state ===== The “table of contents” (TOC) can be shown or hidden by the user. This setting defines the default state when a page is opened: * **Opened** – The TOC is open by default. * **Collapsed** – The TOC is collapsed by default. The way the TOC is generated can be configured via the following DokuWiki settings: [[doku>config:toptoclevel|toptoclevel]], [[doku>config:tocminheads|tocminheads]] and [[doku>config:maxtoclevel|maxtoclevel]]. ===== Title above TOC ===== This is an experimental option that tries to move the main article headline above the TOC for a neater appearance.
**Important:** This may not work in all circumstances and should be tested thoroughly before deploying!
===== Homelink ===== When enabled, this option adds a “higher-level” home item above the wiki navigation that is used as a “home” for the site. This also overrides the link for the site logo. Setting this (e.g. to “''/''”) can be useful if the wiki is part of a larger site, which has a homepage that is separate from the wiki. Leave empty to disable this feature. ===== Dark mode ===== Enables a user-controlled alternative [[wp>Light-on-dark color scheme|Light-on-dark color scheme]]. * **Disabled** – Dark mode is not available. * **Follow user settings** – Dark mode is active for users that have dark mode enabled on their devices. Note that for usability reasons it is not possible to force dark mode to users who don’t have it enabled on their device. ===== Neatnik mode ===== This enables a special debugging mode that makes the HTML code more legible, at the expense of the data transfer size. Should probably be disabled in production systems.