Issue 6900: Sub-optimal "Locate" button behaviour in Windows CHM file (original) (raw)
Created on 2009-09-13 12:06 by tom_seddon, last changed 2022-04-11 14:56 by admin. This issue is now closed.
Messages (7)
Author: Tom Seddon (tom_seddon)
Date: 2009-09-13 12:06
Behaviour of "Locate" in latest Windows CHM file for Python 2.6.2 is sub-optimal.
I first spotted this with the optparse module, so this bug refers to the optparse module. It looks as if this is a global problem, though.
First, ensure one has latest patched Python 2.6.2 CHM file.
Sample repro steps:
Load Windows CHM file (observe fully collapsed contents tree);
Select "Global Module Index" in contents tree (note availability of "Locate" button);
Click "O" link;
Click "optparse" link.
Note that contents remains collapsed and "Locate" button is unavailable. This makes navigating through the page a bit tiring. The Find functionality in the CHM viewer isn't great.
Also try:
Load Windows CHM file;
Select Index;
Enter "optparse" in keyword field;
Select "optparse (module)" entry in index.
Note lack of Locate button. This looks to be the same thing as selecting optparse from the module index (as it maybe is).
Also try:
Load Windows CHM file;
Expand "The Python Standard Library" folder in contents;
...expand "Generic Operating System Services" folder in contents;
Click "optparse --- More powerful command line option parser" folder in contents (note optparse page appears again, but this time you can see the location line at the top, and Locate button remains available);
If one then collapses the "The Python Standard Library" folder, one is then almost where one was in the first set of steps. This time, though, one may click "Locate" to find the entry in the contents so that the page is a bit easier to navigate.
Also try:
Load Windows CHM file;
Select "Global Module Index" from content;
Click "C" link;
Select "Carbon.AE" link (note availability of Locate button).
In this case, the Locate button IS available. Same goes for some other sub-libraries -- e.g. compiler.ast and wsgiref.handlers -- but not all -- e.g., xml.dom.
Expected behaviour:
When navigating to any module's doc page from its entry in the global module index, or its entry in the index, or indeed by following any link in the docs, it should be possible to click "Locate" to find it in the contents tree. The document search facilities in the CHM viewer are a bit lame, so having the contents tree at hand is very useful (I might say essential -- but that could just be me).
(This was less of an issue in previous versions of the docs, because the pages were split up into parts, so one could use Back once or twice to get to the contents then click a link to go straight to the desired section.)
Thanks.
Author: Moese (moese)
Date: 2009-12-22 00:16
This seem to have been broken when the help file style was changed (from 2.5 to 2.6).
I'm also bothered by this issue, since you cannot locate easily now related modules.
For example, in the old help version I would go in the index to urllib, display the module, then click Locate and I would then see all the Internet related modules.
Now I have to search them through the Contents page.
Author: Tiberius Teng (Tiberius.Teng)
Date: 2010-05-22 15:24
I believe I have isolated the problem.
After generating html help files with sphinx $ sphinx-build -bhtmlhelp -a . build
Edit build/python265.hhp and remove following two lines:
Binary TOC=Yes Binary Index=No
And build the chm again, the result file will have the correct 'Locate' button functionality. I believe the problem is caused by Binary TOC.
Author: Tiberius Teng (Tiberius.Teng)
Date: 2010-05-22 15:26
I have built a copy myself, with some icon style/CSS tweaking. Please test it out ;)
Author: Tiberius Teng (Tiberius.Teng)
Date: 2010-05-22 15:28
Here's the .hhp file I used to compile this chm, other files can be obtained by using HTML Help Workshop to decompile this chm.
Author: Tom Seddon (tom_seddon)
Date: 2010-05-22 23:02
Yes, this new version looks to do the job!
(Regarding the CSS, I'm not so sure about the serifs yet, but I'll let it sink in and see how I feel :)
Author: Georg Brandl (georg.brandl) * 
Date: 2010-05-23 12:48
OK, I've now deactivated the "Binary TOC" setting in Sphinx' repo; it will be used for Python when I release a new version.
History
Date
User
Action
Args
2022-04-11 14:56:52
admin
set
github: 51149
2010-05-23 12:48:42
georg.brandl
set
status: open -> closed
resolution: fixed
messages: +
2010-05-22 23:02:46
tom_seddon
set
messages: +
2010-05-22 15:28:37
Tiberius.Teng
set
files: + python265.hhp
messages: +
2010-05-22 15:26:33
Tiberius.Teng
set
files: + python265.chm
messages: +
2010-05-22 15:24:32
Tiberius.Teng
set
nosy: + Tiberius.Teng
messages: +
2009-12-22 00:16:34
moese
set
nosy: + moese
messages: +
2009-09-16 01:49:24
ezio.melotti
set
priority: low
nosy: + ezio.melotti
2009-09-13 12:06:49
tom_seddon
create