Modèle : page application

wiki, modèle, comment participer

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 Dokuwiki de cette page, servez vous du modèle à copier/coller ou télécharger, en bas de cette 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 (si vous pensez avoir laissé des fautes, ajoutez le tag orthographe_a_corriger à la page).

—[ le modèle commence ICI ]—

Bionic, Xenial, BROUILLON

Les tags d'une page "application" sont à introduire dans l'ordre suivant :
Versions¹⁾ autres_tags²⁾ BROUILLON
Pour en savoir plus sur l'usage des tags : voir ici.

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… Par exemple :

Le logiciel Bidule est un gestionnaire d'archives sous licence libre (GPL v3), ayant la particularité de pouvoir …

Optionnel: [Capture d'écran du logiciel fonctionnant sous Ubuntu (voir ce tutoriel)]

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 des pré-requis sont nécessaires pour la suite des opérations, indiquez-les. Citons quelques exemples :

Avoir activé l'accès au dépôt Partenaires de Canonical.
Avoir installé le paquet paquet 1.

Pour installer ce logiciel, il suffit d'installer les paquets paquet1 paquet2 paquet3.

Puis, …

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 comme indiqué ici ou via le terminal (toutes versions ou variantes d'Ubuntu) avec 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. Selon la méthode choisie, la configuration globale de l'application est conservée ou supprimée. Les journaux du système, et les fichiers de préférence des utilisateurs dans leurs dossiers personnels sont toujours conservés.

(en) Site officiel du logiciel Bidule
(fr, en) Manuel d'utilisation du logiciel Bidule
Discussion « J'ai un soucis avec le logiciel Bidule » sur le forum Ubuntu-fr

Si vous considérez que votre contribution à la page de documentation est significative et/ou que vous souhaitez pouvoir être contacté par les lecteurs, vous avez la possibilité de la signer en ajoutant votre identifiant dans la ligne ci-dessous. Vous pouvez aussi vous abonner aux modifications de la page en cliquant sur "S'abonner à la page" (menu en haut à gauche).

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.

—[ Modèle à copier/coller ]—

modèle_application

{{tag>Bionic Xenial BROUILLON}}
----
{{ :applications:icone_de_l'application.png?80}}
====== Nom affiché de l'application ======
 
[DESCRIPTION DE L'APPLICATION]
 
===== Pré-requis =====
 
  * Avoir activé l'accès au [[:depots#depot_partenaire_ou_depot_commercial|dépôt Partenaires de Canonical]].
  * Avoir [[:tutoriel:comment_installer_un_paquet|installé le paquet]] **[[apt>paquet1|paquet 1]]**.
[AUTRES PRÉ-REQUIS NÉCESSAIRES]
 
===== Installation =====
 
Pour installer ce logiciel, il suffit d'[[:tutoriel:comment_installer_un_paquet|installer les paquets]] **[[apt>paquet1,paquet2,paquet3|paquet1 paquet2 paquet3]]**.
 
Puis, …
 
===== Configuration =====
 
Tout d'abord, [[:tutoriel:comment_modifier_un_fichier|ouvrez le fichier]] **/truc/machin/bidule** en modification puis …
 
===== Utilisation =====
 
Lancez l'application comme indiqué [[:tutoriel:comment_lancer_application|ici]] ou via le [[:terminal]] (toutes [[:versions]] ou [[:variantes]] d'Ubuntu) avec la [[:commande_shell|commande]] suivante : <code>machin-chose</code>
 
===== Désinstallation =====
 
Pour supprimer cette application, il suffit de [[:tutoriel:comment_supprimer_un_paquet|supprimer son paquet]]. Selon la méthode choisie, la configuration globale de l'application est conservée ou supprimée. Les journaux du système, et les fichiers de préférence des utilisateurs dans leurs dossiers personnels sont toujours conservés.
 
===== Voir aussi =====
 
  * **(en)** [[Site officiel du logiciel]]
  * **(fr)** [[Site de la communauté francophone du logiciel Bidule]]
  * [[http://forum.ubuntu-fr.org/viewtopic.php?id=64840|Discussion « J'ai un soucis avec le logiciel Bidule »]] sur le forum Ubuntu-fr
 
----
 
//Contributeurs principaux : [[utilisateurs:votre_identifiant|votre nom ou pseudonyme]], [[utilisateurs:autre_identifiant|nom ou pseudo autre]].//
 
//Basé sur [[http://www.document_source.com|« Titre original de l'article »]] par Auteur Original.//

¹⁾

versions d'Ubuntu LTS pour lesquelles la page est valide

²⁾

au moins un, à choisir parmi les tags existants