DokuWiki

It's better when it's simple

User Tools

Site Tools


codex

This is an old revision of the document!


DokuWiki Codex

Welcome to the DokuWiki Codex, an in-depth guide into DokuWiki's functions and classes. The end goal here is to organize and document every function within the platform so that searching DokuWiki %function_name or typing dokuwiki.com/codex:function_name keeps you in your development flow.

Template Functions

  • tpl_content
  • tpl_content_core
  • tpl_toc
  • tpl_admin
  • tpl_metaheaders
  • _tpl_metaheaders_action
  • tpl_pagelink
  • tpl_getparent
  • tpl_button
  • tpl_actionlink
  • tpl_get_action
  • tpl_action
  • tpl_searchform
  • tpl_breadcrumbs
  • tpl_youarehere
  • tpl_userinfo
  • tpl_pageinfo
  • tpl_pagetitle
  • tpl_img_getTag
  • tpl_img
  • _tpl_img_action
  • tpl_indexerWebBug
  • tpl_getConf
  • tpl_loadConfig
  • tpl_getLang
  • tpl_locale_xhtml
  • tpl_localFN
  • tpl_mediaContent
  • tpl_mediaFileList
  • tpl_mediaFileDetails
  • tpl_mediaTree
  • tpl_actiondropdown
  • tpl_license
  • tpl_include_page
  • tpl_subscribe
  • tpl_flush
  • tpl_getMediaFile
  • tpl_includeFile
  • tpl_favicon
  • tpl_media
  • tpl_classes

Document Template

If you'd like to help out with the documentation, why not try out the template below (or improve it :) )

====== Function:  ======
Description goes here.

----
===== Usage =====
''function_name($param1, $param2, ...)''

  //If an parameters contains an array list out the defaults here, ex)
  $param1 = array(
      'key1'  => 'value1',
      'key2'  => 'value2'
  )

----
===== Parameters =====
**$param1**
(STRING) Short description.\\ 
//Default: None//

**$param2**
(STRING/ARRAY)[optional] Short description\\ 
//Default: None//

----
===== Examples =====

----
===== Change Log =====

----
===== Source File =====
Link to the source file, example: http://xref.dokuwiki.org/reference/dokuwiki/nav.html?_functions/tpl_link.html

----
===== Resources =====
Links to forum posts or related external pages that focus on this particular function.

----
===== Related =====



//**This page is incomplete, why not fill in a section?**//
codex.1391054058.txt.gz · Last modified: 2014-01-30 04:54 by OzRamos

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