Utilisation de dcDOAP

Présentation

Ce plugin permet de générer automatiquement un ou plusieurs fichiers DOAP (Description of a Project) à la racine de son blog (un fichier doap unique par projet/plugin) .

Champs/listes de sélection

Champs obligatoires

Installation suppression et mise à jour des tables du plugin.

• Le plugin dcDOAP s'installe automatiquement à la toute première utilisation : la(es) table(s) seront automatiquement crées (c.f. fichier install/db-create.xml)
• La mise à jour des tables se fera à chaque nouvelle version du plugin qui nécessitera une modification de la structure de la table (la mise à jour ne se fera que si le plugin est déjà installé).Cette opération est dangereuse et peut entrainer la perte de vos anciennes données enregistrées,il est très vivement recommandé de faire une sauvegarde des données de la table avant d'effectuer cette mise à jour (note : nous ne serons aucunement responsables de la perte de vos données si vous effectuez une mauvaise manipulation de la commande "upgrade table(s)")
• La suppression des tables se fait en cliquant sur le lien correspondant en haut à droite de l'interface de l'administration.La suppresion des tables du plugin est irréversible et toutes les données s'y trouvant seront perdues,soyez prudents et faites une sauvegarde de celles-ci avant (note : nous ne serons aucunement responsables de la perte de vos données si vous effectuez une mauvaise manipulation de la commande "delete table(s)")
• Pour la suppresion du(es) table(s) du plugin,le fichier se trouve dans uninstall/db-delete.xml.Pour la mise à jour du(es) table(s) le fichier se trouve dans upgrade/db-upgrade.xml (note : ce plugin est une première version,il n'y a pas de mise à jour des tables à effectuer).
• Pour une suppresion complète du plugin dans le répertoire DC_ECRIRE/tools/ aller au plugin initial correspondant de DotClear.

Langue du fichier DOAP

Cette liste de langues permet de définir la langue globale du fichier DOAP obtenu (attribut xml:lang).Il est obligatoire.

Nom du projet

Ce champ contient le nom du projet.Ce champ est obligatoire.

Nom de la release du projet ou état de la release

Ce champ contient le nom de la release du projet,on peut y mettre par exemple stable,unstable,testing ou un nom caractéristique différent du nom du projet (exemple : tiger,woody ...).Ce champ est obligatoire.

Date de création du projet

Ce champ contient la date de création du projet.Cette date peut être différente de la date de création du profil DOAP (si possible une date antérieure à la date de création du fichier DOAP).Ce champ est obligatoire.

Version (ou numéro de révision)

Ce champ contient le numéro de version ou de révision du projet (exemple : 0.1,1.0..).Ce champ est obligatoire.

La page d'accueil du projet

Ce champ contient l'url vers la page d'accueil du projet (ou le lien général vers le blog si le projet est dans un blog).Ce champ est obligatoire.

Description longue du projet

Ce champ contient la description longue du projet.Ce champ est obligatoire.

Description courte (ou libellé) du projet

Ce champ contient la description courte (ou libellé) du projet en général pas plus de 10 mots (maximum 255 caractères).Ce champ est obligatoire.

Nom du mainteneur principal (ou "chef de projet")

Ce champ contient le nom du mainteneur principal (ou chef de projet/project leader) du projet.Ce nom doit être unique et pour la liste de l'ensemble des développeurs c.f. doap_developers.Ce champ est obligatoire.

Pseudo du mainteneur principal

Ce champ contient le pseudo du mainteneur principal.Ce champ est obligatoire (note : on peut mettre le nom si il n'y a pas de pseudo).

Adresse email du mainteneur principal (cryptée avec sha1)

Ce champ contient l'email du mainteneur.Notes : l'adresse email ,lors de la création du projet sera cryptée avec l'algorithme sha1,l'édition d'un profil DOAP existant affichera l'adresse email cryptée par cette méthode sha1.Cette adresse email ne pourra pas être rééditée (excepté si on veut garder celle-ci en clair),car lors de l'édition la méthode de cryptage n'est pas réutilisée.Champ obligatoire sauf lors d'une édition d'un profil existant (sauf si on veut garder l'adresse email en claire (ie non cryptée).

Url vers le fichier FOAF du mainteneur

Ce champ comporte l'adresse url vers le fichier FOAF (Friend of A Friend) du mainteneur.Ce champ est obligatoire (mais peut pointer vers un 404 si on n'a pas de fichier FOAF).

OS (Operating System/systèmes d'exploittion) supportés par le projet

Ce champ correspond aux différents systèmes d'exploitation supportés par le projet.Ce champ peut être vide (vide signifiant support pour toute plateforme/OS : il y sera mis Any si le Champ est vide (note : chaque système d'exploitation supporté doit être séparé par une virgule dans le champ)

Langage(s) de programmation utilisé(s) pour le projet

Cette liste propose l'ensemble des langages de programmation utilisés pour le projet.Cette liste est à choix multiple et au moins un langage doit être spécifié.(note : nécessite la function multicombo() dans le fichier inc/libs/lib.form.php de DotClear fourni avec le plugin)

Licence du projet

Cette liste présente les différentes licences que le projet peut avoir (exemple : GNU/GPL,Mozilla Public license...).Ce choix est obligatoire et peut être multiple (dans le cadre d'un projet multi-licence par exemple) et au moins une licence doit être spécifiée.(note : nécessite la function multicombo() dans le fichier inc/libs/lib.form.php de DotClear fourni avec le plugin)

Type du projet pour la spécification des dépôts.

Cette liste présente les différents choix possibles pour la nature du(es) dépôt(s)/repository(ies) (i.e l'url où se trouveront les sources).Le choix est unique (DOTCLEAR,CVS,ARCH,SVN,BiTKEEPER).Si vous créez un plugin pour DotClear choisissez DOTCLEAR les dépots des sources correspondront alors à l'adresse url vers le pkg.gz,vers le zip et vers le tar.gz du plugin et l'url de base sera l'url vers l'ensemble de ces archives. (Note : pour un plugin DotClear seule l'adresse url_base sera pris en compte lors de la génération du fichier DOAP

Url vers la spécification du dépot repos1

Champ indiquant les différentes url où l'on pourra trouver les sources du projets.Ce choix peut être optionnel suivant le type de projet spécifié (note indiquée en italique au-dessus des champs).Pour un plugin DotClear ,ce champ correspond à l'url vers l'archive pkg.gz du plugin(note : la valeur de ce champ n'apparaîtra que dans la partie admin de dcDOAP,il ne sera pas présent dans le fichier DOAP).

Url vers la spécification du dépot repos2

Champ indiquant les différentes url où l'on pourra trouver les sources du projets.Ce choix peut être optionnel suivant le type de projet spécifié.Pour un plugin DotClear,ce champ correspond à l'url vers l'archive zip du plugin (note : la valeur de ce champ n'apparaîtra que dans la partie admin de dcDOAP,il ne sera pas présent dans le fichier DOAP).

Url vers la spécification du dépot repos3

Champ indiquant les différentes url où l'on pourra trouver les sources du projets.Ce choix peut être optionnel suivant le type de projet spécifié (note indiquée en italique au-dessus des champs).Pour un plugin DotClear ,ce champ correspond à l'url de l'archive tar.gz du plugin (note : la valeur de ce champ n'apparaîtra que dans la partie admin de dcDOAP,il ne sera pas présent dans le fichier DOAP).

Url vers la spécification du dépot base_url

Champ indiquant les différentes url où l'on pourra trouver les sources du projets.Ce choix peut être optionnel suivant le type de projet spécifié (note indiquée en italique au-dessus des champs).Pour un plugin DotClear ,ce champ correspond à l'url vers l'ensemble des archives et fichiers md5.(note : dans le cadre d'un plugin DotClear,seul ce champ apparaîtra dans le fichier DOAP du projet).

