LocalStyleGuide

From TTWiki
Revision as of 06:49, 14 January 2004 by admin (talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

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:

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)

Examples of not-so-useful comments:

         (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?)

-=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>* Not inspired by the author's use of TeX.  Honestly ...</nowiki>