DokuWiki

It's better when it's simple

User Tools

Site Tools


template:starter

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
template:starter [2013-11-18 02:59] – added info about event hooks achtemplate:starter [2024-01-21 14:21] (current) – template updated ach
Line 5: Line 5:
 author        : Anika Henke author        : Anika Henke
 email         : anika@selfthinker.org email         : anika@selfthinker.org
-lastupdate    : 2013-18-11 +lastupdate    : 2024-01-21 
-compatible    : 2012-10-13 "Adora Belle", 2013-05-10 "Weatherwax", "Binky"+compatible    : Frusterick Manners, Elenor of Tsort, Detritus, "Ponder Stibbons", Hrun, Greebo, Hogfather, 2023-04-04
 depends       :  depends       : 
 conflicts     :  conflicts     : 
 similar       :  similar       : 
 screenshot_img: :template:starter_template.png screenshot_img: :template:starter_template.png
-tags          : start, discussion, simple, sidebar, userpage+tags          : start, simple, sidebar
  
-downloadurl   : https://www.dokuwiki.org/_media/template:dokuwiki_template_starter.zip+downloadurl   : https://github.com/selfthinker/dokuwiki_template_starter/zipball/master
 bugtracker    : https://github.com/selfthinker/dokuwiki_template_starter/issues bugtracker    : https://github.com/selfthinker/dokuwiki_template_starter/issues
 sourcerepo    : https://github.com/selfthinker/dokuwiki_template_starter sourcerepo    : https://github.com/selfthinker/dokuwiki_template_starter
 donationurl   : https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=11071728 donationurl   : https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=11071728
 ----  ---- 
- 
  
 The **Starter Template** is designed to be the starting point of your custom template. It has a lot of inline comments in the code which should explain many things. It focuses less on design, but more on maintainability. The **Starter Template** is designed to be the starting point of your custom template. It has a lot of inline comments in the code which should explain many things. It focuses less on design, but more on maintainability.
Line 36: Line 35:
 ===== Download and Install ====== ===== Download and Install ======
  
-Use the following URL to download this template:+  * For DokuWiki version 2014-05-05 (Ponder Stibbons) and later: Use the extension manager to install this template
 +  * For Binky or Weatherwax: You can {{:template:dokuwiki_template_starter.zip|download an older version}}. 
 +  * If you're interested in a more stripped down version of the template, you can use the [[https://github.com/selfthinker/dokuwiki_template_starter/tree/minimal|"minimal" branch]]. That version hardly uses any CSS at all and doesn't include any additional functionalities.
  
