TOTEM TWiki rules

TWiki is a great technology, but without rules, conventions and a bit of coordination, a TWiki web can easily become messy. Here are a few simple TOTEM TWiki rules that will evolve on the basis of experience. Suggestions for improvement are welcome.

For guidelines and advice about web usability, see what Jakob Nielsen has to say. At any rate, even with the best rules and convention, in a few years from now the extensive TOTEM TWiki will probably require some refactoring. At that time, see how Paolo Palazzi organized the redesign of the BaBar web in 1998.


  • start the page with an H1 header ( ---+ Title ...), with a meningful title that helps to understand the context;

  • just below add at least one summary paragraph to summarize what comes below and make the scope of the page even clearer;

  • in the same spirit, when inserting H2 and H3 headers, always insert a paragraph after a header before you insert a lower level header, unless the context is crystal-clear;


The TOTEM TWiki pages are organized with the same groups as the main TOTEM web, and also the TOTEM hypernews:

  • 1. Organization
  • 2. Detector
  • 3. Software and computing
  • 4. Physics
  • 5. Documentation
  • 6. Miscellaneous

and it would be interesting to try and maintain the consistency also at the lower levels; this will require some discussions and adjustments from time to time;

page names

  • the beginning of the name can be omitted if the rest of the name is unambiguous; for example, the name of the page containing the DCS Glossary could be shortened from CompDcsGlossary to DcsGlossary, but not to Glossary, because there might be several TOTEM glossaries other than the DCS one.

  • when in Rome, do like the Romans: the TWiki WikiWord style, with strings of two or more words with initial capitals run together, does not match with acronyms that are all uppercase; when appropriate, give priority to the WikiWord style, for example when using the acronym DCS within a WikiWord, spell it Dcs, like in CompDcsGlossary.

access rights

currently all TOTEM TWiki pages are visible to the world, but editable only by users in TotemGroup; in the future this may change depending on the TOTEM information access policy;

if you wish to restrict the access of a given page to TotemGroup, when you are on that page you should click on MoreTopicActions, then EditSettings, then copy and paste the two lines listed below:

   @asterisk@ Set DENYTOPICVIEW = Main.TWikiGuest
   @asterisk@ Set ALLOWTOPICVIEW = Main.TotemGroup
and replace @asterisk@ by * mark.

if you want to be even more restrictive, and give read acces only to some selected people (and not to the whole TotemGroup), then on the second line you should list the selected users, for example:

   @asterisk@ Set ALLOWTOPICVIEW = Main.LeszekGrzanka , Main.PaoloPalazzi
and replace @asterisk@ by * mark.

notice that TWiki has strict formatting rules, so please make sure that you have three spaces, an asterisk, and an extra space in front of any access control rule;

those two access control rules could also be added directly in the body of the page.

This topic: TOTEM > WebLeftBar > TotemTwikiRules
Topic revision: r21 - 2006-10-13 - PaoloPalazzi
This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback