Skip to topic | Skip to bottom


Home

TWiki
TWiki.GoodStyler1.9 - 13 Mar 2004 - 09:58 - PeterThoeny

Start of topic | Skip to actions

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 - 24 Nov 2017
    • 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]] - 24 Nov 2017
      • 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.

-- TWiki:Main.MikeMannix - 01 Dec 2001
-- TWiki:Trash.PeterThoeny - 13 Mar 2004


Edit | Attach | Printable | Raw | More topic actions
Revisions: | r1.10 | > | r1.9 | > | r1.8 | Page history | Backlinks
You are here: TWiki > GoodStyle

to top

Copyright © 2003-2017, Software Engineering Research Group, Delft University of Technology, The Netherlands
http://swerl.tudelft.nl/bin/view/TWiki/GoodStyle
swerl.tudelft.nl
crawl=CC-MAIN-2017-47
9876
application/http; msgtype=response
sha1:4CIIQI73VZCBTYOJL4VS2UD4T5GQI6MN
<urn:uuid:90fdc94e-b400-4221-9bde-19a3aa051fa5>
2017-11-24T18:10:56Z
131.180.125.80
application/xhtml+xml
sha1:N74NAS6QOUM56FYX3ITW3ET3NB5H5MSQ
<urn:uuid:1e86a1cc-2cf1-466b-8122-0994ea2c867c>
http://swerl.tudelft.nl/bin/view/TWiki/GoodStyle
length
response
<urn:uuid:2d0dc29a-f77a-4e01-8169-837ae6d6c6e8>
robots: classic
hostname: ip-10-146-22-70.ec2.internal
software: Nutch 1.6 (CC)
isPartOf: CC-MAIN-2017-47
operator: Common Crawl Admin
description: Wide crawl of the web for November 2017
publisher: Common Crawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf