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

—[ 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 …

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 suffisant. Le plan affiché 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é. Citons quelques exemples :
  • Disposer des droits d'administration pour l'installation.
  • Disposer d'une connexion à Internet fonctionnelle et active pour l'installation du paquet.
  • Disposer d'Ubuntu en version xx.xx au minimum (à ne pas préciser si le minimum requis est la plus vieille version encore supportée !).
  • Avoir activé l'accès au dépôt Partenaires de Canonical.
  • Avoir préalablement installé le paquet paquet 1.
  • Disposer d'une connexion à Internet fonctionnelle et active pour l'utilisation de telle fonctionnalité du logiciel.
  • Avoir installé tel autre logiciel pour pouvoir utiliser telle fonctionnalité du logiciel.
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.
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, l'ajout doit être indiqué dans la sous-partie concernée de "installation".

Méthode recommandée

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

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

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

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 :

  • l'ajout de PPA (avec avertissement relatif à la stabilité du système)
  • l'installation par flatpak (17.04 et supérieur)
  • l'installation par snap (16.04 et supérieur)
  • l'installation par appimage
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).

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

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

Lancez l'application "Bidule" comme indiqué 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 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>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 =====
 
==== Méthode recommandée ====
 
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, …
 
==== Méthode alternative ====
 
===== 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|comme indiqué 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 =====
 
  * **(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]].//
 
//Basé sur [[http://www.document_source.com|« Titre original de l'article »]] par Auteur Original.//

1)
versions d'Ubuntu LTS pour lesquelles la page est valide
2)
au moins un, à choisir parmi les tags existants
  • utilisateurs/roschan/brouillon.1500387199.txt.gz
  • Dernière modification: Le 18/07/2017, 16:13
  • par Roschan