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