This is an old revision of the document!
Table of Contents
mikio Template
Compatible with DokuWiki
Greebo
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
Features
- Navbar with dropdown support
- Subnavbar support (using a page named submenu)
- Right sidebar
- Hero element
- Icon support
- Customizable breadcrumbs
- Subtheming support
- Tags plugin support
- Mobile friendly
Configuration
iconTag
: icon tag to use to engage the icon engine. Default toicon
customTheme
: the mikio subtheme to use
navbarUseTitleIcon
: show the site logo in the navbarnavbarUseTitleText
: show the site title in the navbarnavbarUseTaglineText
: show the site tagline in the navbar. Requires thenavbarUseTitleText
to be enablednavbarCustomMenuText
: custom menu to use in the navbar. Menu items are in the format of url|title with each item seperated by a semicolon. Requires one of thenavbarPos
to be set tocustom
navbarDWMenuType
: how to show the DokuWiki menu items in the navbar. Can be either icons, text or bothnavbarDWMenuCombine
: how to show the DokuWiki menu in the navbar. Can be either category dropdowns, single items or a combined dropdown. The combined menu title is pulled from thetools-menu
language value
navbarPosLeft
: what menu to show on the left of the navbarnavbarPosMiddle
: what menu to show in the middle of the navbarnavbarPosRight
: what menu to show on the right of the navbarnavbarShowSub
: show the sub navbar. This menu is pulled from thesubmenu
page in the current or parent namespaces. The menu is also shown on child pages. If no page is found, the sub navbar is automatically hidden
searchButton
: show the search button as a icon or text
heroTitle
: show the hero block on pagesheroImagePropagation
: search for hero images in parent namespaces if none is found in the current namespace
tagsConsolidate
: Consolidate tags found in the current page and display it in the hero, content header or sidebar
breadcrumbHideHome
: hide breadcrumbs in the root namespacebreadcrumbPosition
: where to display the breadcrumbs, either under the navbar, in the hero element or above the page contentbreadcrumbPrefix
: enable changing the breadcrumb prefixbreadcrumbPrefixText
: text to set the breadcrumb prefix. RequiresbreadcrumbPrefix
to be enabledbreadcrumbSep
: enable changing the breadcrumb seperatorbreadcrumbSepText
: text to set the breadcrumb seperator. RequiresbreadcrumbSep
to be enabledbreadcrumbHome
: change the breadcrumb home item to none, page title of root page, 'home' or an icon/image. The 'home' text is pulled from thehome
language valuebreadcrumbShowLast
: only show an amount of breadcrumbs from the last. Will also show the home item in the list if enabled. Set this to0
to show all items
sidebarShowLeft
: show the left sidebar if content is foundsidebarLeftRow1
: content to show in the first row of the left sidebarsidebarLeftRow2
: content to show in the second row of the left sidebarsidebarLeftRow3
: content to show in the third row of the left sidebarsidebarLeftRow4
: content to show in the forth row of the left sidebarsidebarShowRight
: show the right sidebar if content is found
tocFull
: show the table of contents as a full height item
pageToolsFloating
: when and if to show the floating page toolspageToolsFooter
: when and if to show page tools in the footer
footerCustomMenuText
: custom menu to use in the footer. Menu items are in the format of url|title with each item seperated by a semicolonfooterSearch
: show the search bar in the footer
licenseType
: how to show the license in the footerlicenseImageOnly
: show the license in the footer as an image only. RequireslicenseType
to at least be enabled
includePageUseACL
: respect ACL when including pagesincludePagePropagate
: search parent namespaces when including pages
Include Pages
The following pages can be either html files in the root of the theme or a page in the namespace. Namespace pages take priority.
topheader
: content to include above the navbarheader
: content include below the navbar but above the page contentcontentheader
: content to include above the page contentcontentfooter
: content to include below the page contentsidebarheader
: content to include above the left sidebar contentsidebarfooter
: content to include below the left sidebar contentrightsidebarheader
: content to include above the right sidebar contentrightsidebarfooter
: content to include below the right sidebar contentfooter
: content to include in the footerbottomfooter
: content to include below the footer
Include Images
The following images can be used to replace content in the theme. Images can be in the root of the theme or in the namespace. Images can be either png, jpg, gif or svg.
logo
: site logo in the navbarbreadcrumb-prefix
breadcrumb prefixbreadcrumb-sep
breadcrumb seperatorhero
hero image for hero element
Hero Element
title
: The hero title is sourced from the page title. The page title is removed from the page contentsubtitle
: Pages can set the subtitle by inserting ~~hero-subtitle TEXT~~ in the page contentimage
: The hero image is sourced from an image named hero in the current or parental namespace. Namespace searching can be confined by theincludePagePropagate
setting. Pages can also override the image by inserting ~~hero-image URL~~ in the page content. DokuWiki and external URLs are supportedcolors
: Colors can be overridden by including ~~hero-colors BACKGROUND_COLOR HERO_TITLE_COLOR HERO_SUBTITLE_COLOR BREADCRUMB_TEXT_COLOR BREADCRUMB_HOVER_COLOR~~. You do not need to include all the color options. Use 'initial' to skip a color override
Namespaces can also apply the above hero settings in child pages by including the above settings in a page named theme
.
Icon Engine
- Mikio includes an icon engine that allows you to include icons in your pages by using <icon OPTIONS> in your content
- If the icon tag conflicts with another plugin, you can change the tag from
icon
to a user set value in the settings - By default, Mikio enables FontAwesome 4 by also includes FontAwesome 5, Elusive 2 and Bootstrap Icons which can be enabled by uncommenting their inclusions in
/icons/icons.php
Users can also add their own icon sets into the theme. Supported icon sets can either be webfonts or indivial files (such as a SVG library). Instructions can be found in the /icons/icons.php
file.
Subthemes
Subthemes should be placed in the themes directory in its own directory. LESS files are supported.
Mikio Plugin
The Mikio Plugin is also available to add bootstrap 4 style + more elements to DokuWiki pages.
Languages
sidebar-title
: Text for the collapsable block in the sidebartools-menu
: Text for the combined tools DokuWiki menu titlehome
: Text for the breadcrumb home title
Support
- If you think you have found a problem, or would like to see a feature, please open an issue
- If you are a coder, feel free to create a pull request, but please be detailed about your changes!