Processus annuaire

De Framawiki.

Framatutos

Processus annuaire
Création et mise à jour de notices

Logiciel et version : Framasoft
Plateforme : Web
Domaine : Framasoft
Site du logiciel : http://www.framasoft.net

Auteur : pyg
Licence du tutoriel : CC BY SA
Difficulté : tout public
Actualisation : à jour



Licence CC-BY-SA

Cc by sa.png

Creative Commons - CC-By-sa

Vous êtes libres

de reproduire, distribuer et communiquer cette création au public

de modifier cette création

Selon les conditions suivantes :

Paternité — Vous devez citer le nom de l'auteur original de la manière indiquée par l'auteur de l'oeuvre ou le titulaire des droits qui vous confère cette autorisation (mais pas d'une manière qui suggérerait qu'ils vous soutiennent ou approuvent votre utilisation de l'oeuvre).

Partage des Conditions Initiales à l'Identique — Si vous modifiez, transformez ou adaptez cette création, vous n'avez le droit de distribuer la création qui en résulte que sous un contrat identique à celui-ci.



Modifier

Sommaire

Introduction

Ce tutoriel a pour but de décrire les étapes de la création d'une notice d'un point de vu « administrateur ».

Pour plus d'information sur la création des notices d'un point de vue « contributeur » et donc sur leur rédaction, consulter : « Proposer_un_logiciel ».

Évaluation d'une notice

Les critère de sélection sont quelque peu détaillés dans le manuel d'aide à la rédaction des notices. Toutefois, une explication orientée administrateurs peut également s'avérer utile.

Les notices se doivent de ne pas être dithyrambiques ni trop succinctes. On doit pouvoir retrouver, dans chaque notice :

  • une description générale du logiciel en question (orientée tout public, donc en mots simples) ;
  • un petit inventaire de ses principales fonctionnalités (orientée utilisateur, donc plus pointu et technique) ;
  • un point sur le contexte et les logiciels proches, complémentaires ou concurrents (et des liens !) ;
  • et enfin un retour d'expérience utilisateur si possible objectif (donc équilibré, et faisant état des défauts ou manques du logiciel décrit).

Le ton doit être le plus neutre possible dans la description du logiciel et de ses fonctionnalités, puis plus humain dans le retour d'expérience utilisateur. Et il reste malgré tout de la place pour la fantaisie de chacun, notamment sur l'organisation de la notice, tant que les principaux éléments s'y retrouvent.

Un dernier point à surveiller est la présence de liens vers la définition des termes complexes et les autres logiciels cités dans la notice. La plupart des logiciels libres seront déjà dans l'annuaire et donc facile à trouver pour le lien, et sinon... il ne reste qu'à les ajouter ;).

Création d'une notice

Généralités

Les notices sont rédigées sur le précédent wiki de Framasoft, aujourd'hui principalement dédié à la gestion des notices.

Leur rédaction est détaillée ici : Proposer_un_logiciel.

Ainsi que les principaux critères sur lesquels se baser pour retenir une notice, demander qu'elle soit retravaillée ou la refuser.

Le wiki étant public, il suffit de préciser un pseudo pour pouvoir modifier une page, et c'est sur cette information que l'on se base pour savoir qui a fait quoi.

Importation dans SPIP

L'import se fait à la main, par copié/collé.

Le site Framasoft.net est pour l'instant géré par un SPIP. Pour y ajouter du contenu il faut donc y détenir un compte (à demander auprès d'un administrateur à l'adresse : annuaire arobase framasoft point net).

Une fois logé dans le SPIP à l'adresse : http://framasoft.net/ecrire Il convient de naviguer dans l'arborescence des catégories de logiciel répertoriés pour créer la notice au bon endroit. Le chemin vers la catégorie peut être précisé dans la description de la notice dans le wiki, sinon on peut s'aider en cherche un logiciel proche pour voir où il avait été rangé.

Une petite îcone de loupe dans la barre d'outil de SPIP permet ces recherches, et sinon tout Framasoft.net est indexé par Google et peut-être interrogé via la case de recherche de la page d'accueil publique du site (sous le menu à gauche).

Une fois au bon endroit, cliquer sur : « Écrire un nouvel article » (en bas à droite).

Les champs d'un nouvel article

Dans le formulaire de rédaction proposé :

  • La 1ère case de texte « Sur-titre » est destinée à contenir le lien vers la page d'accueil du projet du logiciel ajouté.
  • La case suivante, « Titre » de la notice, est le nom du logiciel ajouté.
  • La case suivante « Sous-titre », est à nouveau destinée à contenir un lien, prévu pour cibler une galerie de captures d'écran du logiciel.
  • Ensuite, le champs « Descriptif rapide » doit présenter le logiciel de manière la plus concise possible, en quelques mots.
  • Le champs considéré ensuite est l'« URL » du « Lien hypertexte ». On y copie ici l'URL de la page décrivant au mieux comment aider le projet présenté. C'est généralement sa page de don.
  • Vient ensuite le « Chapeau ». Une notice bien rédigée comporte généralement déjà le texte à copier ici, et il s'agit d'une description résumée en quelque lignes du logiciel.
  • Et enfin le texte de la notice lui-même. Le collage du texte est une nouvelle occasion de relire le fond, mais sur la forme, il convient de vérifier que c'est bien la syntaxe de mise en page de SPIP qui est utilisée pour les liens, les puces...

Il est d'ailleurs important de garnir les notices d'un maximum de liens hypertextes, et en particulier ceux pointant vers d'autres contenus du site :)

  • Une section « Post-Scriptum » est encore disponible (tout en bas) pour contenir une liste de liens connexes au logiciel décrit : page Wikipédia, tutoriels...

