Differences

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

--- template:material [2017-11-10 20:52] – updated the template. Enjoy :) ls
+++ template:material [2023-04-08 23:19] (current) – Aleksandr
@@ Line 4: / Line 4: @@
 description   : A versatile material design style template
 author        : ls
-email         : leon.staufer@gmail.com
+email         : leon@staufer.me
-lastupdate_dt : 2017-11-10
+lastupdate_dt : 2020-11-04
-compatible    : 2017-02-19e, Hrun
+compatible    : 2017-02-19e, Hrun, Greebo, Hogfather
 depends       :
 conflicts     : # prefix templates by template:
 similar       :
-screenshot_img: https://s1.postimg.org/71yp86jwq7/screen.jpg
-tags          : material modern clean simplistic elegant editor
+tags          : material modern clean simplistic elegant editor responsive themes sidebar configuration
 downloadurl   : https://github.com/LeonStaufer/material-dokuwiki/zipball/master
 bugtracker    : https://github.com/LeonStaufer/material-dokuwiki/issues
 sourcerepo    : https://github.com/LeonStaufer/material-dokuwiki
-donationurl   : https://www.paypal.me/LeonStaufer
+donationurl   : https://www.paypal.me/StauferLeon
+screenshot_img:
 ----
 This Material template is very easy to install and use, whilst offering a multitude of customization options.
-Foremost, you can choose a primary (and primary dark) and accent color. From there on, you can fully customize the sidebar, making use of the entire material icon pack.
+You can begin by choosing between several color themes in the style.ini file. From there on, you can fully customize the sidebar, making use of the entire material icon pack.
 ===== How it looks =====
-{{https://s1.postimg.org/6fmrfcwptr/material.jpg|screenshot}}
+{{ https://i.imgur.com/1QibmKg.jpg |screenshot}}
+==== Beautiful themes ====
+{{ https://i.imgur.com/bnWd8k3.png |different themes}}
 ==== Elegant editor ====
-{{https://s1.postimg.org/8c6ott88rj/editor.png|Screenshot of editor}}
+{{ https://i.imgur.com/e9TqMB2.png |Screenshot of editor}}
 The material template now sports an elegant looking editor. You can further improve it by replacing the toolbar icons found in ''DOKUWIKI_ROOT/lib/images/toolbar'' with [[https://material.io/icons/|material icons]].
-The toolbar can then looking like the following:
+The toolbar can then look like the following:
-{{https://s1.postimg.org/3gejih6esf/toolbar.png|Image of toolbar with material icons}}
+{{https://i.imgur.com/XSyhyPU.png|Image of toolbar with material icons}}
-===== Download and Install ======
+===== Installation =====
 Use the following URL to download this template:
-  * https://github.com/LeonStaufer/material-dokuwiki/zipball/master
+  * [[https://github.com/LeonStaufer/material-dokuwiki/zipball/master|Link to ZIP file on GitHub]]
 Refer to [[:template|this guide]] on how to install and use templates in DokuWiki.
-===== Configure it =====
+===== Upgrading =====
+Regularly visit the installed templates via the configuration manager in order to update this template to the latest version.
+**WARNING**: updating overrides all changed files. That means if you edited the ''%%main.php%%'' or ''%%sidebar.php%%'' you will need to backup these or any others before upgrading.
+===== Configuration =====
   - install the template
-  - navigate to the ''DOKUWIKI_ROOT/lib/tpl/material'' folder
+  - navigate to the ''%%DOKUWIKI ROOT/lib/tpl/material%%'' folder
-  - open the ''style.ini'' file and scroll to the "replacements" section
+  - open the ''%%style.ini%%'' file and scroll to the “replacements” section
   - follow the instructions there to change the colors
-  - if you wish you can now open the ''sidebar.php'' file and change its contents to your liking
+  - if you wish you can now open the ''%%sidebar.php%%'' file and change its contents to your liking
-  - and you're set!
+  - and you’re set!
+The template also comes with several configuration options, which you can set via the Configuration Manager.
+^Key                        ^Description                                                                 ^Default                                                                                                                                                                                                                          ^
+|''%%dokuwikiSidebar%%''    |use the sidebar page within the wiki instead of the ''%%sidebar.php%%'' file|''%%false%%''                                                                                                                                                                                                                    |
+|''%%feedbackForm%%''       |add a button that allows users to give feedback                             |''%%true%%''                                                                                                                                                                                                                     |
+|''%%technicalFeedbackForm%%''       |technical information is included in the feedback email                             |''%%true%%''                                                                                                                                                                                                                     |
+|''%%feedbackEmail%%''      |the recipient Email address for the feedback                                |''%%address@domain.com%%''                                                                                                                                                                                                       |
+|''%%feedbackSubjectLine%%''|subject line of the Email                                                   |''%%Feedback for Website%%''                                                                                                                                                                                                     |
+|''%%feedbackBody%%''       |body of the Email                                                           |''%%Thank you so much for taking the time to write feedback. We really appreciate it :) \n\n [your message] \n\n\n You can ignore all the technical information below. It only helps us track down what the problem might be.%%''|
+|''%%hiddenActions%%''      |DokuWiki actions that are hidden                                            |''%%backlink,top%%''                                                                                                                                                                                                             |
+|''%%protrudingDrawer%%''   |if the drawer should stick out on the left                                  |''%%true%%''                                                                                                                                                                                                                     |
+|''%%subtlePagename%%''     |if the title of the page should not be the focus                            |''%%false%%''                                                                                                                                                                                                                    |
-===== Problems or Suggestions? =====
+===== Feedback =====
-If you encounter any problems or would like to see functionality added, please head over to the template's [[https://github.com/LeonStaufer/material|GitHub page]] and submit a bug.
+If you encounter any problems or would like to see functionality added, please head over to the [[https://github.com/LeonStaufer/material-dokuwiki/issues|issue page]] on GitHub and submit your bug/request.