data/TWiki/GoodStyle.txt
changeset 0 414e01d06fd5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/GoodStyle.txt	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,41 @@
     1.4 +%META:TOPICINFO{author="TWikiContributor" date="1174436429" format="1.1" version="13"}%
     1.5 +---+ <nop>GoodStyle Collaboration Tips
     1.6 +
     1.7 +   * TWiki has a very simple *[[TWikiShorthand][text formatting shorthand]]*. In any case, you won't go wrong if you simply:
     1.8 +      * start each line without spaces
     1.9 +      * separate paragraphs with a blank line 
    1.10 +
    1.11 +   * Run together capitalized words to form *[[WikiWords][WikiWords]]:* 
    1.12 +      * WikiWords automatically appear as hyperlinks
    1.13 +      * make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
    1.14 +      * WikiWords has name-creation tips that may help
    1.15 +
    1.16 +#SignAndDate
    1.17 +   * If a *discussion* is going on:
    1.18 +      * separate each follow-up with a space
    1.19 +      * add your WikiName and the date at the end. Example:%BR%
    1.20 +        =-- <nop>%WIKIUSERNAME% - %SERVERTIME{$day $mon $year}%=
    1.21 +      * OR, by all means, insert your comment where it seems to fit best:
    1.22 +         * you may want to inset it with a bullet and/or _set it in italics_ so it's clear (always sign and date)
    1.23 +      * if you'd like to use an initial, use a link with label. Example:%BR%
    1.24 +        =-- [<nop>[%WIKIUSERNAME%][ZXQ]] - %SERVERTIME{$day $mon $year}%=
    1.25 +
    1.26 +   * A good format for a *new topic* is "dissertation followed by discussion": 
    1.27 +      * start with a brief, factual introduction, followed by double horizontal rules
    1.28 +      * let the discussion begin
    1.29 +
    1.30 +   * When a discussion dies down and the page becomes static, if you're clear on your course, feel free to *refactor mercilessly*:
    1.31 +      * fearlessly edit down to capture the key points
    1.32 +      * reduce the noise without losing the facts or the flavor
    1.33 +      * if you merge or delete comments, group credit =Contributors:= at the end of the page
    1.34 +      * _This is how Wiki content matures and grows in value over time._
    1.35 +
    1.36 +   * 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. 
    1.37 +
    1.38 +   * 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,...
    1.39 +
    1.40 +   * *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. 
    1.41 +
    1.42 +__Related Topics:__ UserDocumentationCategory
    1.43 +
    1.44 +-- __Contributors:__ TWiki:Main.MikeMannix, TWiki:Main.PeterThoeny