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.
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).
—[ Le modèle commence ICI ]—
Versions1) autres_tags2) BROUILLON
Pour en savoir plus sur l'usage des tags : voir ici.
Nom affiché de 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.
- 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.
Pré-requis
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…
- 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 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".
Installation
Méthode recommandée
Ce logiciel se trouve normalement dans la logithèque sous le nom de "Bidule".
Sinon, pour installer ce logiciel, il suffit d'installer le paquet paquet1.
Puis, …
[Méthode alternative 1]
[…]
[Méthode alternative 2]
[…]
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 appimage
Si un pré-requis est spécifique à une méthode alternative, précisez explicitement cette spécificité dans les pré-requis.
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
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 …
- 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
».
Utilisation
Lancez l'application "Bidule" comme indiqué ici, ou via le terminal avec la commande suivante :
machin-chose
Problèmes connus
Désinstallation
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.
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.
Voir aussi
- Basé sur « Titre original de l'article » par Auteur Original.
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.
- Discussion « J'ai un soucis avec le logiciel Bidule » sur le forum Ubuntu-fr
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]] , ...//