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