DokuWiki

It's better when it's simple

User Tools

Site Tools


Sidebar

Translations of this page?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

namespace_templates

Namespace Templates

Sometimes you might want to have every page in a certain namespace based on a common skeleton. For example, in the address namespace you could have an already prepared table, which only needs to be filled with data. This can be easily achieved with so called “namespace templates”.

When a page is created, DokuWiki looks up whether a template file exists and it shows it within the editor window. The templates therefore are .txt files and should contain wiki markup.

Template files

Two kinds of template files can be used:

  • _template.txt, which are used in the current namespace.
  • __template.txt (two leading underscores), which work as the normal _template.txt files apart from the fact they are used in all namespaces below as well (they are inherited).

If both (inherited and normal) templates are present in a namespace, the normal one is taken.

One way to create the template file is to

  1. use the wiki to save a page with the content that you want to use as a template into the appropriate namespace
  2. use FTP or WebDAV to rename it as _template.txt, then
  3. Note: 1)

Syntax

The content of the file is just standard wiki markup.

Replacement patterns

Inside of the file, you may also use some replacement patterns to make the template a little more dynamic.

@ID@ full ID of the page
@NS@ namespace of the page
@PAGE@ page name (ID without namespace and underscores replaced by spaces)
@!PAGE@ same as above but with the first character uppercased
@!!PAGE@ same as above but with the first character of all words uppercased
@!PAGE!@ same as above but with all characters uppercased
@FILE@ page name (ID without namespace, underscores kept as is)
@!FILE@ same as above but with the first character uppercased
@!FILE!@ same as above but with all characters uppercased
@USER@ ID of user who is creating the page
@NAME@ name of user who is creating the page
@MAIL@ mail address of user who is creating the page
@DATE@ date and time when edit session started
%a %d-%m-%y etc. e.g. Thu 06-12-12. Strftime placeholders are replaced by page creation time
%% a literal % character appears in your template

In addition you may also use any strftime placeholder to insert the time of page creation in any format you like. If you want to use a literal % character in your template you need to double it.

Still editing templates via wiki

You can't edit the _template.txt through DokuWiki (only someone who can edit the files inside the filesystem folders (usually an administrator using FTP or WebDAV) can modify these files). There are three ways to accomplish this, though:

  • the easiest is using the TemplatePagename plugin which let you change the default templatename _template into another name e.g. template that is allowed as normal editable wikipage.
  • or by setting up through symbolic links

NOTE: This section contains instructions for use on a Linux server and will not work on a Windows system.

This way, you can store your templates in a special namespace, and make symlinks for DokuWiki to find them. You can also choose to make a specific template non-editable by removing its particular symlink.

  1. Create a namespace called “templates”, or something similar.
  2. In this namespace, create a page for each Namespace Template that you wish to be editable.
  3. Follow the instructions given above, but make _template.txt a hard link 2) to the correct page under your templates namespace. You now have a template that can be modified easily via the wiki interface.

Another way is to create symlinks in the folder itself. Thus you create a template.txt which is a symbolic link to the _template.txt, in it's own namespace.

cd /var/www/html/dokuwiki/data/pages/namespace/something
ln -s _template.txt template.txt

For these softlinks to work, you might need the FollowSymLinks option set for this directory in your webserver's configuration.

NOTE: This section contains instructions for use on a Windows server and will not work on a Linux system.

Open up command prompt (cmd.exe) on the server, and browse to the location you with there to be a template. Use the MKLINK command to create a symbolic link.

cd c:\inetpub\wiki\data\pages\namespace\something
mklink template.txt _template.txt

Plugins

Additional template features are implemented by plugins.

  • TemplatePagename Plugin can change the names of _template and __template in your choice via configuration manager. Has as defaults respectively c_template and i_template. This plugin will let you choose normal wiki pages as template so that they are editable via the wiki interface.
  • TemplateByName Plugin extends available templates with
    • ~yourpagename.txt for the page named yourpagename in the current namespace
    • ~yournamespace.txt for all pages in the subnamespace named yournamespace
    • and variants for deeper namespaces too and some other templates e.g. for start pages.
      All these plugins are only editable via the file system.
  • NewPageTemplate Plugin adds a URL parameter that defines which existing page from the wiki is loaded as the template. Every page allowed by ACL is available.
  • Snippets Plugin adds a button to the editor toolbar which allows to easily insert templates while editing a page. The shown templates needs to be list on one page, default snippets.
  • Headerfooter Plugin adds header text or footer text to pages only when they are displayed.

@GROUPS@ support

It may be interesting to have support for the @GROUPS@ keyword to extend to the group list of the user creating the page (e.g. to specify a set of tags on a user's home page). The following patch implements it.

Index: dokuwiki-2009-02-14/inc/common.php
===================================================================
--- dokuwiki-2009-02-14.orig/inc/common.php    2009-11-19 11:58:41.000000000 +0100
+++ dokuwiki-2009-02-14/inc/common.php 2010-01-05 10:17:35.000000000 +0100
@@ -840,6 +840,7 @@
                         '@USER@',
                         '@NAME@',
                         '@MAIL@',
+                        '@GROUPS@',
                         '@DATE@',
                      ),
                      array(
@@ -855,6 +856,7 @@
                         $_SERVER['REMOTE_USER'],
                         $INFO['userinfo']['name'],
                         $INFO['userinfo']['mail'],
+                        implode(" ", $INFO['userinfo']['grps']),
                         $conf['dformat'],
                      ), $tpl);

Olivier Mehani 2010/01/05 10:19

1)
These changes only apply to new pages that you create in the namespace.
2)
soft links seem not to work, but see the note about FollowSymLinks below
namespace_templates.txt · Last modified: 2016-11-03 02:21 by ach