Bug 37362 - let the HTML documentation support sync-ToC
Summary: let the HTML documentation support sync-ToC
Status: RESOLVED INVALID
Alias: None
Product: xorg
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 7.6 (2010.12)
Hardware: x86-64 (AMD64) Linux (All)
: medium enhancement
Assignee: Xorg Project Team
QA Contact: Xorg Project Team
URL:
Whiteboard: 2011BRB_Reviewed
Keywords:
Depends on:
Blocks:
 
Reported: 2011-05-19 05:39 UTC by Christopher Yeleighton
Modified: 2018-06-12 19:07 UTC (History)
2 users (show)

See Also:
i915 platform:
i915 features:


Attachments

Description Christopher Yeleighton 2011-05-19 05:39:39 UTC
The documentation books like [1] available on line have a table of contents.  However, the documentation nodes do not have any navigation facilities.  At least up-links should be supported (by attaching a jumper to the node H3 or just converting the node H3 to a link to the corresponding entry in the table of contents).

___
[1] <URL: http://www.x.org/releases/X11R7.6/doc/libX11/specs/libX11/libX11.html#Setting_and_Reading_the_WM_PROTOCOLS_Property >
Comment 1 Matt Dew 2011-05-19 20:38:02 UTC
How do we go about doing this in the xml?

I'm all for making getting around in the documentation easier.  I don't know how to do this in the xml.
Ideas?
Comment 2 Gaetan Nadon 2011-05-20 08:56:56 UTC
(In reply to comment #1)
> How do we go about doing this in the xml?
> 
> I'm all for making getting around in the documentation easier.  I don't know
> how to do this in the xml.
> Ideas?

A brief reading of DocBook manual indicates the toc is generated and not written in the source. The customization of the toc can be done in the xorg stylesheet following these options:
http://docbook.sourceforge.net/release/xsl/current/doc/html/toc_index.html

Nothing is obvious to me as for adding uplinks to the toc. This would have to be a feature of the toc generation function as the toc does not exist in the source.
Comment 3 Christopher Yeleighton 2011-05-20 13:16:43 UTC
Heck, the generated ToC elements do not even have identifiers to target.  Seems a DocBook-XSL problem then.
Comment 4 Christopher Yeleighton 2011-05-21 05:15:38 UTC
(In reply to comment #1)
> How do we go about doing this in the xml?
> 
> I'm all for making getting around in the documentation easier.  I don't know
> how to do this in the xml.
> Ideas?

http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html
Comment 5 Adam Jackson 2018-06-12 19:07:19 UTC
Mass closure: This bug has been untouched for more than six years, and is not
obviously still valid. Please reopen this bug or file a new report if you continue to experience issues with current releases.


Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.