Differences

This shows you the differences between two versions of the page.

--- template:sprintdoc [2018-04-24 14:37] – not compatible with Frusterick Manners: it requires Greebo's _search.less grosse
+++ template:sprintdoc [2024-03-30 23:51] (current) – version upped andi
@@ Line 2: / Line 2: @@
 ---- template ----
-description   : modern, responsive template that integrates multiple plugins useful for small to medium sized company intranets and project wikis
+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
+author        : Jana Deutschländer / Andreas Gohr / Michael Große
 email         : dokuwiki@cosmocode.de
-lastupdate_dt : 2018-04-24
+lastupdate_dt : 2024-03-30
-compatible    : Greebo, !Frusterick Manners
+compatible    : Kaos
 depends       :
-conflicts     : # prefix templates by template:
 similar       :
-screenshot_img: # URL to a screenshot (should be a bigger one)
+screenshot_img: template:sprintdoc-clean.png
-tags          :
+tags          : modern, responsive
 downloadurl   : https://github.com/cosmocode/dokuwiki-template-sprintdoc/zipball/master
@@ Line 23: / Line 22: @@
 Install the template as usual through the [[plugin:extension|Extension]] manager.
-Refer to [[:template]] on how to install and use templates in Dokuwiki.
+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 =====
-  * [[https://demo.sprintdoc.de/]]
+  * [[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.
@@ Line 33: / Line 34: @@
 ===== Overview =====
-FIXME
+{{ :template:sprintdoc-annotated.png?600 }}
 ===== Sidebar =====
@@ Line 51: / Line 52: @@
-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:
+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>
@@ Line 62: / Line 63: @@
 ====== Section with MDI icon @alert-octagram.svg ======
 </code>
 ===== Configuration =====
@@ Line 67: / Line 69: @@
 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]].
-===== 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.
+===== Logos =====
-FIXME list additional images
+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 =====
@@ Line 82: / Line 90: @@
 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: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: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:qc]] -- page quality is integrated into the page attributes
-  * [[plugin:dw2pdf]] - PDF export is integrated into the page tools
+  * [[plugin:tplinc]] -- there are several includes available to this plugin (see [[#Includes]])
-  * [[plugin:odt]] - ODT export is integrated into the page tools
+  * [[plugin:highlightparent]] -- integrated into breadcrumbs
-  * [[plugin:move]] - page renaming is integrated into the page tools
+  * [[plugin:tagging]] -- integrated into the page tabs
-  * [[plugin:tplinc]] - there are several includes available to this plugin (see [[#Includes]])
+  * [[plugin:struct]] -- adjusted styling
-  * [[plugin:highlightparent]] - integrated into breadcrumbs
+  * [[plugin:data]] -- adjusted styling
-  * [[plugin:tagging]] - integrated into the page tabs
+  * [[plugin:quicksubscribe]] -- the subscription Icon is integrated into the page attributes
-  * [[plugin:struct]] - adjusted styling
+  * All plugins supporting the new menu system introduced in Greebo, this includes
-  * [[plugin:data]] - adjusted styling
+    * [[plugin:dw2pdf]]
+    * [[plugin:odt]]
+    * [[plugin:move]]
 ===== Development =====
 ==== Commit-Ticker ====
@@ Line 101: / Line 113: @@
 **Releases:**
 {{rss>https://github.com/cosmocode/dokuwiki-template-sprintdoc/releases.atom description author}}