xref: /plugin/mikioplugin/README.md (revision beae10569609c073e726df9eef35ee6d8306dbd5)
1<img src="https://raw.githubusercontent.com/nomadjimbob/nomadjimbob/master/wiki/mikioplugin/images/mikio_plugin_header.png">
2
3[![License: GPL-2](https://img.shields.io/github/license/nomadjimbob/mikioplugin?color=blue)](LICENSE)
4[![saythanks](https://img.shields.io/badge/say-thanks-ff69b4.svg)](https://saythanks.io/to/james.collins%40outlook.com.au)
5
6Mikio Plugin adds a heap of layout and Bootstrap 4 elements that can be used on your [DokuWiki](http://dokuwiki.org/) pages.
7
8This plugin can be used by itself, however is designed to complement the [Mikio DokuWiki template](http://dokuwiki.org/template:mikio).
9
10## Flexbox Fix
11
12A flexbox fix was applied to the card body element. This may affect existing layouts that relied on the previous (incorrect) formatting. For example, buttons that were unintentionally displayed as `block` elements will now render with their correct inline behavior.
13
14## Updating Styles
15
16You can update the colors used by the elements by editing the `/assets/variables.css` file. From version 2022-10-31 onwards, the theme supports darkmode within browsers.
17
18If you have the [Mikio DokuWiki template](http://dokuwiki.org/template:mikio) 2022-10-31 onwards installed, the `/assets/variables.css` will be ignored as the template adds the variables itself. These can be edited using
19**Template Style Settings** in your sites **Administration** page.
20
21## Setting Up
22
23Download the [latest release](https://github.com/nomadjimbob/mikioplugin/releases/latest) and place it in the\
24\
25:file_folder: dokuwiki\
26&nbsp;&nbsp;&nbsp;&nbsp; :file_folder: lib\
27&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; :file_folder: plugins
28
29directory of your DokuWiki installation.
30
31Sometimes GitHub releases change the name of the mikioplugin directory, so make sure that the directory is `mikioplugin` else you may see errors in DokuWiki.
32
33## Disabling Tags
34
35If a Mikio Plugin tag is conflicting with another plugins tag, or you want to simply disable a tag, you can do this in the `disabled-tags.php` file.
36
37Simply change the tag you want to disable to `true` instead of `false`. Pages that have already been generated while the tag was enabled will need to be regenerated.
38
39## Releases
40
41- **_Next-Release_**
42    -   Added support for the attribute [`collapse-opened-text`](https://github.com/nomadjimbob/mikioplugin/wiki/Collapse#attributes-button) for buttons that support a collapsable element.
43
44- **_2025-11-01_**
45    -   Fixed Collapse elements not supporting other markdown items inside [#43](https://github.com/nomadjimbob/mikioplugin/issues/43). Thanks locodarwin.
46
47- **_2025-10-05_**
48    -   Fixed bug in icon engine where bootstrap icons were not being rendered correctly [#42](https://github.com/nomadjimbob/mikioplugin/issues/42). Thanks nhratos.
49    -   Fixed rendering bug inside columns in certain instances due to flexbox [#41](https://github.com/nomadjimbob/mikioplugin/issues/41). Thanks reissmann.
50    -   Fixed rendering bug inside card body in certain instances due to flexbox [#40](https://github.com/nomadjimbob/mikioplugin/issues/40). Thanks mueniko.
51    -   Other Navs now close when a second one is opened [#39](https://github.com/nomadjimbob/mikioplugin/issues/39). Thanks aloade.
52    -   Fixed undefined array key errors under PHP 8.1 [#37](https://github.com/nomadjimbob/mikioplugin/issues/37). Thanks MartijnSanders.
53
54- **_2025-07-24_**
55    -   Fixed security vulnerability, parsing less error discloses the physical path. Reported by B Mercer.
56    -   Fixed invalid white-space property in stylesheet.
57    -   Various PHP optimizations and code cleanup.
58
59- **_2024-06-05_**
60
61    -   Added `<tags>` element to support rendering the page tags anywhere if using the Mikio theme [Mikio-#70](https://github.com/nomadjimbob/mikio/issues/70). Requested by garanovich.
62    -   Fixed images being stretched in cards [#32](https://github.com/nomadjimbob/mikioplugin/issues/32). Thanks Elanndelh.
63    -   Added `align-` support to cards [#35](https://github.com/nomadjimbob/mikioplugin/issues/35). Requested by garanovich.
64    -   `<right-sidebar>` element added for making right handed sidebars within the page.
65
66- **_2024-02-09_**
67
68    -   Added support for DokuWiki Kaos
69    -   Updated to support PHP 8.2
70
71-   **_2024-01-14_**
72
73    -   `<col>` now supports the `vertical-align` option, defaulting to top [#30](https://github.com/nomadjimbob/mikioplugin/issues/30). Thanks EmmaKnijn.
74    -   `<right-sidebar>` element added for making right handed sidebars within the page.
75
76-   **_2024-01-06_**
77
78    -   Fix missing default options of height and width in nav element [#29](https://github.com/nomadjimbob/mikioplugin/issues/29). Thanks armandostyl.
79
80-   **_2023-12-10_**
81
82    -   Fix a LESS compiliation error introduced in [#26](https://github.com/nomadjimbob/mikioplugin/issues/26). Thanks WetenSchaap.
83
84-   **_2023-12-04_**
85
86    -   Multiple paginations on a single page is now supported.
87    -   Pagination will try it best in resolving malformed URLs with missing content.
88    -   Fixed parsing to ignore <> symbols in element options which used to break the element.
89    -   Added ability to create group radio items in a multiple quiz item by surrounding options in []. Requested by Dylan.
90    -   Renamed pagenation to pagination while keep backwards compatibility.
91    -   Fixed pagination when using nice urls, rewrites and slashes [#26](https://github.com/nomadjimbob/mikioplugin/issues/26). Thanks armandostyl.
92    -   Updated pagination to use its own variables inside variables.css.
93    -   Fixed up some border radius issues and dark mode theming on pagination element.
94
95-   **_2023-11-19_**
96
97    -   Fix quiz results not shown correctly when markdown formatting applied.
98    -   Quiz placeholders can now be markdown formatted.
99    -   Quiz result elements now have classes that can be manually styled through css.
100    -   Fix button backgrounds being overridden by the DokuWiki theme when styled.
101
102-   **_2023-11-18_**
103
104    -   Better handling when a `quizitem` does not contain a `scores` or `answer` attribute.
105    -   Added `full` attribute to `quiz` to show the entire quiz.
106    -   Quiz questions, text and options support basic markdown to bold and italic points.
107    -   Quiz now supports [style](https://github.com/nomadjimbob/mikioplugin/wiki/Common-Attributes#styles) attribute for buttons.
108    -   Custom styles now automatically builds the `outline-` style.
109
110-   **_2023-11-17_**
111
112    -   Added scoring and multiple options to the `quiz` elements. Requested by Dylan.
113
114-   **_2023-10-16_**
115
116    -   Added support to justify individual components of the card. Requested by Dylan.
117
118-   **_2023-10-10_**
119
120    -   Fixed custom styles not being implemented correctly and added direct type support. Thanks Dylan
121    -   Heading element now supports `color` and `text-decoration` options. Requested by Dylan.
122
123-   **_2023-09-11_**
124
125    -   Fixed small tag not being inline [#22](https://github.com/nomadjimbob/mikioplugin/issues/22). Thanks Rayaqu
126    -   Added support to disable tags.
127
128-   **_2023-09-03_**
129
130    -   Fixed card height issues on smaller viewports.
131    -   Fixed columns not stacking on small viewports when using sizing. [#21](https://github.com/nomadjimbob/mikioplugin/issues/21). Thanks armandostyl
132
133-   **_2023-06-16_**
134
135    -   Fixed spacing issues with listgroup items with mixed styles. [#20](https://github.com/nomadjimbob/mikioplugin/issues/20). Thanks armandostyl
136
137-   **_2023-06-06_**
138
139    -   Added Nav item to create dropdown navigation items. [#18](https://github.com/nomadjimbob/mikioplugin/issues/18). Thanks armandostyl
140    -   Added support for elements in sidebars
141
142-   **_2023-05-20_**
143
144    -   AccordionItem, Alert, Blockquote, Card and CardBody now support containing 'protected' type which fixes some elements not rendering correctly (ie <&lt>code<&gt>)
145
146-   **_2023-05-19_**
147
148    -   Updated to include a polyfill for array_key_first if PHP < 7.3
149
150-   **_2022-10-31_**
151
152    -   Fixed 'link' type for Buttons
153    -   Updated CSS to use CSS Variables (supporting switchable themes and style editor within Mikio template). Thanks chrbinder.
154    -   variables.css no longer included if the mikio template is installed, active and version 2022-10-31 or greator
155
156-   **_2022-01-18_**
157
158    -   Fixed accordian not rendering tables inside itself [#15](https://github.com/nomadjimbob/mikioplugin/issues/15). Thanks Melphios
159
160-   **_2021-12-15_**
161
162    -   Added `autoclose` attribute to Accordions to close any other open accordion items other than the one clicked by the user. Requested by eFreshman
163
164-   **_2021-12-14_**
165
166    -   Fix Carousel not containing image by default [#14](https://github.com/nomadjimbob/mikioplugin/issues/14). Thanks eFreshman
167
168-   **_2021-12-13_**
169
170    -   Fix Struct Plugin Aggregation [#13](https://github.com/nomadjimbob/mikioplugin/issues/13). Thanks eFreshman
171
172-   **_2021-11-13_**
173
174    -   Carousel control colors can now be customized
175    -   Carousel now supports circle indicators
176    -   Dynamically build and fullscreen carousels now supported
177    -   SyntaxRender method now correctly converts tagName to methodNames
178
179-   **_2021-08-11_**
180
181    -   Replace Windows directory separator in CSS paths
182    -   Fixed path check in LESS engine on Windows
183    -   Recompiled CSS
184    -   Fixed PHP warnings
185
186-   **_2021-08-10_**
187
188    -   Button outline styling fix [#12](https://github.com/nomadjimbob/mikioplugin/issues/12)
189    -   Added small margin to left and right of buttons
190
191-   **_2021-07-13_**
192
193    -   Element class shortcuts (eg text-center) working again
194    -   LESS engine updated to match the Mikio theme
195    -   LESS fallback to CSS
196
197-   **_2021-04-23_**
198
199    -   Fixed Card element overflow issues. Cards will now be their own height when inside a row element. To force cards to all be the same height, wrap each card in a col element
200    -   Adding a card-footer element inside a card-body element will now work. This fixes inside card elements
201    -   Cards and Carousel images are now contained inside the element instead of covering the element
202    -   Added `cover` attributes to Card and Carousel for images to cover element instead of being contained
203    -   Height attribute bugfix for placeholders
204
205-   **_2021-04-19_**
206
207    -   Fixed images not always being contained within elements such as card headers [#9](https://github.com/nomadjimbob/mikioplugin/issues/9)
208
209-   **_2021-03-05_**
210
211    -   Added support for custom element types and styling [#6](https://github.com/nomadjimbob/mikioplugin/issues/6)
212
213-   **_2021-03-02_**
214    -   Fixed a dokuwiki rendering issue in card bodies [#7](https://github.com/nomadjimbob/mikioplugin/issues/7)
215    -   Fixed a text alignment not being applied in alerts [#8](https://github.com/nomadjimbob/mikioplugin/issues/8)
216
217## Links
218
219-   DokuWiki Plugin Page: (http://dokuwiki.org/plugin:mikioplugin)
220-   Download: (https://github.com/nomadjimbob/mikioplugin/releases/latest)
221-   Docs: (https://github.com/nomadjimbob/mikioplugin/wiki)
222-   Donate: (https://www.ko-fi.com/nomadjimbob)
223-   License: (https://raw.githubusercontent.com/nomadjimbob/mikioplugin/master/LICENSE)
224
225## Contributing
226
227Any contributions are appreciated. Please feel free to reach out to me at james.collins@outlook.com.au
228