
release
dev builds
extras
themes manual
wiki
device status forums
mailing lists
IRC bugs
patches
dev guide



Wiki > System > GoodStyle

Collaboration Tips

Following you will find a short list of hints and recommendations that are considered basic knowledge when starting to edit existing topics.

  • Wiki 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.WikiGuest - 01 May 2016
    • OR, by all means, insert your comment where it seems to fit best:
      • you may want to insert 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.WikiGuest][ZXQ]] - 01 May 2016

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

  • Foswiki is intended for world-wide use, and an internationally understood date format like 01 Sep 2016 or 2016-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,...

  • Check the source when you want to find out how something is formatted: click [Raw view] on the toolbar.
  • To see earlier versions, click either on [History] (to see all previous versions of a topic) or click on the revision number you would like to see; the formatted revision version will be shown.
  • To see the source of a previous revision, click [More topic actions], then at View previous topic revision, enter the revision number, mark the in raw text format checkbox and click [View]. A bit of HTML experience can't hurt, but you'll soon see with wiki syntax how far that is from necessary.

Related Topics: UserDocumentationCategory
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Wiki? Send feedback
http://www.rockbox.org/wiki/System/GoodStyle?template=viewplain
www.rockbox.org
crawl=CC-MAIN-2016-18
11886
application/http; msgtype=response
sha1:EZ6N7G3SPNOGNFGWK4WEAB6KILCZMZZO
<urn:uuid:f81b5092-1ba7-47b8-822e-11d5889fffb1>
2016-05-01T12:13:21Z
80.67.6.50
sha1:L3GUZGFLYBZICKFWABWH2NNUNYS5OOKH
<urn:uuid:085bb8f8-4312-4a5c-ba58-0a624e45eaa4>
http://www.rockbox.org/wiki/System/GoodStyle?template=viewplain
response
<urn:uuid:8ffd54bd-74d7-41ea-a63b-74e0c1edcbe4>
robots: classic
hostname: ip-10-239-7-51.ec2.internal
software: Nutch 1.6 (CC)/CC WarcExport 1.0
isPartOf: CC-MAIN-2016-18
operator: CommonCrawl Admin
description: Wide crawl of the web for April 2016
publisher: CommonCrawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf