(file) Return to GoodStyle.txt CVS log (file) (dir) Up to [RizwankCVS] / geekymedia_web / twiki / data / TWiki

 1 rizwank 1.1 %META:TOPICINFO{author="PeterThoeny" date="1079171880" format="1.0" version="1.9"}%
 2             ---+ <nop>GoodStyle Collaboration Tips
 3             
 4             	* TWiki has a very simple *[[TWikiShorthand][text formatting shorthand]]*. In any case, you won't go wrong if you simply:
 5             		* start each line without spaces
 6             		* separate paragraphs with a blank line 
 7             
 8             	* Run together capitalized words to form *[[WikiWords][WikiWords]]:* 
 9             		* WikiWords automatically appear as hyperlinks
10             		* make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
11             		* WikiWords has name-creation tips that may help
12             
13             #SignAndDate
14             	* If a *discussion* is going on:
15             		* separate each follow-up with a space
16             		* add your WikiName and the date at the end. Example:%BR%
17             		  =-- <nop>%WIKIUSERNAME% - %SERVERTIME{$day $mon $year}%=
18             		* OR, by all means, insert your comment where it seems to fit best:
19             			* you may want to inset it with a bullet and/or _set it in italics_ so it's clear (always sign and date)
20             		* if you'd like to use an initial, use a link with label. Example:%BR%
21             		  =-- [<nop>[%WIKIUSERNAME%][ZXQ]] - %SERVERTIME{$day $mon $year}%=
22 rizwank 1.1 			* To automate that, add a bullet like =* Initials: ZXQ= to your [[%WIKIUSERNAME%][home page]].
23             
24             	* A good format for a *new topic* is "dissertation followed by discussion": 
25             		* start with a brief, factual introduction, followed by double horizontal rules
26             		* let the discussion begin
27             
28             	* When a discussion dies down and the page becomes static, if you're clear on your course, feel free to *refactor mercilessly*:
29             		* fearlessly edit down to capture the key points
30             		* reduce the noise without losing the facts or the flavor
31             		* if you merge or delete comments, group credit =Contributors:= at the end of the page
32             		* _This is how Wiki content matures and grows in value over time._
33             
34             	* 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. 
35             
36             	* TWiki is intended for world-wide use, and an internationally understood date format like ==01 Sep 2003== or ==2003/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,...
37             
38             	* *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. 
39             
40             -- TWiki:Main.MikeMannix - 01 Dec 2001 %BR%
41             -- TWiki:Main.PeterThoeny - 13 Mar 2004

Rizwan Kassim
Powered by
ViewCVS 0.9.2