Nice TWiki > TWiki > GoodStyle (r1.1 vs. r1.6) TWiki webs:
Dev | Doc | Main | TWiki | Sandbox
TWiki . { Welcome | Register | Changes | Topics | Index | Search | Go }
 <<O>>  Difference Topic GoodStyle (r1.6 - 02 Dec 2001 - MikeMannix?)
Changed:
<
<

>
>

Changed:
<
<

  • Run together capitalized words to make WikiWords:
>
>

  • Run together capitalized words to form WikiWords:
Changed:
<
<

    • make up meaningful Wiki names - it can be a challenge (it'll sharpen you up!)
>
>

    • make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
Changed:
<
<

    • separate each follow-up with a horizontal rule
>
>

    • separate each follow-up with a space
Added:
>
>

    • if a sub-topic develops, separate it with a horizontal rule at beginning and end
Changed:
<
<

    • start with a brief, factual introduction
    • then bring on the opinions.
>
>

    • start with a brief, factual introduction, followed by double horizontal rules
    • let the discussion begin
Changed:
<
<

  • When a discussion dies down and the page becomes static, feel free to refactor mercilessly:
>
>

  • When a discussion dies down and the page becomes static, if you're clear on your course, feel free to refactor mercilessly:
Changed:
<
<

    • 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.
>
>

    • 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.
Changed:
<
<

  • 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.
>
>

  • 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.
Changed:
<
<

-- PeterThoeny - 13 Sep 2001
-- MikeMannix - 14 Sep 2001

>
>

-- MikeMannix? - 01 Dec 2001


 <<O>>  Difference Topic GoodStyle (r1.5 - 14 Sep 2001 - MikeMannix?)
Changed:
<
<
>
>

GoodStyle Collaboration Tips

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


 <<O>>  Difference Topic GoodStyle (r1.4 - 13 Sep 2001 - PeterThoeny?)
Changed:
<
<

  • 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,...
>
>

  • 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,...
Changed:
<
<

  • 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.
>
>

  • 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.
Changed:
<
<

-- PeterThoeny? - 30 Jul 2000

>
>

-- PeterThoeny? - 13 Sep 2001


 <<O>>  Difference Topic GoodStyle (r1.3 - 30 Aug 2001 - MikeMannix?)
Changed:
<
<

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 become hyperlinks. This sometimes requires creativity; you're up to it. WikiWords tells you how to create good topic names.

>
>

  • 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

  • Run together capitalized words to make WikiWords:
    • WikiWords automatically appear as hyperlinks
    • make up meaningful 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 on a WikiTopic:
    • separate each follow up with a horizontal rule
    • add your WikiName and date at the end

  • A good format for a new topic is "dissertation followed by discussion":
    • start with a brief, factual introduction
    • then bring on the opinions.

  • 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
    • if you merge or delete comments, you can group list "Contributors:" at the end of the page
    • That's how Wiki content matures and grows in value over time.
Changed:
<
<

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.

>
>

  • 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:
<
<

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.

>
>

  • 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,...
Changed:
<
<

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.

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 TWiki or leaving it. It is usually better not to use the HTML tag <A HREF="..."> .

Date format: TWiki 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.

>
>

  • 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.
Deleted:
<
<


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.

-- TWikiGuest - 27 May 2000


 <<O>>  Difference Topic GoodStyle (r1.2 - 07 Aug 2001 - JohnTalintyre?)
Added:
>
>
Changed:
<
<

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.

>
>

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.


 <<O>>  Difference Topic GoodStyle (r1.1 - 18 Aug 2000 - PeterThoeny?)
Added:
>
>

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 become hyperlinks. This sometimes requires creativity; you're up to it. WikiWords tells you how to create good topic names.

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.

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.

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.

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 TWiki or leaving it. It is usually better not to use the HTML tag <A HREF="..."> .

Date format: TWiki 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.

-- PeterThoeny? - 30 Jul 2000


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.

-- TWikiGuest - 27 May 2000


Topic GoodStyle . { View | Diffs | r1.6 | > | r1.5 | > | r1.4 | More }
Revision r1.1 - 18 Aug 2000 - 08:42 GMT - PeterThoeny?
Revision r1.6 - 02 Dec 2001 - 07:59 GMT - MikeMannix?
Copyright © 1999-2003 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback.