====== Starter Template ====== ---- template ---- description : The template that gets you started author : Anika Henke email : anika@selfthinker.org lastupdate : 2024-01-21 compatible : Frusterick Manners, Elenor of Tsort, Detritus, "Ponder Stibbons", Hrun, Greebo, Hogfather, 2023-04-04 depends : conflicts : similar : screenshot_img: :template:starter_template.png tags : start, simple, sidebar downloadurl : https://github.com/selfthinker/dokuwiki_template_starter/zipball/master bugtracker : https://github.com/selfthinker/dokuwiki_template_starter/issues sourcerepo : https://github.com/selfthinker/dokuwiki_template_starter 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. It is done in a way which lets you worry less about DokuWiki's core styles. Instead you only need to care about the five main styles: * ''basic.css'': You probably only want to touch this if you'd like to change general font sizes and font stacks. * ''structure.css'': You probably only want to touch this if you'd like to change the general structure of the site (to 3 columns or have different widths or make everything fluid or switch the sidebar to the right, etc). * **''design.css''**: Here you can style all the bits that surround the page content. * **''content.css''**: Here you can style all of the page content. * **''mobile.css''**: Here you can style all of the changes for mobile devices and smaller screens. You can find further advice on [[http://blog.andreas-haerter.com/2011/03/16/how-to-create-a-maintainable-dokuwiki-template|How to create an easily maintainable DokuWiki template]] written by Andreas Haerter (based on a former blog post by Michael Klier). Refer to [[devel:template|Template Development documentation]] for general information. ===== Download and Install ====== * 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. Refer to [[:template]] on how to install and use templates in DokuWiki. ===== Configuration ====== These are in //[theme root]/starter/conf/default.php//. It can be changed from the Configuration panel. ^config option ^description ^default value ^ ^ ''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'' | Config options in previous versions (removed in version 2021-01-25): * ''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]] ===== More Info ====== ==== Credits ===== * Thanks to [[user>andi|Andreas Gohr]] for general advice. * Thanks to [[clarencedglee@gmail.com|Clarence Lee]] for his design advice, especially concerning typography. ==== Changes ===== If you are a template author using this template as a base for your own, you might want to check out the [[:template:starter:changes|list of detailed changes]]. {{rss>https://github.com/selfthinker/dokuwiki_template_starter/commits/master.atom date}} ==== Demo ==== * http://demo.selfthinker.org/ ===== Templates based on Starter ===== * [[template:dokuwiki|the new default template since Adora Belle]] * [[ACH]] * [[monobook]] (the DokuWiki CSS parts) * [[vector]] (the DokuWiki CSS parts) * [[Taratasy]] * [[Apricot]] * [[Scanlines]] * [[writers|Writer's]] * [[zenlike|Zenlike]] * [[benjamin|Benjamin]] * [[template:stm|STM]] ===== Comments ===== * clear and useful！ great！ * thank you, this template is very clean and useful for most cases! love this :) * Very nice stuff. ==== How to translate this theme? ==== 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) 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/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. ==== How to insert a logo image instead of text? ==== Open the template's ''main.php'' and search for "logo". It's explained in there. ==== CSS bug w/ zoom plugin ==== An image included with the zoom plugin will scroll over the footer and hide it > I cannot reproduce this. Do you have any more specific information? (Browser, other installed plugins, etc?) --- [[user>ach|Anika Henke]] //2011/05/02 16:45// ==== Tools hidden - can't login ==== In the template config, I selected «//hide editing and other tools when not logged in//» and then I logged out. But now I can't log in as there is no «Login» button/link showing. Am I missing something? --- //Nactus 2011-11-10// >You probably need to save/remember the login URL (you can get it just by adding //''?do=login''// to any DokuWiki URL). In fact I use the following [[wp>bookmarklet]]: >javascript:window.location=window.location+"?do=login" (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// ==== 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//