NOTE: This is a DistributionDocument. Please help maintain high quality documentation: This is a wiki, please fix the documentation if you find errors or incomplete content. Put questions and suggestions concerning the documentation of this topic in the comments section below. Use the Support web for problems you are having using TWiki.

GoodStyle Collaboration Tips

• TWiki has a very simple 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 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

• If a discussion is going on:
  • separate each follow-up with a space
  • add your WikiName and the date at the end. Example:
    -- Main.TWikiGuest - 03 Jul 2009
  • 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:
    -- [[Main.TWikiGuest][ZXQ]] - 03 Jul 2009
    • To automate that, add a bullet like * Initials: ZXQ to your 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.

Related Topics: UserDocumentationCategory

Comments & Questions about this Distribution Document Topic

'01 Sep 2001' is not an international standard date format. The international standard is ISO 8601, '2001-11-01'. This format is also difficult to mistake for another, and is language-independent and an ISO standard.

-- EdAvis - 2003-10-01

The topic TerserSignature implies that the Initials feature got pulled from CairoRelease. I don't think it should still be in this topic. If no-one objects within a couple of days I'll amend this topic.

• Done - -- GarethEdwards - 19 Jan 2005

-- GarethEdwards - 04 Jan 2005