Ce manuel est écrit en XML en utilisant le schéma DocBook XML DTD, qui utilise DSSSL (Document Style and Semantics Specification Language) pour sa mise en forme. L'outil utilisé pour la mise en forme des versions HTML est Jade, écrit par James Clark et The Modular DocBook Stylesheets écrit par Norman Walsh.

La structure est basé sur le fantastique travail effectué par le groupe de la documentation de PHP. Lisez A propos du manuel PHP pour plus de détails.

Ce guide explique la structure générale, l'interface ainsi que les conventions utilisées dans le manuel PEAR. Le manuel est divisé en six parties qui sont :

• A propos de PEAR

  Cette section contient une introduction sommaire de ce qu'est PEAR et ce qu'il offre. Vous y trouverez également des informations générales sur l'installation de PEAR, son utilisation, les options supportées et les réponses aux questions les plus fréquemment posées concernant PEAR.

• Guide du développeur

  Informations générales concernant le développement et la disponibilité des paquetages PEAR.

• Composants du noyau

  Cette section contient la documenation relatives aux classes internes de PEAR. Ces composants sont la base de PEAR pour toutes classes PEAR et leur compréhension vous permette l'utilisation générale des librairies PEAR. Vous y trouverez la base PEAR, l'administration de PEAR, la gestion des erreurs en utilisant l'onjet PEAR_Error ainsi que les commandes systèmes. Ces classes sont généralement fournies avec toutes les distributions des sources de PHP.

• Paquetages

  Il y a beaucoup de paquetages PEAR et le nombre augmente chaque jour. La pluspart des paquetages sont documentés et beaucoup ne sont pas installés par défaut. Pour plus d'informations sur l'installation de classes PEAR sur votre système, lisez le chapitre Installation.

  Chaque documentation sur des classes contient une documentation basique sur les fonctions publiques disponibles pour le paquetage. Elle peut également contenir d'autres informations comme une introduction, la liste des constantes disponibles ainsi qu'un exemple d'utilisation. Plus d'informations peuvent également existées dans les sources du paquetage lui-même.

  La description d'une fonction peut comporter les parties suivantes :

  • Synopsis

    Présente la structure et la synoptie des fonctions.

  • Description

    Donne une description de ce que fait exactement la fonction.

  • Parameter

    Décrit chaque paramètre de la fonction avec leurs noms et leurs types. Les paramètres obligatoires et optionnels sont listés.

  • Returns

    Décrit la valeur renvoyée si la fonction n'échoue pas.

  • Throws

    Décrit les objets PEAR_Error renvoyés si la fonction échoue.

  • Note

    Informations supplémentaires sur la fonction.

  • See

    Liens vers d'autres fonctions apparentées ou vers des points précis du manuel.

  • Example

    Un exemple simple de la fonction ou de la classe.

• Apporter sa contribution à PEAR

  Contient des informations permettant de développer ses propres paquetages PEAR.

La liste ci-dessous présente les personnes qui aident à la création et au maintient de la documentation de PEAR. Si vous devez rentrer en contact avec l'une de ces personnes, écrivez à l'adresse [email protected].

• Edited By

  Lorenzo Alberton

• Edited By

  Gregory Beaver

• Edited By

  David Coallier

• Edited By

  Daniel Convissor

• Edited By

  David Costa

• Edited By

  Thomas V.V. Cox

• Edited By

  Michael Gauthier

• Edited By

  Christophe Gesché

• Edited By

  Ken Guest

• Edited By

  Martin Jansen

• Edited By

  Alan Knowles

• Edited By

  Clay Loveless

• Edited By

  Alexander Merz

• Edited By

  Stefan Neufeind

• Edited By

  Jon Parise

• Edited By

  Tobias Schlitt

• Edited By

  Stephan Schmidt

• Edited By

  Mika Tuupola

• Edited By

  Michael Wallner

• Edited By

  Christian Weiske

• Edited By

  Mark Wiesemann

La liste suivante présente les personnes qui ont rendu la traduction de ce document possible.

• Edited By

  Mehdi Achour

• Edited By

  Thierry Bothorel

• Edited By

  Romain Bourdon

• Edited By

  Christophe Gesché

• Edited By

  Olivier Hill

• Edited By

  Etienne Kneuss

• Edited By

  Thomas Moulard

• Edited By

  Yannick Torrès

(En ordre alphabétique.)