Bug #53901 HTML documentation not readable on high DPI monitors
Submitted: 21 May 2010 19:38 Modified: 2 Jun 2010 11:55
Reporter: Farid Zidan (Candidate Quality Contributor) Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:5.1.44 OS:Microsoft Windows (XP SP3)
Assigned to: MC Brown CPU Architecture:Any
Tags: qc
Triage: Needs Triage: D2 (Serious)

[21 May 2010 19:38] Farid Zidan
Description:
Compiled HTML documentation does not have font button on toolbar to adjust font size. When viewing compiled HTML MySQL 5.0 Reference Manual on high DPI monitor (196DPI, 200%) the text is very small and hard to read

How to repeat:
Open MySQL 5.0 Reference Manual on small-pitch 0.22mm monitor running at 200% DPI. Windows is DPI aware and menus and help index text are displayed correctly. However, the manual text font is very small and hard to read and there is not Font size button on toolbar for user to increase font size

Suggested fix:
Add Font button to Windows compiled html MySQL Reference Manual toolbar
[21 May 2010 19:41] Farid Zidan
screenshot

Attachment: mysql_doc.jpg (image/jpeg, text), 73.53 KiB.

[21 May 2010 19:42] Farid Zidan
To see how doc looks on 200% DPI Windows, open the attached jpeg and zoom to 50% on regular 96DPI monitor
[22 May 2010 15:37] Valeriy Kravchuk
Please, specify the exact URL used to download the documentation you are complaining about. 

You set version as 5.1.44, documentation is for 5.0 on a screenshot. Let's clarify this.
[22 May 2010 17:09] Farid Zidan
I thought this is a bug reporting system. I am reporting a usability issue with MySQL compiled HTML documentation on Windows. I would not characterize my original report as a complaint, that's your unwise choice of words, I would say rather say this is a bug report.

My documentation set is from MySQL 5.0 since when I install/re-install latest build of MySQL 5.1 http://www.mysql.com/downloads/mirror.php?id=389420 the installer does not install documentation nor creates a shortcut for documentation in Window MySQL 5.1 program group, even though I have checked the option in the installer screen to install documentation, but that's a different issue, or as you may want to say complaint. 

Anyway, the issue, to re-iterate, is that there is no Font button on the compiled help reader toolbar. I am attaching a screenshot from a competing product documentation that shows what a Font button on the compiled html reader toolbar looks like if you haven't seen that before.

Again, this is about the appearance of the documentation text pane (font size) rather than about a specific documentation error or inaccuracy that may change with server versions.

To view the screenshot as they look on my monitor, zoom out of the screen shot until the screenshot window title/help index pane text appears normal size on your monitor and then see if you can easily read the documentation pane text and if that's very usable to you and is something you would like to look at and consult for help.
[22 May 2010 17:10] Farid Zidan
Compiled HTML help reader with Font button on toolbar

Attachment: sqlanyhelp.jpg (image/jpeg, text), 71.46 KiB.

[23 May 2010 12:14] Valeriy Kravchuk
My only intention was to find as much details about the real problem as possible. The only version of MySQL server I have that included .chm manual is 6.0.10, and there fonts are readable.

Also, both http://downloads.mysql.com/docs/refman-5.1-en.chm
and http://downloads.mysql.com/docs/refman-5.0-en.chm are mostly useless now, as navigation does not work there at all for me on Windows XP SP3.

I confirm that there is no Font button in the toolbar of all 3 versions of .chm manual I have.
[27 May 2010 16:28] Stefan Hinz
I don't think this is anything we (the MySQL documentation team). We're just providing the CHM file, not the CHM viewer. But assigning this bug report, anyway, in case I'm missing something.
[27 May 2010 16:48] Farid Zidan
Displaying Font button for the CHM viewer toolbar is an option that can be enabled by setting an option in the project compiled help hhp file. 

Example,

[WINDOWS]
CompareData=,"InSync.hhc","insync.hhk","main_index.htm",,,,,,0x2520,,0x10300e,,,,,,,,0
[2 Jun 2010 11:55] MC Brown
Thanks for the bug report and heads-up. I've updated our builds to enable the Zoom button, but it will be 24-48 hours before all the CHMs get rebuilt with the new button.