Infos

Fil RSSYannick Pavard

Archives

TYPO3 et la documentation, un problème ?

Posté par Yannick Pavard le 27 janvier 2008

J’entends souvent des gens se plaindre que TYPO3 n’est pas documenté ou bien mal documenté. C’est vrai que la documentation n’est pas toujours très bien classée, la preuve en image ici : Cliquez ici pour remonter deux ans en arrière.

Comme vous pouvez le voir, avant la sortie de TYPO3 4.0 nous avions un beau tableau (matrix documentation) qui présentait les documentations les plus importantes et nous pouvions voir celles qui étaient disponibles en français ou non. D’ailleurs ce qui est regrettable également, c’est que la documentation depuis cette période a été déplacée, semble-t’il, et tous les liens que nous pouvons trouver sur internet, notamment dans les listes de discussions (support) pointent vers des pages 404 sur le serveur de TYPO3, ça c’est dommage.

On y accède comment ?

A présent, nous pouvons accéder à la documentation en passant par ce lien : typo3.org/documentation/ et naviguer dans 5 sections :

  • Tutoriaux
  • Installation
  • Documentation du core (Coeur de TYPO3)
  • Références
  • Manuels des extensions

Mais rien n’indique très clairement dans quelle langue se trouve le manuel.

Documentation du core :

Bon pas de panique, voilà à peine quelques jours maintenant qu’un gros problème a été réglé ! Je veux parler ici des documentations de la section “Core” qui étaient absentes. De mois en mois, on voyait disparaitre les liens un part un.. Pour finir, y’a de ça 10 jours, le lien vers la documentation TSREF était absent ! Un comble quand on voit que c’est la documentation la plus importante ou l’on y trouve toutes les informations pour faire du Typoscript.

Petit point concernant cette section du site.. je ne sais pas pourquoi, mais j’ai découvert il y a quelque temps maintenant, que les documentations de cette section étaient également disponibles sur le serveur SVN de TYPO3 et il semble que les dates de mises à jour sont encore plus récentes ! Cela vous intéresse ? Le lien est ici : typo3.svn.sourceforge.net/viewvc/typo3/CoreDocs/trunk/

Et les manuels des extensions la dedans ?

La documentation des manuels peut être accessible aussi depuis cette section, ils sont tous classés par ordre alphabétique et disponibles en version PDF, en ligne ou OpenOffice. Sinon lorsque l’on recherche une extension, on accède uniquement à la version “en ligne”. Et enfin si vous téléchargez l’extension sur votre serveur pour l’installer, vous pouvez demander à recevoir la version OpenOffice. C’est un peu bordélique, mais quand on a comprend comment ça marche, on trouve ce que l’on veut.

La qualité des documentations est au bon vouloir du développeur, mais dans l’ensemble je trouve que les extensions les plus “populaires” et les plus utiles sont très bien documentées, on y trouve toujours des captures d’écrans, un guide d’installation, un guide d’utilisation et la partie références pour le Typoscript ainsi que les derniers changements effectués (fameux changelog)

Autres ressources du site

Il existe d’autres ressources dans cette section du site de TYPO3.org que je vous laisse découvrir, en l’occurrence des vidéos (qui sont un peu anciennes..) disponibles en anglais et des références vers des livres. Vous pouvez également télécharger des DVD de la conférence annuelle de TYPO3 (celle de 2007 est disponible ici)

Mais je vais vous laisser deux liens qui me semblent vraiment importants ! Car il est vrai que certaines documentations ne sont plus très jeunes comme les vidéos par exemple, mais si vous souhaitez consulter des informations fraiches sur TYPO3 alors il faut vraiment consulter la section “T3N Magazine” ou l’on trouve des articles traduits en anglais du célèbre magazine allemand sur TYPO3 ainsi que la section PodKast de Kasper ici : typo3.org/podcast/. Pour ce dernier, ce n’est certes pas de la documentation en tant que telle, mais je classerais cela parfaitement dans les “Trucs et astuces”.

Ah oui j’allais oublier de vous donner le lien vers le wiki de TYPO3, ou l’on peut également trouver quelques informations utiles sur des extensions et TYPO3 en général : http://wiki.typo3.org

