Openmoko Wiki Editing Guidelines
From Openmoko
(Difference between revisions)
m (→Utilisabilité) |
(restoring to english version (french version was copied to OpenMoko_Wiki_Editing_Guidelines/fr)) |
||
| Line 2: | Line 2: | ||
| − | == | + | == Naming == |
| − | # OpenMoko | + | # OpenMoko is only referring to pure Software (think OpenMoko GNU/Linux distribution) |
| − | # Neo1973 | + | # Neo1973 is the first hardware device that officially runs OpenMoko |
| − | # | + | # Use "the smartphone" if you refer to a hardware device that could be Neo1973 but could also be a later version |
| − | == | + | == Rules == |
| − | # | + | # If you're adding information (esp. Pages) about the Hardware, keep in mind that the Neo1973 is only one of the various devices that will run OpenMoko. Thus, |
| − | ## | + | ## Do not create generic pages like "Battery", rather use "Neo1973 Battery" |
| − | ## | + | ## If it makes sense to have generic pages, use per-device sections and make sure you always link to the Neo1973 section from other Neo1973 specific pages |
| − | # | + | # The wiki is primarily meant to contain factual information on actual project software, hardware, even though parts might still be under development. Thus, |
| − | ## | + | ## 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. |
| − | ## | + | ## 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 [[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 sytazx to create a new one. | |
<pre> | <pre> | ||
[[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. | |
<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.] | ||
{{Languages|OpenMoko_Wiki_Editing_Guidelines}} | {{Languages|OpenMoko_Wiki_Editing_Guidelines}} | ||
[[Category:Help]] | [[Category:Help]] | ||
Revision as of 22:35, 16 July 2007
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
- OpenMoko is only referring to pure Software (think OpenMoko GNU/Linux distribution)
- Neo1973 is the first hardware device that officially runs OpenMoko
- Use "the smartphone" if you refer to a hardware device that could be Neo1973 but could also be a later version
Rules
- If you're adding information (esp. Pages) about the Hardware, keep in mind that the Neo1973 is only one of the various devices that will run OpenMoko. Thus,
- Do not create generic pages like "Battery", rather use "Neo1973 Battery"
- If it makes sense to have generic pages, use per-device sections and make sure you always link to the Neo1973 section from other Neo1973 specific pages
- The wiki is primarily meant to contain factual information on actual project software, hardware, even though parts might still be under development. Thus,
- 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.
- 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 sytazx 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.
 |
Languages: |
English • العربية • Български • Česky • Dansk • Deutsch • Esperanto • Eesti • Español • فارسی • Suomi • Français • עברית • Magyar • Italiano • 한국어 • Nederlands • Norsk (bokmål) • Polski • Português • Română • Русский • Svenska • Slovenčina • Українська • 中文(中国大陆) • 中文(台灣) • Euskara • Català |