Champs pouvant être optionnels

Url vers le Wiki du projet

Champ indiquant l'adresse url vers le wiki .Ce champ est optionnel.(note : si le champ est vide le blog devra être pris en compte,les champs wiki et blog peuvent être remplis tous les deux)

Url vers le Blog du projet

Champ indiquant l'adresse url vers le blog relatif au projet.Ce champ est optionnel.(note : si le champ est vide le Wiki devra être pris en compte,les champs wiki et blog peuvent être remplis tous les deux)

Url vers la bug-list du projet

Champ indiquant l'adresse url vers la liste des bugs relatifs au projet.Ce champ est optionnel.

Url vers la mailing-list

Champ indiquant l'adresse url vers la mailing-list du projet (ou du forum).Dans le cadre d'un plugin DotClear le lien pointera vers la mailing-list dev de DotClear.Ce champ est optionnel.

Url vers les captures d'écrans du projet

Champ indiquant l'adresse url vers les captures d'écrans du projet.Ce champ est optionnel (mais très vivement recommandé).

Url vers le logo du projet

Champ indiquant l'adresse url du logo du projet.Ce champ est optionnel.Dans le cadre d'un plugin DotClear il s'agira de l'image icon.png du plugin copiée et renommée automatiquement en doap-nom_plugin.png vers le répertoire où se trouve les captures d'écrans.

