[issue10583] Encoding issue with chm help in 2.7.1

New submission from flashk flashk@gmail.com:
I just updated to Python 2.7.1 and noticed a small issue with the chm help file.
The search results tab displays incorrect characters for various topic titles. It seems to be an encoding issue.
For example, searching for 'json' yields the following results:
- 18.2 json — JSON encoder and decoder - What’s New in Python 2.6
I noticed this issue on Windows XP 32-bit and Windows 7 64-bit.
This issue does not exist with the 2.7 chm file.
---------- assignee: docs@python components: Documentation, Windows messages: 122857 nosy: docs@python, flashk priority: normal severity: normal status: open title: Encoding issue with chm help in 2.7.1 type: behavior versions: Python 2.7
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

Changes by Martin v. Löwis martin@v.loewis.de:
---------- nosy: +loewis
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

Sandro Tosi sandro.tosi@gmail.com added the comment:
Hello, can you still replicate it with 2.7.2 ?
---------- nosy: +sandro.tosi
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

Kristian Vlaardingerbroek kristian.vlaardingerbroek@gmail.com added the comment:
I can reproduce the issue with Python 2.7.2 and Python 3.2 on Windows 7 Enterprise SP 1 64-bit.
---------- nosy: +Kristian.Vlaardingerbroek
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

Sandro Tosi sandro.tosi@gmail.com added the comment:
Adding Georg to nosy, he might now how CHM is generated on Windows and shine some light here
---------- nosy: +georg.brandl
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

Kristian Vlaardingerbroek kristian.vlaardingerbroek@gmail.com added the comment:
I've looked at the output from make html and make htmlhelp and taking the library/json.html as example the text between <title> </title> is exactly the same.
Chrome renders both fine:
<title>18.2. json — JSON encoder and decoder — Python v2.7.2 documentation</title>
But when looking at the file in the HTML Help Workshop it looks like this:
<title>18.2. json — JSON encoder and decoder</title>
Which is what you see when doing the search.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

Kristian Vlaardingerbroek kristian.vlaardingerbroek@gmail.com added the comment:
This might be non-fixable:
http://support.microsoft.com/kb/269766/
HTML Help 1.x does not compile the Unicode characters. Meaning that in the search and index views you'll get garbage. For the rest of the rendering IE is used which does render the correct characters.
There is support in HTML Help 2.x but as far as I can see that is only available as a component in Visual Studio and not included with a default Windows installation.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

flashk flashk@gmail.com added the comment:
Yes, I still notice this issue with the 2.7.2 release.
As I mentioned earlier, I did not notice this problem with 2.7. Were there any significant changes to the docs between 2.7 and 2.7.1?
Considering the bug with HTML Help pointed out by Kristian, I'm thinking there was either a change in the html encoding or the build environment for the Windows installer. Anybody aware of either of these changes happening between 2.7 and 2.7.1?
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

Mark Lawrence added the comment:
I don't see this in 3.4.1.
---------- nosy: +BreamoreBoy
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

Zachary Ware added the comment:
I do in 2.7.8, though. This appears to have been a Sphinx issue (likely caused by HTML Help's lack of Unicode support), introduced sometime between Sphinx versions 0.6.5 and 0.6.7, and fixed sometime between versions 1.1.3 and 1.2.2.
---------- nosy: +zach.ware
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

Mark Lawrence added the comment:
Is there anything to be done here as Sphinx is a third party tool and the root cause is already fixed?
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________

Georg Brandl added the comment:
Agreed, closing.
---------- resolution: -> fixed status: open -> closed
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue10583 _______________________________________
participants (7)
-
flashk
-
Georg Brandl
-
Kristian Vlaardingerbroek
-
Mark Lawrence
-
Martin v. Löwis
-
Sandro Tosi
-
Zachary Ware