GNOME Bugzilla – Bug 670245
Documentation problems
Last modified: 2012-02-25 21:57:20 UTC
On http://library.gnome.org/users/eog/stable/ the description text under the item: View detailed information about a picture looks pretty out of place: it is too long and it contains links, but such texts usually do not. The source is this: #: C/plugin-exif-digital.page:7(desc) msgid "" "You can view lots of information about pictures taken with a digital camera, " "such as <link xref=\"plugin-exif-digital#exif\">camera settings and " "histogram</link>, <link xref=\"plugin-exif-digital#map\">geolocation</link>, " "and <link xref=\"plugin-exif-digital#date\">date</link>." The "Zoom and rotate" link at the very bottom of http://library.gnome.org/users/eog/stable/zoom.html.en has no description, unlike most other "See Also" links. This link points to the description of keyboard shortcuts relevant to zooming and rotating, not to the description of these operations - confusing. Comes from http://git.gnome.org/browse/eog/tree/help/C/zoom.page#n7 The http://library.gnome.org/users/eog/stable/format-change.html.en page is inconsistent in its terminology: at one place it talks about converting to another "file type", at another it talks about converting to another "file format". Why is there a difference?
(In reply to comment #0) > On http://library.gnome.org/users/eog/stable/ the description text under the > item: > > View detailed information about a picture > > looks pretty out of place: it is too long and it contains links, but such texts > usually do not. > The source is this: > > #: C/plugin-exif-digital.page:7(desc) > msgid "" > "You can view lots of information about pictures taken with a digital camera, " > "such as <link xref=\"plugin-exif-digital#exif\">camera settings and " > "histogram</link>, <link xref=\"plugin-exif-digital#map\">geolocation</link>, " > "and <link xref=\"plugin-exif-digital#date\">date</link>." Well, it works okay in the help viewer so maybe there's also a hole in library.gnome.org's CSS that prevents the hover background from working. The text could probably be shortened to "You can view lots of information about pictures taken with a digital camera." But I'll leave that to the docs team to decide as I don't know if there are any guidelines regarding this. > The "Zoom and rotate" link at the very bottom of > http://library.gnome.org/users/eog/stable/zoom.html.en has no description, > unlike most other "See Also" links. This link points to the description of > keyboard shortcuts relevant to zooming and rotating, not to the description of > these operations - confusing. Comes from > http://git.gnome.org/browse/eog/tree/help/C/zoom.page#n7 I don't know if that can actually be overridden. The link text seems to be generated from the link target's title. > The http://library.gnome.org/users/eog/stable/format-change.html.en page is > inconsistent in its terminology: at one place it talks about converting to > another "file type", at another it talks about converting to another "file > format". > Why is there a difference? I guess it's not on purpose. Considering we talk about "file formats" everywhere else (even in eog itself) this is probably the term that should be used here.
(In reply to comment #1) > (In reply to comment #0) > > On http://library.gnome.org/users/eog/stable/ the description text under the > > item: > > > > View detailed information about a picture > > > > looks pretty out of place: it is too long and it contains links, but such texts > > usually do not. > > The source is this: > > > > #: C/plugin-exif-digital.page:7(desc) > > msgid "" > > "You can view lots of information about pictures taken with a digital camera, " > > "such as <link xref=\"plugin-exif-digital#exif\">camera settings and " > > "histogram</link>, <link xref=\"plugin-exif-digital#map\">geolocation</link>, " > > "and <link xref=\"plugin-exif-digital#date\">date</link>." > > Well, it works okay in the help viewer so maybe there's also a hole in > library.gnome.org's CSS that prevents the hover background from working. > > The text could probably be shortened to "You can view lots of information about > pictures taken with a digital camera." > But I'll leave that to the docs team to decide as I don't know if there are any > guidelines regarding this. Shortened the text and removed the links. > > > The "Zoom and rotate" link at the very bottom of > > http://library.gnome.org/users/eog/stable/zoom.html.en has no description, > > unlike most other "See Also" links. This link points to the description of > > keyboard shortcuts relevant to zooming and rotating, not to the description of > > these operations - confusing. Comes from > > http://git.gnome.org/browse/eog/tree/help/C/zoom.page#n7 > > I don't know if that can actually be overridden. The link text seems to be > generated from the link target's title. Correct, so leaving this as is. > > > The http://library.gnome.org/users/eog/stable/format-change.html.en page is > > inconsistent in its terminology: at one place it talks about converting to > > another "file type", at another it talks about converting to another "file > > format". > > Why is there a difference? > > I guess it's not on purpose. Considering we talk about "file formats" > everywhere else (even in eog itself) this is probably the term that should be > used here. Replaced all references to "file type" by "file format" This problem has been fixed in our software repository. The fix will go into the next software release. Thank you for your bug report.
(In reply to comment #2) > This problem has been fixed in our software repository. The fix will go into > the next software release. Thank you for your bug report. I think you forgot to push your changes back onto GNOME's git server. The repository isn't showing any updates for me yet. ;)
You are right. Thanks! Pushed now.