Ceci est une ancienne révision du document !



Modèle : page application

Cette page présente un modèle de base servant à la rédaction d'un article sur une application dans cette documentation. Pour récupérer le code wiki de cette page, cliquez sur le bouton « Éditer » du menu de gauche et copiez le code dans votre nouvelle page. Cette présentation est suggérée, mais n'est pas statique ; n'hésitez pas à personnaliser vos pages. Par contre, ne modifiez pas cette page modèle !
Quelques conventions à respecter au maximum :
  • Le nom de la page (URL) doit être le nom du paquet principal de l'application ou le nom de l'application si elle n'est pas présente dans les dépôts.
  • La page doit se situer à la racine du wiki.
    Par exemple, la page sur le navigateur web Mozilla Firefox sera à l'adresse : http://doc.ubuntu-fr.org/firefox.
  • Évitez les fautes d'orthographe, particulièrement déplaisantes.

—[ le modèle commence ICI ]—

Introduisez d'abord les différents tags représentant le mieux votre page. Le minimum est d'indiquer la(les) version(s) d'Ubuntu pour lesquelles la procédure a été testée (avec la première lettre en majuscule. exemple).
Un tag particulier est le tag « BROUILLON ». Ce tag (en majuscule pour se démarquer des autres tags) indique que la page doit être relue, est en cours de rédaction ou doit être améliorée.
  • Les tags sont à introduire dans l'ordre suivant :
    Version autre_tag BROUILLON
  • Si il y a des accents dans les tags, ils doivent être présents.
  • S'il y a des espaces, ils sont matérialisés par un tiret bas « _ ».
  • Les tags doivent être au singulier.

Exemples :

Voir une liste de tags possibles


Modèle : page application

Il est important de mettre un et un seul titre de niveau 1 (H1) à toutes vos pages. Ainsi, si une page liste toutes les pages contenant un des tags de cette page, alors cette page pourra être inclue à la liste. Dans le cas contraire, elle ne le pourra pas (et dans ce cas-là, les tags ne servent à rien). :-(
Rédigez ici une courte introduction sur l'application.
De manière brève, concise et claire, indiquez par exemple ce à quoi est destinée l'application, dans quel cas elle peut être utile, la licence sous laquelle elle est diffusée, toute autre information que vous jugerez utile de savoir avant de commencer la lecture de la page…
Chaque section aura un titre de niveau 2 (H2) puis ses sous-sections, un titre de niveau 3 (H3) et ainsi de suite… Remarque : il n'y a que 5 niveaux de titre, ce qui devrait être amplement suffisant.
Si, pour la suite des opérations, des pré-requis sont nécessaires, indiquez-les. Citons quelques exemples :

Installez le paquet foo.

Il vous suffit, pour cela, d'installer les paquets truc machin chose.

Ensuite, …

Tout d'abord, ouvrez le fichier /truc/machin/bidule en modification puis …

Configuration particulière ? Expliquez les détails utiles de configuration (il n'est pas nécessaire de faire un copier-coller de la page de manuel ; les grandes lignes suffisent avec éventuellement un lien dans les références).

Lancez l'application depuis le menu Applications → Accessoires → Machin Chose ou via la commande suivante :

machin-chose
Raccourcis intéressants ? Fonctions cachées ? Expliquez le fonctionnement général de ce que vous présentez (là non plus, il n'est pas nécessaire de copier-coller la page de manuel).

Pour supprimer cette application, il suffit de supprimer son paquet. La configuration de l'application sera conservée ou supprimée selon la méthode de désinstallation que vous choisirez.

Des références particulièrement intéressantes pour approfondir le sujet peuvent être utiles.

Si vous considérez que votre contribution à la page de documentation est significative, vous avez la possibilité de la signer en ajoutant votre identifiant dans la ligne ci-dessous.

Contributeurs principaux : votre nom ou pseudonyme, nom ou pseudo autre.

Si vous vous êtes basé sur un document existant pour écrire votre article, citez la source originale ! Ceci est indispensable afin de respecter les droits d'auteur.

Basé sur « Titre original de l’article » par Auteur Original.

  • mercurial.1250707503.txt.gz
  • Dernière modification: Le 19/08/2009, 20:45
  • par 213.95.41.13