xref: /plugin/autocolor/README.md (revision b793955eddd2624cb69021cb40fd25fd606a0408)
1# AutoColor Plugin for DokuWiki
2
3The **AutoColor** plugin for DokuWiki automatically highlights and colors predefined keywords across your wiki pages. Instead of relying on a clunky admin interface, it uses a standard DokuWiki table as its central configuration source.
4
5![Vorschau des AutoColor Plugins: Konfigurationsseite](dokuwiki-plugin-autocolor-screenshot.png)
6
7## ✨ Features
8
9* **Wiki-Based Configuration:** Manage all your keywords, acronyms, and colors intuitively via a simple wiki table.
10* **Case-Sensitive:** Differentiates between exact uppercase and lowercase spellings.
11* **Lightweight & Fast:** Hooks directly into DokuWiki's native lexer and fully supports the caching system. Zero performance overhead.
12
13
14## �� Installation
15
16### Option 1: Via Extension Manager (Recommended)
17
18### Option 2: Manual installation
191. Download the latest release as a `.zip` file from this repository.
202. Log into your DokuWiki and navigate to **Admin -> Extension Manager**.
213. Go to the **Manual Install** tab.
224. Upload the `.zip` file and click "Install".
23
24## ��️ Usage & Configuration
25
26Once installed, setting up your colors takes less than a minute.
27
281. Navigate to **Admin -> Configuration Settings** and find the `autocolor` section.
292. Define the wiki page you want to use for your configuration (Default is `admin:autocolor`).
303. Create this exact page in your DokuWiki and insert a table using the following syntax:
31
32```text
33====== AutoColor Configuration ======
34
35^ Keywords (comma-separated) ^ Color (Hex code or HTML color name) ^
36| DokuWiki, Wiki             | #0055b3                             |
37| Error, Warning, Danger     | red                                 |
38| Success, Done, Finished    | green                               |
39