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