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 - 23 Oct 2018
    • 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]] - 23 Oct 2018

  • 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 2018-09-01 (ISO 8601 date format) or 01 Sep 2018 (RFC 5322 date format) is preferred. It's clearer than the xx/xx/xx format, where 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,...

  • 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 topic actions], 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

-- Contributors: TWiki:Main/MikeMannix, TWiki:Main/PeterThoeny

Edit | Attach | Watch | Print version | History: r14 < r13 < r12 < r11 < r10 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r14 - 2010-05-31 - TWikiContributor
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.GoodStyle.
http://www.openfst.org/twiki/bin/view/TWiki/GoodStyle
www.openfst.org
crawl=CC-MAIN-2018-43
24829
application/http; msgtype=response
sha1:NOJFBCRJNJV5QLCWBV64WEFXCVGQHHTZ
<urn:uuid:332ebf60-8f95-4fe9-8c28-63b14335b470>
2018-10-23T22:09:50Z
206.196.111.47
application/xhtml+xml
sha1:MKQMKU2MXFCIFIL64ULEU4VD3W5K2AGF
<urn:uuid:8ecfccbc-326d-4c1f-a9d9-48e7db21e680>
http://www.openfst.org/twiki/bin/view/TWiki/GoodStyle
response
<urn:uuid:00fc5cf4-0830-40ce-b165-b75dfd282406>
isPartOf: CC-MAIN-2018-43
publisher: Common Crawl
description: Wide crawl of the web for October 2018
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-111-241-198.ec2.internal
software: Apache Nutch 1.15 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 0.11-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/