Differences

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

--- devel:templates [2015-06-14 16:59] – mentioned cleaner "minimal" branch of starter template ach
+++ devel:templates [2023-09-24 01:08] (current) – Klap-in
@@ Line 13: / Line 13: @@
   - When your template is ready, consider [[#Publishing a Template on dokuwiki.org|publishing]] it on DokuWiki's [[:template]] page.
-===Template naming conventions===
+=== Template naming conventions ===
 A valid template name (directory):
@@ Line 20: / Line 20: @@
     * DokuWiki's infrastructure doesn't support them anywhere
     * Using underscore will also give a [[:popularity|popularity]] rating of zero.
+  * Spaces '' '' are also not allowed in the base name of the template defined in ''template.info.txt'' and the folder name, including the page name used in the [[:templates|template listing]] e.g. ''template:myfirsttemplate''
   * If the same name is used by two different templates
     * they are mutually exclusive and inherent incompatible,
-    * furthermore only one of them can have a template homepage on dokuwiki.org.
+    * furthermore only one of them can have a template homepage on [[:dokuwiki|dokuwiki.org]]
 **It is important to have a unique base field value (i.e. template name) in [[devel:template_info|template.info.txt]] or an already existing template with that name could be overwritten.**
@@ Line 30: / Line 31: @@
 Templates should follow the following directory structure (all paths are relative to the template directory).
-CSS files are specified in the ''[[CSS#style.ini]]'' file. Use as many files as you like, but you should at least provide one CSS file for the screen presentation and one for printing.
+CSS files are specified in the ''[[style.ini]]'' file. Use as many files as you like, but you should at least provide one CSS file for the screen presentation and one for printing.
   * ''<dokuwiki>/lib/tpl/<template>/''
@@ Line 52: / Line 53: @@
-===== Functions =====
+===== Inner workings explained =====
+==== Functions ====
 A list of available functions can be found in [[xref>inc/template.php|API documentation]]. Some specialities are listed here.
@@ Line 91: / Line 94: @@
   * Further many other useful template functions are available. Please have a look in [[xref>inc/template.php|API documentation]].
-===== Global Variables And Constants =====
+==== Global Variables And Constants ====
 For a complete list of useful global variables and constants please refer to the [[environment]] page.
-===== Automated Housekeeping =====
+==== Automated Housekeeping ====
-Almost at the bottom of the default template's [[devel:templates:main.php]] file you'll see a function call to ''[[xref>tpl_indexerWebBug()]]''. The function generates a HTML ''%%<img>%%'' tag which results in a request to ''[[:indexer|lib/exe/indexer.php]]''. This **vital** part of DokuWiki provides important housekeeping work to keep the wiki running smoothly. All templates should include this function, without it the wiki may not function correctly (for example the [[:search|search index]] wont be built).
+Almost at the bottom of the default template's [[devel:templates:main.php]] file you'll see a function call to ''[[xref>tpl_indexerWebBug()]]''. The function generates a HTML ''%%<img>%%'' tag which results in a request to ''[[:taskrunner|lib/exe/taskrunner.php]]''. This **vital** part of DokuWiki provides important housekeeping work to keep the wiki running smoothly. All templates should include this function, without it the wiki may not function correctly (for example the [[:search|search index]] wont be built).
-===== 'dokuwiki' class =====
+==== 'dokuwiki' class ====
 A class named ''dokuwiki'' should be added to some content surrounding element (either around everything or at least around ''tpl_content()'') in each template's [[devel:templates:main.php]], [[devel:templates:detail.php]] and [[devel:templates:mediamanager.php]]. This is to make sure that DokuWiki's styles don't interfere with other styles if it gets integrated into an existing site with potentially conflicting CSS.
-===== Include Hooks =====
+==== Include Hooks ====
 Include Hooks are a simple way to add some static content to your [[:DokuWiki]] installation without writing your own [[:Template]]. You can use them for adding a standard header at the top or a disclaimer at the bottom of each page.
-The DokuWiki's default template looks for files with special names in the template directory and simply includes them at the correct places when displaying the page. You can add whatever HTML or even PHP you like into these files. Of course this only works if you are using the //default// template or a template supporting the [[template:dokuwiki#supported_include_hooks|same include hooks]] (like the starter template).
+The DokuWiki's default template looks for files with special names in the template directory and simply includes them at the correct places when displaying the page. You can add whatever HTML or even PHP you like into these files. Of course this only works if you are using the //dokuwiki// template or a template supporting the [[template:dokuwiki#supported_include_hooks|same include hooks]] (like the starter template).
+===== Converting existing templates =====
+If you're lacking design skills you can also convert existing templates. There are lots of free options available. If you'd like to publish one of those as well, please make sure it is [[https://www.gnu.org/philosophy/license-list.html#GPLCompatibleLicenses|GPL2-compatible]].
+  * [[WP_to_DW_template|How to convert a WordPress theme to a DokuWiki template]]
 ===== Avoiding problems =====
@@ Line 134: / Line 143: @@
 From version Ponder Stibbons on an automated update signalling is possible. For the update process to work properly it is necessary that the date “Last updated on” on the template's wiki page equals the date in the file [[devel:template_info|template.info.txt]] in the source tarball/zip file. If this is not the case the update will not take place or the “Update” signal persists.
-Uploads are not allowed on dokuwiki.org, so you need to host your template files somewhere else. We recommend to manage your source with a Revision Control System like [[git]]. If you do, it's easiest to use a public repository host like [[http://github.com|GitHub]] which also offers a bug tracker for your repository.
+Uploads are not allowed on dokuwiki.org, so you need to host your template files somewhere else. We recommend to manage your source with a Revision Control System like [[git]]. If you do, it's easiest to use a public repository host like [[https://github.com|GitHub]] which also offers a bug tracker for your repository.