put title attributes on section/div elements in API documentation

Bug #426323 reported by Karl Fogel
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Launchpad itself
Fix Released
Undecided
Karl Fogel

Bug Description

The documentation at https://edge.launchpad.net/+apidoc/ has "id" attributes on the div elements that delimit its various sections (go to the page, do View Source, and search for "id=" to see). However, there are no corresponding "title" attributes with the same values as the "id" attrs.

If there were title attributes then -- in some browsers, at least -- one could see a section's anchor name just by hovering over that section. This would be very useful for referring someone to a specific place in the documentation.

I have a branch for this, but am still gathering enough xslt-fu to actually test it. Review welcome.

Note: bug #325367 ("the API docs should have a table of contents") is likely to involve similar knowledge.

Related branches

Karl Fogel (kfogel)
description: updated
tags: added: api
Revision history for this message
Karl Fogel (kfogel) wrote :

When I was chatting with geser in IRC about bug #325367, he gave me some testing hints that apply here too:

  kfogel: I branched lp:launchpadlib (to get the source), used thekorn's script to fetch the wadl file (modified it to store in a file) and use xmlstarlet to go the transformation (using xsltproc works too)

  kfogel: http://paste.ubuntu.com/267586/ here is the modified script I used to download the wadl file and also how I did the XSL transformation.

Revision history for this message
Karl Fogel (kfogel) wrote :
Changed in launchpad:
assignee: nobody → Karl Fogel (kfogel)
status: New → In Progress
Karl Fogel (kfogel)
Changed in launchpad:
status: In Progress → Fix Committed
Curtis Hovey (sinzui)
affects: launchpad → launchpad-foundations
Changed in launchpad-foundations:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.