Burgaud.com

Javadoc To CHM (jd2chm) est un programme qui, à partir d’un ensemble de fichiers Javadoc, génère les sources nécessaires à la création d’une aide au format CHM (Microsoft Compiled HTML Help). Après avoir produit le fichier projet (.HHP), le fichier de contenu (.HHC) et le fichier d’index (.HHK), Jd2chm lance hhc.exe (compilateur d’aide Microsoft), afin de complèter l’aide au format CHM.

Fiche Technique

• Nom: Javadoc To CHM (jd2chm)
• Version: 0.3
• Système d’exploitation: Win32
• Date: 18/06/2004
• Licence: Logiciel Libre, Licence du MIT
• Télécharger l’executable: jd2chm_exe_03.zip (1MB)
• Télécharcher les fichiers sources: jd2chm_py_03.zip (10kB)

Capture D’écran

Notes à propos de Jd2chm Version 0.3

Jd2chm 0.3 n’est pas fourni avec une documentation autre que les paragraphes suivants. Vous pouvez toutefois aussi consulter la documentation en anglais de Jd2chm 0.2, jd2chm_doc.htm ou jd2chm.pdf (138kB), ou contacter l’auteur.

Caractéristiques

Jd2chm 0.3 comprend d’importantes améliorations. La liste ci-dessous décrit les principales nouveautés et corrections d’erreurs depuis la version précédente.

• Jd2chm 0.3 est disponible sous deux formats:
  • Script Python, jd2chm_py_03.zip (10kB), pour ceux qui ont déjà Python installé sur leur ordinateur.
  • Exécutable Win32, jd2chm_exe_03.zip (1MB), pour les autres.
• La version exécutable a été préparée avec le produit McMillan Installer. Consultez la section Ressources pour plus d’informations.
• Le script jd2chm.py est compatible avec Python version 2.2 et supérieures.
• Amélioration de performance: Jd2chm n’utilise plus l’analyseur HTML, mais un ensemble d’expressions régulières.
• Le compilateur d’aide de Microsoft est requis! Vous pouvez l’obtenir gratuitement en téléchargeant et en installant Microsoft HTML Help Workshop (consultez les ressources).
• Détecte la présence du compilateur d’aide HTML.
• Démarre automatiquement la compilation HTML, si le compilateur d’aide est présent sur l’ordinateur.
• Pour générer le fichier d’aide a partir de la documentation Javadoc du JDK de SUN, il n’est plus nécessaire de faire une copie des fichiers HTML dans un répertoire temporaire. Jd2chm 0.3 prend en charge l’opération qui était manuelle avec la version 0.2.
• Jd2chm 0.3 a été testé avec succès pour produire les fichiers d’aide CHM du JDK 1.4.2, J2SE 5.0 et 6.0. Bien sûr Jd2chm peut aussi être utilisé pour générer les fichiers d’aide de toute documentation Javadoc autre que celle du JDK.
• La table de contenu (.HHC) du fichier d’aide est, par défaut, compilée au format binaire dans un souci de performance. Ceci est particulièrement sensible pour un fichier d’aide comportant de nombreuses pages, comme celui obtenu à partir des fichiers Javadoc du JDK. Ceci peut être modifié en changeant certains paramètres du script principal jd2chm.py.
• La table de contenu présente les entrées jusqu’au niveau des fonctions. Cela était limité aux classes avec la version 0.2.
• Les classes Java internes non publiques ont été ajoutées à la table de contenu.
• Des fonctions de trace ont été ajoutées à Jd2chm 0.3.
• Les fichiers CHM obtenus peuvent être utilisés sous Linux grâce à xCHM.

Installation

1. Téléchargez soit l’archive Script Python jd2chm_py_03.zip (10kB) ou l’exécutable jd2chm_exe_03.zip (1MB).
2. Pour installer le script, fichier .py, décompactez les 2 fichiers, .bat et .py, du paquet jd2chm_py_03.zip (10kB) et copiez les dans un répertoire inclus dans la variable d’environnement PATH.
3. Pour installer la version exécutable, décompactez le fichier jd2chm.exe de l’archive jd2chm_exe_03.zip (1MB) et copiez ce fichier dans un répertoire inclus dans la variable d’environnement PATH.

Utilisation

1. Ouvrir une fenêtre de commande DOS dans un répertoire contenant une documentation Javadoc,
2. Tapez la commande jd2chm suivie de la touche Entrée,
3. Entrez les informations requises (voir exemple ci-dessous).

C:\javadoc\beanshell>jd2chm
jd2chm Version 0.3
Copyright (c) 2000-2004 Andre Burgaud

http://www.burgaud.com

The project name will be given to:
- The HTML Help project files (.HHP, .HHK, .HHC)
- To the final CHM file
Enter the project name: bsh
The project title will be assign to the CHM window
Enter the project title: "Beanshell API"
[11-08-2005 14:21:44] INFO      Starts building the project
[11-08-2005 14:21:44] INFO      Project: bsh
[11-08-2005 14:21:44] INFO      Title: "Beanshell API"
...

Téléchargement

Ressources

• D’une façon comparable à jd2chm, javadoc to chm conversion convertit les documentations Javadoc du format HTML au format CHM.
• Sur son site Java documentations in Windows Help format Frank Allimant met a votre disposition les documents du JDK (Standard et Enterprise Edition) ainsi que les Java Tutorials au format CHM.
• xCHM permet de lire les fichiers CHM sous Linux, UNIX et Mac OS X.
• Microsoft HTML Help Workshop.
• Microsoft HTML Help Workshop Documentation.
• McMillan Installer a évolué sous la forme de PyInstaller. Les anciennes versions de McMillan Installer sont disponibles au téléchargement depuis la section Download du site PyInstaller.

Mentions Légales

• Java est une marque ou marque déposée de Sun Microsystems, Inc. aux Etats-Unis et dans d’autres pays.