Types d'aide HTML

De RAD Studio
Aller à : navigation, rechercher

Remonter à Appel de l'aide HTML depuis les applications

Les applications utilisateur peuvent utiliser plusieurs formats d'aide sous Windows :

CHM -- HTMLHelp

HTMLHelp est le format d'aide HTML compilé de Microsoft. HTMLHelp est un format d'aide en ligne de marque déposée sous Windows 32 bits. Il a été introduit en tant que successeur du format Microsoft WinHelp avec la release de Windows 98 et est toujours supporté dans Windows 7. C'est le format d'aide Windows le plus populaire.

Les fichiers d'aide HTMLHelp sont livrés sous la forme de fichiers binaires avec l'extension CHM. Un fichier CHM contient un ensemble de fichiers HTML, une table hyperliée de contenus, et un index.

Des visionneuses de fichiers d'aide CHM sont fournies avec les systèmes opérationnels Windows. La fonction HTMLHelp fournit l'API de la visionneuse des fichiers d'aide CHM.

La VCL de RAD Studio fournit l'unité Vcl.HtmlHelpViewer qui implémente les wrappers Delphi et C++ pour l'API de la fonction HTMLHelp. Pour utiliser les fichiers d'aide au format CHM dans vos applications VCL, vous devez inclure l'unité Vcl.HtmlHelpViewer dans la section uses de la fiche principale de votre application VCL. Pour C++, vous devez inclure le fichier d'en-tête Vcl.HtmlHelpViewer.hpp. (Pour de plus amples informations, voir les rubriques HTMLHelp dans MSDN.)

C'est le système d'aide hors ligne que RAD Studio utilise. Voir Utilisation de l'aide - CHM.

Aide Microsoft HXS -- HTML Help 2.0

Le format HTML Help 2.0 est utilisé par Visual Studio de 2002 à 2008.
Les fichiers HTML Help 2.0 ont l'extension HXS. Les fichiers d'aide HXS compilés contiennent des fichiers source HTML.

Chaque collection de fichiers d'aide HXS doit être recensée (dans le Registre Windows) avant d'être visualisée. Votre application peut exécuter un tel recensement avec l'installateur spécialement programmé, ou en utilisant un outil de recensement tiers spécial.

Les fichiers d'aide HXS peuvent être visualisés avec la visionneuse d'aide Microsoft dexplore.exe ou avec des visionneuses tierces. Les visionneuses des fichiers HXS ne sont pas fournies avec les systèmes Windows.

L'API de dexplore.exe n'est pas officiellement documenté, et RAD Studio ne fournit pas d'unité qui encapsule l'API de dexplore.exe.

Notez que le format Microsoft Help 2 a été conçu essentiellement pour les intégrateurs d'aide Visual Studio. Microsoft ne recommande pas l'usage des fichiers d'aide HXS dans les applications générales.

MSHC -- Microsoft Help 3

L'aide MSHC est également connue sous le nom Microsoft Help 3 ou Microsoft Help Viewer 1.x. Ce format supplante Microsoft Help 2.

Le format des fichiers de rubriques est XHTML 1.x (compatible avec HTML). Un fichier d'aide a une extension de fichier MSHC (Microsoft Help Container) et est un fichier Zip standard contenant des fichiers de rubriques. Un fichier d'aide MSHC ne contient pas de fichiers propriétaire, seulement des fichiers de rubriques. Les balises méta HTML standard sont utilisées pour définir divers attributs de rubriques, notamment la table des matières (TOC) ou sommaire, l'index et les mots clés.

Les fichiers d'aide MSHC peuvent être visualisés par n'importe quel navigateur Web.

Un compilateur d'aide n'est pas requis.

Le format d'aide MSHC a le potentiel pour devenir le prochain système d'aide général (basé sur Unicode) pour Windows.

RAD Studio ne fournit aucun support pour l'aide MSHC.

A partir des applications RAD Studio, vous pouvez ouvrir les fichiers d'aide MSHC en utilisant la fonction ShellExecute.

Pour utiliser ShellExecute dans vos applications, vous devez inclure l'unité ShellAPI dans la clause uses de la fiche principale de votre application. Pour obtenir une description de ShellExecute, voir l'aide MSDN. La RTL de RAD Studio déclare ShellExecute dans le fichier "source\rtl\win\ShellAPI.pas".

HLP -- WinHelp (obsolète)

A partir de Windows Vista, Microsoft a déprécié le format d'aide HLP. Par conséquent, l'usage de l'aide HLP et de l'unité WinHelpViewer est devenue obsolète.

Microsoft WinHelp est un format de marque déposée pour les fichiers d'aide en ligne sous Windows 16 bits et 32 bits, de la plate-forme Windows 3.0 à Windows XP. Les fichiers d'aide au format WinHelp ont l'extension HLP. Le format WinHelp est basé sur les documents RTF (Rich Text Format).

Pour visualiser les fichiers d'aide HLP, vous pouvez utiliser le navigateur d'aide Microsoft winhelp.exe ou winhlp32.exe. La fonction WinHelp fournit l'API de la visionneuse des fichiers d'aide HLP.

La VCL de RAD Studio fournit l'unité WinHelpViewer qui implémente les wrappers Delphi et C++ pour l'API de la fonction WinHelp. Pour utiliser le format d'aide HLP dans vos applications VCL, vous devez inclure l'unité WinHelpViewer dans la section uses de la fiche principale de votre application VCL. Pour télécharger la visionneuse WinHelp, visitez le site web Microsoft : http://www.microsoft.com/downloads/details.aspx?familyid=6ebcfad9-d3f5-4365-8070-334cd175d4bb

Autres formats d'aide HTML

Il existe plusieurs autres formats d'aide HTML, les plus communs sont les suivants :

  • Aide HTML -- Un ensemble de fichiers HTM/HTML interliés.
Ces fichiers peuvent être visualisés dans n'importe quel navigateur web.
RAD Studio ne fournit aucun support pour l'aide HTML.
A partir des applications RAD Studio, vous pouvez ouvrir les rubriques d'aide HTML en utilisant la fonction ShellExecute.
  • WebHelp -- Une collection de fichiers individuels (HTML) qui ne sont pas compressés ou compilés. WebHelp est commode pour la publication sur un serveur intranet ou Web. WebHelp peut également être déployé comme l'aide installée localement.
Les fichiers WebHelp peuvent être visualisés dans n'importe quel navigateur web.
RAD Studio ne fournit aucun support pour l'aide HTML.
A partir des applications RAD Studio, vous pouvez ouvrir les rubriques d'aide HTML en utilisant la fonction ShellExecute.

Voir aussi

Récupérée de « https://docwiki.embarcadero.com/RADStudio/Sydney/f/index.php?title=Types_d%27aide_HTML&oldid=168385 »