1====== Radarchart Plugin ======
2
3---- plugin ----
4description: A flexible DokuWiki plugin for creating radar charts with multiple datasets, custom styling, and extensive configuration options.
5author     : HeinrichKrupp
6email      : heinrich.krupp@gmail.com
7type       : syntax
8lastupdate : 2024-11-10
9compatible : Kaos
10depends    :
11conflicts  :
12similar    :
13tags       : Charts Radar Spider_web
14
15downloadurl: https://github.com/doobidoo/dokuwiki-plugin-radarchart/archive/refs/heads/main.zip
16bugtracker : https://github.com/doobidoo/dokuwiki-plugin-radarchart/issues
17sourcerepo : https://github.com/doobidoo/dokuwiki-plugin-radarchart/
18donationurl: https://paypal.me/HeinrichKrupp
19
20screenshot_img : https://i.imgur.com/gY9bEM2.png
21
22----
23
24===== Installation =====
25
261. Create a new folder named 'radarchart' in your DokuWiki's lib/plugins directory
272. Copy all the provided files into this directory
283. Log into your DokuWiki installation as an administrator
294. Go to the Configuration Settings page
305. Look for the radarchart plugin in the list and enable it if necessary
31Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
32
33===== Key features of the plugin: =====
34
35  - Responsive design that works on all devices
36  - Interactive tooltips showing values
37  - Clean, modern appearance
38  - Easy-to-use syntax
39  - Automatic scaling of values
40  - Support for multiple charts on one page
41  - Multiple datasets support
42  - Customizable colors
43  - Dark mode support
44  - Smooth hover effects
45  - Improved accessibility
46  - Graceful fallback for invalid colors
47  - Default values for missing configurations((Default values can be configured in configuration manager))
48  - Protection against malformed input
49
50===== Examples/Usage =====
51
52==== Syntax ====
53
54Use the following syntax in your wiki pages to create a radar chart:
55
56=== Basic Example ===
57
58The basic sample uses the default properties, hence no attributes in <radar> tag needed.
59<code>
60<radar>
61Speed|85
62Accuracy|92
63Power|78
64Control|95
65Endurance|88
66</radar>
67</code>
68Eeach line represents a data point with:
69  - Label before the pipe symbol (|)
70  - Value after the pipe symbol (between 0 and 100 recommended)
71
72=== Advanced Sample with multiple overlays ===
73
741. **Multiple Color Schemes**:
75   - Default: Professional blue-based scheme
76   - Pastel: Soft, muted colors
77   - Dark: Monochromatic dark theme
78   - Neon: High contrast, vibrant colors
79
802. **Configurable Chart Settings**:
81<code>
82<radar width="600" height="600" colorScheme="pastel" minScale="0" maxScale="100" legendPosition="top" borderWidth="2" pointRadius="3">
83@dataset Player 1|rgba(255,0,0,0.2)|rgb(255,0,0)
84Speed|85
85Accuracy|92
86...
87</radar>
88</code>
89
903. **Custom Dataset Colors**:
91<code>
92@dataset Player 1|rgba(255,0,0,0.2)|rgb(255,0,0)
93</code>
94Format: `@dataset Label|backgroundColor|borderColor`
95
964. **Configuration Options**:
97   - `width`: Chart width in pixels
98   - `height`: Chart height in pixels
99   - `colorScheme`: Choose from predefined schemes
100   - `minScale`: Minimum scale value
101   - `maxScale`: Maximum scale value
102   - `legendPosition`: Legend placement (top, bottom, left, right)
103   - `borderWidth`: Line thickness
104   - `pointRadius`: Size of data points
105   - `fillOpacity`: Opacity of filled areas
106
107Example usage with all features:
108<code>
109<radar width="600" height="600" colorScheme="pastel" minScale="0" maxScale="100" legendPosition="right" borderWidth="3" pointRadius="4">
110@dataset Player 1|rgba(255,100,100,0.2)|rgb(255,100,100)
111Speed|85
112Accuracy|92
113Power|78
114Control|95
115Endurance|88
116
117@dataset Player 2|rgba(100,255,100,0.2)|rgb(100,255,100)
118Speed|75
119Accuracy|88
120Power|92
121Control|85
122Endurance|79
123</radar>
124</code>
125
126
127==== Requirements ====
128  - DokuWiki
129  - Modern web browser with JavaScript enabled
130  - Internet connection (for loading Chart.js from CDN)
131
132==== Files Structure ====
133<code>
134radarchart/
135├── conf
136│   ├── default.php
137│   └── metadata.php
138├── helper.php
139├── lang
140│   └── en
141│       └── settings.php
142├── manager.dat
143├── plugin.info.txt
144├── radarchart_sample.png
145├── README.md
146├── style.css
147└── syntax.php
148</code>
149
150===== Configuration and Settings =====
151
152not applicable
153
154===== Development =====
155
156The source code of the plugin is available at GitHub: https://github.com/HeinrichKrupp/dokuwiki-plugin-radarchart.
157
158=== Changelog ===
159
160{{rss>https://github.com/HeinrichKrupp/dokuwiki-plugin-radarchart/commits/master.atom date 8}}
161
162=== ToDo/Wish List ===
163
164Maybe some additional features...
165
166===== FAQ =====
167
168