diff options
| -rw-r--r-- | TWiki/GoodStyle.mdwn | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/TWiki/GoodStyle.mdwn b/TWiki/GoodStyle.mdwn index 5b8b372e..028bbcf9 100644 --- a/TWiki/GoodStyle.mdwn +++ b/TWiki/GoodStyle.mdwn @@ -1,3 +1,5 @@ +# <a name="GoodStyle_Collaboration_Tips"> GoodStyle Collaboration Tips </a> + * TWiki has very simple **[[TextFormattingRules]]**. You won't go wrong if you: * start each line without spaces * separate paragraphs with a blank line @@ -7,9 +9,11 @@ * 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 +* If a **discussion** is going on: + * separate each follow-up with a horizontal rule + * add your [[WikiName]] and the date at the end + * OR, by all means, insert your comment where it seems to fit best: + * you may want to inset it with a bullet and/or _set it in italics_ so it's clear (always sign and date) * A good format for a **new topic** is "dissertation followed by discussion": * start with a brief, factual introduction @@ -18,13 +22,13 @@ * 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 + * if you merge or delete comments, you can group credit `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. +* For **external site links**, you can type URLs directly into the text - `http://etcete.ra/...` - it'll clear to anyone where they're headed on click. -* 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,... +* TWiki is intended for world-wide use, and an international **standard date format** like 01 Sep 2001 is preferred. It's universally understood, and 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,... -* 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. +* 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 TWiki shorthand how far that is from necessary. --- [[Main/PeterThoeny]] - 13 Sep 2001 +-- [[PeterThoeny]] - 13 Sep 2001<br /> -- [[MikeMannix]] - 14 Sep 2001 <br /> |