Openmoko Wiki Editing Guidelines

From Openmoko

(Difference between revisions)
Jump to: navigation, search
m
(added 'follow your pages', better readabilty of 'categories' section)
Line 18: Line 18:
 
## Always make sure that an outside user can clearly distinguish between the actual feature set of the device, and "interesting theoretical plans of what one could do if he had time" :)
 
## Always make sure that an outside user can clearly distinguish between the actual feature set of the device, and "interesting theoretical plans of what one could do if he had time" :)
  
== Helpfulness ==
+
== Use categories ==
 +
 
 +
Adding [[Special:Categories | categories]] to a page allows the wiki engine to organize the content automagically. This allows readers to find information in an organized way.
 +
 
 +
* Please add one or more categories at the bottom of the pages you create
 +
* Review the existing category list on the [[Special:Categories | categories]] page
 +
* If a category does not exist and you think a new one is required then use the same category syntax to create a new one
 +
 
 +
To add your page to a category:
  
As you author new pages or edit existing pages, please add a category at the bottom of the page. Review the existing category list on the [[Special:Categories | Categories page]].  Adding [[Special:Categories | categories]] to a page allows the wiki engine to organize the content automagically.  If a category does not exist and you think a new one is required then use the category syntax to create a new one.
 
 
<pre>
 
<pre>
 +
  [[Category:My selected category]]
 
   [[Category:My new category]]
 
   [[Category:My new category]]
 
</pre>
 
</pre>
This example shows how both an exsiting category named '''My new category''' or a new category called '''My new category''' would be created.  If you are creating a new category, then be sure to click on the new page like and define what you were thinking should go in this page.
+
 
 +
If you are creating a new category, then be sure to click on the new category link and define what you were thinking should go into this category. Please be as brief that readers will easily realize the automatically indexed page links below your introductiont text.
 +
 
 +
To link to a category page within the page text:
 
<pre>
 
<pre>
 
   [[:Category:My new category | My new category]]
 
   [[:Category:My new category | My new category]]
 
</pre>
 
</pre>
Moreover, this example shows how you can use a category page as an actual wiki page.  Yes you will have to type a few more characters, but your readers will link to an actual page of information with all the other related pages at the bottom!. Here again we are using the wiki engine to perform our indexing and linking for us.
 
  
 
