Les Méthodes

• HelpML - Nouvelle Instance
• setEncoding - Fixer l'encodage du document
• addTitle - Fixer le titre du document
• addURL - Fixer l'URL du document
• addDescription - Fixer la description du document
• addInfo - Ajouter une information sur le format du document
• addTopic - Ajouter un nouveau topic (question)
• unsetTopic - Detruire un topic
• addCatID - Ajouter une catégorie
• toXML - Générer le XML

Exemples

1. Exemple de fichier HelpML
2. Création d'un document HelpML

---

Description des Méthodes

Nouvelle Instance

HelpML( [string $HelpMLFile] )

• HelpMLFile : Optionnel. Chemin vers un fichier HelpML à précharger.

• $HML = new HelpML();
• $HML = new HelpML('helpMLfile.xml');

Fixer l'encodage du document

setEncoding( string $Encoding )

• Encoding : Nouvel encodage.

• $HML -> setEncoding('UTF-8');

Fixer le titre du document

addTitle( string $Title )

• Title : Nouveau titre.

• $HML -> addTitle('Ma Faq');

Fixer l'URL du document

addURL( string $URL )

• URL : Nouvelle URL ou adresse email.

• $HML -> addURL('http://scriptsphp.org');
• $HML -> addURL('fabrice@scriptsphp.org');

Fixer la description du document

addDescription( string $Description )

• Title : Nouvelle description.

• $HML -> addDescription('Ma Faq sur le PHP');

Ajouter une information sur le format du document

addInfo( string $Information )

• Information : Informations sur le format.

• $HML -> addInfo('This is an HelpML formatted XML document ...');

Ajouter un nouveau topic (question)

addTopic( string $Title, string $Keywords, string $Answer [, string $CatID] )

• Title : Titre du topic.
• Keywords : Mot clés associés à ce topic.
• Answer : Réponse au sujet du topic.
• CatID : Optionnel. La catégorie à laquelle apartient ce topic

• $HML -> addTopic('C est quoi PHP?', 'PHP langage serveur', 'Google est ton ami');

Detruire un topic

unsetTopic( string $Title )

• Title : Titre du topic à detruire.

• $HML -> unsetTopic('C est quoi PHP?');

Ajouter une catégorie

addCatID( string $CatID, string $Name )

• CatID : Nouvelle catégorie.
• Name : Description de la catégorie.

• $HML -> addCatID('PHP', 'Questions relatives à PHP');

Générer le XML

toXML( [string $FileName )

• FileName : Optionnel. Si FileName est spécifié, le fichier correspondant sera (re)généré.

• $HML -> toXML();
• $HML -> toXML('mafaq.xml');