LocalStyleGuide - Revision history

Orudge: Redirect to Manual of Style

2020-06-17T10:58:03Z

Redirect to Manual of Style

← Older revision		Revision as of 10:58, 17 June 2020
Line 1:		Line 1:
			#REDIRECT [[Manual of Style]]
	===Use of "Preview"===

	ALWAYS, and we mean '''ALWAYS''', use the Preview feature to check on your edits before committing them. Do lots of edits and then save, not lots of saves while you edit.

	To find out what markup you can use in addition to the stuff available from the sidebar and [[Help:Editing\|Editing help]] <!-- TBC --> when editing, see the [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia Cheatsheet] page for now, which is the MediaWiki syntax and formatting help page. New pages specific to [Main_Page\|The Transport Tycoon Wiki] will be created and linked in the nick of time.

	===Use of the Summary field===

	When editing a page, put something helpful in the "'''Summary'''" field (when you go to make an edit, it's directly beneath the big edit box - see?) to make it easier for all concerned to see who did what at-a-glance. The idea for the comments list is that someone can look at a version comment, and establish '''without''' having to look at individual diffs and comparisons to see what changed between versions. It also facilitates transparency, one of the reasons why Wikis even exist.

	Examples of useful comments:

	<pre>Fixed some typos. (Tells us what you did)

	Expanded upon first paragraph. (Tells us where you did it)

	Removed obsolete information about Thisthat & Theother, plc. (Does exactly what it says on the tin)

	Updated revision dates. (Brief, but hopefully there won't be much of those on the given page to be updated)</pre>

	Examples of not-so-useful comments:

	<pre> (Empty comment - people have to check the diffs for each version)

	Written by xyz. (You don't say? It's not as if the "history" list already shows who wrote it ...)

	Added more information. (Oh, well isn't that helpful? Tells everything doesn't it?)</pre>

	Be warned -- if you do not include a useful comment with an edit, that page may be rolled back and your edit UNDONE.

Orudge: Reformat and update

2011-07-30T16:09:24Z

Reformat and update

← Older revision		Revision as of 16:09, 30 July 2011
Line 1:		Line 1:
		⚫	===Use of "Preview"===
	TTDPatch Wiki Local Style Guide*

⚫	===Use of ~~'''~~Preview~~'''~~===

	ALWAYS, and we mean '''ALWAYS''', use the Preview feature to check on your edits before committing them. Do lots of edits and then save, not lots of saves while you edit.		ALWAYS, and we mean '''ALWAYS''', use the Preview feature to check on your edits before committing them. Do lots of edits and then save, not lots of saves while you edit.

	To find out what markup you can use in addition to the stuff available from the sidebar and [[Help:Editing\|Editing help]] <!-- TBC --> when editing, see the [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia Cheatsheet] page for now, which is the MediaWiki syntax and formatting help page. New pages specific to [~~http://www.tt-wiki.net/wiki/~~Main_Page The Transport Tycoon Wiki] will be created and linked in the nick of time.		To find out what markup you can use in addition to the stuff available from the sidebar and [[Help:Editing\|Editing help]] <!-- TBC --> when editing, see the [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia Cheatsheet] page for now, which is the MediaWiki syntax and formatting help page. New pages specific to [Main_Page\|The Transport Tycoon Wiki] will be created and linked in the nick of time.

	===Use of the Summary field===		===Use of the Summary field===
Line 30:		Line 28:

	Be warned -- if you do not include a useful comment with an edit, that page may be rolled back and your edit UNDONE.		Be warned -- if you do not include a useful comment with an edit, that page may be rolled back and your edit UNDONE.

	<nowiki><nowiki>* Not inspired by the author's use of TeX. Honestly ...</nowiki></nowiki>

Hgnmu128: /* Local Style Guide* */

2011-06-14T01:31:07Z

Local Style Guide*

← Older revision		Revision as of 01:31, 14 June 2011
Line 1:		Line 1:
	=Local Style Guide*=		TTDPatch Wiki Local Style Guide*

	===Use of '''Preview'''===		===Use of '''Preview'''===

Hgnmu128: Style edits, corrected links, added

2011-06-14T00:06:51Z

Style edits, corrected links, added

← Older revision		Revision as of 00:06, 14 June 2011
Line 1:		Line 1:

	=Local Style Guide*=		=Local Style Guide*=

	-=Use of ~~"~~Preview~~"~~=-		===Use of '''Preview'''===

	ALWAYS, and we mean '''ALWAYS''', use the Preview feature to check on your edits before committing them. ~~ ~~Do lots of edits and then save, not lots of saves while you edit.		ALWAYS, and we mean '''ALWAYS''', use the Preview feature to check on your edits before committing them. Do lots of edits and then save, not lots of saves while you edit.

	To find out what markup you can use in addition to the stuff available from the ~~"Quicklinks"~~ ~~bar~~ when editing, see the ~~))TikiWiki[[]]TikiWiki[[~~ [http://~~tikiwiki~~.org/~~tiki-index.php?page=WikiSyntax\|WikiSyntax~~] page ~~and~~ the ~~))TikiWiki[[]]TikiWiki[[~~ [http://~~doc~~.~~tikiwiki.org/tiki~~-~~index~~.~~php?page=Wiki%20Text%20Formatting\|Text~~ ~~Formatting~~] ~~page~~.		To find out what markup you can use in addition to the stuff available from the sidebar and [[Help:Editing\|Editing help]] <!-- TBC --> when editing, see the [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia Cheatsheet] page for now, which is the MediaWiki syntax and formatting help page. New pages specific to [http://www.tt-wiki.net/wiki/Main_Page The Transport Tycoon Wiki] will be created and linked in the nick of time.

	-=Use of the ~~"comment"~~ field=-		===Use of the Summary field===

	When editing a page, put something helpful in the ~~"comment"~~ field (when you go to make an edit, it's directly beneath the big edit box - see?) ~~ ~~to make it easier for all concerned to see who did what at-a-glance. ~~ ~~The idea for the comments list is that someone can look at a version comment, and establish '''without''' having to look at individual diffs and comparisons to see what changed between versions. ~~ ~~It also facilitates transparency, one of the reasons why Wikis even exist.		When editing a page, put something helpful in the "'''Summary'''" field (when you go to make an edit, it's directly beneath the big edit box - see?) to make it easier for all concerned to see who did what at-a-glance. The idea for the comments list is that someone can look at a version comment, and establish '''without''' having to look at individual diffs and comparisons to see what changed between versions. It also facilitates transparency, one of the reasons why Wikis even exist.

	Examples of useful comments:		Examples of useful comments:
Line 16:		Line 15:
	<pre>Fixed some typos. (Tells us what you did)		<pre>Fixed some typos. (Tells us what you did)

	Expanded upon first paragraph. ~~ ~~(Tells us where you did it)		Expanded upon first paragraph. (Tells us where you did it)

	Removed obsolete information about Thisthat & Theother, plc. ~~ ~~(Does exactly what it says on the tin)		Removed obsolete information about Thisthat & Theother, plc. (Does exactly what it says on the tin)

	Updated revision dates. ~~ ~~(Brief, but hopefully there won't be much of those on the given page to be updated)</pre>		Updated revision dates. (Brief, but hopefully there won't be much of those on the given page to be updated)</pre>

	Examples of not-so-useful comments:		Examples of not-so-useful comments:

	<pre> ~~ ~~ ~~ ~~ ~~ ~~ ~~ ~~ (Empty comment - people have to check the diffs for each version)		<pre> (Empty comment - people have to check the diffs for each version)

	Written by xyz. (You don't say? ~~ ~~It's not as if the ~~"~~history~~"~~ list already shows who wrote it ...)		Written by xyz. (You don't say? It's not as if the "history" list already shows who wrote it ...)

	Added more information. ~~ ~~(Oh, well isn't that helpful? ~~ ~~Tells everything doesn't it?)</pre>		Added more information. (Oh, well isn't that helpful? Tells everything doesn't it?)</pre>

	Be warned -- if you do not include a useful comment with an edit, that page may be rolled back and your edit UNDONE.		Be warned -- if you do not include a useful comment with an edit, that page may be rolled back and your edit UNDONE.

	<nowiki><nowiki>* Not inspired by the author's use of TeX. ~~ ~~Honestly ...</nowiki></nowiki>		<nowiki><nowiki>* Not inspired by the author's use of TeX. Honestly ...</nowiki></nowiki>

Orudge: 5 revisions

2011-06-12T19:09:14Z

5 revisions

New page

=Local Style Guide*=

-=Use of "Preview"=-

ALWAYS, and we mean '''ALWAYS''', use the Preview feature to check on your edits before committing them.  Do lots of edits and then save, not lots of saves while you edit.

To find out what markup you can use in addition to the stuff available from the "Quicklinks" bar when editing, see the ))TikiWiki[[]]TikiWiki[[ [http://tikiwiki.org/tiki-index.php?page=WikiSyntax|WikiSyntax] page and the ))TikiWiki[[]]TikiWiki[[ [http://doc.tikiwiki.org/tiki-index.php?page=Wiki%20Text%20Formatting|Text Formatting] page.

-=Use of the "comment" field=-

When editing a page, put something helpful in the "comment" field (when you go to make an edit, it's directly beneath the big edit box - see?)  to make it easier for all concerned to see who did what at-a-glance.  The idea for the comments list is that someone can look at a version comment, and establish '''without''' having to look at individual diffs and comparisons to see what changed between versions.  It also facilitates transparency, one of the reasons why Wikis even exist.

Examples of useful comments:

<pre>Fixed some typos. (Tells us what you did)

Expanded upon first paragraph.  (Tells us where you did it)

Removed obsolete information about Thisthat & Theother, plc.  (Does exactly what it says on the tin)

Updated revision dates.  (Brief, but hopefully there won't be much of those on the given page to be updated)</pre>

Examples of not-so-useful comments:

<pre>         (Empty comment - people have to check the diffs for each version)

Written by xyz. (You don't say?  It's not as if the "history" list already shows who wrote it ...)

Added more information.  (Oh, well isn't that helpful?  Tells everything doesn't it?)</pre>

Be warned -- if you do not include a useful comment with an edit, that page may be rolled back and your edit UNDONE.

<nowiki><nowiki>* Not inspired by the author's use of TeX.  Honestly ...</nowiki></nowiki>

admin at 06:49, 14 January 2004

2004-01-14T06:49:17Z

New page

=Local Style Guide*=

-=Use of "Preview"=-

ALWAYS, and we mean '''ALWAYS''', use the Preview feature to check on your edits before committing them.

To find out what markup you can use in addition to the stuff available from the "Quicklinks" bar when editing, see the [[Markup]] page.

-=Use of the "comment" field=-

When editing a page, put something helpful in the "comment" field to make it easier for all concerned to see who did what at-a-glance.  The idea for the comments list is that someone can look at a version comment, and establish '''without''' having to look at individual diffs and comparisons to see what changed between versions.  It also facilitates transparency, one of the reasons why Wikis even exist.

Examples of useful comments:

<pre>Fixed some typos. (Tells us what you did)

Expanded upon first paragraph.  (Tells us where you did it)

Removed obsolete information about Thisthat & Theother, plc.  (Does exactly what it says on the tin)

Updated revision dates.  (Brief, but hopefully there won't be much of those on the given page to be updated)</pre>

Examples of not-so-useful comments:

<pre>         (Empty comment - people have to check the diffs for each version)

Written by xyz. (You don't say?  It's not as if the "history" list already shows who wrote it ...)

Added more information.  (Oh, well isn't that helpful?  Tells everything doesn't it?)</pre>

-=Use of "minor edit"=-

If you are only making a small change, e.g. changing one or two words, or correcting one or two typos, check the "minor edit" box.  By doing this, the change isn't recorded specifically in the history, but added to "current_version".  However, they will still bump the page to the top of "Last Changes", and we will not be amused if you try to cover up some terrorism by use of the "minor edit" feature.

<nowiki><nowiki>* Not inspired by the author's use of TeX.  Honestly ...</nowiki></nowiki>