wiki-archive/twiki/data/TWiki/GoodStyle.txt,v

head	1.12;
access;
symbols;
locks; strict;
comment	@# @;


1.12
date	2006.06.25.16.26.25;	author TWikiContributor;	state Exp;
branches;
next	1.11;

1.11
date	2006.04.01.05.55.07;	author TWikiContributor;	state Exp;
branches;
next	1.10;

1.10
date	2006.02.01.12.01.17;	author TWikiContributor;	state Exp;
branches;
next	1.9;

1.9
date	2004.03.13.09.58.00;	author PeterThoeny;	state Exp;
branches;
next	1.8;

1.8
date	2003.12.31.07.31.53;	author PeterThoeny;	state Exp;
branches;
next	1.7;

1.7
date	2003.12.16.07.55.15;	author PeterThoeny;	state Exp;
branches;
next	1.6;

1.6
date	2001.12.02.07.59.13;	author MikeMannix;	state Exp;
branches;
next	1.5;

1.5
date	2001.09.14.03.29.01;	author MikeMannix;	state Exp;
branches;
next	1.4;

1.4
date	2001.09.13.08.48.35;	author PeterThoeny;	state Exp;
branches;
next	1.3;

1.3
date	2001.08.30.12.24.21;	author MikeMannix;	state Exp;
branches;
next	1.2;

1.2
date	2001.08.07.16.28.28;	author JohnTalintyre;	state Exp;
branches;
next	1.1;

1.1
date	2000.08.18.08.42.11;	author PeterThoeny;	state Exp;
branches;
next	;


desc
@none
@


1.12
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="12"}%
---+ <nop>GoodStyle Collaboration Tips

   * TWiki has a very simple *[[TWikiShorthand][text formatting shorthand]]*. In any case, you won't go wrong if you simply:
      * start each line without spaces
      * separate paragraphs with a blank line 

   * Run together capitalized words to form *[[WikiWords][WikiWords]]:* 
      * WikiWords automatically appear as hyperlinks
      * 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

#SignAndDate
   * If a *discussion* is going on:
      * separate each follow-up with a space
      * add your WikiName and the date at the end. Example:%BR%
        =-- <nop>%WIKIUSERNAME% - %SERVERTIME{$day $mon $year}%=
      * 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 you'd like to use an initial, use a link with label. Example:%BR%
        =-- [<nop>[%WIKIUSERNAME%][ZXQ]] - %SERVERTIME{$day $mon $year}%=

   * A good format for a *new topic* is "dissertation followed by discussion": 
      * start with a brief, factual introduction, followed by double horizontal rules
      * let the discussion begin

   * When a discussion dies down and the page becomes static, if you're clear on your course, 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, 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 be clear to anyone where they're headed on click. 

   * TWiki is intended for world-wide use, and an internationally understood date format like ==01 Sep 2003== or ==2003/09/01== 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 ==Edit== on the lower toolbar. To see earlier versions, click ==More==, then check ==Raw text format== and click ==View revision==. A bit of HTML experience can't hurt, but you'll soon see with TWikiShorthand how far that is from necessary. 

__Related Topics:__ UserDocumentationCategory

@


1.11
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="11"}%
a21 1
         * To automate that, add a bullet like =* Initials: ZXQ= to your [[%WIKIUSERNAME%][home page]].
@


1.10
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="10"}%
d4 8
a11 8
	* TWiki has a very simple *[[TWikiShorthand][text formatting shorthand]]*. In any case, you won't go wrong if you simply:
		* start each line without spaces
		* separate paragraphs with a blank line 

	* Run together capitalized words to form *[[WikiWords][WikiWords]]:* 
		* WikiWords automatically appear as hyperlinks
		* 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
