Rapport du project Editeur web

13 fvrier 2009

Table des matires

1 Cahier des Charges 1.1 Introduction . . . . . . . . . . . . 1.2 Analyse de quelques diteurs web 1.3 Fonctionnalits obligatoires . . . 1.4 Fonctionnalits optionnelles . . . 1.5 Syntaxe . . . . . . . . . . . . . . 1.6 Dcomposition du groupe . . . . 1.7 Diagramme de Gantt 6 . . . . . . existants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1 1 2 3 4 4

1
1.1

Cahier des Charges

Introduction
Dans le cadre de lunit denseignement Projet du semestre 6 en 3eme anne de licence informatique la facult des Sciences de Montpellier nous ralisons un diteur Web. Nous avons dcid de le raliser en C++ car cela nous permet dutiliser la bibliothque Qt de trolltech.

1.2

Analyse de quelques diteurs web existants

Frontpage : Frontpage est un diteur de la suite Microsoft Oce, cest donc un logiciel propritaire. Cet diteur est considr comme tant plutt destin des petites entreprises, notamment grce la gestion des tches pour le travail par quipe. Il est de type WYSIWYG (What You See Is What You Get => ce quon voit est ce quon obtient), ce qui fait de lui un diteur assez intuitif pour les amateurs. Il dispose entre autre dun diteur dimages et dun client ftp intgrs. Nanmoins, pour des utilisateurs possdants des notions de langage html, le code gnr par Frontpage est parfois superu, et de moyenne qualit (le code nest pas toujours conforme aux normes W3C). De plus, cest un logiciel payant, et utilisable sous Windows (bien quune version Mac ait t cre). 1

Adobe Dreamweaver : Dreamweaver est aussi un diteur de site web de type WYSIWYG possdant une licence propritaire. Cest un des diteurs les plus connus. Tout comme Frontpage, un utilisateur qui na aucune connaissance particulire concernant la fabrication de sites internet peut aisment utiliser Dreamweaver pour crer un site web labor, dautant plus que Dreamweaver permet de faire des pages web dynamiques grce lintgration doutils PHP. Il possde aussi un client ftp. De plus, cet diteur permet dinsrer des scripts prprogramms pour par exemple mettre une horloge ou un compteur dans son site. Cependant, Dreamweaver produit parfois du code de mauvaise qualit, et coute plutt cher. KompoZer : KompoZer est un logiciel libre de type WYSIWYG, conu pour tre facile dutilisation. Il est multiplateforme, et permet donc dtre install sous Windows, Linux, ou Mac. Il possde de nombreuses fonctionnalits telles que : client ftp, gestion des feuilles de style CSS. . . Cependant, la dernire version de KompoZer comporte de nombreux problmes de stabilit, ainsi quune interface graphique peu developpe. Notepad++ : Notepad++ est un diteur de texte qui gre la coloration du code html (mais aussi dautres langages). Il est donc destin aux personnes maitrisant le langage HTML ou PHP. De plus, comme cest un diteur de texte, il ne possde pas de client ftp, mais il est gratuit. PHPEdit : PHPEdit est un environnement de dveloppement intgr, spcialis dans le PHP. Il intgre la coloration syntaxique, ainsi que la compltion automatique des fonctions PHP ainsi quune interface personnalisable pour faciliter son usage. Nanmoins, cest un diteur de texte et il requiert donc certaines connaissances de langages. Enn, il est galement payant.

1.3

Fonctionnalits obligatoires

Coloration syntaxique : Coloration des mots-cls du langage et des fonctions qui seront placs dans un chier texte. Possibilit de laisser lutilisateur changer les couleurs de coloration. Lutilisateur pourra, dans un chier texte, rentrer les mots-cls et les fonctions dautres langages (tel que Python) ou dans le cas dune mise jour de langage, rajouter les nouvelles fonctions dans les chiers correspondant. Il faudra alors se poser la question des droits de lutilisateur concernant la modication de certains chiers ncessaires au bon droulement du logiciel pour ne pas quil commette des erreurs qui nuiraient au logiciel. Il faudra galement prvoir une syntaxe particulire pour ce chier. Auto-compltion : 2

 Pour faire lauto-compltion, nous utiliserons les chiers textes crs pour la coloration syntaxique. Les fonctions des manuels seront-elles aussi incorpores dans lauto-compltion. Les variables ainsi que les fonctions cres par lutilisateur seront aussi intgres dans lauto-compltion. Fermeture automatique des balises (avec possibilit de ne pas utiliser cette fonction). Possibilit laide dun raccourci de mettre automatiquement un ; la n de chaque ligne notamment pour les scripts PHP (avec possibilit de ne pas utiliser cette fonction). Auto-indentation : Avec possibilit de changer la taille de ces indentations. Accs tous les manuels : Cette partie est lie lauto-compltion et donc la coloration syntaxique. Achage dune bulle daide lorsque, dans la fentre de lauto-compltion, on choisira une fonction, ou au passage de la souris sur une fonction. Prsence dans la fentre dun champ de texte permettant de chercher laide sur une fonction particulire. Ce champ texte permettrait galement de chercher des scripts dj faits sur des sites internet o il y a des codes sources (exemple : http ://www.siteduzero.com , www.codessources.com). Plan de site : Fabrication dun arbre de lien reprsentant larborescence du site cre laide du logiciel. Listage des variables, des fonctions, et des classes dans un volet du logiciel. Web browser : Crer notre propre web browser. Utiliser notre web browser ainsi que ceux dj existant pour tester les pages internet cres. Graphisme : Achage du nombre de pages du projet. Ainsi que du nombre de lignes et du nombre de caractres dans le projet. Modication de thmes. Achage gnrale du logiciel (zones de texte, menus. . . )

1.4

Fonctionnalits optionnelles

Client ftp. Dbuggeur. Validation W3C. Renommage rcursif de toutes les pages et des liens dans le cas dune modication de nom de page. Editeur WYSIWYG Copie automatique des images du site dans un dossier an de les rfrencer par un chemin relatif. 3

 Vrication de lexistence de la page pointe externe ou interne an dviter les liens morts. Correcteur orthographique. Mises jour du logiciel. Gestion de base de donnes, gnration automatique de scripts MYSQL. Traduction du logiciel en plusieurs langues. Aide au dveloppement de lapplication, cration dune aide en ligne, explication des classes et des mthodes utilises dans la fabrication du logiciel.

1.5

Syntaxe

Nous coderons en franais cest--dire que les attributs, les noms de classes, les mthodes, et les fonctions que nous utiliserons pour crer cet diteur web auront des noms franais. Classe : majuscule puis minuscule et majuscule pour sparer les mots. Mthode : minuscule et majuscule pour separer les mots. Attribut : minuscule puis underscore. indentation : Mettre le maximum daccolades, mme si il ny a quune ligne de code aprs le for ou le if. Et les placer en dessous du for et de la dernire ligne de la boucle. Commentaires : les mettre au dessus de chaque fonction, de chaque classe, dans le .h de prfrence.Doxygen sera utilis pour gnrer la documentation Gestion des erreurs avec le format : Erreur : courte description de lerreur, situes sur nom de la page, a telle ligne.

1.6

Dcomposition du groupe

Coloration syntaxique, Auto-compltion : KONIG Mlanie NOVAK Audrey SAUVAN William Auto-indentation : AZRIA Julien DURAND Romain Accs tous les manuels : MAILLET Laurent Plan de site : BALIMA Dietrich

Web browser : MANESCHI Romain (chef de projet) Graphisme : FHAL Jonathan

1.7

Diagramme de Gantt