Url vers la clef publique du fichier DOAP

Champ indiquant l'adresse url de la clé publique du fichier DOAP généré.Ce champ est optionnel.

Liste des développeurs du projet

Champ indiquant la liste des développeurs du projet.Le nom du mainteneur du projet y est inclus et les noms doivent être séparés par des virgules dans le champ.Ce champ est obligatoire.

Personnes ayant paticipé à l'élaboration de la documentation du projet

Champ indiquant la liste des personnes ayant participé à l'élaboration de la documentation du projet.Le nom du mainteneur du projet peut y être inclus et les noms doivent être séparés par des virgules dans le champ.Ce champ est obligatoire.

Personnes ayant paticipé à l'internationalisation/traduction du projet

Champ indiquant la liste des personnes ayant aidé à la traduction du projet.Le nom du mainteneur du projet peut y être inclus et les noms doivent être séparés par des virgules dans le champ.Ce champ est optionnel.

Ce champ n'existe pas

Ce champ n'existe pas pour le moment.

Ce champ n'existe pas

Ce champ n'existe pas pour le moment

Divers

Notes :

Pour plus d'informations sur DOAP vous pouvez visiter les sites http://doap-fr.org (fr) , http://www.bonjourlesmouettes.org (fr)http://doap.net (en)et http://usefulinc.com/doap(en)

En ce qui concerne la partie front-end de ce plugin,plusieurs possibilités sont offertes :

1. Placer dans le head du template un appel vers la fonction getHTMLHeaders() pour tous les profils DOAP du blog :

   <?php dcdoap::getHTMLHeaders(); ?>

2. Ou bien placer directement dans le head de votre template.php cette ligne (dans le cas où vous ne voulez mettre qu'un seul profil DOAP) :

   <link rel="meta" type="application/rdf+xml" title="DOAP" href="./doap-nom_du_projet.rdf" />

3. Placer dans la sidebar un appel vers la fonction showDOAPViewer() qui affichera dans une liste tous les projets ayant un profil DOAP (chaque lien pointera vers le DOAP-viewer du projet concerné)

   <?php dcdoap::showDOAPViewer(); ?>

4. Ou bien sur votre site placer une petite icone (fourni avec le plugin sous le nom de doap.png) indiquant que votre blog possède un profile DOAP :

   <img src="./doap.png" alt="DOAP-compliant" title="DOAP-compliant" />

5. Vous pouvez aussi rajouter un lien <a href=... dans votre template vers DOAP-viewer écrit par Vincent Tabard (Balbinus) :

   http://doapy.bonjourlesmouettes.org/doap-viewer.php?url=http://url_de_votre_blog/doap-nom_du_projet.rdf

6. Il existe aussi un bookmarklet pour les navigateurs web qui pointe vers le DOAP-viewer :

    http://crschmidt.net/doap/bookmarklet.html

7. Note : pour chaque projet ou plugin ,un fichier DOAP doap-nom_projet.rdf/doap-nom_plugin.rdf sera créé à la racine du blog (i.e : chaque plugin/projet aura un fichier doap unique).

Pour les utilisateurs de Mozilla Firefox,il existe une sidebar nommée DOAPer qui permet de savoir si la page possède un fichier DOAP en affichant la petite icône DOAP en bas du navigateur :

http://crschmidt.net/doap/doaper.html