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.

Un exemple basé sur ce modèle est présent ici.

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 en ligne de commande 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 ]—

Les tags d'une page "application" sont à introduire dans l'ordre suivant :
Versions1) autres_tags2) 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.

Logo ou icône de l'application

Nom affiché de l'application

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 … et …

Il est inclut par défaut depuis la version 15.04 dans les variantes Ubuntu Machin et Ubuntu Truc.

Optionnel : une 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.
Indiquez les pré-requis nécessaires pour la suite des opérations, en précisant (si possible et de manière simple) leur utilité (pour l'installation ? pour l'activation d'une fonctionnalité ?).

Si les seuls pré-requis sont des pré-requis triviaux (uniquement les droits d'admin et la connexion internet pour l'installation), il est possible de les omettre.

Pour l'installation, il faut disposer des droits d'administration et d'une connexion à Internet fonctionnelle et active.

L'utilisation de telle fonctionnalité nécessite…

Citons quelques 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 jamais besoin de présenter autant de pré-requis !

Si ils commencent à être nombreux, les présenter sous forme de liste peut être une bonne idée (mais généralement, il n'y a que 2 ou 3 prérequis, qui sont plus clairs avec des phrases grammaticalement correctes).

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 ! Bien entendu, les dépendances gérées par apt ne sont pas à indiquer dans les pré-requis.

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

Méthode recommandée

Ce logiciel se trouve normalement 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.

Sinon, pour installer ce logiciel, il suffit d'installer le paquet paquet1.

Puis, …

[Méthode alternative 1]

[…]

[Méthode alternative 2]

[…]

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.

Exemple pour Flatpak :

Au format Flatpak

Ajoutez le dépôt flatpak machin (dont l'adresse est https://chose.com/machin.flatpakrepo), puis installez le paquet flatpak org.truc.Bidule selon le niveau de privilèges qui vous convient.

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 la commande sudo (ou ses variantes graphiques) :
  • il faut que cet usage soit nécessaire, ne l'indiquez jamais sudo sans raison ;
  • ne mettez pas sudo gedit /etc/apt/source.list mais « avec les droits 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é, …) !
Des problèmes (graves ou bénins) reviennent parfois sur le forum, ou dans votre propre expérience ? Expliquez si possible comment les résoudre, ou dans le cas contraire les contourner ;-)

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érences des utilisateurs dans leurs dossiers personnels sont toujours conservés.

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

Au cas où une installation alternative (par flatpak, snap ou appimage) soit proposée sur la page, des sous-paragraphes seront peut-être nécessaires pour détailler les méthodes de désinstallation relatives à ces formats.

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

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>Bionic 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 normalement dans la [[:gnome-software|logithèque]] sous le nom de "**Bidule**".
 
Sinon, pour installer ce logiciel, il suffit d'[[:tutoriel:comment_installer_un_paquet|installer le paquet]] **[[apt>paquet1]]**.
 
===== 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>
 
===== Problèmes connus =====
 
[PROBLÈMES COURAMMENT RENCONTRÉS SI IL EN EXISTE]
 
===== 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érences 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]]
, ...//

1)
uniquement les versions d'Ubuntu LTS pour lesquelles la page est valide
2)
au moins un, à choisir parmi les tags existants
  • utilisateurs/roschan/brouillon.txt
  • Dernière modification: Le 27/09/2019, 19:43
  • par L'Africain