====== sprintdoc Template ======

---- template ----
description   : Modern, responsive template that integrates multiple plugins useful for small to medium sized company intranets and project wikis
author        : Jana Deutschländer / Andreas Gohr / Michael Große
email         : dokuwiki@cosmocode.de
lastupdate_dt : 2024-03-30
compatible    : Kaos
depends       :
similar       :
screenshot_img: template:sprintdoc-clean.png
tags          : modern, responsive

downloadurl   : https://github.com/cosmocode/dokuwiki-template-sprintdoc/zipball/master
bugtracker    : https://github.com/cosmocode/dokuwiki-template-sprintdoc/issues
sourcerepo    : https://github.com/cosmocode/dokuwiki-template-sprintdoc/
----


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

Install the template as usual through the [[plugin:extension|Extension]] manager.

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

:!: The Template requires PHP's SimpleXML extension to be available. On some systems you may need to install an additional package for that.

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

For a realistic view and a first playground you may visit the demo wiki on:

  * [[https://demo.ickewiki.de/]] (in German)

The sprintdoc template is the spiritual successor to the [[template:icke|ICKE template]]. The goal is to provide a modern, responsive template that integrates multiple plugins useful for small to medium sized company intranets and project wikis.

===== Overview =====

{{ :template:sprintdoc-annotated.png?600 }}

===== Sidebar =====

{{ https://i.imgur.com/LLguZ52.png?direct|Sidebar Sections}}

The sprintdoc template features a standard [[faq:sidebar]] mechanism. Simply create a page named ''sidebar'' to create a permanent navigation menu.

By default each headline in the sidebar page will automatically create a collapsible section - this can be changed in the [[#configuration]].

<code>
====== A Section ======

  * [[wiki:dokuwiki|About DokuWiki]]
  * [[wiki:syntax|DokuWiki Syntax]]
</code>


A special syntax allows you to specify **SVG icons** to be used instead of the automatically created icons. To do so, simply provide a valid media id after an ''@'' character. The icon must be publicly accessible, which means not protected by any [[:acl|ACL]] rules. Please refer to [[:mime]] on how to enable SVG uploads in your wiki:

<code>
====== Section with local icon @icons:fish.svg ======
</code>

Alternatively you can refer to any icon available at [[https://pictogrammers.com/library/mdi/| Material Design Icons (MDI)]] i.e. the former <del>materialdesignicons.com</del> site was moved. When an icon can not be found locally it is looked up at MDI:

<code>
====== Section with MDI icon @alert-octagram.svg ======
</code>


===== Configuration =====

The template allows to configure certain features in DokuWiki's [[plugin:config|configuration manager]]. Design features (like colors) can be configured via the [[plugin:styling|Styling Manager]].

==== Alternative breadcrumbs ====

The sprintdoc template offers an alternative kind of breadcrumbs displaying the hierarchy of namespaces a page is in. This feature can be activated by a //combination of two settings// in the configuration as:
  * set [[config:breadcrumbs]] to ''0'' to //disable//
  * set [[config:youarehere]] to ''1''

This setting provides an appropriate display of hierarchy of namespaces of the active page near it's top on the right of the "Collapsible Page" button.

===== Logos =====

The template supports various logos, favicons etc. They have to be provided in PNG or SVG format and need to be uploaded to the ''wiki'' namespace. At the very minimum you should provide a ''wiki:logo.png/svg'' image and maybe a ''wiki:favicon.ico''. Additional images can be provided, but are created from the main logo if missing.

  * ''wiki:logo.png/svg'' -- used when no specialized logo is found
  * ''wiki:logo-wide.png/svg'' -- main logo for desktop mode
  * ''%%wiki:logo-32x32.png/svg%%'' -- main logo for mobile mode 
  * ''wiki:favicon.ico'' -- favicon
  * ''wiki:favicon.png/svg'' -- favicon fallback
  * ''wiki:logo-square.png/svg'' -- mobile logo fallback

===== Includes =====

The template supports traditional include hooks as defined in the [[template:dokuwiki#supported_include_hooks|dokuwiki template]] as well as includes configurable via the [[plugin:tplinc|Template Include plugin]].


===== Plugin-Support =====

The sprintdoc template support a handful of plugins right out of the box. That means there's no additional configuration needed other than installing to make use of these plugins. All of these plugins are completely optional but can enhance the experience.

  * [[plugin:starred]] -- bookmarks are shown in the sidebar, the star icon to bookmark pages is integrated the page attributes
  * [[plugin:do]] -- list of open tasks is integrated in the user tools, page tasks are listed in the page attributes
  * [[plugin:qc]] -- page quality is integrated into the page attributes
  * [[plugin:tplinc]] -- there are several includes available to this plugin (see [[#Includes]])
  * [[plugin:highlightparent]] -- integrated into breadcrumbs //(however, **deprecated** due to lack of maintenance)//
  * [[plugin:tagging]] -- integrated into the page tabs
  * [[plugin:struct]] -- adjusted styling
  * [[plugin:data]] -- adjusted styling //(however, you might want to **consider using 'struct'** as the spiritual successor to this plugin)//
  * [[plugin:quicksubscribe]] -- the subscription Icon is integrated into the page attributes
  * All plugins supporting the new menu system introduced in Greebo, this includes
    * [[plugin:dw2pdf]]
    * [[plugin:odt]]
    * [[plugin:move]]


===== Development =====

==== Commit-Ticker ====

{{rss>https://github.com/cosmocode/dokuwiki-template-sprintdoc/commits/master.atom date}}

**Releases:**
{{rss>https://github.com/cosmocode/dokuwiki-template-sprintdoc/releases.atom description author}}