skip to content

nuropa

off the beaten track

Sidebar

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
components:toolbar:index [2025/02/18 09:13] – created admincomponents:toolbar:index [2025/07/19 14:58] (current) – external edit 127.0.0.1
Line 1: Line 1:
-<div> +====== Toolbar ======
-== Toolbar == +
-</div> +
-<h1>The Site Toolbar</h1>+
  
 The topmost element on every page is the site toolbar, which by default hosts the DokuWiki administration tools and user menu. The topmost element on every page is the site toolbar, which by default hosts the DokuWiki administration tools and user menu.
Line 14: Line 11:
 ==== User menu ==== ==== User menu ====
  
 +This is the default item for this place. It shows the user menu, or, if no user is logged in at this point, the login button, which looks as follows:
 +
 +<figure box>{{:components:toolbar:toolbar-login.png?nolink|Nuropa toolbar login button}}<figcaption>Toolbar login button</figcaption></figure>
 +
 +Once your are logged in to the DokuWiki system, it shows the name of the currently logged in account instead:
 +
 +<figure box>{{:components:toolbar:toolbar-username.png?nolink|Nuropa toolbar user menu button}}<figcaption>Toolbar user menu (closed)</figcaption></figure>
 +
 +In this case, this works as a menu, which gives access to the user functions, as provided by DokuWiki:
 +
 +<figure box>{{:components:toolbar:toolbar-usermenu.png?nolink|Nuropa toolbar user menu open}}<figcaption>Toolbar user menu (closed)</figcaption></figure>
 +
 +<aside info>
 +**Note 1:** The functions of the user button are also available in the right-hand “overflow menu”. See below for more information.
 +</aside>
 +
 +<aside info>
 +**Note 2:** The available functions of this item are the same as the ones that can be configured for the [[..:searchbar:tool|searchbar tools]] item. 
 +</aside>
 ==== Languages menu ==== ==== Languages menu ====
  
-This element can be configured in the Settings to appear instead of the user menu, but it is only shown if the DokuWiki Translations plugin is also installed.+This element can be configured in the Settings to appear instead of the user menu, but it is only shown if the [[doku>plugin:translation|Translation plugin]] is also installed. 
 + 
 +In this case, the menu will always show the current language and provide a menu with other configured languages: 
 + 
 +<figure box> 
 +{{:components:toolbar:toolbar-languages-menu.png?nolink|Nuropa toolbar languages menu}} 
 +<figcaption>Languages menu in the toolbar</figcaption></figure> 
 + 
 +<aside info>**Note:** The languages menu will not be shown in some situations, e.g. in the Administration view. 
 +</aside>
  
 ==== Hooks ==== ==== Hooks ====
Line 22: Line 47:
 There are two include hooks available for this location: There are two include hooks available for this location:
  
-  * toolbar_pre.html will be inserted before the built-in item +  * ''toolbar-pre.html'' will be inserted before the right-hand item. 
-  * toolbar_post.html will be inserted afterwards.+  * ''toolbar-post.html'' will be inserted after the right-hand item. 
 + 
 +The following screenshot shows the positioning of these two hooks: 
 + 
 +<figure box>{{:components:toolbar:toolbar-with-hooks.png?nolink|Nuropa Toolbar right items with hooks}}<figcaption>Left-hand item with hooks</figcaption></figure> 
 +===== Right-hand items ===== 
 + 
 +==== Page-tools menu ==== 
 + 
 +<figure><div [style=text-align:right]>{{:components:toolbar:toolbar-pagetools.png?nolink|Nuropa toolbar page-tools with overflow menu}}</div> 
 +<figcaption>Page-tools when no user is logged in.</figcaption></figure> 
 + 
 +The items actually shown here depend on a number of circumstances, including the current state that the user is in (e.g. there are different items in editing mode) and additional items can also be installed by plugins. 
 + 
 +==== Overflow menu ==== 
 + 
 +If there is not enough space to show all items (in particular on smaller screens, e.g. on smartphones or similar devices), the additional items will move to the “overflow menu” on the right-hand side: 
 + 
 +<figure box><div [style=text-align:right]>{{:components:toolbar:toolbar-pagetools-overflow.png?nolink|Nuropa toolbar with overflow menu}}</div> 
 +<figcaption>Page-tools move to overflow menu when there is not enough space.</figcaption></figure> 
 + 
 +Please note that the user account items (“Update profile”, “Log Out” or “Log In”) are //always// found in the overflow menu. They are, however, also available in the user menu, e.g. on the left-hand side of the toolbar. 
 + 
 +By changing the configuration option “toolbarstyle" (title: “How should the toolbar menu be displayed?”) the behaviour can be changed so that all page-tools items will //always// be in the shown in the overflow menu //only//. This leaves more space in the toolbar for left-hand items (e.g. static content included via hooks). 
 + 
 +===== Behaviour ===== 
 + 
 +The site toolbar is designed to appear visually distinct from the rest of the page, more resembling a part of the browser rather than being part of the page. It is also considered a less important tool for not logged-in users that only want to read the site content as it is for logged-in users, which may want to work with the site. These considerations are also reflected in some aspects of the toolbar’s behaviour: 
 + 
 +  * The toolbar always uses the whole width of the browser viewport, while the page content is limited to a (configurable) maximum width in the centre. On large screens, this can be very visible, while on smaller screen, this may not even be noticeable. 
 + 
 +  * When no user is logged in, the toolbar will scroll “out of the way”, however, when a user is logged in, it becomes “sticky” to the top of the viewport, making sure that the tools are always available without scrolling. 
 + 
 +===== Configuration ===== 
 + 
 +==== Template settings ==== 
 + 
 +In the <a [href=?do=admin&page=config#tpl____nuropa____tpl_settings_name] [target=_blank]>DokuWiki Configuration for this plugin</a>, the following options are directly related to the toolbar: 
 + 
 +  * **Toolbar Menu Style** – should the toolbar menu (on the right-hand side) appear as a popup menu only, or as a horizontal menu that only overflows into the menu if space is tight? 
 +  * **Toolbar Option** – What should be shown in the left-hand side of the toolbar? Options are: “User information”, “Languages menu” or “Nothing”. 
 + 
 +For more information, please see the page <span maniculus>[[customisation:settings|Settings]]</span>. 
 + 
 +==== Style settings ==== 
 + 
 +In the <a [href=?do=admin&page=styling] [target=_blank]>Template Style Settings</a>, the following options are directly related to the appearance of the toolbar:
  
 +  * **Toolbar font family** – a list of fonts that should be used for the toolbar.
 +  * **Toolbar font size** – the font size to use in the toolbar.
 +  * **Toolbar font size mobile** – alternative font size to use in mobile view.
 +  * **Toolbar background colour** – Background colour for the toolbar <strong red>*</strong>.
 +  * **Toolbar text colour** - Text colour for the toolbar <strong red>*</strong>.
 +  * **Toolbar icon colour** – Colour to use for icons in the toolbar <strong red>*</strong>.
 +  * **Toolbar focus colour** – colour to use for focus highlights in the toolbar <strong red>*</strong>.
  
 +<aside info>**Note 1:** All “colour” items (marked with <strong red>*</strong>) exist in two variants, the second of which is used for the “dark mode”, if enabled.</aside>
  
 +The idea of the toolbar is that is should appear visually distinct from the page, more resembling a browser feature rather than a part of the web page. For this reason, there are so many configuration options for this element.