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