After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 690452 - It is not clear that annotations like "transfer-full" have an accompanying descriptive text
It is not clear that annotations like "transfer-full" have an accompanying de...
Status: RESOLVED FIXED
Product: website
Classification: Infrastructure
Component: developer.gnome.org
current
Other Linux
: Normal enhancement
: ---
Assigned To: GNOME Web maintainers
GNOME Web maintainers
Depends on:
Blocks:
 
 
Reported: 2012-12-18 21:09 UTC by Henrique Camargo
Modified: 2014-01-26 17:15 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
add the acronym styling to lgo2010.css (889 bytes, patch)
2012-12-18 22:20 UTC, David King
committed Details | Review

Description Henrique Camargo 2012-12-18 21:09:32 UTC
The documentation makes use of annotations like "transfer-full" and "allow-none" to describe how certain arguments and return values should be treated. For example, in the documentation for the "g_data_input_stream_read_line" function [1] several annotations are used.

These annotations alone are not clear enough to convey their meanings, so they have an accompanying text that explains what the annotation means.

In the generated HTML documentation this description text is associated with the annotation by the use of an acronym tag. This has the effect of rendering the description text as a title text on most browsers.

In the current CSS, the presence of this title text is not obvious as the annotations have the same style of normal text.

One possible solution is to underline the annotation with a dotted line, hinting to the user that the annotation text has a different meaning/behavior than that of a normal text. This is the approach used in the CSS for the GStreamer documentation [2].

If that is a good solution, the style rule that can be added to achieve this behavior is:

acronym {
    border-bottom: 1px dotted;
}

[1] http://developer.gnome.org/gio/stable/GDataInputStream.html#g-data-input-stream-read-line
[2] http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/annotation-glossary.html#glsO
Comment 1 David King 2012-12-18 22:20:50 UTC
Created attachment 231840 [details] [review]
add the acronym styling to lgo2010.css

The attached patch adds the proposed styling to lgo2010.css. Is there a better place or maybe a more specific selector that should be applied?