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