none
[openafs-wiki.git] / TWiki / GoodStyle.mdwn
index 4f041fd..78ca620 100644 (file)
@@ -9,12 +9,15 @@
   - make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
   - [[WikiWords]] has name-creation tips that may help
 
+<a name="SignAndDate"></a>
+
 - If a **discussion** is going on:
   - separate each follow-up with a space
-  - add your [[WikiName]] and the date at the end
+  - add your [[WikiName]] and the date at the end. Example:%BR% `-- Main.admin - 29 Jun 2010`
   - 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)
-  - if a sub-topic develops, separate it with a horizontal rule at beginning and end
+  - if you'd like to use an initial, use a link with label. Example:%BR% `-- [[Main.admin][ZXQ]] - 29 Jun 2010`
+    - To automate that, add a bullet like `* Initials: ZXQ` to your [[home page|Main/Admin]].
 
 - A good format for a **new topic** is "dissertation followed by discussion":
   - start with a brief, factual introduction, followed by double horizontal rules
   - if you merge or delete comments, group credit `Contributors:` at the end of the page
   - _This is how Wiki content matures and grows in value over time._
 
-- 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.
+- 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.
 
-- 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,...
+- 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,...
 
 - **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.
 
--- [[MikeMannix]] - 01 Dec 2001
+-- TWiki:Main.MikeMannix - 01 Dec 2001 %BR% -- TWiki:Main.PeterThoeny - 13 Mar 2004