Using sphinx to create context sensitive html help

views:

answers:

Using sphinx to create context sensitive html help

Hi all,

I am currently using AsciiDoc (http://www.methods.co.nz/asciidoc/) for documenting my software projects because it supports pdf and html help generation. I am currently running it through cygwin so that the a2x tool chain functions properly. This works well for me but is a pain to setup on other windows computers. I have been looking for alternative methods and recently revisited Sphinx. Noticing that it now produces html help files I gave it a try and it seems to work well in the small tests I performed.

My question is, is there a way to specify map id's for context sensitive help in the text so that my windows programs can call the proper help api and the file is launched and opened to the desired location?

In AsciiDoc I am using "pass::[]". By using these constructs a context.h and alias.h are generated along with the other html help files (context sensitive help information).

+1 A:

I do not know about AcsiiDoc much, but in Sphinx you can reference arbitrary locations by placing anchors where you need them. http://sphinx.pocoo.org/markup/inline.html#ref-role

techtonik 2010-04-23 17:44:07

I tried adding the anchor and generating the htmlhelp but the context.h and alias.h files were not created. The link would need to have number which is used by the htmlhelp as a mapid.

Bluebill 2010-04-27 12:24:00

The MSDN page at http://msdn.microsoft.com/en-us/library/aa164218%28office.10%29.aspx specifies that you may display required page by either using the HH_HELP_CONTEXT command (your map ids) or HH_DISPLAY_TOPIC. The latter case requires that you know the name of HTML file inside of CHM, but for Sphinx this is easily calculated. For example, the source file markup/inline.rst will produce markup/inline.html path in CHM. If you need to generate additional html anchors for section headings - they are turned off for HtmlHelp, but could be added on request.

techtonik 2010-04-28 20:24:35

techtonik, where would I go to request that the anchors for section headings be turned on for HtmlHelp?

Bluebill 2010-05-11 14:38:32

You need to subscribe to this bugreports on BitBucket http://www.bitbucket.org/birkenfeld/sphinx/issue/400/paragraph-anchors-in-htmlhelp

techtonik 2010-05-12 06:43:50

ansaurus

tags:

views:

answers:

Using sphinx to create context sensitive html help

related questions