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