classification
Title: Add General Index to Windows .chm help file Contents
Type: Stage: needs patch
Components: Documentation, Windows Versions: Python 3.1, Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: later
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, terry.reedy, tim.golden
Priority: normal Keywords: easy

Created on 2011-04-25 17:21 by terry.reedy, last changed 2011-04-27 20:21 by terry.reedy. This issue is now closed.

Messages (3)
msg134398 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2011-04-25 17:21
The Windows distribution comes with the docs in a very nice Windows help file .chm form. When displayed, they is a left side bar with a Contents tab. The top entry is 'Python vx.y documentation' followed by 'Python Module Index' and 'What's New in Python' and so on down to 'History and Licence'. Everything on the "Python vx.y documentation' page is listed in the Contents EXCEPT the General Index. Consequently, if one only uses the contents lists, one might not even know it exists. In any case, it is harder to get to than anything else.

I presume the omission is unintentional. In any case, I would like to see it fixed, with 'General Index' added right after the module index entry. I presume this should be easy for someone who knows how the contents list is generated.
msg134531 - (view) Author: Tim Golden (tim.golden) * (Python committer) Date: 2011-04-27 07:50
I can't say I'd object as such, but the [Index] tab already
contains the items in the General Index and is arguably the
killer feature of the CHM in any case.
msg134613 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2011-04-27 20:21
I had not really noticed that the Index *was* the General Index. In trying it out, I discovered that double-clicking on entries with multiple links in the General Index, such as 'name,binding' with 7 links, brings up a sub-box with all seven.

So I will close this at least until I decide that I would really want the addition enough to help make the change.
History
Date User Action Args
2011-04-27 20:21:14terry.reedysetstatus: open -> closed
resolution: later
messages: + msg134613
2011-04-27 07:50:28tim.goldensetnosy: + tim.golden
messages: + msg134531
2011-04-25 17:21:46terry.reedycreate