Acronyms in hardware/disks doesn't explain what they are

Bug #721992 reported by AJenbo
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
ubuntu-docs (Ubuntu)
Won't Fix
Low
Connor Imes

Bug Description

Binary package hint: ubuntu-docs

<acronym class="acronym">FAT16</acronym>, with out a title attribute on that tag it is pretty useless.

I also sported this with FAT32, NTFS and HFS+

Connor Imes (ckimes)
Changed in ubuntu-docs (Ubuntu):
assignee: nobody → Connor Imes (rocket2dmn)
importance: Undecided → Low
status: New → In Progress
Revision history for this message
Connor Imes (ckimes) wrote :

AJenbo, thanks for your report. Can you please explain what exactly the problem is here? "title" is not an acceptable docbook attribute for the acronym element. Are you just concerned that the CSS class in the generated HTML docs doesn't look any different than regular text on the page?

Changed in ubuntu-docs (Ubuntu):
status: In Progress → Incomplete
AJenbo (ajenbo)
summary: - Acronums in hardware/disks dosn't explain what they are
+ Acronyms in hardware/disks doesn't explain what they are
description: updated
Revision history for this message
AJenbo (ajenbo) wrote :

Well it's not a direct violation of HTML, but normally you would use <acronym> to explain what the acronym stands for. On the Danish loco we have the default style for <acronym> be underlined and have a question mark as the cursor, so this makes the "issue" more pronounced.

Revision history for this message
Connor Imes (ckimes) wrote :

OK, thanks for clarifying. The class is created automatically since acronym is a docbook element, we just don't have a CSS class for it to show in HTML. I can add one, but I'm not sure that we should given that the "acronym" doesn't appear differently when viewing the documentation in yelp anyway. What do other documenters think?

Revision history for this message
AJenbo (ajenbo) wrote :

If it is shown the same in the actual docs then i think it should be kept unstyled in the html as well. But what i don't understand is what is the reason for having the tag in there at all?

Revision history for this message
Connor Imes (ckimes) wrote :

There are other docbook tags that are not emphasized in any way in yelp and in the html docs. Also, there are other attributes that can be added to the acronym tag, like ID, which would mean you could post a direct link to it. Other viewers could display them differently in the same way that you said the Danish LoCo does. Because we don't display it differently in yelp, I won't change it in html either. Thanks again for the report, AJenbo.

Changed in ubuntu-docs (Ubuntu):
status: Incomplete → Won't Fix
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.