Differences

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

--- template:readthedokus [2023-09-25 07:40] – [Link to login page] 121.118.62.109
+++ template:readthedokus [2024-05-11 05:55] (current) – [Read the Dokus Template] 125.205.2.224
@@ Line 6: / Line 6: @@
 email         : my17560@gmail.com
 lastupdate_dt : 2023-08-22
-compatible    : hogfather,Igor,Jack Jackrum
+compatible    : Hogfather, Igor, Jack Jackrum, Kaos
 depends       :
 conflicts     :
@@ Line 34: / Line 34: @@
 Refer to [[:template]] on how to install and use templates in DokuWiki.
-===== Sites using this Template =====
+===== Sites Using This Template =====
 Please feel free to add your sites here or ask me via e-mail or GitHub issues.
@@ Line 40: / Line 40: @@
   * Web Components Based Javascript Framework [[https://bitsmist.com/doku.php?id=en:bitsmist-js-core:general:overview|BitsmistJS Core]] (Customized)
-===== Template settings =====
+===== Template Settings =====
 These are template settings for this theme.
@@ Line 46: / Line 46: @@
 ^Option^Description^
 |Sidebar position|Choose "left" for the left sidebar, "right" for the right sidebar. |
-|Use DokuWiki breadcrums|Check to use DokuWiki style breadcrumbs.|
+|Use DokuWiki breadcrumbs|Check to use DokuWiki style breadcrumbs.|
 |Show toolbox even when logged out|Check to show the Toolbox always. By default, it is not shown unless you log in.|
 |Start Page|Set start page URL. This page is shown when the "previous" button is pressed on the first page.|
@@ Line 53: / Line 53: @@
 |Enable Google Fonts|Check if you want to use Google Fonts. Don't forget to put the necessary tags in the option below. Technically, this option only puts the tags specified in the head tag.|
 |Specify tags to include Google Fonts|Specify tags to include Google Fonts.  The tags specified here are put in the head tag.|
-===== Template variables =====
+===== Template Variables =====
-These are some of the options on "Template Style Settings".
+These are some of the options on "Template Style Settings". Other options are available to change various colors used in this template.
 ^Option^Description^
@@ Line 68: / Line 68: @@
 ===== Notes =====
-==== Sidebar format ====
+==== Sidebar Format ====
 Use strong for captions, and lists for items. Anything other than that won't be styled, so use your own styles for them.
@@ Line 81: / Line 81: @@
   * page4
 </code>
-==== Previous/Next buttons ====
+Some index plugins are supported by this template and can be used in the sidebar.
+  * [[doku>plugin:acmenu|AcMenu]] Plugin
+  * [[doku>plugin:indexmenu|IndexMenu]] Plugin
+  * [[doku>plugin:nspages|nspages]] Plugin
+  * [[doku>plugin:simplenavi|simplenavi]] Plugin
+==== Previous/Next Buttons ====
 Previous/Next buttons follow links to DokuWiki on the sidebar, picked up by using querySelector(".aside > #sidebar a[data-wiki-id]"). The previous button on the first page will jump to root(/) by default. You can change this in "Start Page" option in the settings.
-==== Link to login page ===
+==== Link to Login Page ===
 This theme doesn't have any links to the login page by default. Go directly to the login page by appending "&do=login" to the current URL. Or, check the "Show toolbox even when logged out" option in the settings to show the Toolbox always which has the link to the login page.
@@ Line 104: / Line 112: @@
   * tip
-You can use "Wrap Plugin" to make it a bit simpler.
+You can use "[[doku>plugin:wrap|Wrap]] Plugin" to make it a bit simpler.
 <code>
@@ Line 112: / Line 120: @@
 </code>
-If you use the plugin, do not forget to add classes (admonition,danger,caution,note,tip) to the "noPrefix" plugin option otherwise admonitions will not be styled correctly. You need to add four types listed above and "admonition" to the option value.
+If you use the plugin, do not forget to add classes (admonition,danger,caution,note,tip) to the "noPrefix" in the Wrap plugin option otherwise admonitions will not be styled correctly.
-==== Recommended options ===
-^Option^Value^Description^
-|useheading|on|Breadcrumbs on the page header looks nicer.|
 ===== Customization =====
@@ Line 132: / Line 134: @@
 Also, you can use google fonts for better looking. 'Lato' and 'Roboto Slab' fonts are set in font-family in this theme CSS. If you decide to use it, check the option in the configuration manager to enable it. Change the tags in the following option.
-==== Adding a fixed header/footer ====
+==== Adding a Fixed Header/Footer ====
-This theme supports a fixed header and footer. On the "Template Style Setting" page, enter a header height in the "Header height" option, a footer height in the "Footer height" option. The theme will add paddings according to those options on top for header, bottom for footer. You can put your own header/footer in "header.html"/"footer.html" in the "lib/tbl/readthedokus/" directory.
+This theme supports a fixed header and footer. On the "Template Style Setting" page, enter a header height in the "Header height" option, a footer height in the "Footer height" option. The theme will add paddings according to those options on top for header, bottom for footer. You can put your own header/footer in "header.html"/"footer.html" in the "lib/tpl/readthedokus/" directory.
 === 1. Set header/footer height in "Template Style Settings" ===
-These values must be valid css values.
+These values must be valid CSS values.
 e.g. "50px"
@@ Line 168: / Line 170: @@
 </code>
-You might want to hide a mobile menu since both the sticky header and the mobile menu are displayed at the same time on mobile devices. To hide the mobile menu add below to CSS file (DokuWiki folder)/conf/userall.css
+You might want to hide a mobile menu since both the sticky header and the mobile menu are displayed at the same time on mobile devices. To hide the mobile menu add below to the CSS file (DokuWiki folder)/conf/userall.css
 <code>
@@ Line 176: / Line 178: @@
 </code>
-==== Centering the content ====
+==== Centering the Content ====
 To center the content, enter the content width in the "Site width" option on the "Template Style Settings".