d14 19
a32 19
	* If a *discussion* is going on:
		* separate each follow-up with a space
		* add your WikiName and the date at the end. Example:%BR%
		  =-- <nop>%WIKIUSERNAME% - %SERVERTIME{$day $mon $year}%=
		* 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 you'd like to use an initial, use a link with label. Example:%BR%
		  =-- [<nop>[%WIKIUSERNAME%][ZXQ]] - %SERVERTIME{$day $mon $year}%=
			* To automate that, add a bullet like =* Initials: ZXQ= to your [[%WIKIUSERNAME%][home page]].

	* A good format for a *new topic* is "dissertation followed by discussion": 
		* start with a brief, factual introduction, followed by double horizontal rules
		* let the discussion begin

	* When a discussion dies down and the page becomes static, if you're clear on your course, 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, group credit =Contributors:= at the end of the page
		* _This is how Wiki content matures and grows in value over time._
d34 1
a34 1
	* 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. 
d36 1
a36 1
	* TWiki is intended for world-wide use, and an internationally understood date format like ==01 Sep 2003== or ==2003/09/01== 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,...
d38 1
a38 1
	* *TIP:* Check the source when you want to find out how something is formatted: click ==Edit== on the lower toolbar. To see earlier versions, click ==More==, then check ==Raw text format== and click ==View revision==. A bit of HTML experience can't hurt, but you'll soon see with TWikiShorthand how far that is from necessary. 
@


1.9
log
@none
@
text
@d1 41
a41 41
%META:TOPICINFO{author="PeterThoeny" date="1079171880" format="1.0" version="1.9"}%
---+ <nop>GoodStyle Collaboration Tips

	* TWiki has a very simple *[[TWikiShorthand][text formatting shorthand]]*. In any case, you won't go wrong if you simply:
		* start each line without spaces
		* separate paragraphs with a blank line 

	* Run together capitalized words to form *[[WikiWords][WikiWords]]:* 
		* WikiWords automatically appear as hyperlinks
		* 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

#SignAndDate
	* If a *discussion* is going on:
		* separate each follow-up with a space
		* add your WikiName and the date at the end. Example:%BR%
		  =-- <nop>%WIKIUSERNAME% - %SERVERTIME{$day $mon $year}%=
		* 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 you'd like to use an initial, use a link with label. Example:%BR%
		  =-- [<nop>[%WIKIUSERNAME%][ZXQ]] - %SERVERTIME{$day $mon $year}%=
			* To automate that, add a bullet like =* Initials: ZXQ= to your [[%WIKIUSERNAME%][home page]].

	* A good format for a *new topic* is "dissertation followed by discussion": 
		* start with a brief, factual introduction, followed by double horizontal rules
		* let the discussion begin

	* When a discussion dies down and the page becomes static, if you're clear on your course, 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, 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 be clear to anyone where they're headed on click. 

	* TWiki is intended for world-wide use, and an internationally understood date format like ==01 Sep 2003== or ==2003/09/01== 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 ==Edit== on the lower toolbar. To see earlier versions, click ==More==, then check ==Raw text format== and click ==View revision==. A bit of HTML experience can't hurt, but you'll soon see with TWikiShorthand how far that is from necessary. 

-- TWiki:Main.MikeMannix - 01 Dec 2001 %BR%
-- TWiki:Main.PeterThoeny - 13 Mar 2004
@


1.8
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1072855913" format="1.0" version="1.8"}%
d13 1
d16 2
a17 1
		* add your WikiName and the date at the end
d20 3
a22 1
		* if a sub-topic develops, separate it with a horizontal rule at beginning and end
d41 1
a41 1
-- TWiki:Main.PeterThoeny - 16 Dec 2003
@


1.7
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1071561315" format="1.0" version="1.7"}%
d30 1
a30 1
	* 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. 
@


1.6
log
@none
@
text
@d1 2
a2 2
%META:TOPICINFO{author="MikeMannix" date="1007279953" format="1.0" version="1.6"}%
---+ <nop />GoodStyle Collaboration Tips
d32 1
a32 1
	* 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,...
d36 2
a37 1
-- Main.MikeMannix - 01 Dec 2001
@


1.5
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000438229" format="1.0" version="1.5"}%
d4 1
a4 1
	* TWiki has very simple *[[TextFormattingRules][text formatting rules]]*. You won't go wrong if you:
d8 1
a8 1
	* Run together capitalized words to make *[[WikiWords][WikiWords]]:* 
d10 1
a10 1
		* make up meaningful Wiki names - it can be a challenge (it'll sharpen you up!)
d14 1
a14 1
		* separate each follow-up with a horizontal rule
d18 1
d21 2
a22 2
		* start with a brief, factual introduction
		* then bring on the opinions.
d24 1
a24 1
	* When a discussion dies down and the page becomes static, feel free to *refactor mercilessly*:
d27 2
a28 2
		* 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. 
d34 1
a34 1
	* Check the source when you want to find out how something is formatted: click ==Edit== on the lower toolbar. To see earlier versions, click ==More==, then check ==Raw text format== and click ==View revision==. A bit of HTML experience can't hurt, but you'll soon see with TWiki shorthand how far that is from necessary. 
d36 1
a36 2
-- PeterThoeny - 13 Sep 2001<br />
-- MikeMannix - 14 Sep 2001 <br />
@


1.4
log
@none
@
text
@d1 3
a3 1
%META:TOPICINFO{author="PeterThoeny" date="1000370951" format="1.0" version="1.4"}%
d13 5
a17 3
	* 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 
d26 1
a26 1
		* if you merge or delete comments, you can group list "Contributors:" at the end of the page
d29 1
a29 1
	* 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. 
d31 1
a31 1
	* 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,...
d33 1
a33 1
	* 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. 
d35 2
a36 1
-- Main.PeterThoeny - 13 Sep 2001
@


1.3
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999177139" format="1.0" version="1.3"}%
d27 1
a27 1
	* 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,...
d29 1
a29 1
	* 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. 
d31 1
a31 1
-- Main.PeterThoeny - 30 Jul 2000
@


1.2
log
@none
@
text
@d1 23
a23 3
%META:TOPICINFO{author="JohnTalintyre" date="997201773" format="1.0beta2" version="1.2"}%
TWiki has very simple TextFormattingRules. You won't go wrong if you start each line without spaces and separate paragraphs with a blank line. Run capitalized words together to make WikiWords, which
become hyperlinks. This sometimes requires creativity; you're up to it. WikiWords tells you how to create good topic names.
d25 1
a25 1
If a discussion is going on on a WikiTopic, separate each follow up with a separator. It is style to add your WikiName and date at the end.
d27 1
a27 1
A good format for a new topic is "dissertation followed by discussion": a factual introduction followed by opinions. After a while, the discussion will die down and the page will become static. At that point, feel free to "refactor mercilessly" to capture the key points whilst reducing the noise; this is how wiki content matures with time. 
d29 1
a29 5
If you summarise an old discussion and merge or delete individual contributions, you can add the word "Contributors:" to the bottom of the page, and list the contributors there. 

If you want to link to external sites: Just type hyperlinks directly into the text - that makes it clear to readers whether they're browsing within %WIKITOOLNAME% or leaving it. It is usually better *not* to use the HTML tag =&lt;A HREF="..."&gt;= . 

Date format: %WIKITOOLNAME% is international, so the ISO date format like "06 Feb 1998" is preferred to one like "2/6/98", which can mean either February or June to different readers. For the month use Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov or Dec.
a31 6

-----

Feel free to look at the source to an existing page (click =Raw text=) if you want to see how something is formatted. A bit of HTML experience can't hurt, but is far from necessary. 

-- Main.TWikiGuest - 27 May 2000
@


1.1
log
@none
@
text
@d1 1
d19 1
a19 1
Feel free to look at the source to an existing page if you want to see how something is formatted. A bit of HTML experience can't hurt, but is far from necessary. 
@