Bug #32923 Add "Table of contents" label for each chapter of the mysql test manual

• Submitted: 3 Dec 2007 11:43
• Modified: 6 Dec 2007 13:30
• Reporter: Philip Stoev
• Status: Closed
• Category: MySQL Server: Documentation
• Severity: S4 (Feature request)
• OS: Any
• CPU Architecture: Any

[3 Dec 2007 11:43] Philip Stoev

Description:
This web page

http://dev.mysql.com/doc/mysqltest/en/tutorial-running-test-cases.html

reads:

"3.1. Running Test Cases

3.1.1. Constraints on Simultaneous Test Runs

Typically, you run the test suite either...."

The 3.1.1 heading should not appear there, it is the heading of the next section.

How to repeat:
Visit

http://dev.mysql.com/doc/mysqltest/en/tutorial-running-test-cases.html

Suggested fix:
I think the markup of the documentation file is a bit off.

[3 Dec 2007 11:46] Jon Stephens

It's not the heading of the current section; it's a link to the subsection within the current section.

[3 Dec 2007 11:55] Philip Stoev

Yes, you are right, however I think it is confusing anyway. Contrast with:

http://dev.mysql.com/doc/refman/5.1/en/optimization.html

It would be nice to have a "Table of Contents" label above each list of subheadings to avoid confusion.

[3 Dec 2007 14:09] Valeriy Kravchuk

I think last comment is a reasonable documentation request.

[6 Dec 2007 13:30] Stefan Hinz

Thank you for your bug report. This issue has been addressed in the documentation: We've changed the CSS to display links in blue and underlined. This should make it clear that the TOC line isn't a subheading.

Apart from that, it's generally not a good idea to have a section that contains a single subsection. We're working to remove/merge/split those "orphaned" subsections.