Modèle : page application

Ceci est une ancienne révision du document !

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.

Ne modifiez pas cette page modèle sans concertation !

Quelques conventions à respecter au minimum :

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).

Pour faire part de votre projet de création de page, ou si la syntaxe n'est pas votre tasse de thé, n'hésitez pas à contacter la liste de discussion à l'adresse suivante: ubuntu_wiki-fr [AROBASE] listes.ubuntu-fr.org

—[ Le modèle commence ICI ]—

Trusty, 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.

Si possible, ajouter l'icône par défaut de l'application rendra votre page plus facilement reconnaissable.

Il est important de mettre un et un seul titre de niveau 1 (H1) à vos pages. Ainsi, si un portail 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, ce qui la différencie de ses alternatives éventuelles, 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…

Il n'y a que 5 niveaux de titre, ce qui devrait être suffisant. Si ça ne l'est pas, votre page est sans doute "trop complète", et mériterait qu'un de ses aspects soit traité à part (par exemple dans un tutoriel) ;
La table des matières affichée au début de la page ne liste que les titres h2 et h3.

Si des pré-requis sont nécessaires pour la suite des opérations, indiquez-les, en précisant (si possible et de manière simple) leur utilité (pour l'installation ? pour l'activation d'une fonctionnalité ?) comme le montre l'exemple suivant.

Disposer des droits d'administration pour l'installation ;
Disposer d'une connexion à Internet fonctionnelle et active pour:
- l'installation du paquet ;
- telle(s) fonctionnalité(s) du logiciel ;

Citons quelques autres exemples possibles :

Disposer des droits d'administration pour :
- l'installation ;
- l'utilisation (cas d'applications comme des gestionnaires de partitions ou des logithèques) ;
- une manipulation de configuration spécifique ;
Disposer d'une connexion à Internet fonctionnelle et active pour:
- l'installation du paquet ;
- telle(s) fonctionnalité(s) du logiciel ;
- …
Disposer d'Ubuntu en version xx.xx au minimum.
Avoir activé l'accès au dépôt Partenaires de Canonical.
Avoir préalablement installé tel autre logiciel pour pouvoir utiliser telle fonctionnalité du logiciel.
Avoir préalablement installé le paquet paquet 1.

Il s'agit d'une liste d'exemples : il n'y a absolument pas besoin de présenter vos pré-requis sous la forme d'une liste, ni besoin qu'elle soit aussi longue.

Si la version minimale exigée est la version encore supportée la plus ancienne, il est totalement superflu de l'indiquer.
Si un autre logiciel est pré-requis et qu'il a une page dans la doc, donnez le lien de la page mais pas le lien apt !
Les dépôts "partenaires Canonical" doivent être indiqués dans les "Pré-requis" si nécessaire, mais dans le cas d'un éventuel PPA spécifique, l'ajout doit être indiqué dans la sous-partie concernée de "installation".

Il peut être utile de préciser si le logiciel est déjà présent par défaut (en précisant les variantes voire les versions concernées si besoin et non déjà précisé dans les "Pré-requis"), comme le montre l'exemple suivant

Le logiciel Bidule devrait être installé par défaut à partir de la version 16.10.
Le cas échéant, il est possible de l'installer de 3 façons:

La Méthode recommandée;
La Méthode par ajout de PPA
La Méthode alternative 3

Méthode recommandée

Ce logiciel se trouve dans la logithèque sous le nom de "Bidule".

Il est souhaitable d'indiquer comment trouver et installer graphiquement les applications, mais ce n'est hélas pas applicable à tous les logiciels, ni valable pour toutes les variantes.

Le cas échéant, pour installer ce logiciel, il suffit d'installer les paquets paquet1 paquet2 paquet3.

Puis, …

Méthode par ajout de PPA

[…]

Méthode alternative 3

[…]

Une/des méthode(s) alternative(s) n'ont besoin d'être fournie(s) que si la méthode "normale" présente des dysfonctionnements (version dans les dépôts trop ancienne ou trop instable, absence des dépôts, etc.).

Parmi les méthodes alternatives, on peut noter :

méthode différente spécifique à une ancienne LTS (cas d'un changement du nom du paquet par exemple)
l'ajout de PPA (avec avertissement relatif à la stabilité du système)
l'installation par flatpak (17.04 et supérieures)
l'installation par snap (16.04 et supérieures)
l'installation par appimage

Si un pré-requis est spécifique à une méthode alternative, précisez explicitement cette spécificité dans les pré-requis.

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).

Quand c'est possible (notamment quand c'est valable pour toutes les versions/variantes), il est préférable d'expliquer en priorité la configuration graphique, de manière si possible un minimum illustrée.

Les manipulations de fichiers ou de clés de paramétrage dconf arrivant dans un second temps.

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

En cas d'usage de l'outil sudo :

il faut que cet usage soit nécessaire, ne l'indiquez jamais sans raison ;
ne mettez pas
```
sudo gedit /etc/apt/source.list
```
par exemple, mais mettez:
« avec les droits d'administration, ouvrez le fichier /etc/apt/source.list »

Lancez l'application "Bidule" comme indiqué ici, ou via le terminal 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), en revanche, faites attention à bien définir ce dont vous parlez (clarté du vocabulaire utilisé, …) !

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.

N'oubliez pas de proposer une éventuelle suppression du PPA si nécessaire.

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.

Tutoriels ou ressources intéressantes relatives à l'application (que ce soit dans le wiki, sur le forum, sur un site externe ou sur Wikipédia.
Si un site officiel pour le projet existe, il est utile de le préciser ici, ainsi que (si le code est hébergé sur une plateforme de ce style) un lien vers github/launchpad/sourceforge/etc.

Site officiel du logiciel Bidule ^(en)
Manuel d'utilisation du logiciel Bidule ^{(fr, en)}
Tutoriel en rapport avec bidule
Page en rapport
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 pouvez 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 , …

—[ Modèle à copier/coller ]—

modèle_application

{{tag>Trusty Xenial BROUILLON}}
----
{{ :?100|Logo ou icône de l'application}}
====== Nom affiché de l'application ======
 
[DESCRIPTION DE L'APPLICATION]
 
===== Pré-requis =====
 
Pour l'installation, il faut disposer des [[:sudo|droits d'administration]] et d'une connexion à Internet fonctionnelle et active.
 
[AUTRES PRÉ-REQUIS NÉCESSAIRES]
 
===== Installation =====
 
Ce logiciel se trouve dans la [[:gnome-software|logithèque]] sous le nom de "**Bidule**".
 
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 "**Bidule**" comme indiqué **[[tutoriel:comment_lancer_application|ici]]**, ou via le [[:terminal]] 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 =====
  * Basé sur [[http://www.document_source.com|« Titre original de l'article »]] par Auteur Original.
  * **(en)** [[Site officiel du logiciel]]
  * **(fr)** [[Site de la communauté francophone du logiciel Bidule]]
  * [[:tutoriel/faire_ceci_avec_bidule|Tutoriel en rapport avec le 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]]
, ...//

¹⁾

versions d'Ubuntu LTS pour lesquelles la page est valide

²⁾

au moins un, à choisir parmi les tags existants