L'écriture des fichiers d'aide HTML
Comment écrire des fichiers d'aide HTML pour Delphi.
l'Écriture des fichiers d'Aide HTML
par Vegard A. Larsen
(écrit à l'origine pour UNDU, l'Officieux Newsletter les Utilisateurs de Delphi, adapté pour www.HowToDoThings.com)
Après, j'avais écrite à l'application Journal du Défenseur, je ressentais le besoin d'écrire un décent fichier d'aide pour aller avec l'ensemble. Eh bien, j'ai fait ce que je fais toujours, comme je suis un freeware développeur, d'exploitation avec presque pas d'argent disponible. J'ai découvert ce qui l'aide à écrire des programmes existé, et vérifié si l'un d'eux ont été freeware. Eh bien, comme il s'avère, le plus proche que j'ai eu était HelpScribble, qui est un shareware. Sur cette page, j'ai remarqué que le HTML Help Workshop, de Microsoft, qui étaient en effet gratuit. C'est ce qui, normalement, ont été utilisés comme le compilateur de ces tiers de l'aide écrivains, mais comme je le voyais maintenant, il n'était pas impossible d'écrire des fichiers d'aide en utilisant seulement cet outil. Certains d'entre vous ont entendu parler de l'Atelier d'Aide, ce qui est presque le même, seulement pour une aide (.hlp) des fichiers. Après ce que je me souviens, c'est extrêmement compliqué, et il a été trahi par mal par la documentation (et de bon: c'est une aide de l'écrivain programme).
Bien, j'ai décidé qu'il devrait être possible d'écrire ce fichier d'aide uniquement à l'aide de HTML Help Workshop et un éditeur HTML. J'ai tranquillement assis et lire les fichiers d'aide qui est venu avec elle, mais cette fois, trop, pas de tutoriel disponible (honte sur vous, Microsoft!). De sorte que lorsque j'ai décidé d'écrire cet article. J'ai décidé de rendre ce processus aussi simple que possible, que l'aide de l'écriture n'est pas toujours aussi facile qu'il y paraît.
Ce dont vous avez besoin avant de commencer:
HTML Help Workshop
Un décent éditeur HTML (ou vous pouvez utiliser le bloc-notes si vous êtes assez doués)). Pour commencer, je vous recommande d'affecter un répertoire distinct pour ce tutoriel. Créer votre premier fichier HTML (je le recommande à l'accueil/contenu de la page) et de l'enregistrer dans ce répertoire. J'ai appelé le mien welcome.htm. Après vous avez simplement créé la page (il n'a pas besoin de contenir quoi que ce soit, juste le besoin de
, , et d'autres balises pour qu'il soit complet d'un fichier HTML).
& nbsp
le Feu jusqu'à l'Atelier d'Aide HTML (à partir de maintenant: DDD). Sélectionnez Fichier, Nouveau, puis sur Projet. Passez le premier écran en cliquant sur Suivant et spécifiez l'emplacement où vous voulez que votre fichier d'aide d'être créé (utiliser le même répertoire que vous avez créé ci-dessus). Cliquez sur Suivant, puis sélectionnez la dernière case (fichiers HTML), et cliquez de nouveau sur Suivant. Ajouter votre fichier HTML, puis cliquez sur Suivant, puis sur Terminer. Vous allez maintenant être porté à la fenêtre principale de RDD, ont été vous allez passer beaucoup de temps à partir de maintenant. En vertu de la section [FILES] dans le cadre de gauche, vous pouvez voir que le fichier HTML que vous avez créé plus tôt, est présent. Vous aurez besoin d'ajouter tous les fichiers HTML de votre projet à la présente section, et cela se fait en cliquant sur le deuxième bouton en partant du haut. Maintenant, cliquez sur l'onglet Sommaire de RDD. Sélectionnez Créer un nouveau fichier de contenu lorsque demandé, et cliquez sur OK. L'enregistrer dans le même répertoire qu'avant (je vais supposer que vous avez compris ce à partir de maintenant).Vous verrez un complètement liste vide, et c'est ce que nous allons changer de côté.
faites un clic Droit dans le vide de la zone de liste et cliquez sur Insérer Sujet. Le Titre de l'Entrée editbox, écrivez ce que vous voulez ('Bienvenue' serait appropriée), et cliquez sur Ajouter. Sélectionnez le fichier dans la liste (il sera répertorié avec le même nom que vous avez spécifié dans le code HTML balise
), et cliquez sur OK à deux reprises. Maintenant, vous aurez un seul élément dans la liste. Maintenant, cliquez sur l'onglet Index de RDD, et sélectionnez Créer un nouveau fichier d'index lorsque demandé. Vous verrez un nouveau vide listbox. Je vais la remplir en temps voulu.
Maintenant, vous pouvez commencer à créer votre deuxième fichier HTML (et votre troisième, quatrième...). Tous les ajouter dans la liste du fichier Projet (deuxième bouton en partant du haut). Vous n'avez pas besoin de créer tous les fichiers avant de commencer à construire le fichier, il est souvent une bonne idée d'ajouter un fichier à la fois pour le projet, complet, mots-clés et étaient-ils sont censés être dans la liste de contenu. Lorsque vous avez créé et ajouté un ou deux fichiers de plus en plus, se déplacer en arrière dans l'onglet Index. Faire un clic droit et sélectionnez Insérer un mot-Clé. Tapez le mot-clé, puis cliquez sur Ajouter. Vous pouvez associer plusieurs fichiers avec un mot clé. Ajouter plus de mots-clés que vous allez. Vous pouvez également créer des sous-mots-clés, par la création d'un mot clé normal, et de le déplacer en utilisant les boutons de direction (sur la barre d'outils).
pour revenir à l'onglet Contenu. Ajouter des Thèmes et du Contenu pour les fichiers que vous souhaitez utiliser. Vous pouvez déplacer de la même manière à l'aide de la barre d'outils les boutons de flèche.
Bien que ce n'est pas un tutoriel très complet dans la façon d'écrire les fichiers d'aide, je sens qu'il couvre ce que vous devez savoir lorsque vous êtes sur le document de votre programme. L'expérimentation n'est pas une mauvaise chose, surtout avec une documentation qui ne s'embête à apprendre les utilisateurs les bases de l'HTML à l'Aide de l'écriture. La documentation de RDD ont obtenu une pièce simple (comme 'la Conception d'un système d'aide') et une plus-partie technique ('HTML Help Références'). De toute façon, DDD n'est pas un mauvais programme, il est tout simplement lâché par sa documentation, et vous remarquerez que lorsque vous habituer à l'interface. Espérons que vous avez apprécié ce mini-tutoriel.
Microsoft a dû changer de l'API utilisée pour accéder à des fonctions d'aide lors de la création de l'Aide HTML (HH) du système, et donc la mise en œuvre de l'aide de Delphi est un peu nulle. Pour contourner ce problème, j'ai téléchargé un logiciel gratuit, kit de www.helpware.net. Il est censé rendre le processus de mise en œuvre d'une HH de fichier dans votre application un jeu d'enfant.
Quand j'ai regardé la documentation pour ce kit, j'ai vu que tout ce qui est venu avec elle était un simple fichier texte. Cependant, j'ai rapidement réalisé qu'il était le seul de la documentation nécessaire. Dans cet article, je vais mettre l'accent sur la fonction HtmlHelp, utilisé pour mettre en place un HH fenêtre d'affichage n'importe quel sujet que vous souhaitez. Les sujets sont obtenus en utilisant le nom de la rubrique que vous souhaitez afficher, par exemple, si l'un des fichiers dans votre HH fichier est nommé 'versionhistory.htm', l'appel suivant fait apparaître l'HH fichier avec la Version de l'histoire sujet:
HtmlHelp(GetDesktopWindow, 'C:\help.chm::/versionhistory.htm',
& nbsp & nbsp HH_DISPLAY_TOPIC, 0)
GetDesktopWindow peut être remplacé par un simple 0, mais la Helpware Groupe recommande l'utilisation de GetDesktopWindow. Rappelez-vous, l'exemple ci-dessus est une mauvaise façon de le faire, vous devez disposer d'une variable de chemin d'accès au fichier (ne pas utiliser l'Application.HelpFile directement).
L'ecriture des fichiers d'aide HTML
L'ecriture des fichiers d'aide HTML : Plusieurs milliers de conseils pour vous faciliter la vie.
Comment ecrire des fichiers d'aide HTML pour Delphi.
l'Ecriture des fichiers d'Aide HTML
par Vegard A. Larsen
(ecrit a l'origine pour UNDU, l'Officieux Newsletter les Utilisateurs de Delphi, adapte pour www.HowToDoThings.com)
Apres, j'avais ecrite a l'application Journal du Defenseur, je ressentais le besoin d'ecrire un decent fichier d'aide pour aller avec l'ensemble. Eh bien, j'ai fait ce que je fais toujours, comme je suis un freeware developpeur, d'exploitation avec presque pas d'argent disponible. J'ai decouvert ce qui l'aide a ecrire des programmes existe, et verifie si l'un d'eux ont ete freeware. Eh bien, comme il s'avere, le plus proche que j'ai eu etait HelpScribble, qui est un shareware. Sur cette page, j'ai remarque que le HTML Help Workshop, de Microsoft, qui etaient en effet gratuit. C'est ce qui, normalement, ont ete utilises comme le compilateur de ces tiers de l'aide ecrivains, mais comme je le voyais maintenant, il n'etait pas impossible d'ecrire des fichiers d'aide en utilisant seulement cet outil. Certains d'entre vous ont entendu parler de l'Atelier d'Aide, ce qui est presque le meme, seulement pour une aide (.hlp) des fichiers. Apres ce que je me souviens, c'est extremement complique, et il a ete trahi par mal par la documentation (et de bon: c'est une aide de l'ecrivain programme).
Bien, j'ai decide qu'il devrait etre possible d'ecrire ce fichier d'aide uniquement a l'aide de HTML Help Workshop et un editeur HTML. J'ai tranquillement assis et lire les fichiers d'aide qui est venu avec elle, mais cette fois, trop, pas de tutoriel disponible (honte sur vous, Microsoft!). De sorte que lorsque j'ai decide d'ecrire cet article. J'ai decide de rendre ce processus aussi simple que possible, que l'aide de l'ecriture n'est pas toujours aussi facile qu'il y paraît.
Ce dont vous avez besoin avant de commencer:
HTML Help Workshop
Un decent editeur HTML (ou vous pouvez utiliser le bloc-notes si vous etes assez doues)). Pour commencer, je vous recommande d'affecter un repertoire distinct pour ce tutoriel. Creer votre premier fichier HTML (je le recommande a l'accueil/contenu de la page) et de l'enregistrer dans ce repertoire. J'ai appele le mien welcome.htm. Apres vous avez simplement cree la page (il n'a pas besoin de contenir quoi que ce soit, juste le besoin de
, , et d'autres balises pour qu'il soit complet d'un fichier HTML).
& nbsp
le Feu jusqu'a l'Atelier d'Aide HTML (a partir de maintenant: DDD). Selectionnez Fichier, Nouveau, puis sur Projet. Passez le premier ecran en cliquant sur Suivant et specifiez l'emplacement ou vous voulez que votre fichier d'aide d'etre cree (utiliser le meme repertoire que vous avez cree ci-dessus). Cliquez sur Suivant, puis selectionnez la derniere case (fichiers HTML), et cliquez de nouveau sur Suivant. Ajouter votre fichier HTML, puis cliquez sur Suivant, puis sur Terminer. Vous allez maintenant etre porte a la fenetre principale de RDD, ont ete vous allez passer beaucoup de temps a partir de maintenant. En vertu de la section [FILES] dans le cadre de gauche, vous pouvez voir que le fichier HTML que vous avez cree plus tot, est present. Vous aurez besoin d'ajouter tous les fichiers HTML de votre projet a la presente section, et cela se fait en cliquant sur le deuxieme bouton en partant du haut. Maintenant, cliquez sur l'onglet Sommaire de RDD. Selectionnez Creer un nouveau fichier de contenu lorsque demande, et cliquez sur OK. L'enregistrer dans le meme repertoire qu'avant (je vais supposer que vous avez compris ce a partir de maintenant).Vous verrez un completement liste vide, et c'est ce que nous allons changer de cote.
faites un clic Droit dans le vide de la zone de liste et cliquez sur Inserer Sujet. Le Titre de l'Entree editbox, ecrivez ce que vous voulez ('Bienvenue' serait appropriee), et cliquez sur Ajouter. Selectionnez le fichier dans la liste (il sera repertorie avec le meme nom que vous avez specifie dans le code HTML balise
), et cliquez sur OK a deux reprises. Maintenant, vous aurez un seul element dans la liste. Maintenant, cliquez sur l'onglet Index de RDD, et selectionnez Creer un nouveau fichier d'index lorsque demande. Vous verrez un nouveau vide listbox. Je vais la remplir en temps voulu.
Maintenant, vous pouvez commencer a creer votre deuxieme fichier HTML (et votre troisieme, quatrieme...). Tous les ajouter dans la liste du fichier Projet (deuxieme bouton en partant du haut). Vous n'avez pas besoin de creer tous les fichiers avant de commencer a construire le fichier, il est souvent une bonne idee d'ajouter un fichier a la fois pour le projet, complet, mots-cles et etaient-ils sont censes etre dans la liste de contenu. Lorsque vous avez cree et ajoute un ou deux fichiers de plus en plus, se deplacer en arriere dans l'onglet Index. Faire un clic droit et selectionnez Inserer un mot-Cle. Tapez le mot-cle, puis cliquez sur Ajouter. Vous pouvez associer plusieurs fichiers avec un mot cle. Ajouter plus de mots-cles que vous allez. Vous pouvez egalement creer des sous-mots-cles, par la creation d'un mot cle normal, et de le deplacer en utilisant les boutons de direction (sur la barre d'outils).
pour revenir a l'onglet Contenu. Ajouter des Themes et du Contenu pour les fichiers que vous souhaitez utiliser. Vous pouvez deplacer de la meme maniere a l'aide de la barre d'outils les boutons de fleche.
Bien que ce n'est pas un tutoriel tres complet dans la façon d'ecrire les fichiers d'aide, je sens qu'il couvre ce que vous devez savoir lorsque vous etes sur le document de votre programme. L'experimentation n'est pas une mauvaise chose, surtout avec une documentation qui ne s'embete a apprendre les utilisateurs les bases de l'HTML a l'Aide de l'ecriture. La documentation de RDD ont obtenu une piece simple (comme 'la Conception d'un systeme d'aide') et une plus-partie technique ('HTML Help References'). De toute façon, DDD n'est pas un mauvais programme, il est tout simplement lache par sa documentation, et vous remarquerez que lorsque vous habituer a l'interface. Esperons que vous avez apprecie ce mini-tutoriel.
Microsoft a dû changer de l'API utilisee pour acceder a des fonctions d'aide lors de la creation de l'Aide HTML (HH) du systeme, et donc la mise en œuvre de l'aide de Delphi est un peu nulle. Pour contourner ce probleme, j'ai telecharge un logiciel gratuit, kit de www.helpware.net. Il est cense rendre le processus de mise en œuvre d'une HH de fichier dans votre application un jeu d'enfant.
Quand j'ai regarde la documentation pour ce kit, j'ai vu que tout ce qui est venu avec elle etait un simple fichier texte. Cependant, j'ai rapidement realise qu'il etait le seul de la documentation necessaire. Dans cet article, je vais mettre l'accent sur la fonction HtmlHelp, utilise pour mettre en place un HH fenetre d'affichage n'importe quel sujet que vous souhaitez. Les sujets sont obtenus en utilisant le nom de la rubrique que vous souhaitez afficher, par exemple, si l'un des fichiers dans votre HH fichier est nomme 'versionhistory.htm', l'appel suivant fait apparaître l'HH fichier avec la Version de l'histoire sujet:
HtmlHelp(GetDesktopWindow, 'C:\help.chm::/versionhistory.htm',
& nbsp & nbsp HH_DISPLAY_TOPIC, 0)
GetDesktopWindow peut etre remplace par un simple 0, mais la Helpware Groupe recommande l'utilisation de GetDesktopWindow. Rappelez-vous, l'exemple ci-dessus est une mauvaise façon de le faire, vous devez disposer d'une variable de chemin d'acces au fichier (ne pas utiliser l'Application.HelpFile directement).
L'écriture des fichiers d'aide HTML
By commentfaire
L'écriture des fichiers d'aide HTML : Plusieurs milliers de conseils pour vous faciliter la vie.