summaryrefslogtreecommitdiff
path: root/TWiki/GoodStyle.mdwn
blob: 380c3d91d88256e4bc68a07338c39a0cca74e503 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
* TWiki has very simple **[[TextFormattingRules]]**. You won't go wrong if you:
  * start each line without spaces
  * separate paragraphs with a blank line

* Run together capitalized words to make **[[WikiWords]]:**
  * [[WikiWords]] automatically appear as hyperlinks
  * make up meaningful Wiki names - it can be a challenge (it'll sharpen you up!)
  * [[WikiWords]] has name-creation tips that may help

* If a **discussion** is going on on a [[WikiTopic]]:
  * separate each follow up with a horizontal rule
  * add your [[WikiName]] and date at the end

* A good format for a **new topic** is "dissertation followed by discussion":
  * start with a brief, factual introduction
  * then bring on the opinions.

* When a discussion dies down and the page becomes static, feel free to **refactor mercilessly**:
  * fearlessly edit down to capture the key points
  * reduce the noise without losing the facts or the flavor
  * if you merge or delete comments, you can group list "Contributors:" at the end of the page
  * That's how Wiki content matures and grows in value over time.

* 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.

* TWiki is international, and an ISO international standard **date format** like 06 Feb 1998 is preferred. A date like 2/6/98, can mean either Feb or Jun, depending on the local conventions of the readers. For months, use the first three letters: Jan, Feb, Mar, Apr,...

* Look at the source when you want to find out how something is formatted: click **Raw text** on the lower toolbar. A bit of HTML experience can't hurt, but you'll soon see with TWiki how far that is from necessary.

-- [[Main/PeterThoeny]] - 30 Jul 2000