Ayez l'esprit Libre, partagez vos connaissances!!
Cet espace est communautaire et est basé sur les contributions de chacun. N'hésitez pas a créer de nouveaux documents en suivant les bonnes pratiques.
FORMATION !!!
La société Néréide partenaire historique de Neogia, propose une session de formation destinée aux développeurs débutants et aux consultants fonctionnels.
Documentation au format docbook dans OFBiz
Présentation
- Le système d'aide a été intégré dans la version trunk d'OFBiz par Hans Bakker, avec le commit 813311, en août 2009.
- Le format DocBook a été utilisé.
- Un template ftl permet d'afficher l'aide :
trunk/applications/content/template/HelpTemplate.ftl
- Les fichiers d'aide sont stockés :
- soit dans <composant>/documents
- soit dans <composant>/data/helpdata
- les DTD sont situées dans application/content/dtd
- l'aide est accessible dans le fichier header.ftl, qui assigne à la variable helpTopic la valeur webSiteId + le nom de la vue en cours (helplink.ftl). Exemple :
showHelp?helpTopic=ACCOUNTING_main
- Pour créer de l'aide pour un composant (prendre en référence le composant ACCOUNTING) :
- dans data/helpData créer le fichier HELP_${helpTopic}.xml
- créer le fichier data/${componentName}HelpData.xml et le déclarer dans ofbiz-component.xml
- le fichier ${componentName}HelpData.xml contient :
- la déclaration de tous les fichiers d'aide du composant