Une fois le contenu transféré, cliquer sur le bouton « Enregistrer » (tout en bas à droite). Vous arrivez alors sur une vue où la mise en page de votre article est interprétée (liens, puces...), et vous pouvez donc contrôler cette dernière.

Les mots-clés

Une fois le texte bon, il convient encore de préciser quelques informations sous la forme de mots-clés. Pour pouvoir éditer ces derniers, il faut utiliser l'interface de SPIP en mode « complète » et non « simplifiée » comme c'est le cas par défaut. Pour changer ce réglage, il suffit de placer sa souris sur l'icône « point/Soleil » de la barre d'outil, pour faire apparaître les liens « interface simplifiée / interface complète » et donc de cliquer sur « interface complète ».

Ensuite, pour travailler avec les mots-clés il faut en déplier la case, située entre « Les auteurs » et « Langue et traductions » (en haut). Apparaît alors une liste de boîte de sélection. La plupart des mots-clés sont simple à placer, on les sélectionnent dans la liste et on clique sur le bouton « valider » qui apparaît alors à droite de la liste.

Toutefois, notons qu'il est possible de placer plusieurs mots-clés d'une même catégorie (notamment utile pour les langues ou le code).

Ensuite, même si l'annuaire ne comporte plus aujourd'hui que des logiciels libres, il faut continuer à positionner le mot-clé correspondant pour que le logiciel soit listé dans les boîtes de la page d'accueil (en tant que nouveau logiciel, ou mise-à-jour).

Les tailles sont données par fourchettes, et tout le monde s'en contente :-p

Enfin pour les versions, lorsque vous saisissez une version dans la case de texte prévue à cet effet et que vous validez votre saisie à l'aide du bouton qui apparaît alors, une recherche est effectuée sur les étiquettes de version existantes, et seul cette sélection vous est proposées si la version que vous avez saisie n'avait jamais été rencontrée. Ce qui est à peu près le cas tous les 6 mois avec Ubuntu. Or, dans le cas où le numéro de version que l'on souhaite préciser n'est pas déjà disponible, il suffit de le créer via le lien (à gauche) « Créer un nouveau mot-clé et le lier à cet article ». Dans le cas où celle action est invoquée après une recherche infructueuse de mot-clé, le nom du nouveau mot-clé est pré-rempli dans l'écran de création de mot-clé et il suffit de préciser le type de mot-clé puis de valider le formulaire de création pour revenir à l'écran d'édition de notice (article SPIP). C'est donc expédié en quatre clics :

  1. Saisie de la version puis « Chercher » ;
  2. « Créer un nouveau mot-clé et le lier à cet article » si la cherche est infructueuse ;
  3. Sélection du type de mot-clé à créer (typiquement : « version ») ;
  4. validation du formulaire de création qui apparaît alors.

La vignette

En plus des liens (accueil du projet, galerie de captures, page de soutien), il est possible d'illustrer une notice avec une capture d'écran directement présentée dans la notice ensuite. Pour ce faire, il faut enregistrer la capture choisie sur son disque dur puis la téléverser dans SPIP via la boîte « Ajouter une image » présente à gauche de l'écran de modification du texte de la notice. Une fois l'image uploadée dans SPIP, il convient de changer le « Titre de l'image » en « screen- » avec ce que vous voulez derrière le tiret (et par exemple le nom original de l'image...). N'oubliez pas de cliquer sur le bouton « Enregistrer » qui apparaît lorsqu'une modification est apportée aux champs de l'image. Par un jeu de feuilles de styles l'image apparaîtra alors à sa place et aux bonnes dimensions dans la version en-ligne de la notice.

Tenir le wiki à jour

Une fois la mise en-ligne réussie côté SPIP, il ne faut pas oublier de changer la catégorie de la notice dans le wiki de :

 [[!Publiable]]

à

 [[!Publiee]]

Pour qu'on ne s'y intéresse plus par erreur.

Évaluation d'une mise à jour de notice

Mise à jour d'une notice

La mise à jour d'une notice est plus simple que sa création, mais il faut avoir compris les astuces de la création pour comprendre celles d'une mise à jour.

Lorsqu'il s'agit d'une mise à jour, le texte que l'on trouve dans le wiki est déjà mis en page selon la syntaxe de SPIP. Du coup, il est assez efficace de comparer les deux versions de la notice (celle du wiki et celle en-ligne sur Framasoft.net) en recopiant les deux textes dans des fichiers sur son disque dur pour lancer ensuite la commande unix « diff » (voire « colordiff »).

Une fois les différences bien mises en évidence et contrôlées, il suffit de les reporter dans le texte de la notice en-ligne côté SPIP.

Généralement, le mot-clé de version est lui aussi à mettre à jour. Pour cela, il suffit de supprimer l'ancien et d'en ajouter un nouveau.

La liste des auteurs de la notice côté SPIP peut également être mise à jour.

Et il convient enfin de veiller à ce que le mot-clé « divers->mise en lumière en page d'accueil » soit effectivement positionné sur la notice, afin que la mise à jour soit visible dans la boîte des mises à jour de la page d'accueil de Framasoft.net.

Enfin, là encore, penser à modifier, après publication, les catégories de la notice côté wiki pour qu'elle disparaisse de la liste des notices à traiter (suppression des « MAJ / Ouverture / Publiable » au profit d'un « Publiee »).


Framasoft : http://www.framasoft.net

La route est longue, mais la voie est libre.