TWiki/GoodStyle.mdwn

   1 - TWiki has very simple **[[text formatting rules|Main/TextFormattingRules]]**. You won't go wrong if you:
   2   - start each line without spaces
   3   - separate paragraphs with a blank line
   4
   5 - Run together capitalized words to make **[[WikiWords]]:**
   6   - [[WikiWords]] automatically appear as hyperlinks
   7   - make up meaningful Wiki names - it can be a challenge (it'll sharpen you up!)
   8   - [[WikiWords]] has name-creation tips that may help
   9
  10 - If a **discussion** is going on on a [[WikiTopic]]:
  11   - separate each follow up with a horizontal rule
  12   - add your [[WikiName]] and date at the end
  13
  14 - A good format for a **new topic** is "dissertation followed by discussion":
  15   - start with a brief, factual introduction
  16   - then bring on the opinions.
  17
  18 - When a discussion dies down and the page becomes static, feel free to **refactor mercilessly**:
  19   - fearlessly edit down to capture the key points
  20   - reduce the noise without losing the facts or the flavor
  21   - if you merge or delete comments, you can group list "Contributors:" at the end of the page
  22   - That's how Wiki content matures and grows in value over time.
  23
  24 - For **external site links**, you can type URLs directly into the text - <code>**http://etcete.ra/...**</code> - it'll clear to anyone where they're headed on click.
  25
  26 - TWiki is international, and an international standard **date format** like 01 Sep 2001 is preferred. A date like 9/1/01, can mean either January or September, depending on the local conventions of the readers. For months, use the first three letters: Jan, Feb, Mar, Apr,...
  27
  28 - Look at the source when you want to find out how something is formatted: click **More** on the lower toolbar, then checkmark **Raw text format** and click on **[ View revision ]**. A bit of HTML experience can't hurt, but you'll soon see with TWiki how far that is from necessary.
  29
  30 -- [[PeterThoeny]] - 13 Sep 2001