Per Wiki Templates

Per Wiki Templates

When you create a new wiki with the soks-create-wiki command, it copies the contents of path-to-soks-installation/templates/default into a new folder called soks-wiki.

If you change anything in the soks-wiki folder (see ‘how to change the way this wiki looks’ for ideas and tips) then it will apply to that wiki only.

If you wish to create a default set up for future wikis:
  1. Change a running wiki into a form that you find useful,
  2. Create a new folder under path-to-soks-installation/templates/ e.g. path-to-soks-installation/templates/yourtemplate
  3. Copy the contents of your running wiki to this new folder
  4. (Optional) edit the path-to-soks-installation/templates/yourtemplate/start.rb file to allow the port, url, name etc to be set from the soks-create-wiki command (see the path-to-soks-installation/templates/default/start.rb for ideas on how to do this)

You can then use this template to create future wikis by using the—template option of the soks-create-wiki.rb command. e.g. soks-create-wiki.rb --template yourtemplate


I’m still confused as to exactly what templates are doing and why/when I would use them. In other words, what’s a typical use case? —Bil

So, the use I imagine is so that I a user of Soks might wish to be able to quickly deploy (by soks-create-wiki.rb --template frenchwiki)...
  1. An internal team wiki
  2. An external public wiki
  3. A wiki that looks just like other wiki X
  4. A French localised wiki
  5. A wiki that acts like a blog and no more

...Each with a diffent look and feel, different default automatic summaries, default authentication, with or without a calendar by default, etc.. etc…—tamc2

What do the currently supplied instiki, default, and someother templates do for me? (Still dense on this topic.)—Bil

For you? Probably nothing! They just show how can have a different look and feel. The default, instiki and rails layouts are just the three different layouts I originally considered for Soks1:

1 I’ve only been updating the default template recently.

Tag: Include this page in the distribution

Edit this page or watch for changes using RSS.