Editing a TWiki page is easy: just open an edit session, write some text and save. One thing to remember is that it can be more than just a page of text and there are features that can enhance your documentation. Here are some tips to help you to make the most of your TWiki experience.

Turn your page into a slide show

The SlideShowPlugin converts your topic into a slide show presentation. Simply add %SLIDESHOWSTART% to the topic, a few headers to split the pages and some bullets as typically used for presentations. Add the tag %SLIDESHOWEND% to finish the presentation area and your page is ready for an online slide show.

Table of contents

The variable %TOC% will automatically create a table of contents for a topic based on the headers of the topic.

Roll-back to a previous version

A "Restore topic" feature has been added to the "More topic actions" menu to easily restore an older version of a topic.

Editing with WYSIWYG

The latest version of TWiki has integrated the TinyMCE WYSIWYG editor. This is a fast, highly functional editor and supports a wide range of browsers. The CERN TWiki default editor is "raw edit" but both are available. Each user can set the preference for the editor button by setting the EDITMETHOD in the user homepage.

Set EDITMETHOD = wysiwyg

Print a workbook in PDF

The PDF button found at the top right of each page will generate a PDF version of the page. It is also possible to generate a PDF document containing all of the descendants of the base topic as separate chapters. For example, if you create a ParentTopic, then create topics FirstChild and SecondChild with ParentTopic as their parent topic, then you can create GrandChildOne with FirstChild as its parent. You get a tree:

ParentTopic
- FirstChild
- GrandChildOne
- GrandChildTwo
- SecondChild
- GrandChildThree

If you add "?pdfrecursive=on" to the URL parameters, all of the topics will be rolled into the PDF.

Tree view of your documents

You can also dynamically create a site map for a given web or for a selection of topics. The following example returns a site map for all topics that were created under the topic ParentOfMyFaqs in the Sandbox web.

%TREEVIEW{web=" Sandbox " topic=" ParentOfMyFaqs " formatting="ullist"}%

Shared blackboard

Collaborate with your project team by using TWiki as a virtual blackboard. Set up a few user topics: SubBlackboard1, SubBlackboard2, SubBlackboard3 and SubBlackboard4. Now with the %INCLUDE% variable make a main blackboard topic that contains each sub-blackboard.

This allows several people to write on the same page simultaneously.


%INCLUDE%{"SubBlackboard1"}%INCLUDE%{"SubBlackboard2"}
%INCLUDE%{"SubBlackboard3"}%INCLUDE%{"SubBlackboard4"}

Search functionality

There are several search methods. The box at the top right of each TWiki page uses the CERN search, which indexes TWiki pages every day and returns fast results.

Each web has a topic called WebSearch providing a search that returns an alphabetical list of pages found for the given keywords or regular expressions.

The %SEARCH% variable can be embedded into a TWiki page to create a dynamic search. Searches can be of different types; among others, TWiki offers keyword search, regular-expression search and a flexible SQL-like query language. Inserting the following line into a TWiki topic will return the seven most recently changed pages in the current web.

%SEARCH{ "\.*" scope="topic" type="regex" nosearch="on" nototal="on" order="modified" reverse="on" format="| $topic | $wikiusername | $date |" limit="7" }%

Access control with egroups

Since November 2009, egroups can be used for access control on the web level or in individual topics. For example, to allow read access only to members of the egroup myegroup:

* Set ALLOWTOPICVIEW = myegroup

Action tracking

It is possible to track actions from the browser with the ActionTracker plugin, e.g. by changing their status inline. This can also be used for managing personal to-do lists and for highlighting things.

%ACTION{ who="JohnSmith" due="2 Apr 2010" state="open" }% Write the minutes %ENDACTION%

Report a problem

E-mail twtool.support@cernSPAMNOT.ch.