data/TWiki/GoodStyle.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
%META:TOPICINFO{author="TWikiContributor" date="1174436429" format="1.1" version="13"}%
colas@0
     2
---+ <nop>GoodStyle Collaboration Tips
colas@0
     3
colas@0
     4
   * TWiki has a very simple *[[TWikiShorthand][text formatting shorthand]]*. In any case, you won't go wrong if you simply:
colas@0
     5
      * start each line without spaces
colas@0
     6
      * separate paragraphs with a blank line 
colas@0
     7
colas@0
     8
   * Run together capitalized words to form *[[WikiWords][WikiWords]]:* 
colas@0
     9
      * WikiWords automatically appear as hyperlinks
colas@0
    10
      * make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
colas@0
    11
      * WikiWords has name-creation tips that may help
colas@0
    12
colas@0
    13
#SignAndDate
colas@0
    14
   * If a *discussion* is going on:
colas@0
    15
      * separate each follow-up with a space
colas@0
    16
      * add your WikiName and the date at the end. Example:%BR%
colas@0
    17
        =-- <nop>%WIKIUSERNAME% - %SERVERTIME{$day $mon $year}%=
colas@0
    18
      * OR, by all means, insert your comment where it seems to fit best:
colas@0
    19
         * you may want to inset it with a bullet and/or _set it in italics_ so it's clear (always sign and date)
colas@0
    20
      * if you'd like to use an initial, use a link with label. Example:%BR%
colas@0
    21
        =-- [<nop>[%WIKIUSERNAME%][ZXQ]] - %SERVERTIME{$day $mon $year}%=
colas@0
    22
colas@0
    23
   * A good format for a *new topic* is "dissertation followed by discussion": 
colas@0
    24
      * start with a brief, factual introduction, followed by double horizontal rules
colas@0
    25
      * let the discussion begin
colas@0
    26
colas@0
    27
   * When a discussion dies down and the page becomes static, if you're clear on your course, feel free to *refactor mercilessly*:
colas@0
    28
      * fearlessly edit down to capture the key points
colas@0
    29
      * reduce the noise without losing the facts or the flavor
colas@0
    30
      * if you merge or delete comments, group credit =Contributors:= at the end of the page
colas@0
    31
      * _This is how Wiki content matures and grows in value over time._
colas@0
    32
colas@0
    33
   * For *external site links*, you can type URLs directly into the text - =http://etcete.ra/...= - it'll be clear to anyone where they're headed on click. 
colas@0
    34
colas@0
    35
   * TWiki is intended for world-wide use, and an internationally understood date format like ==01 Sep %SERVERTIME{$year}%== or ==%SERVERTIME{$year}%-09-01== is preferred. It's clearer than the xx/xx/xx format, where a date like 9/1/01 can mean either Jan or Sep, depending on the local conventions of the readers. For months, use the first three letters: Jan, Feb, Mar, Apr,...
colas@0
    36
colas@0
    37
   * *TIP:* Check the source when you want to find out how something is formatted: click ==Edit== on the lower toolbar. To see earlier versions, click ==More==, then check ==Raw text format== and click ==View revision==. A bit of HTML experience can't hurt, but you'll soon see with TWikiShorthand how far that is from necessary. 
colas@0
    38
colas@0
    39
__Related Topics:__ UserDocumentationCategory
colas@0
    40
colas@0
    41
-- __Contributors:__ TWiki:Main.MikeMannix, TWiki:Main.PeterThoeny