DokuWiki

It's better when it's simple

User Tools

Site Tools


devel:templates

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
devel:templates [2020-06-04 12:25] andidevel:templates [2021-03-03 09:42] (current) – [Getting Started] Aleksandr
Line 13: Line 13:
   - When your template is ready, consider [[#Publishing a Template on dokuwiki.org|publishing]] it on DokuWiki's [[:template]] page.   - 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): A valid template name (directory):
Line 20: Line 20:
     * DokuWiki's infrastructure doesn't support them anywhere     * DokuWiki's infrastructure doesn't support them anywhere
     * Using underscore will also give a [[:popularity|popularity]] rating of zero.      * Using underscore will also give a [[:popularity|popularity]] rating of zero. 
 +  * Spaces m are also not allowed in the template name defined in ''template.info.txt'' and the folder name, including in the template page name on [[:dokuwiki|dokuwiki.org]] ''template:myfirsttemplate''
   * If the same name is used by two different templates   * If the same name is used by two different templates
     * they are mutually exclusive and inherent incompatible,      * 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.** **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).  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>/''   * ''<dokuwiki>/lib/tpl/<template>/''
Line 144: Line 145:
 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. 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.
  
-===== See Also ===== +
-If you are converting a wordpress theme to a dokuwiki template, it's worth looking at [[devel:wp_to_dw_template|this page]].+
devel/templates.1591266324.txt.gz · Last modified: 2020-06-04 12:25 by andi

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