1# MindTheDark Template 2This template is based on the standard [DokuWiki Template](https://www.dokuwiki.org/template:dokuwiki). 3 4MindTheDark offers a light and a dark color scheme for your DokuWiki. The color scheme and the style are optimized for software documentation. The optics are flat. 5 6If the `userChoice` option is enabled, an option to change the color scheme will appear in the header. If only `userChoice` is enabled, then the selected static mode will be used until the user makes a choice. 7 8 9 10If the `autoDark` option is enabled, the color scheme of the operating system is used. 11 12 13 14If neither of the two options is selected, a static color scheme can be selected via `theme`. 15 16If both options are enabled, then Auto mode will be used until the user makes a choice. From this point on, only the user's choice is taken into account. 17 18## Features 19* light and a dark color scheme (`theme` option in Configuration Manager) 20* automatic color scheme depending on operating system settings (`autoDark` option in Configuration Manager) 21* change of the color scheme by the user (`userChoice` option in Configuration Manager) 22* all colors of the light and dark color scheme can be set in the Configuration Manager 23* and all features the standard [DokuWiki Template](https://www.dokuwiki.org/template:dokuwiki#features) offers 24* light and dark color theme for syntax highlighting in GeShi (thx @pv2b, @asfethan) 25 26## Plugin Support 27### Note Plugin 28If [Note Plugin](https://www.dokuwiki.org/plugin:note) is installed you can activate the support with the option `pluginNote` in the configuration manager. If the option `pluginNote` is enabled, the base colors of the notes can also be changed. 29 30<img src="screenshot/screenshot_note_plugin.png" height="200"> 31 32### Wrap Plugin 33If [Wrap Plugin](https://www.dokuwiki.org/plugin:wrap) is installed you can activate the support with the option `pluginWrap` in the configuration manager. 34 35## Customizing 36The MindTheDark Template offers all customizing like the standard [DokuWiki Template](https://www.dokuwiki.org/template:dokuwiki#customizing). 37 38### Changing Styles 39Additionally to the standard guaranteed [style.ini](https://www.dokuwiki.org/devel:style.ini) placeholders and the standard [DokuWiki Template customizing](https://www.dokuwiki.org/template:dokuwiki#customizing), the template uses the following variables: 40 41| placeholder variable | meaning | 42|----------------------|---------| 43| `__pre_text_color__` | text color of inline code formating| 44| `__pre_background_color__` | backgroung color of inline code formating| 45| `__selection_color__` | text color of selection| 46| `__selection_background_color__` | backgroung color of selection| 47| `__scrollbar_track__` | color of the scrollbar| 48| `__scrollbar_thumb__` | color of the scrollbar button| 49| `__note_plugin_classic_color__` | base color for note plugin `<classic>`| 50| `__note_plugin_important_color__` | base color for note plugin `<important>`| 51| `__note_plugin_warning_color__` | base color for note plugin `<warning>`| 52| `__note_plugin_tip_color__` | base color for note plugin `<tip>`| 53 54## Localization 55The texts are translated into German, English and Czech. Contributions are welcome. 56 57## Status 58The plugin is currently used in about ~1% of DokuWiki installations. Almost no problems are reported. The current version is stable. 59 60Issues and improvements can be reported [here](https://github.com/MrReSc/MindTheDark). 61 62[MindTheDark popularity](https://dokuwiki.org/lib/plugins/pluginrepo/popularity.php?key=conf_template&output=pie&limit=8&d=20&x=.png) 63 64## Installation 65 66Refer to [template](https://www.dokuwiki.org/template) on how to install and use templates in DokuWiki. 67 68 69## Remarks 70* The `autoDark` option only works with modern browsers. The compatibility can be checked [here](https://caniuse.com/#feat=prefers-color-scheme). 71* GeShi dark mode style sheet provided by @asfethan [https://cyberasylum.eu/how-to-change-geshi-stylesheet](https://cyberasylum.eu/how-to-change-geshi-stylesheet) 72* Wrap plugging support was created by @Gamemap [@Gamemap](https://github.com/Gamemap). Thanks for that! 73* Czech translation by [@jvn](https://github.com/jnv). Thanks for that! 74* Optimization of the theme selection by [@Racso](https://github.com/Racso). Thanks for that!
){kind=link}