Difference: GoodStyle (4 vs. 5)

Revision 52001-09-14 - MikeMannix

Line: 1 to 1
Added:
>
>

GoodStyle Collaboration Tips

 
  • TWiki has very simple text formatting rules. You won't go wrong if you:
    • start each line without spaces
    • separate paragraphs with a blank line
Line: 8 to 10
 
    • make up meaningful Wiki names - it can be a challenge (it'll sharpen you up!)
    • WikiWords has name-creation tips that may help
Changed:
<
<
  • 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
>
>
  • If a discussion is going on:
    • separate each follow-up with a horizontal rule
    • add your WikiName and the date at the end
    • 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)
 
  • A good format for a new topic is "dissertation followed by discussion":
    • start with a brief, factual introduction
Line: 19 to 23
 
  • When a discussion dies down and the page becomes static, feel free to refactor mercilessly:
    • fearlessly edit down to capture the key points
    • reduce the noise without losing the facts or the flavor
Changed:
<
<
    • if you merge or delete comments, you can group list "Contributors:" at the end of the page
>
>
    • 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.
Changed:
<
<
  • 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.
>
>
  • 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.
 
Changed:
<
<
  • 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,...
>
>
  • 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,...
 
Changed:
<
<
  • 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.
>
>
  • 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.
 
Changed:
<
<
-- PeterThoeny - 13 Sep 2001
>
>
-- PeterThoeny - 13 Sep 2001
-- MikeMannix - 14 Sep 2001
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding URCS? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.GoodStyle.