2010-04-22 9 views
3

J'utilise actuellement AsciiDoc (http://www.methods.co.nz/asciidoc/) pour documenter mes projets logiciels car il prend en charge la génération d'aide pdf et html. Je l'utilise actuellement sur cygwin pour que la chaîne d'outils a2x fonctionne correctement. Cela fonctionne bien pour moi mais est une peine à installer sur d'autres ordinateurs Windows. J'ai cherché des méthodes alternatives et récemment revisité Sphinx. En remarquant qu'il produit maintenant des fichiers d'aide html, je l'ai essayé et il semble bien fonctionner dans les petits tests que j'ai effectués. Ma question est, est-il un moyen de spécifier l'ID de la carte pour l'aide contextuelle dans le texte afin que mes programmes Windows peuvent appeler l'aide api appropriée et le fichier est lancé et ouvert à l'emplacement souhaité?Utilisation de sphinx pour créer de l'aide html contextuelle

Dans AsciiDoc j'utilise "pass :: []". En utilisant ces constructions, context.h et alias.h sont générés avec les autres fichiers d'aide html (context sensitive help information).

Répondre

1

Je ne connais pas beaucoup AcsiiDoc, mais dans Sphinx vous pouvez référencer des emplacements arbitraires en plaçant des ancres là où vous en avez besoin. http://sphinx.pocoo.org/markup/inline.html#ref-role

+0

J'ai essayé d'ajouter l'ancre et de générer htmlhelp mais les fichiers context.h et alias.h n'ont pas été créés. Le lien devrait avoir un nombre qui est utilisé par le htmlhelp en tant que mapid. – Bluebill

+0

La page MSDN à l'adresse http://msdn.microsoft.com/fr-fr/library/aa164218%28office.10%29.aspx spécifie que vous pouvez afficher la page requise en utilisant la commande HH_HELP_CONTEXT (vos ID de carte) ou HH_DISPLAY_TOPIC . Ce dernier cas nécessite que vous connaissiez le nom du fichier HTML à l'intérieur de CHM, mais pour Sphinx, ceci est facilement calculé. Par exemple, le balisage du fichier source/inline.rst produira le chemin markup/inline.html dans CHM. Si vous avez besoin de générer des ancres html supplémentaires pour les en-têtes de section, ils sont désactivés pour HtmlHelp, mais peuvent être ajoutés sur demande. –

+0

techtonik, où irais-je demander que les ancres des en-têtes de section soient activées pour HtmlHelp? – Bluebill