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