Cette documentation fournira davantage de détails que les instructions incluses dans l'installation de PhpWebGallery. Je tenterai de l'orienter selon 3 profils : utilisateur, administrateur et technique.

  • utilisateur : informations minimales. Normalement, PhpWebGallery doit faire parti du lot d'applications suffisamment intuitives pour se passer d'explications... du point de vue utilisateur.
  • administrateur : le plus gros paquet d'informations a priori. Il s'agit d'expliquer aux administrateurs d'une galerie comment utiliser les fonctionnalités de l'application pour une exploitation optimale.
  • technique : ce qui se cache derrière. Ce qui n'intéresse pas le non développeur bidouilleur.

Cela risque de ne pas être toujours simple de séparer les informations sur chaque fonctionnalité entre 2 types d'utilisateurs. Peut-être que chaque domaine sera décrit sur une page et que des sections sépareront les profils concernés. L'avenir nous le dira.

Il y a plus d'un an, lors de la sortie de la branche 1.3, je pensais utiliser DocBook pour écrire cette documentation et la faire partager. Depuis, j'ai fait traîner et j'ai réfléchi. DocBook ou une autre technique de formattage n'aurait certainement pas pu vivre très longtemps car cela nécessite un mainteneur de documentation et que cette activité est plutôt pénible à mes yeux...

Aujourd'hui, la solution la plus appropriée se rapproche bien plus du Wiki. Pour ceux qui ne savent pas ce qu'est un Wiki (1), il s'agit d'une nouvelle forme de site web dont le contenu est géré collaborativement : chacun a le droit de créer et de modifier le contenu des pages. Cela signifie tout simplement qu'une communauté peut faire vivre cette documentation sans devoir tout centraliser par un administrateur. Le Wiki le plus connu sur internet est certainement Wikipedia, la popularité et la croissance de site sont époustouflants !

Justement, suite à quelques soirées de surf sur Wikipedia, j'ai décidé d'utiliser mediawiki comme moteur de wiki. Mediawiki est un moteur de wiki très (trop?) complet, ils couvrent au moins 100% des besoins que j'avais listé. J'ai commencé à travailler en local avec mediawiki mais même en local, l'application était d'une lenteur suspecte. Installé sur mon serveur distant, la même lenteur m'a fait penser que mediawiki était certainement plus adapté à des serveurs dédiés pour des sites très volumineux.

Au hasard du web, je suis tombé sur dokuwiki. Dokuwiki est un autre moteur de Wiki beaucoup plus simple que mediawiki mais qui couvraient également 100% de mes besoins. Il avaient également d'autres avantages par rapport à mediawiki :

  • pas de base de données, les articles sont stockés au format texte
  • gestion native de l'utf8
  • vraiment rapide
  • simple d'utilisation
  • simple de configuration (fichiers de configuration limpides)

C'est ainsi que j'ai migré les quelques 4 articles existants vers dokuwiki. Un embryon de documentation existait.

La documentation est constitué de 2 sites distincts : un site français et un site anglais. J'ai commencé par écrire des articles en anglais, pensant que je trouverais plus facilement des bonnes volontés pour traduire de l'anglais vers le français que le contraire. Et j'avais raison, puisque mattheox a dors et déjà traduit les 4 premiers articles et m'a confié qu'il n'attendait que d'autres articles à traduire !

La documentation officielle de PhpWebGallery est donc ouverte, j'espère que les utilisateurs satisfaits de PhpWebGallery s'investiront dans cet outil mis à leur disposition :-)

Notes :

  • (1) évidemment, la définition est simpliste, pour coller avec les objectifs de la documentation de PhpWebGallery
  • (2) toutes les questions que se posent les utilisateurs ne trouveront pas de réponse dans le Wiki, mais une FAQ y aura sa place par exemple. Les problèmes d'installation par contre seront encore traités sur le forum.