====== DokuKITv2 Template ======

---- template ----
description   :
author        : particlekit
email         : particle-admin@lists.kit.edu
lastupdate_dt : 2020-08-01
compatible    : Hogfather, Greebo
depends       :
conflicts     :
similar       : template:dokukit
screenshot_img: 
tags          : dokukit, cms, kit

downloadurl   : https://github.com/particleKIT/DokuKITv2/archive/master.zip
bugtracker    : https://github.com/particleKIT/DokuKITv2/issues
sourcerepo    : https://github.com/particleKIT/DokuKITv2
donationurl   :
----

===== What is this? =====

A dokuwiki template that imitates the new [[https://www.kit.edu/english/|KIT]] design introduced in August 2020.

For the old KIT-design see [[template:dokukit]].

Features:   
  * static menu using JSON input
  * dynamic menu built from the dokuwiki index
  * breadcrumps showing the current trace
  * mobile friendly 

==== Install ====

Either install automatically via Dokuwikis admin interface or install by cloning 

<code bash>
git clone https://github.com/particleKIT/dokuKITv2.git dokukitv2
</code>
into the ''lib/tpl'' directory of you dokuwiki instance and then enabling in the admin interface (check file permissions!).

===== Static menu =====

  * select ''file'' for the ''menu''-option in the admin panel
  * specify a dokuwiki page used build the static menu using the ''menusite'' config in the admin panel
  * put a JSON menu into that file encapsulated by ''<MENU> ...JSON...</MENU>''
    * the JSON code should contain three associative array ''level1..3'' that specify menu point on the respective level
    * menu entries of level ''n+1'' that should be associated with those of level ''n'' need to have the same key (see example below)
    * each key can only be used once, use anchors ('':page#example'') to make them unique again
    * amongst anchors also further GET parameters can be specified (e.g. '':page?key=value#anchor'')

==== Example ====

<code menubar.txt>
<MENU>
{
    "level1": {
            ":start": "Startpage",
            ":staff": "Staff",
            ":research": "Research"
    },
    "level2": {
        ":staff": {
            ":staff:profs" : "Principal Investigators",
            ":staff:students" : "Students"
        },
        ":research": {
            ":research:pubs" : "Publications",
            ":research:these" : "Theses"
        }
    },
    "level3": {
        ":staff:profs": {
            ":profs:erika.mustermfrau": "Prof. Dr. Erika Musterfrau",
            ":profs:max.mustermann": "Prof. Dr. Max Mustermann"
        },
        ":research:pubs": {
            "https://preprint.server.de": "Preprints",
            "https://journal.server.de": "Peer Review"
        },
        ":research:these": {
            ":research:theses:phd": "PhD Theses",
            ":research:theses:dipl": "Diploma Theses"
        }
    }
}
</MENU>
</code>
The "''level4''" which is sometimes used in the original KIT design is not supported.

If you get a JSON parser error, consider using a [[http://json.parser.online.fr/|JSON online parser]] to get a more meaningful error message.

===== Dynamic Menu =====

  * select ''index'' for the ''menu''-option in the admin panel
  * give a comma separated list of dokuwiki pages for ''cleanindexlist''
   * these pages are excluded from the navigation
   * ACLs should be taken care of automatically


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

  * [[https://www.itp.kit.edu/|Institute for Theoretical Physics]]
  * [[https://www.ttp.kit.edu/|Institute for Theoretical Particle Physics]]