Openmoko Wiki Editing Guidelines

From Openmoko

Revision as of 19:18, 16 July 2007 by Kheldar (Talk | contribs)

Jump to: navigation, search

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.


Conventions de nommage

  1. OpenMoko est purement Logiciel (une sorte de distribution OpenMoko GNU/Linux)
  2. Neo1973 est la première machine physique officiellement capable de fonctionner sous OpenMoko
  3. Dites "l'ordiphone" si vous faites référence à une machine qui peut être Neo1973 mais aussi une version ultérieure

Règles

  1. Lors d'un ajout d'informations sur le Matériel (en particulier des pages), gardez à l'esprit que le Neo1973 n'est qu'une machine parmi d'autres destinées à fonctionner sous OpenMoko. De ce fait,
    1. Ne pas créer de pages génériques du type "Batterie", mais plutôt "Batterie Neo1973"
    2. Dans le cas ou il soit valable de créer une page générique, créer des sections spécifiques aux machines, et s'assurer de toujours y faire pointer les liens provenant de pages spécifiques au Neo1973
  2. Le wiki a pour but principal de contenir des informations factuelles concernant des projets logiciels existants, ou du matériel, même si des morceaux peuvent être encore en développement. Par conséquent,
    1. Si vous ajoutez des informations concernant des points de Wishlist (voire même des élucubrations encore plus échevelées), prenez soin de l'indiquer en les marquant d'un préfixe "Wishlist:" dans le titre de la page.
    2. Assurez vous toujours qu'un utilisateur extérieur puisse clairement distinguer les fonctionnalités réelles de la machine des "passionnantes évolutions (théoriquement possibles) que nous pourrions réaliser si seulement nous en avions le temps" :)

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.

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.


Conventions de nommage

  1. OpenMoko est purement Logiciel (une sorte de distribution OpenMoko GNU/Linux)
  2. Neo1973 est la première machine physique officiellement capable de fonctionner sous OpenMoko
  3. Dites "l'ordiphone" si vous faites référence à une machine qui peut être Neo1973 mais aussi une version ultérieure

Règles

  1. Lors d'un ajout d'informations sur le Matériel (en particulier des pages), gardez à l'esprit que le Neo1973 n'est qu'une machine parmi d'autres destinées à fonctionner sous OpenMoko. De ce fait,
    1. Ne pas créer de pages génériques du type "Batterie", mais plutôt "Batterie Neo1973"
    2. Dans le cas ou il soit valable de créer une page générique, créer des sections spécifiques aux machines, et s'assurer de toujours y faire pointer les liens provenant de pages spécifiques au Neo1973
  2. Le wiki a pour but principal de contenir des informations factuelles concernant des projets logiciels existants, ou du matériel, même si des morceaux peuvent être encore en développement. Par conséquent,
    1. Si vous ajoutez des informations concernant des points de Wishlist (voire même des élucubrations encore plus échevelées), prenez soin de l'indiquer en les marquant d'un préfixe "Wishlist:" dans le titre de la page.
    2. Assurez vous toujours qu'un utilisateur extérieur puisse clairement distinguer les fonctionnalités réelles de la machine des "passionnantes évolutions (théoriquement possibles) que nous pourrions réaliser si seulement nous en avions le temps" :)

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.