1# Mikio DokuWiki Template 2 3 4 5## About 6 7`Mikio` is a Bootstrap 4 style template for [DokuWiki](http://dokuwiki.org) 8 9## Features 10 11- [bootstrap styling](http://getbootstrap.com/) 12- Navbar with dropdown support 13- Subnavbar support (using a page named submenu) 14- Right sidebar 15- Hero element 16- Icon support 17- Customizable breadcrumbs 18- Theming support 19- Tags plugin support 20- Mobile friendly 21 22## Changes 23 24- 2022-03-05 25 - Breadcrumbs and You Are Here have now been seperated instead of combined. This removed the options `breadcrumbHome` and `breadcrumbShowLast` for the breadcrumbs as it only applies to the you are here bar. **Breadcrumbs and You Are Here options may have reset** 26 27- 2020-09-27 28 - Sidebars now collapse by default on mobile. This can be overridden with the `sidebarMobileDefaultCollapse` option 29 - The mikio LESS stylesheet is now disabled by default, with a precompilied CSS used. This can be reverted using the `useLESS` option 30 31## Configuration 32 33The configuration can be change with the [Configuration Manager Plugin](https://www.dokuwiki.org/plugin:config) 34 35- `iconTag` : icon tag to use to engage the icon engine. Default to `icon` 36- `customTheme` : the mikio theme to use, located in the `mikio/themes` directory 37- `showNotifications` : where to show site notifications for admin staff 38- `useLESS` : use the LESS compilier or direct CSS for the mikio stylesheet. Requires the ctype PHP extension installed 39 40- `navbarUseTitleIcon` : show the site logo in the navbar 41- `navbarUseTitleText` : show the site title in the navbar 42- `navbarUseTaglineText` : show the site tagline in the navbar. Requires the `navbarUseTitleText` to be enabled 43- `navbarCustomMenuText` : 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 the `navbarPos` to be set to `custom` 44 45- `navbarDWMenuType` : how to show the DokuWiki menu items in the navbar. Can be either icons, text or both 46- `navbarDWMenuCombine` : 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 the `tools-menu` language value 47 48- `navbarPosLeft` : what menu to show on the left of the navbar 49- `navbarPosMiddle` : what menu to show in the middle of the navbar 50- `navbarPosRight` : what menu to show on the right of the navbar 51- `navbarShowSub` : show the sub navbar. This menu is pulled from the `submenu` 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 52 53- `navbarItemShowCreate` : show the Create Page menu item 54- `navbarItemShowShow` : show the Show Page menu item 55- `navbarItemShowRevs` : show the Revisions menu item 56- `navbarItemShowBacklink` : show the Backlinks menu item 57- `navbarItemShowRecent` : show the Recent Changes menu item 58- `navbarItemShowMedia` : show the Media Manager menu item 59- `navbarItemShowIndex` : show the Sitemap menu item 60- `navbarItemShowProfile` : show the Update Profile menu item 61- `navbarItemShowAdmin` : show the Admin menu item 62- `navbarItemShowLogin` : show the Login menu item 63- `navbarItemShowLogout` : show the Logout menu item 64 65- `searchButton` : show the search button as a icon or text 66 67- `heroTitle` : show the hero block on pages 68- `heroImagePropagation` : search for hero images in parent namespaces if none is found in the current namespace 69 70- `tagsConsolidate` : Consolidate tags found in the current page and display it in the hero, content header or sidebar 71 72- `breadcrumbHideHome` : hide breadcrumbs in the root namespace 73- `breadcrumbPosition` : where to display the breadcrumbs, either under the navbar, in the hero element or above the page content 74- `breadcrumbPrefix` : enable changing the breadcrumb prefix 75- `breadcrumbPrefixText` : text to set the breadcrumb prefix. Requires `breadcrumbPrefix` to be enabled 76- `breadcrumbSep` : enable changing the breadcrumb seperator 77- `breadcrumbSepText` : text to set the breadcrumb seperator. Requires `breadcrumbSep` to be enabled 78 79- `youarehereHideHome` : hide you are here in the root namespace 80- `youareherePosition` : where to display the you are here, either under the navbar, in the hero element or above the page content 81- `youareherePrefix` : enable changing the you are here prefix 82- `youareherePrefixText` : text to set the you are here prefix. Requires `you are herePrefix` to be enabled 83- `youarehereSep` : enable changing the you are here seperator 84- `youarehereSepText` : text to set the you are here seperator. Requires `you are hereSep` to be enabled 85- `youarehereHome` : change the you are here home item to none, page title of root page, 'home' or an icon/image. The 'home' text is pulled from the `home` language value 86- `youarehereShowLast` : only show an amount of you are here from the last. Will also show the home item in the list if enabled. Set this to `0` to show all items 87 88- `sidebarShowLeft` : show the left sidebar if content is found 89- `sidebarLeftRow1` : content to show in the first row of the left sidebar 90- `sidebarLeftRow2` : content to show in the second row of the left sidebar 91- `sidebarLeftRow3` : content to show in the third row of the left sidebar 92- `sidebarLeftRow4` : content to show in the forth row of the left sidebar 93- `sidebarMobileDefaultCollapse` : collapse the sidebars by default when viewed on mobile 94- `sidebarShowRight` : show the right sidebar if content is found 95 96- `tocFull` : show the table of contents as a full height item 97 98- `pageToolsFloating` : when and if to show the floating page tools 99- `pageToolsFooter` 100 101- `pageToolsShowCreate` : show the Create Page item 102- `pageToolsShowEdit` : show the Edit Page item 103- `pageToolsShowRevs` : show the Revisions item 104- `pageToolsShowBacklink` : show the Backlinks item 105- `pageToolsShowTop` : show the Back to Top item 106 107- `footerCustomMenuText` : custom menu to use in the footer. Menu items are in the format of url|title with each item seperated by a semicolon 108- `footerSearch` : show the search bar in the footer 109 110- `licenseType` : how to show the license in the footer 111- `licenseImageOnly` : show the license in the footer as an image only. Requires `licenseType` to at least be enabled 112 113- `includePageUseACL` : respect ACL when including pages 114- `includePagePropagate` : search parent namespaces when including pages 115 116## Include Pages 117 118The following pages can be either html files in the root of the template or a page in the namespace. Namespace pages take priority. 119 120- `topheader` : content to include above the navbar 121- `header` : content include below the navbar but above the page content 122- `contentheader` : content to include above the page content 123- `contentfooter` : content to include below the page content 124- `sidebarheader` : content to include above the left sidebar content 125- `sidebarfooter` : content to include below the left sidebar content 126- `rightsidebarheader` : content to include above the right sidebar content 127- `rightsidebarfooter` : content to include below the right sidebar content 128- `footer` : content to include in the footer 129- `bottomfooter` : content to include below the footer 130 131## Include Images 132 133The following images can be used to replace content in the template. Images can be in the root of the template or in the namespace. Images can be either png, jpg, gif or svg. 134 135- `logo` : site logo in the navbar 136- `breadcrumb-prefix` breadcrumb prefix 137- `breadcrumb-sep` breadcrumb seperator 138- `hero` hero image for hero element 139 140## Hero Element 141 142- `title` : The hero title is sourced from the page title. The page title is removed from the page content 143- `subtitle` : Pages can set the subtitle by inserting `~~hero-subtitle TEXT~~` in the page content 144- `image` : The hero image is sourced from an image named hero in the current or parental namespace. Namespace searching can be confined by the `includePagePropagate` setting. Pages can also override the image by inserting `~~hero-image URL~~` in the page content. DokuWiki and external URLs are supported 145- `colors` : 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 146 147Namespaces can also apply the above hero settings in child pages by including the above settings in a page named `theme`. 148 149## Hiding Elements 150 151Mikio now supports hiding elements using the `~~hide-parts (parts)~~` macro. Each element within the hide-parts macro is required to be seperated by spaces. Currently the following parts are supported: 152 153- `topheader` : content above the navbar 154- `navbar` : the main navigation bar 155- `header` : content below the navbar but above the page content 156- `hero` : the page hero bar 157- `contentheader` : content above the page content 158- `contentfooter` : content below the page content 159- `sidebarheader` : content above the left sidebar content 160- `sidebarfooter` : content below the left sidebar content 161- `rightsidebarheader` : content above the right sidebar content 162- `rightsidebarfooter` : content below the right sidebar content 163- `footer` : content in the footer 164- `bottomfooter` : content below the footer 165 166To hide the topheader, navbar and hero, you would use the macro `~~hide-parts topheader navbar hero~~` 167 168## Icon Engine 169 170- Mikio includes an icon engine that allows you to include icons in your pages by using <icon OPTIONS> in your content 171- If the icon tag conflicts with another plugin, you can change the tag from `icon` to a user set value in the settings 172- 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` 173 174Users can also add their own icon sets into the template. 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. 175 176## Themes 177 178Themes should be placed in the themes directory, in its own directory. LESS files are supported. 179 180## Mikio Plugin 181 182The [Mikio Plugin](https://github.com/nomadjimbob/mikioplugin/) is also available to add bootstrap 4 style + more elements to DokuWiki pages. 183 184## Languages 185 186- `sidebar-title` : Text for the collapsable block in the sidebar 187- `tools-menu` : Text for the combined tools DokuWiki menu title 188- `home` : Text for the breadcrumb home title 189 190## Releases 191 192- **_2022-03-05_** 193 194 - Fixed page tools in footer not being horizontal [#38]. Thanks chitland 195 - Fixed Mikio Config headers disappearing in some cases 196 - Separated Breadcrumbs and You Are Here items [#36]. Thanks chitland 197 198- **_2021-12-11_** 199 200 - Added table row background styling options 201 - Fixed styling issue when using the indexmenu plugin [#35](https://github.com/nomadjimbob/mikio/issues/35). Thanks 3ole. 202 - Fixed inconsitant tab/spaces in mikio.less and mikio.css 203 - Removed debug logs from mikio.js 204 - Fixed input placeholders not hiding in prepopulated fields [#34](https://github.com/nomadjimbob/mikio/issues/34) 205 - Added option to hide menu and page tool items [#32](https://github.com/nomadjimbob/mikio/issues/32). Thanks annievoss. 206 - Fixed compadibility with BookCreator [#26](https://github.com/nomadjimbob/mikio/issues/26). Thanks johncourtland. 207 - Fixed Greebo styling errors not present in Hogsfather 208 209- **_2021-08-11_** 210 211 - Fixed path check on Windows [#33](https://github.com/nomadjimbob/mikio/issues/33) 212 - Recompilied CSS 213 214- **_2021-06-17_** 215 216 - Added support for navbar title link to use showpageafterlogin setting if installed [#27](https://github.com/nomadjimbob/mikio/issues/27) 217 218- **_2021-06-09_** 219 220 - TOC is now full width on mobile [#25](https://github.com/nomadjimbob/mikio/issues/25) 221 - Hamburger and sidebar icons are now displayed correctly [#23](https://github.com/nomadjimbob/mikio/issues/23), [#24](https://github.com/nomadjimbob/mikio/issues/24) 222 - Site width is now available under Template Style Settings [#22](https://github.com/nomadjimbob/mikio/issues/22) 223 - TOC is now sticky when set to full height [#21](https://github.com/nomadjimbob/mikio/issues/21) 224 - Added support to the theme being linked by a symbolic link [#20](https://github.com/nomadjimbob/mikio/issues/20) 225 - Mikio will now fallback to using CSS when there is the LESS engine is not detected [#20](https://github.com/nomadjimbob/mikio/issues/20) 226 227- **_2021-03-10_** 228 229 - Fixed bad breadcrumb URL formatting on sites using userewrite [#19](https://github.com/nomadjimbob/mikio/issues/19) 230 231- **_2021-03-04_** 232 233 - Added support to hide page elements [#18](https://github.com/nomadjimbob/mikio/issues/18) 234 235- **_2021-01-22_** 236 237 - Fixed a syntax error with the core css 238 239- **_2020-11-12_** 240 241 - Corrected terminology in readme to match Dokuwiki [#17](https://github.com/nomadjimbob/mikio/issues/17) 242 - Fix showing part of the sidebar when it should be hidden in certain conditions [#16](https://github.com/nomadjimbob/mikio/issues/16) 243 - Added option to always show the sidebar, even when there is no content [#16](https://github.com/nomadjimbob/mikio/issues/16) 244 245- **_2020-10-07_** 246 247 - Fixed hero header parsing on some servers 248 - Fixed safari color picker issue [#14](https://github.com/nomadjimbob/mikio/issues/14) 249 - LESS now defaults to enabled with fallback to ctype functions built into mikio for docker apps [#13](https://github.com/nomadjimbob/mikio/issues/13) 250 - Fix for Template Style Settings being ignored [#12](https://github.com/nomadjimbob/mikio/issues/12) 251 252- **_2020-10-01_** 253 254 - Fix for `sidebarMobileDefaultCollapse` option being inconsistent in code and not working correctly [#11](https://github.com/nomadjimbob/mikio/issues/11). Thanks to GJRobert for catching that. 255 256- **_2020-09-27_** 257 258 - Sidebars hidden by default in mobile view [#10](https://github.com/nomadjimbob/mikio/issues/10) 259 - Fixed errors with the LESS compilier on some nginx configurations 260 - Fixed styling and image display thumb size in media manager popup 261 - Fixed text field placeholders not disappearing with text entry 262 - Added support for Hogfather 263 - Added option to use LESS or direct CSS. Some configurations (docker linuxserver/dokuwiki) do not have the required PHP extensions installed 264 - Supports Docker linuxserver/dokuwiki container file structures 265 266- **_2020-09-10_** 267 268 - Floating page tools is now a UL element with classes applied from getType and getLinkAttributes. Fixes popup dialogs initiated from the a page menu [#7](https://github.com/nomadjimbob/mikio/issues/7) 269 - Template.info.txt now shows correct release dates [#8](https://github.com/nomadjimbob/mikio/issues/8) 270 - Fixed rightsidebar php warnings 271 - Code/Pre blocks no longer have padding applied on the admin pages 272 273- **_2020-08-26_** 274 275 - Footer is no longer shown outside of page view 276 - Public messages are now displayed on the page 277 - Fixed icon rendering in hero bar 278 - Fixed TOC rendering bug 279 280- **_2020-07-27_** 281 282 - Added option to show wiki footer in page content 283 284- **_2020-07-24_** 285 286 - Fixed image detail bug 287 288- **_2020-07-20_** 289 290 - Fixed prewrap and sidebar search bar margins 291 292- **_2020-07-16_** 293 294 - Merged code block styling with pre 295 - Fixed mediamanager failures on 2018-04-22a "Greebo" [#5](https://github.com/nomadjimbob/mikio/issues/5) 296 - Icon tag is rendered correctly in preview [#4](https://github.com/nomadjimbob/mikio/issues/4) 297 298- **_2020-07-15_** 299 300 - Fixed an issue with the simple_html_dom library when editing a section of a page caused page corruption [#3](https://github.com/nomadjimbob/mikio/issues/3) 301 302- **_2020-07-14_** 303 304 - Added id=dokuwiki\_\_content identifier for the page content element 305 - Added styling and fixed overflow issues with pre elements 306 - Fixed page width overflow issues 307 308- **_2020-07-09_** 309 310 - Fixed cosmetic display issues when `input[type=file]` is hidden by plugins [#2](https://github.com/nomadjimbob/mikio/issues/2) 311 312- **_2020-07-07_** 313 - Initial release 314 315## Third Party Libraries 316 317This template uses a [modified version](https://github.com/nomadjimbob/simple_html_dom) of [simple_html_dom](https://sourceforge.net/projects/simplehtmldom/) 318 319## Support 320 321- If you think you have found a problem, or would like to see a feature, please [open an issue](https://github.com/nomadjimbob/mikio/issues) 322- If you are a coder, feel free to create a pull request, but please be detailed about your changes! 323
){kind=link}