create new tag
, view all tags

Book On TWiki

We all know that documentation is scattered around twiki.org. It's about time to move forward and consolidate all these resources into a central place. The Book is contributed by the community, but must have key dedicated individuals that keep track on the quality of sections.

Three books are suggested.


The Nutshell Book comprises of generic and common understanding of TWiki. It includes,
  • System requirements and its fallbacks
  • The purpose of TWiki
    • Disadvantages and advantages of TWiki - What TWiki is and what it is not!
    • Specific use cases
    • Also on ConvincingYourBoss
  • Installation of TWiki on various platforms
    • Include what works and what does. Which requires expert knowledge, which doesn't.
    • Step by step guide (to improve README and INSTALL)
  • Installation of Plugins, Contribs, Addons, and Templates/Skins
    • Introduction to =configure='s FindMoreExtension
  • Customisation (Generic level)
    • Introduction to the structure of TWiki
    • Customising common Plugins
    • Understanding Templates and Skins
    • e.g. ConsolidateShorterURLs


The Reference Book goes in depth for developers/users who wish to further customise their TWiki environment. So it will include specifics on Plugin/Contrib/Addon/Template/Skin customisation with its API.

Each of them has their own Topic which describes the API, so reference linking is suffice.

A very important part of this Book, is examples. Examples that can be found in Sandbox, for instance. A wide range of examples is a must.


The Developer Book provides technical knowledge of TWiki's engine. It includes...
  • Structure of TWiki
  • Dependencies?
  • How-to write good Plugins/Contribs/Addons/Templates/Skins
  • Deprecations (if any)

The entire purpose of this exercise is to not rely on twiki.org as a whole, but rather on any of these 3 relevant books that should have everything under the Internet/Intranet about TWiki.

This should provide support for DocumentationRating and others.

-- Contributors: KwangErnLiew - 11 May 2007


Kwang, you bring up some good points. Instead of writing a new book from scratch, how about extending the existing DistributionDocuments to be in a format/with content where we can create a TWiki book? There is alerady a lot of good material, but it is currently mainly focusing on the technical details. We could even enhance the build script to generate a nice PDF book out of selected distribution documents.

BTW, the Wikis for Dummies book (to be published in the June 2007) covers TWiki quite a bit, as well as social aspects of deploying wikis.

-- PeterThoeny - 12 May 2007

Edit | Attach | Watch | Print version | History: r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r3 - 2007-05-12 - PeterThoeny
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.