Differences

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

--- template:material [2020-01-02 13:51] – updated links, fixed spelling ls
+++ template:material [2020-04-10 17:17] – added explanation of configuration options ls
@@ Line 5: / Line 5: @@
 author        : ls
 email         : leon@staufer.me
-lastupdate_dt : 2019-01-29
+lastupdate_dt : 2020-04-10
 compatible    : 2017-02-19e, Hrun, Greebo
 depends       :
@@ Line 42: / Line 42: @@
 {{https://s1.postimg.org/3gejih6esf/toolbar.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.
+Refer to [[https://www.dokuwiki.org/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
-  - optionally, you can open the ''main.php'' and change the content property of this tag, ''%%<meta name="theme-color" content="#1a237e">%%'', to match your primary color
+  - 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%%''                                                                                                                                                                                                                     |
+|''%%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%%''                                                                                                                                                                                                                    |
+===== Feedback =====
-===== Problems or Suggestions? =====
+If you encounter any problems or would like to see functionality added, please head over to the issue page on GitHub and submit your bug/request.
-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.