DokuWiki

It's better when it's simple

User Tools

Site Tools


template:sprintdoc

sprintdoc Template

Compatible with DokuWiki

  • 2018-04-22 "Greebo" yes
  • 2017-02-19 "Frusterick Manners" no
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown

template Modern, responsive template that integrates multiple plugins useful for small to medium sized company intranets and project wikis

Last updated on
2018-09-13
Repository
Source
Conflicts with
ckgedit

Download and Install

Install the template as usual through the Extension manager.

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

Sites using this Template

The sprintdoc template is the spiritual successor to the 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

Sidebar Sections

The sprintdoc template features a standard 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.

====== A Section ======

  * [[wiki:dokuwiki|About DokuWiki]]
  * [[wiki:syntax|DokuWiki Syntax]]

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. Please refer to mime on how to enable SVG uploads in your wiki:

====== Section with local icon @icons:fish.svg ======

Alternatively you can refer to any icon available at materialdesignicons.com (MDI). When an icon can not be found locally it is looked up at MDI:

====== Section with MDI icon @alert-octagram.svg ======

Configuration

The template allows to configure certain features in DokuWiki's configuration manager. Design features (like colors) can be configured via the Styling Manager.

Logos

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

  • wiki:logo.png – used when no specialized logo is found
  • wiki:logo-wide.png – main logo for desktop mode
  • wiki:logo-32×32.png – main logo for mobile mode
  • wiki:favicon.ico – favicon
  • wiki:favicon.png – favicon fallback
  • wiki:logo-square.png – mobile logo fallback

Includes

The template supports traditional include hooks as defined in the dokuwiki template as well as includes configurable via the 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.

  • starred – bookmarks are shown in the sidebar, the star icon to bookmark pages is integrated the page attributes
  • do – list of open tasks is integrated in the user tools, page tasks are listed in the page attributes
  • qc – page quality is integrated into the page attributes
  • tplinc – there are several includes available to this plugin (see Includes)
  • highlightparent – integrated into breadcrumbs
  • tagging – integrated into the page tabs
  • struct – adjusted styling
  • data – adjusted styling
  • All plugins supporting the new menu system introduced in Greebo, this includes

Development

Commit-Ticker

Releases:

template/sprintdoc.txt · Last modified: 2018-09-13 13:44 by grosse