fc607284c4834a4d4caaf395fdeb83c3360d0149
[openafs-wiki.git] / TWiki / GoodStyle.mdwn
1 # <a name="GoodStyle Collaboration Tips"></a><a name="_GoodStyle Collaboration Tips"></a> GoodStyle Collaboration Tips
2
3 - TWiki has a very simple **[[text formatting shorthand|Main/TWikiShorthand]]**. In any case, you won't go wrong if you simply:
4   - start each line without spaces
5   - separate paragraphs with a blank line
6
7 - Run together capitalized words to form **[[WikiWords]]:**
8   - [[WikiWords]] automatically appear as hyperlinks
9   - make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
10   - [[WikiWords]] has name-creation tips that may help
11
12 - If a **discussion** is going on:
13   - separate each follow-up with a space
14   - add your [[WikiName]] and the date at the end
15   - OR, by all means, insert your comment where it seems to fit best:
16     - you may want to inset it with a bullet and/or _set it in italics_ so it's clear (always sign and date)
17   - if a sub-topic develops, separate it with a horizontal rule at beginning and end
18
19 - A good format for a **new topic** is "dissertation followed by discussion":
20   - start with a brief, factual introduction, followed by double horizontal rules
21   - let the discussion begin
22
23 - When a discussion dies down and the page becomes static, if you're clear on your course, feel free to **refactor mercilessly**:
24   - fearlessly edit down to capture the key points
25   - reduce the noise without losing the facts or the flavor
26   - if you merge or delete comments, group credit `Contributors:` at the end of the page
27   - _This is how Wiki content matures and grows in value over time._
28
29 - 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.
30
31 - TWiki is intended for world-wide use, and an internationally understood date format like <code>**01 Sep 2003**</code> or <code>**2003/09/01**</code> 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,...
32
33 - **TIP:** Check the source when you want to find out how something is formatted: click <code>**Edit**</code> on the lower toolbar. To see earlier versions, click <code>**More**</code>, then check <code>**Raw text format**</code> and click <code>**View revision**</code>. A bit of HTML experience can't hurt, but you'll soon see with [[TWikiShorthand]] how far that is from necessary.
34
35 -- TWiki:Main.MikeMannix - 01 Dec 2001 %BR% -- TWiki:Main.PeterThoeny - 16 Dec 2003