Notamment cette page la : http://wiki.typo3.org/index.php/Pending_Documentation ou l’on retrouve toutes les modifications liées aux documentations officielles qui n’ont pas encore été mises à jour mais qui ne seraient tarder.

Autres ressources externes

Il existe d’autres ressources externes qui parlent de TYPO3 et qui ne sont pas toutes référencées sur le site, en voici quelques-unes :

Malheureusement dans tout cela, vous avez peut-être remarqué que je n’avais pas donné le lien du site officiel francophone, alias TYPO3.fr, tout simplement parce que ce site hormis son forum et le lien vers le canal IRC n’offre rien d’intéressant sur TYPO3 ;-(

Il n’y a aucune mise à jour des pages et celles présentes sont vraiment devenues obsolètes avec le temps. Espérons que cela changera très bientôt (avec des articles comme le mien qui poussent un peu lol)

Et par rapport aux autres CMS ?

Bon difficile de comparer TYPO3 avec le “reste du monde”, car il faut du temps pour pouvoir trouver et comprendre comment sont organisés les autres CMS. Cela dit, moi qui connais quand même assez bien Xoops, un CMS de la catégorie des “Communautés”, je dirais qu’il existe incontestablement beaucoup plus de documentation en français, car la communauté a travaillé fort pour créer des documents sur le site de Xoops France. Mais à côté de cela, il va être difficile de trouver un endroit qui réunit toutes les documentations de tous les modules et je dirais même encore… une organisation inexistante pour les développeurs d’extensions. Contrairement à TYPO3 où un modèle OpenOffice est mis à la disposition des développeurs et qui sert par la suite à générer une version online. Par contre, j’ai l’impression que la communauté Xoops met plus d’énergie du côté des wikis :-)

J’ai également été faire un tour du côté du CMS très en vogue, alias DRUPAL. Là j’ai trouvé une partie du site qui regroupe des informations diverses (articles sur DRUPAL, installation, astuces, etc..) ainsi qu’un lieu qui regroupe toutes les contributions (module). Pour chaque module un lien indique ou trouver la documentation : sur le site de drupal, sur le site de l’auteur ou un lien vers un fichier texte. Dans l’ensemble j’ai trouvé que la plupart des modules avaient leur documentation et tout semble clairement affiché. Sauf que je n’ai pas trouvé de versions PDF ou OpenOffice. Avec une version en ligne cela doit être difficile d’imprimer la doc ? Ce qui est appréciable avec TYPO3, c’est que la documentation est au format OpenOffice (donc XML) et qu’il est facile de la produire dans n’importe quel format.

Le meilleur des mondes

Dans le meilleur des mondes que devrions-nous avoir ?

  • Un drapeau qui indique clairement la langue de la documentation lorsqu’on la télécharge sur le site
  • Des documents qui sont remis à jour régulièrement ou du moins centralisés (c’est le cas pour les manuels des extensions, mais pas les documentations du core, vu que l’on trouve des versions à jour sur le svn)
  • Des vidéos, voir même un lieu où les utilisateurs pourraient y déposer leur propre vidéo ou screencast (vidéo didactielle où l’on peut suivre les actions à l’écran pas à pas)
  • Une communauté francophone active (je vous laisse voir par vous même la nuance entre ACTIVE et PLUS ACTIVE) qui pourrait créer des contenus en français ou du moins créer un lieu pour partager ces contenus.
  • Un magazine en anglais sur TYPO3, le rêve !

Avez-vous autre chose ?

Alors bonne lecture, et ne venez plus me dire qu’il n’existe pas de documentation pour TYPO3 !

Partagez ce billet avec :
  • Digg
  • Sphinn
  • del.icio.us
  • Facebook
  • Mixx
  • Google
  • Technorati
  • Wikio FR
  • YahooMyWeb

Catégorie(s) : CMS/SGC

Tag(s) : ,

Pas de commentaire

Pas encore de commentaire.

Laisser un commentaire

Flux RSS des commentaires de cet article. TrackBack URI