1# Khum1, Dokuwiki template for Khaganat
2
3## Description
4
5This template is based on default Dokuwiki template (version available on 2020-04-09).
6
7It try to be responsive and accessible.
8
9Design is for Khaganat, a wonderful open project. Feel free to use it if you Dokuwiki is inspired by Khaganat ; probably better to adapt it at your taste if you have an other project.
10
11It s better with [sidebar](https://www.dokuwiki.org/faq:sidebar). Wiki without sidebar are like a dishes without salt.
12
13## Plugin support
14Khum1 is designed to integrate certain plugins in particular. They have special css or hack on the template. It work without this plugin too !
15
16* [Children pages](https://forge.dotslashplay.it/vv221/dokuwiki-childrenpages) to have tab on top article
17* [Translation](http://www.dokuwiki.org/plugin:translation).
18
19It work well with a lot of plugin too, without hack :)
20
21## Installation
22Install it like any other template. Do "search and install" in the extension manager, find "Khum1", select and install it.
23
24Alternatively and manually :
25Download the folder, unzip it, rename it "khum1" if it has another name, and put it in 'dokuwki/lib/tpl/'.
26
27And after, choose it in admin configuration.
28
29Refer to [template](https://www.dokuwiki.org/template) on how to install and use templates in Dokuwiki.
30
31## Support and contributing
32Please consider that I'm not a real developper. I accept merge request, but probably I can't debug big issue.
33
34If you see a bug, please create an issue on [my depot](https://git.khaganat.net/khaganat/web/dokuwiki/khum1/-/issues) or send me a mail to [zatalyz.khum1@liev.re](zatalyz.khum1@liev.re). I try to resolve when I can, or find people who can resolve it.
35
36I am really happy if you know how make it better. Contribute as you can, I integrate it if I understand !
37
38And if you speak french, you are welcome to contribute in this language. I understand french better than english...
39
40## Changelog
41I try to follow [Keep a Changelog](https://keepachangelog.com/fr/1.0.0/). Changelog are in an other file.
42
43## Credits
44All real work has made by Anika Henke and Clarence Lee (see [Dokuwiki default template credits](https://www.dokuwiki.org/template:dokuwiki)).
45
46Change on this template :
47
48* Zatalyz (design, hack, css)
49* Help of a lot of people on Khaganat to test, find good idea, explain how code work.
50* YannK (background images and advices)
51
52## License
53Dokuwiki is on GPL, so this template too. More easy and legal.
54Share is an act of love, so feel you free.
55