Wiki Editing and Style Guidelines

From Tizen Wiki
Revision as of 21:02, 19 March 2012 by Dawnfoster (talk | contribs) (added initial page content based on old guidelines)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Collaborative Process

Creating articles in the wiki is a collaborative process. After you have written your piece others may:

  • Edit
  • Alter
  • Adapt
  • Add

So don't worry about making your article perfect the first time through. Don't hesitate to add content you think is useful and don't hesitate to make edits where you think you can help. There's always somebody to fix anything that breaks.

Style

  • Keep your writing informative and not too casual, not too formal.
  • Avoid gratuitously using technical language. Explain or define terms which might reasonably be unknown to a reader.
  • If you need to use acronyms, explain them with the first use.
  • Page names should be short and to the point.
    • The page name is a label, not a sentence.
    • Use spaces. NoCamelCase (that is, use "Root access" instead of "RootAccess").
    • Use sentence capitalization for page titles. Only proper nouns should be capitalized after the first word (for example, Contributing to Tizen is OK, Contributing To The Wiki is not)
    • When using sub-pages, please ensure that you are really grouping several related pages under a common root. Deep hierarchies make for long names. As a general rule, use no more than two levels for subpages (for example, Community Office/Meetings is OK, Community Office/Meetings/Meeting minutes from May 11 is not)
    • This article on URL design explains some of the principles behind good URL names - and every wiki page name is also a URL

For more information, see the Wikipedia Style Guide.

Using the Wiki (How-to)

Where to start

Before creating a new page, you should first make sure that a page on your topic does not already exist:

  1. In the search box in the upper right corner, enter your topic.
  2. If the exact topic exists, the page will open.
  3. If there are related pages, you will get a search results page. Check if your topic is in the results.
  4. If your topic does not exist, choose create this page.

How to edit a page

If you'd like to change a page.

  1. Make sure that you are logged in to the wiki with your tizen.org username.
  2. Click the Edit tab.
  3. Enter your changes in the box.
  4. In the Summary box, enter a short explanation of what you did.
  5. Click Show preview if you want to check your changes.
  6. Click Save page.

Creating a subpage

Many sections in the wiki are organized by subtopic. There has been some confusion about how to create subpages, so here are the instructions:

  • Make sure you are logged in (and see instructions above for searching before you create a new page)
  • In the search box, type Community Office/My new page name
  • Click "Go"

Please note that to avoid creating orphan pages (that is, wiki pages that no other wiki page links to) it is recommended that you create a page by linking to it first, and then clicking on the link to the non-existent page. For example Quality/My new page name. Please also note that creating sub-pages more than 2 deep is advised against, since it makes link names longer, and does not help with the maintenance of the wiki. See the Style section above for the very brief style guide to the wiki.

Formatting

We use MediaWiki formatting (the same as used on Wikipedia, for example). For simple formatting, use the buttons above the edit box. For more information see:

Editing conventions on talk pages

Having discussions on a free-form wiki page will seem strange at first. It helps if everyone follows some simple editing conventions:

  • Always sign your name after your comments. Use the four tildes “~~~~” wiki syntax (or the signature button signature button in the toolbar above the editing textbox). For more information see Help:Signatures.
  • Start a new discussion with a ==level 2 heading== at the bottom of the page (or use the “+” tab)
  • Indent replies with colons (:) at the beginning of the line.

For more information see: Help:Signatures and Help:Talk pages.

Credit

Based on Maemo wiki contribution guidelines and the MeeGo guidelines.