data/TWiki/GoodStyle.txt,v
changeset 0 414e01d06fd5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/GoodStyle.txt,v	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,446 @@
     1.4 +head	1.13;
     1.5 +access;
     1.6 +symbols;
     1.7 +locks; strict;
     1.8 +comment	@# @;
     1.9 +
    1.10 +
    1.11 +1.13
    1.12 +date	2008.01.22.03.21.24;	author TWikiContributor;	state Exp;
    1.13 +branches;
    1.14 +next	1.12;
    1.15 +
    1.16 +1.12
    1.17 +date	2006.06.25.16.26.25;	author TWikiContributor;	state Exp;
    1.18 +branches;
    1.19 +next	1.11;
    1.20 +
    1.21 +1.11
    1.22 +date	2006.04.01.05.55.07;	author TWikiContributor;	state Exp;
    1.23 +branches;
    1.24 +next	1.10;
    1.25 +
    1.26 +1.10
    1.27 +date	2006.02.01.12.01.17;	author TWikiContributor;	state Exp;
    1.28 +branches;
    1.29 +next	1.9;
    1.30 +
    1.31 +1.9
    1.32 +date	2004.03.13.09.58.00;	author PeterThoeny;	state Exp;
    1.33 +branches;
    1.34 +next	1.8;
    1.35 +
    1.36 +1.8
    1.37 +date	2003.12.31.07.31.53;	author PeterThoeny;	state Exp;
    1.38 +branches;
    1.39 +next	1.7;
    1.40 +
    1.41 +1.7
    1.42 +date	2003.12.16.07.55.15;	author PeterThoeny;	state Exp;
    1.43 +branches;
    1.44 +next	1.6;
    1.45 +
    1.46 +1.6
    1.47 +date	2001.12.02.07.59.13;	author MikeMannix;	state Exp;
    1.48 +branches;
    1.49 +next	1.5;
    1.50 +
    1.51 +1.5
    1.52 +date	2001.09.14.03.29.01;	author MikeMannix;	state Exp;
    1.53 +branches;
    1.54 +next	1.4;
    1.55 +
    1.56 +1.4
    1.57 +date	2001.09.13.08.48.35;	author PeterThoeny;	state Exp;
    1.58 +branches;
    1.59 +next	1.3;
    1.60 +
    1.61 +1.3
    1.62 +date	2001.08.30.12.24.21;	author MikeMannix;	state Exp;
    1.63 +branches;
    1.64 +next	1.2;
    1.65 +
    1.66 +1.2
    1.67 +date	2001.08.07.16.28.28;	author JohnTalintyre;	state Exp;
    1.68 +branches;
    1.69 +next	1.1;
    1.70 +
    1.71 +1.1
    1.72 +date	2000.08.18.08.42.11;	author PeterThoeny;	state Exp;
    1.73 +branches;
    1.74 +next	;
    1.75 +
    1.76 +
    1.77 +desc
    1.78 +@none
    1.79 +@
    1.80 +
    1.81 +
    1.82 +1.13
    1.83 +log
    1.84 +@buildrelease
    1.85 +@
    1.86 +text
    1.87 +@%META:TOPICINFO{author="TWikiContributor" date="1174436429" format="1.1" version="13"}%
    1.88 +---+ <nop>GoodStyle Collaboration Tips
    1.89 +
    1.90 +   * TWiki has a very simple *[[TWikiShorthand][text formatting shorthand]]*. In any case, you won't go wrong if you simply:
    1.91 +      * start each line without spaces
    1.92 +      * separate paragraphs with a blank line 
    1.93 +
    1.94 +   * Run together capitalized words to form *[[WikiWords][WikiWords]]:* 
    1.95 +      * WikiWords automatically appear as hyperlinks
    1.96 +      * make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
    1.97 +      * WikiWords has name-creation tips that may help
    1.98 +
    1.99 +#SignAndDate
   1.100 +   * If a *discussion* is going on:
   1.101 +      * separate each follow-up with a space
   1.102 +      * add your WikiName and the date at the end. Example:%BR%
   1.103 +        =-- <nop>%WIKIUSERNAME% - %SERVERTIME{$day $mon $year}%=
   1.104 +      * OR, by all means, insert your comment where it seems to fit best:
   1.105 +         * you may want to inset it with a bullet and/or _set it in italics_ so it's clear (always sign and date)
   1.106 +      * if you'd like to use an initial, use a link with label. Example:%BR%
   1.107 +        =-- [<nop>[%WIKIUSERNAME%][ZXQ]] - %SERVERTIME{$day $mon $year}%=
   1.108 +
   1.109 +   * A good format for a *new topic* is "dissertation followed by discussion": 
   1.110 +      * start with a brief, factual introduction, followed by double horizontal rules
   1.111 +      * let the discussion begin
   1.112 +
   1.113 +   * When a discussion dies down and the page becomes static, if you're clear on your course, feel free to *refactor mercilessly*:
   1.114 +      * fearlessly edit down to capture the key points
   1.115 +      * reduce the noise without losing the facts or the flavor
   1.116 +      * if you merge or delete comments, group credit =Contributors:= at the end of the page
   1.117 +      * _This is how Wiki content matures and grows in value over time._
   1.118 +
   1.119 +   * 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. 
   1.120 +
   1.121 +   * TWiki is intended for world-wide use, and an internationally understood date format like ==01 Sep %SERVERTIME{$year}%== or ==%SERVERTIME{$year}%-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,...
   1.122 +
   1.123 +   * *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.124 +
   1.125 +__Related Topics:__ UserDocumentationCategory
   1.126 +
   1.127 +-- __Contributors:__ TWiki:Main.MikeMannix, TWiki:Main.PeterThoeny
   1.128 +@
   1.129 +
   1.130 +
   1.131 +1.12
   1.132 +log
   1.133 +@buildrelease
   1.134 +@
   1.135 +text
   1.136 +@d1 1
   1.137 +a1 1
   1.138 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="12"}%
   1.139 +d35 1
   1.140 +a35 1
   1.141 +   * 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,...
   1.142 +d41 1
   1.143 +@
   1.144 +
   1.145 +
   1.146 +1.11
   1.147 +log
   1.148 +@buildrelease
   1.149 +@
   1.150 +text
   1.151 +@d1 1
   1.152 +a1 1
   1.153 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="11"}%
   1.154 +a21 1
   1.155 +         * To automate that, add a bullet like =* Initials: ZXQ= to your [[%WIKIUSERNAME%][home page]].
   1.156 +@
   1.157 +
   1.158 +
   1.159 +1.10
   1.160 +log
   1.161 +@buildrelease
   1.162 +@
   1.163 +text
   1.164 +@d1 1
   1.165 +a1 1
   1.166 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="10"}%
   1.167 +d4 8
   1.168 +a11 8
   1.169 +	* TWiki has a very simple *[[TWikiShorthand][text formatting shorthand]]*. In any case, you won't go wrong if you simply:
   1.170 +		* start each line without spaces
   1.171 +		* separate paragraphs with a blank line 
   1.172 +
   1.173 +	* Run together capitalized words to form *[[WikiWords][WikiWords]]:* 
   1.174 +		* WikiWords automatically appear as hyperlinks
   1.175 +		* make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
   1.176 +		* WikiWords has name-creation tips that may help
   1.177 +d14 19
   1.178 +a32 19
   1.179 +	* If a *discussion* is going on:
   1.180 +		* separate each follow-up with a space
   1.181 +		* add your WikiName and the date at the end. Example:%BR%
   1.182 +		  =-- <nop>%WIKIUSERNAME% - %SERVERTIME{$day $mon $year}%=
   1.183 +		* OR, by all means, insert your comment where it seems to fit best:
   1.184 +			* you may want to inset it with a bullet and/or _set it in italics_ so it's clear (always sign and date)
   1.185 +		* if you'd like to use an initial, use a link with label. Example:%BR%
   1.186 +		  =-- [<nop>[%WIKIUSERNAME%][ZXQ]] - %SERVERTIME{$day $mon $year}%=
   1.187 +			* To automate that, add a bullet like =* Initials: ZXQ= to your [[%WIKIUSERNAME%][home page]].
   1.188 +
   1.189 +	* A good format for a *new topic* is "dissertation followed by discussion": 
   1.190 +		* start with a brief, factual introduction, followed by double horizontal rules
   1.191 +		* let the discussion begin
   1.192 +
   1.193 +	* When a discussion dies down and the page becomes static, if you're clear on your course, feel free to *refactor mercilessly*:
   1.194 +		* fearlessly edit down to capture the key points
   1.195 +		* reduce the noise without losing the facts or the flavor
   1.196 +		* if you merge or delete comments, group credit =Contributors:= at the end of the page
   1.197 +		* _This is how Wiki content matures and grows in value over time._
   1.198 +d34 1
   1.199 +a34 1
   1.200 +	* 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. 
   1.201 +d36 1
   1.202 +a36 1
   1.203 +	* 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,...
   1.204 +d38 1
   1.205 +a38 1
   1.206 +	* *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.207 +@
   1.208 +
   1.209 +
   1.210 +1.9
   1.211 +log
   1.212 +@none
   1.213 +@
   1.214 +text
   1.215 +@d1 41
   1.216 +a41 41
   1.217 +%META:TOPICINFO{author="PeterThoeny" date="1079171880" format="1.0" version="1.9"}%
   1.218 +---+ <nop>GoodStyle Collaboration Tips
   1.219 +
   1.220 +	* TWiki has a very simple *[[TWikiShorthand][text formatting shorthand]]*. In any case, you won't go wrong if you simply:
   1.221 +		* start each line without spaces
   1.222 +		* separate paragraphs with a blank line 
   1.223 +
   1.224 +	* Run together capitalized words to form *[[WikiWords][WikiWords]]:* 
   1.225 +		* WikiWords automatically appear as hyperlinks
   1.226 +		* make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
   1.227 +		* WikiWords has name-creation tips that may help
   1.228 +
   1.229 +#SignAndDate
   1.230 +	* If a *discussion* is going on:
   1.231 +		* separate each follow-up with a space
   1.232 +		* add your WikiName and the date at the end. Example:%BR%
   1.233 +		  =-- <nop>%WIKIUSERNAME% - %SERVERTIME{$day $mon $year}%=
   1.234 +		* OR, by all means, insert your comment where it seems to fit best:
   1.235 +			* you may want to inset it with a bullet and/or _set it in italics_ so it's clear (always sign and date)
   1.236 +		* if you'd like to use an initial, use a link with label. Example:%BR%
   1.237 +		  =-- [<nop>[%WIKIUSERNAME%][ZXQ]] - %SERVERTIME{$day $mon $year}%=
   1.238 +			* To automate that, add a bullet like =* Initials: ZXQ= to your [[%WIKIUSERNAME%][home page]].
   1.239 +
   1.240 +	* A good format for a *new topic* is "dissertation followed by discussion": 
   1.241 +		* start with a brief, factual introduction, followed by double horizontal rules
   1.242 +		* let the discussion begin
   1.243 +
   1.244 +	* When a discussion dies down and the page becomes static, if you're clear on your course, feel free to *refactor mercilessly*:
   1.245 +		* fearlessly edit down to capture the key points
   1.246 +		* reduce the noise without losing the facts or the flavor
   1.247 +		* if you merge or delete comments, group credit =Contributors:= at the end of the page
   1.248 +		* _This is how Wiki content matures and grows in value over time._
   1.249 +
   1.250 +	* 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. 
   1.251 +
   1.252 +	* 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,...
   1.253 +
   1.254 +	* *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.255 +
   1.256 +-- TWiki:Main.MikeMannix - 01 Dec 2001 %BR%
   1.257 +-- TWiki:Main.PeterThoeny - 13 Mar 2004
   1.258 +@
   1.259 +
   1.260 +
   1.261 +1.8
   1.262 +log
   1.263 +@none
   1.264 +@
   1.265 +text
   1.266 +@d1 1
   1.267 +a1 1
   1.268 +%META:TOPICINFO{author="PeterThoeny" date="1072855913" format="1.0" version="1.8"}%
   1.269 +d13 1
   1.270 +d16 2
   1.271 +a17 1
   1.272 +		* add your WikiName and the date at the end
   1.273 +d20 3
   1.274 +a22 1
   1.275 +		* if a sub-topic develops, separate it with a horizontal rule at beginning and end
   1.276 +d41 1
   1.277 +a41 1
   1.278 +-- TWiki:Main.PeterThoeny - 16 Dec 2003
   1.279 +@
   1.280 +
   1.281 +
   1.282 +1.7
   1.283 +log
   1.284 +@none
   1.285 +@
   1.286 +text
   1.287 +@d1 1
   1.288 +a1 1
   1.289 +%META:TOPICINFO{author="PeterThoeny" date="1071561315" format="1.0" version="1.7"}%
   1.290 +d30 1
   1.291 +a30 1
   1.292 +	* 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.293 +@
   1.294 +
   1.295 +
   1.296 +1.6
   1.297 +log
   1.298 +@none
   1.299 +@
   1.300 +text
   1.301 +@d1 2
   1.302 +a2 2
   1.303 +%META:TOPICINFO{author="MikeMannix" date="1007279953" format="1.0" version="1.6"}%
   1.304 +---+ <nop />GoodStyle Collaboration Tips
   1.305 +d32 1
   1.306 +a32 1
   1.307 +	* 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,...
   1.308 +d36 2
   1.309 +a37 1
   1.310 +-- Main.MikeMannix - 01 Dec 2001
   1.311 +@
   1.312 +
   1.313 +
   1.314 +1.5
   1.315 +log
   1.316 +@none
   1.317 +@
   1.318 +text
   1.319 +@d1 1
   1.320 +a1 1
   1.321 +%META:TOPICINFO{author="MikeMannix" date="1000438229" format="1.0" version="1.5"}%
   1.322 +d4 1
   1.323 +a4 1
   1.324 +	* TWiki has very simple *[[TextFormattingRules][text formatting rules]]*. You won't go wrong if you:
   1.325 +d8 1
   1.326 +a8 1
   1.327 +	* Run together capitalized words to make *[[WikiWords][WikiWords]]:* 
   1.328 +d10 1
   1.329 +a10 1
   1.330 +		* make up meaningful Wiki names - it can be a challenge (it'll sharpen you up!)
   1.331 +d14 1
   1.332 +a14 1
   1.333 +		* separate each follow-up with a horizontal rule
   1.334 +d18 1
   1.335 +d21 2
   1.336 +a22 2
   1.337 +		* start with a brief, factual introduction
   1.338 +		* then bring on the opinions.
   1.339 +d24 1
   1.340 +a24 1
   1.341 +	* When a discussion dies down and the page becomes static, feel free to *refactor mercilessly*:
   1.342 +d27 2
   1.343 +a28 2
   1.344 +		* if you merge or delete comments, you can group credit =Contributors:= at the end of the page
   1.345 +		* That's how Wiki content matures and grows in value over time. 
   1.346 +d34 1
   1.347 +a34 1
   1.348 +	* 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. 
   1.349 +d36 1
   1.350 +a36 2
   1.351 +-- PeterThoeny - 13 Sep 2001<br />
   1.352 +-- MikeMannix - 14 Sep 2001 <br />
   1.353 +@
   1.354 +
   1.355 +
   1.356 +1.4
   1.357 +log
   1.358 +@none
   1.359 +@
   1.360 +text
   1.361 +@d1 3
   1.362 +a3 1
   1.363 +%META:TOPICINFO{author="PeterThoeny" date="1000370951" format="1.0" version="1.4"}%
   1.364 +d13 5
   1.365 +a17 3
   1.366 +	* If a *discussion* is going on on a WikiTopic:
   1.367 +		* separate each follow up with a horizontal rule
   1.368 +		* add your WikiName and date at the end 
   1.369 +d26 1
   1.370 +a26 1
   1.371 +		* if you merge or delete comments, you can group list "Contributors:" at the end of the page
   1.372 +d29 1
   1.373 +a29 1
   1.374 +	* 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.375 +d31 1
   1.376 +a31 1
   1.377 +	* 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,...
   1.378 +d33 1
   1.379 +a33 1
   1.380 +	* 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. 
   1.381 +d35 2
   1.382 +a36 1
   1.383 +-- Main.PeterThoeny - 13 Sep 2001
   1.384 +@
   1.385 +
   1.386 +
   1.387 +1.3
   1.388 +log
   1.389 +@none
   1.390 +@
   1.391 +text
   1.392 +@d1 1
   1.393 +a1 1
   1.394 +%META:TOPICINFO{author="MikeMannix" date="999177139" format="1.0" version="1.3"}%
   1.395 +d27 1
   1.396 +a27 1
   1.397 +	* 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,...
   1.398 +d29 1
   1.399 +a29 1
   1.400 +	* 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. 
   1.401 +d31 1
   1.402 +a31 1
   1.403 +-- Main.PeterThoeny - 30 Jul 2000
   1.404 +@
   1.405 +
   1.406 +
   1.407 +1.2
   1.408 +log
   1.409 +@none
   1.410 +@
   1.411 +text
   1.412 +@d1 23
   1.413 +a23 3
   1.414 +%META:TOPICINFO{author="JohnTalintyre" date="997201773" format="1.0beta2" version="1.2"}%
   1.415 +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
   1.416 +become hyperlinks. This sometimes requires creativity; you're up to it. WikiWords tells you how to create good topic names.
   1.417 +d25 1
   1.418 +a25 1
   1.419 +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.
   1.420 +d27 1
   1.421 +a27 1
   1.422 +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. 
   1.423 +d29 1
   1.424 +a29 5
   1.425 +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. 
   1.426 +
   1.427 +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;= . 
   1.428 +
   1.429 +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.
   1.430 +a31 6
   1.431 +
   1.432 +-----
   1.433 +
   1.434 +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. 
   1.435 +
   1.436 +-- Main.TWikiGuest - 27 May 2000
   1.437 +@
   1.438 +
   1.439 +
   1.440 +1.1
   1.441 +log
   1.442 +@none
   1.443 +@
   1.444 +text
   1.445 +@d1 1
   1.446 +d19 1
   1.447 +a19 1
   1.448 +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. 
   1.449 +@