Annexe M. A propos du manuel

Table des matières
Formats
A propos des notes utilisateurs
Comment lire la définition d'une fonction (prototype)
Versions de PHP documentées dans ce manuel
Où trouver plus d'informations sur PHP?
Comment aider à l'amélioration de la documentation
Comment sont générées les documentations
Traductions
Traduction française

Formats

Le manuel PHP est fourni en différents formats. Ces formats sont divisés en deux groupes : ceux qui sont disponibles en ligne, et les téléchargeables.

Note : Certains éditeurs ont fournis des versions imprimées de ces manuels. Nous n'en recommandons aucune, car elles sont rapidement obsolètes.

Vous pouvez lire le manuel en ligne sur le site http://www.php.net/ et sur les nombreux miroirs. Pour un confort d'utilisation accru, il est recommandé d'utiliser un miroir proche de chez vous. Vous pouvez le voir en version HTML simple (et facilement imprimable), ou bien aux couleurs de PHP.net.

Un des points forts du manuel en ligne sur la plupart des formats téléchargeable, est l'intégration des notes des utilisateurs. Un inconvénient évident est que vous devez être en ligne pour profiter de ces formats.

Il y a de nombreux formats de manuel pour la consultation hors ligne, et le format le plus approprié dépend de votre OS et de vos goûts personnels. Pour savoir comment le manuel est généré, lisez la section 'Comment le manuel est généré'.

Le format le plus portable est le manuel au format HTML. Le manuel est fourni dans un format en une seule page HTML, ou comme un ensemble de fichier de taille réduite (mais un bon millier de fichiers tout de même). Les formats HTML et texte simple sont disponibles sous forme de fichiers d'archives compressées avec bzip2.

Un autre format populaire et portable est le format PDF, le plus pratique pour les impressions. Mais avant de lancer une telle impression, pensez bien que le manuel au complet faire plus de 2000 pages, et qu'il est constamment révisé.

Note : Si vous n'avez pas de programme capable de lire les fichiers PDF, téléchargez le Adobe Acrobat Reader.

Pour les propriétaires de PDA Palm, deux formats Palm document et iSilo sont optimisés pour cette plate-forme. Vous pouvez emporter votre PDA avec vous dans vos déplacements quotidiens, et utiliser les programmes DOC et iSilo pour améliorer vos connaissances de PHP, ou bien profiter de ses références rapides.

Pour les plates-formes Windows, le format Windows HTML Help fournit une version HTML du manuel, avec l'application Windows HTML Help : il intègre un moteur de recherche complet, un index et des signets. De nombreux IDE sous Windows fournissent des liens avec ce format pour une meilleure intégration.