====== Khum1 Template ======

---- template ----
description   : Generic template for Khaganat project. Support a lot of plugin. Try to be responsive and accessible.
author        : zatalyz
email         : zatalyz.khum1@liev.re
lastupdate    : 2022-08-06
compatible    : Greebo, Hogfather, Igor, Jack Jackrum
depends       :
conflicts     : 
similar       :
screenshot_img: https://liev.re/imagesweb/khum1_screenshot1.jpg
tags          : responsive accessible sidebar mobile scifi

downloadurl   : https://git.khaganat.net/khaganat/web/dokuwiki/khum1/-/archive/master/khum1-master.zip
bugtracker    : https://git.khaganat.net/khaganat/web/dokuwiki/khum1/-/issues
sourcerepo    : https://git.khaganat.net/khaganat/web/dokuwiki/khum1/
donationurl   : https://khaganat.net/bienvenue/fr:soutien
----

This template is based on default Dokuwiki template (version available on 2020-04-09).

It try to be [[wp>Responsive_web_design|responsive]] and [[wp>Accessibility|accessible]].

Design is for [[https://khaganat.net|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.

It s better with [[faq:sidebar|sidebar]]. Wiki without sidebar are like a dishes without salt.

===== Plugin support =====

Khum1 is designed to integrate certain plugins in particular. They have special css or hack on the template. It work without this plugin too!

  * [[https://forge.dotslashplay.it/vv221/dokuwiki-childrenpages|Children pages]] to have tab on top article,
  * [[plugin:translation|Translation]]. 

It work well with a lot of plugin too, without hack :) You can find all plugin we use on [[https://khaganat.net/wikhan/fr:wikitools:syntaxe:base#extensions_de_syntaxe|our wiki]].

===== Download and Install ======

Install it like any other template. Do "search and install" in the extension manager, find "Khum1", select and install it. 

Alternatively, use the following URL to download this template:

  * https://git.khaganat.net/khaganat/web/dokuwiki/khum1/-/archive/master/khum1-master.zip
Unzip it, be sure that the folder is named "khum1" and put it in ''dokuwiki/lib/tpl/''. And after, choose it in admin configuration.

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

===== Support and contributing =====
Please consider that I'm not a real developper. I accept merge request, but probably I can't debug big issue. 

If you see a bug, please create an issue on my [[https://git.khaganat.net/khaganat/web/dokuwiki/khum1/-/issues|depot]] or send me a mail to [[zatalyz.khum1@liev.re]]. I try to resolve when I can, or find people who can resolve it.

I am really happy if you know how make it better. Contribute as you can, I integrate it if I understand !

And if you speak french, you are welcome to contribute in this language. I understand french better than english...

===== Changelog =====

I try to follow [[https://keepachangelog.com/fr/1.0.0/|Keep a Changelog]]. Changelog are [[https://git.khaganat.net/khaganat/web/dokuwiki/khum1/-/blob/master/CHANGELOG.md|here]].

===== Credits and license=====
All real work has made by Anika Henke and Clarence Lee (see [[https://www.dokuwiki.org/template:dokuwiki|Dokuwiki default template credits]]). 

Change on this template :

  * Zatalyz (design, hack, css)
  * Help of a lot of people on Khaganat to test, find good idea, explain how code work.
  * YannK (background images and advices)

Dokuwiki is on GPL, so this template too. More easy and legal. Share is an act of love, so feel you free. 

===== Sites using this Template =====

  * https://khaganat.net/wikhan/ : basic flavour.
  * https://khaganat.net/um1/ : with more tab (provided by plugin Children pages).