Utilisation de AbulEduAProposV0¶

Présentation¶

La classe AbulEduAproposV0 doit permettre d'intégrer automatiquement le menu 'Aide' dans les logiciels du Terrier.

Elle implémente les fonctionnalités suivantes :

• Création automatique du menu Aide dans la barre de menu de l'application.
• Création des items de menu :
  • Aide : qui renvoie vers la page d'aide Internet sur abuledu.org/leterrier/NOM_De_MON_LOGICIEL (tel que défini dans Redmine)
  • Aide intégrée... : aide disponible dans la fenêtre A Propos de l'application
  • Ressources... : présente les ressources pédagogiques disponible pour le logiciel dans Pédagosite
  • Nouveautés... : Lecteur de Flux RSS pointant vers la page Annonces du Redmine, devrait présenter les nouvelles versions et fonctionnalités et pointer vers les fichiers à télécharger
  • Forum... : Lecteur de Flux RSS pointant vers la page du forum consacrée à ce logiciel et affichant les derniers messages.
  • Contribuer... : Liens vers les différentes possibilités de contribuer
  • A Propos... : Fenêtre d'A propos, les champs Nom du Logiciel, version du logiciel sont préremplis si les variables ApplicationName et ApplicationVersion sont renseignées.
• Modification du contenu des différents onglets de la fenêtre d'Aide en utilisant directement QtCreator ou QtDesigner.

Installation¶

• Télécharger l'archive abuleduaproposV0 ici: https://redmine.ryxeo.com/projects/leterrier-developpeu/files
• Décompresser l'archive (de préférence dans le répertoire de votre projet)
• Dans QtCreator, faire un clic-droit sur le nom du projet dans l'arborescence et choisir "Ajouter des fichiers existants...". Ajouter les trois fichiers abuleduaproposv0.h, .ui, .cpp (normalement, ils apparaissent dans le .pro du projet.
• Ajouter aussi dans le .pro de votre projet les modules "xml network" sur la ligne (s'il n'y figurent pas déjà...)

QT += script xml network

• Dans le fichier .h de votre application ajouter #include "abuleduaproposv0/abuleduaproposv0.h" (peut-être également dans votre fichier .cpp)
• Il ne reste plus qu'à installer le menu dans le constructeur de votre application ajouter :

AbulEduAproposV0 *monAide=new AbulEduAproposV0(this);

Paramétrage, Personnalisation¶

Pour que l'aide puisse fonctionner correctement en utilisant les paramètres de nom, version , et adresse du site Internet d'aide,
il est nécessaire d'ajouter les lignes suivantes (le main.cpp est le bon endroit pour le faire) :

Avant la ligne : int main(int argc, char *argv[])

//-------------------Nom visible de l'application---------------------
//
extern const QString abeApplicationLongName="Leterrier d'AbulEdu - Joli Nom de Mon Application";
//
//--------------------------------------------------------------------

puis dans le int main...

    qApp->setApplicationName("Nom_Redmine_de_mon_Logiciel");
    qApp->setApplicationVersion("version de mon logiciel");
    qApp->setOrganizationDomain("abuledu.org");
    qApp->setOrganizationName("leterrier");

On laisse organizationDomain et organizationName comme indiqué.
Veiller à bien utiliser le nom du projet Redmine dans setApplicationName, le numéro de version quand à lui doit être du style x.y.z

Avec X: numéro de version majeur, Y sous version, si impair c'est une version de développeur, et Z la sous version. Exemple, le jour de la sortie c'est la version 1.0.0 et 2 semaines après quand tout le monde a débusqué les micro-bugs c'est la 1.0.1 :)

Ensuite, il ne reste plus qu'à compléter les deux onglets ("Aide Intégrée" et "À propos")de la fenêtre d'aide en utilisant QtCreator ou Designer.

Ouvrez le fichier abuleduaproposv0.ui, choisissez l'onglet à modifier et double-cliquez sur le champs de texte : vous êtes dans l'éditeur de ce champ...
En ce qui concerne les images que l'on peut insérer dans ces onglets, il faut les enregistrer de préférence dans data/images et veiller à ce que les liens pointent bien vers ces répertoires.

Et hop !

Code source et application de test¶

Si vous voulez télécharger le dépôt bzr

bzr branch sftp://redmine.ryxeo.com/home/groupes/developpeurs/leterrier/leterrier-developpeu/abuleduaproposv0

Et l'application de test

bzr branch sftp://redmine.ryxeo.com/home/groupes/developpeurs/leterrier/leterrier-developpeu/abuleduaproposv0-test