For more help on categories, please see [http://www.mediawiki.org/wiki/Help:Categories MediaWiki's "Categories" help page.]
 
For more help on categories, please see [http://www.mediawiki.org/wiki/Help:Categories MediaWiki's "Categories" help page.]
Line 107: Line 117:
  
 
*Z
 
*Z
 +
 +
== Follow your own pages ==
 +
 +
When you create a new page, it's a good idea to add it to your watchlist. Check your watchlist regularly to keep up with the evolution of the pages you have created, help the new editors of your page.
  
  

Revision as of 22:17, 23 July 2008

Our Openmoko Wiki Editing Guidelines are meant to assist our users in editing this wiki. They try to ensure a somewhat more consistent and organized structure.


Contents

Naming

  1. Openmoko is only referring to pure Software (think Openmoko GNU/Linux distribution)
  2. Neo 1973 is the first hardware device that officially runs Openmoko
  3. Use "the smartphone" if you refer to a hardware device that could be Neo 1973 but could also be a later version

Rules

  1. If you're adding information (esp. Pages) about the Hardware, keep in mind that the Neo 1973 is only one of the various devices that will run Openmoko. Thus,
    1. Do not create generic pages like "Battery", rather use "Neo 1973 Battery"
    2. If it makes sense to have generic pages, use per-device sections and make sure you always link to the Neo 1973 section from other Neo 1973 specific pages
    3. See this page for a list of other definitive spellings used in the Openmoko project
  2. The wiki is primarily meant to contain factual information on actual project software, hardware, even though parts might still be under development. Thus,
    1. If you're adding information about wishlist items (or even more imaginary things), please clearly mark them with a "Wishlist:" prefix in the page title.
    2. Always make sure that an outside user can clearly distinguish between the actual feature set of the device, and "interesting theoretical plans of what one could do if he had time" :)

Use categories

Adding categories to a page allows the wiki engine to organize the content automagically. This allows readers to find information in an organized way.

  • Please add one or more categories at the bottom of the pages you create
  • Review the existing category list on the categories page
  • If a category does not exist and you think a new one is required then use the same category syntax to create a new one

To add your page to a category:

  [[Category:My selected category]]
  [[Category:My new category]]

If you are creating a new category, then be sure to click on the new category link and define what you were thinking should go into this category. Please be as brief that readers will easily realize the automatically indexed page links below your introductiont text.

To link to a category page within the page text:

  [[:Category:My new category | My new category]]

For more help on categories, please see MediaWiki's "Categories" help page.

Style Sheet

A list of definitive spellings used throughout the site

  • Numbers [0-9]
    • 1973
      • (the model name of the first OpenMoko phone)
  • A
  • B
  • C
  • D
  • E
  • F
    • FreeRunner
      • (not freerunner or Freerunner)
      • (the model name of the 2nd OpenMoko phone)
  • G
  • H
  • I
  • J
  • K
  • L
  • M
    • MokoMakefile (and it's not a script)
  • N
    • Neo
      • (the brand name of OpenMoko phones)
    • Neo 1973
      • (the brand and model name of the first OpenMoko phone)
      • (not neo1973 or neo 1973. Note this has changed during the course of the project and a lot of current entries in the Wiki and software are wrong. See [| here] for the official pronouncement as of Feb08)
    • Neo FreeRunner
      • (the brand and model name of the second OpenMoko phone)
      • (not NeoFreeRunner or neo freerunner)
  • O
    • Openmoko
      • (the name of the complete software stack)
      • (not "OpenMoko" anymore as of March 2008. Note this change means many current entries in the Wiki are wrong - please help to amend!)
    • Openmoko Inc
      • (the name of the Taiwanese company that develops products for the project)
    • openmoko.org
      • (the community, non-commercial website for the project)
    • openmoko.com
      • (the commercial website and webshop of Openmoko Inc)
  • P
  • Q
  • R
  • S
  • T
  • U
  • V
  • W
  • X
  • Y
  • Z

Follow your own pages

When you create a new page, it's a good idea to add it to your watchlist. Check your watchlist regularly to keep up with the evolution of the pages you have created, help the new editors of your page.


Personal tools

Our Openmoko Wiki Editing Guidelines are meant to assist our users in editing this wiki. They try to ensure a somewhat more consistent and organized structure.


Naming

  1. Openmoko is only referring to pure Software (think Openmoko GNU/Linux distribution)
  2. Neo 1973 is the first hardware device that officially runs Openmoko
  3. Use "the smartphone" if you refer to a hardware device that could be Neo 1973 but could also be a later version

Rules

  1. If you're adding information (esp. Pages) about the Hardware, keep in mind that the Neo 1973 is only one of the various devices that will run Openmoko. Thus,
    1. Do not create generic pages like "Battery", rather use "Neo 1973 Battery"
    2. If it makes sense to have generic pages, use per-device sections and make sure you always link to the Neo 1973 section from other Neo 1973 specific pages
    3. See this page for a list of other definitive spellings used in the Openmoko project
  2. The wiki is primarily meant to contain factual information on actual project software, hardware, even though parts might still be under development. Thus,
    1. If you're adding information about wishlist items (or even more imaginary things), please clearly mark them with a "Wishlist:" prefix in the page title.
    2. Always make sure that an outside user can clearly distinguish between the actual feature set of the device, and "interesting theoretical plans of what one could do if he had time" :)

Helpfulness

As you author new pages or edit existing pages, please add a category at the bottom of the page. Review the existing category list on the Categories page. Adding categories to a page allows the wiki engine to organize the content automagically. If a category does not exist and you think a new one is required then use the category syntax to create a new one.

  [[Category:My new category]]

This example shows how both an exsiting category named My new category or a new category called My new category would be created. If you are creating a new category, then be sure to click on the new page like and define what you were thinking should go in this page.

  [[:Category:My new category | My new category]]

Moreover, this example shows how you can use a category page as an actual wiki page. Yes you will have to type a few more characters, but your readers will link to an actual page of information with all the other related pages at the bottom!. Here again we are using the wiki engine to perform our indexing and linking for us.

For more help on categories, please see MediaWiki's "Categories" help page.

Style Sheet

A list of definitive spellings used throughout the site

  • Numbers [0-9]
    • 1973
      • (the model name of the first OpenMoko phone)
  • A
  • B
  • C
  • D
  • E
  • F
    • FreeRunner
      • (not freerunner or Freerunner)
      • (the model name of the 2nd OpenMoko phone)
  • G
  • H
  • I
  • J
  • K
  • L
  • M
    • MokoMakefile (and it's not a script)
  • N
    • Neo
      • (the brand name of OpenMoko phones)
    • Neo 1973
      • (the brand and model name of the first OpenMoko phone)
      • (not neo1973 or neo 1973. Note this has changed during the course of the project and a lot of current entries in the Wiki and software are wrong. See [| here] for the official pronouncement as of Feb08)
    • Neo FreeRunner
      • (the brand and model name of the second OpenMoko phone)
      • (not NeoFreeRunner or neo freerunner)
  • O
    • Openmoko
      • (the name of the complete software stack)
      • (not "OpenMoko" anymore as of March 2008. Note this change means many current entries in the Wiki are wrong - please help to amend!)
    • Openmoko Inc
      • (the name of the Taiwanese company that develops products for the project)
    • openmoko.org
      • (the community, non-commercial website for the project)
    • openmoko.com
      • (the commercial website and webshop of Openmoko Inc)
  • P
  • Q
  • R
  • S
  • T
  • U
  • V
  • W
  • X
  • Y
  • Z