====== MindTheDark Template ======

---- template ----
description   : MindTheDark offers a light and a dark color scheme for your DokuWiki
author        : MrReSc
email         : mindthedark@mailbox.org
lastupdate_dt : 2023-03-05
compatible    : Greebo, Hogfather, Igor
depends       :
conflicts     : # prefix templates by template:
similar       :
screenshot_img: https://raw.githubusercontent.com/MrReSc/MindTheDark/master/screenshot/screenshot_theme.png
tags          : dark, light, sidebar, responsive, modern, clean

downloadurl   : https://github.com/MrReSc/MindTheDark/archive/2023-03-05.zip
bugtracker    : https://github.com/MrReSc/MindTheDark/issues
sourcerepo    : https://github.com/MrReSc/MindTheDark
----

This template is based on the standard [[template:dokuwiki|DokuWiki Template]].

MindTheDark 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.

If 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.

{{https://raw.githubusercontent.com/MrReSc/MindTheDark/master/screenshot/screenshot_toggle.png?recache|screenshot_toggle}}

If the ''%%autoDark%%'' option is enabled, the color scheme of the operating system is used.

{{https://raw.githubusercontent.com/MrReSc/MindTheDark/master/screenshot/screenshot_theme.png?recache|screenshot}}

If neither of the two options is selected, a static color scheme can be selected via ''%%theme%%''.

If 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.

===== Features =====

  * light and a dark color scheme (''%%theme%%'' option in Configuration Manager)
  * automatic color scheme depending on operating system settings (''%%autoDark%%'' option in Configuration Manager)
  * change of the color scheme by the user (''%%userChoice%%'' option in Configuration Manager)
  * all colors of the light and dark color scheme can be set in the Configuration Manager
  * and all features the standard [[template:dokuwiki#features|DokuWiki Template]] offers
  * light and dark color theme for syntax highlighting in GeShi (thx @pv2b, @asfethan)

===== Plugin Support =====

==== Note Plugin ====

If [[plugin:note|Note Plugin]] 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.

{{https://raw.githubusercontent.com/MrReSc/MindTheDark/master/screenshot/screenshot_note_plugin.png?400&recache|screenshot}}

==== Wrap Plugin ====
If [[plugin:wrap|Wrap Plugin]] is installed you can activate the support with the option ''%%pluginWrap%%'' in the configuration manager.

===== Customizing =====

The MindTheDark Template offers all customizing like the standard [[template:dokuwiki#customizing|DokuWiki Template]].

==== Changing Styles ====

Additionally to the standard guaranteed [[devel:style.ini|style.ini]] placeholders and the standard [[template:dokuwiki#customizing|DokuWiki Template customizing]], the template uses the following variables:

^ placeholder variable                     ^ meaning                                         ^
| ''%%__pre_text_color__%%''               | text color of inline code formating             |
| ''%%__pre_background_color__%%''         | backgroung color of inline code formating       |
| ''%%__selection_color__%%''              | text color of selection                         |
| ''%%__selection_background_color__%%''   | backgroung color of selection                   |
| ''%%__scrollbar_track__%%''              | color of the scrollbar                          |
| ''%%__scrollbar_thumb__%%''              | color of the scrollbar button                   |
| ''%%__note_plugin_classic_color__%%''    | base color for note plugin ''%%<classic>%%''    |
| ''%%__note_plugin_important_color__%%''  | base color for note plugin ''%%<important>%%''  |
| ''%%__note_plugin_warning_color__%%''    | base color for note plugin ''%%<warning>%%''    |
| ''%%__note_plugin_tip_color__%%''        | base color for note plugin ''%%<tip>%%''        |

===== Localization =====

The texts are translated into German and English. Contributions are welcome.

===== Status =====

The template is currently used in about ~1% of DokuWiki installations. Almost no problems are reported. The current version is stable.

Issues and improvements can be reported [[https://github.com/MrReSc/MindTheDark|here]].

===== Changelog =====
==== Last 15 commits ====

{{rss>https://github.com/MrReSc/MindTheDark/commits/master.atom date count=15}}

===== Installation =====

Refer to [[:template]] on how to install and use templates in DokuWiki.

===== Remarks =====

  * The ''%%autoDark%%'' option only works with modern browsers. The compatibility can be checked [[https://caniuse.com/#feat=prefers-color-scheme|here]].
  * GeShi dark mode style sheet provided by @asfethan [[https://cyberasylum.eu/how-to-change-geshi-stylesheet]]
  * Wrap plugging support was created by @Gamemap. Thanks for that!
  * Czech translation by @jvn. Thanks for that!
  * Optimization of the theme selection by @Racso. Thanks for that!