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