-  * **{{:template:dokuwiki_template_starter.zip|Download latest version}}** +Refer to [[:template]] on how to install and use templates in DokuWiki.
-  * [[https://github.com/selfthinker/dokuwiki_template_starter|Repository]] +
- +
-The latest version is only compatible to the last two DokuWiki releases. If you need to support older DokuWikis, you can use the [[https://github.com/selfthinker/dokuwiki_template_starter/tree/backwards-compatible|"backwards-compatible" branch]] instead. +
- +
-Refer to [[:template]] on how to install and use templates in Dokuwiki.+
  
 ===== Configuration ====== ===== Configuration ======
Line 50: Line 46:
  
 ^config option         ^description                                                         ^default value   ^ ^config option         ^description                                                         ^default value   ^
-^ ''userPage''         | User page (''@USER@'' is replace by the corresponding user name)   | ''user:@USER@'' | 
-^ ''discussionPage''   | Discussion page (''@ID@'' is replaced by the corresponding page ID)| ''discussion:@ID@'' | 
 ^ ''hideTools''        | hide editing and other tools when not logged in                    | ''0''          | ^ ''hideTools''        | hide editing and other tools when not logged in                    | ''0''          |
 +^ ''sidebarIsNav''     | use a ''nav'' element around the sidebar if it's mainly used for navigation, otherwise use an ''aside'' element (new since version 2021-01-25) | ''1''          |
  
-===== Event hooks =====+Config options in previous versions (removed in version 2021-01-25):
  
-Since 2013-11-18 the following three event hooks are supported:+  * ''discussionPage'': Discussion page functionality was removed and can be replaced by using the [[:plugin:talkpage|Talkpage Plugin]]; just change the ''talkns'' option from 'talk' to 'discussion' to use the same namespace as before 
 +  * ''userPage'': User page functionality was removed and can be replaced by using the [[:plugin:userpage|Userpage Plugin]]
  
-  * ''TEMPLATE_USERTOOLS_DISPLAY'': for changing or adding to items in the user tools (login, admin, etc) 
-  * ''TEMPLATE_SITETOOLS_DISPLAY'': for changing or adding to items in the site tools (recent changes, sitemap, etc) 
-  * ''TEMPLATE_PAGETOOLS_DISPLAY'': for changing or adding to items in the user tools (edit page, old revisions, etc) 
- 
-The items can be accessed via ''%%$event->data['items']%%''. 
  
 ===== More Info ====== ===== More Info ======
- 
-==== To Do ===== 
- 
-  * improve print styles 
  
 ==== Credits ===== ==== Credits =====
Line 80: Line 67:
  
 {{rss>https://github.com/selfthinker/dokuwiki_template_starter/commits/master.atom date}} {{rss>https://github.com/selfthinker/dokuwiki_template_starter/commits/master.atom date}}
 +
 ==== Demo ==== ==== Demo ====
  
Line 95: Line 83:
   * [[writers|Writer's]]   * [[writers|Writer's]]
   * [[zenlike|Zenlike]]   * [[zenlike|Zenlike]]
 +  * [[benjamin|Benjamin]]
 +  * [[template:stm|STM]]
 +
 ===== Comments ===== ===== Comments =====
  
Line 103: Line 94:
 ==== How to translate this theme? ==== ==== How to translate this theme? ====
  
-There are two files to translate: +There are three files to translate: 
-  * [[https://github.com/selfthinker/dokuwiki_template_starter/blob/master/lang/en/lang.php|lang/en/lang.php]] is for everything you see on the frontend (although the "accessibility headlines" are hidden for most users). This file is the most important to translate.+  * [[https://github.com/selfthinker/dokuwiki_template_starter/blob/master/lang/en/lang.php|lang/en/lang.php]] is for everything you see on the frontend (although the "accessibility headlines" are hidden for most users) plus descriptions for style.ini placeholders which the [[plugin:Styling]] plugin in the admin section uses. This file is the most important to translate.
   * [[https://github.com/selfthinker/dokuwiki_template_starter/blob/master/lang/en/settings.php|lang/en/settings.php]] is for the configuration admin. This file is not as important as the other, as it will only be seen by the admin(s).   * [[https://github.com/selfthinker/dokuwiki_template_starter/blob/master/lang/en/settings.php|lang/en/settings.php]] is for the configuration admin. This file is not as important as the other, as it will only be seen by the admin(s).
 +  * [[https://github.com/selfthinker/dokuwiki_template_starter/blob/master/lang/en/style.txt|lang/en/style.txt]] is for extra information about configuration of the template displayed under the form of the [[plugin:Styling]] plugin in the admin section.
  
 You can either send me language files to update by email or post them here or in the [[https://github.com/selfthinker/dokuwiki_template_starter/issues|bugtracker]]. Please have a look at the [[https://github.com/selfthinker/dokuwiki_template_starter/tree/master/lang|available translations]] first. You can either send me language files to update by email or post them here or in the [[https://github.com/selfthinker/dokuwiki_template_starter/issues|bugtracker]]. Please have a look at the [[https://github.com/selfthinker/dokuwiki_template_starter/tree/master/lang|available translations]] first.
Line 129: Line 121:
 ><code javascript>javascript:window.location=window.location+"?do=login"</code> (I'm assuming the use of [[doku>Rewrite|webserver rewriting]]) ---[[user>atnbueno|Antonio Bueno]] //2011/11/11 21:40// ><code javascript>javascript:window.location=window.location+"?do=login"</code> (I'm assuming the use of [[doku>Rewrite|webserver rewriting]]) ---[[user>atnbueno|Antonio Bueno]] //2011/11/11 21:40//
 >>That sounds like a good idea! Thanks --- //Nactus 2011-11-13// >>That sounds like a good idea! Thanks --- //Nactus 2011-11-13//
 +
 +==== Backlink for Discussion Has Wrong Page ID ====
 +in line 31 of tpl_functions
 +  tpl_pagelink($backID, $backTitle); 
 +returns 
 +  discussion:home
 +for the page ID when the link is built. The issue is not with the _tpl_discussion function as replacing //$backID// with //'home'// produces the same problem.
 +
 +A fix is: 
 +  tpl_pagelink(':'.$backID, $backTitle);
 +
 +> Thanks. That's fixed since today's release. --- [[user>ach|Anika Henke]] //2014-05-19 03:24//
template/starter.1384739985.txt.gz · Last modified: 2013-11-18 02:59 by ach

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki