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 748470 - Broken links to images in documentation
Broken links to images in documentation
Status: RESOLVED FIXED
Product: gtkmm
Classification: Bindings
Component: documentation
unspecified
Other Linux
: Normal minor
: ---
Assigned To: gtkmm-forge
gtkmm-forge
Depends on:
Blocks:
 
 
Reported: 2015-04-25 21:29 UTC by Anders Jonsson
Modified: 2015-06-09 17:22 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
patch: Mark images as non-translatable (gnomemm-website) (1.58 KB, patch)
2015-06-08 08:18 UTC, Kjell Ahlstedt
committed Details | Review

Description Anders Jonsson 2015-04-25 21:29:01 UTC
In gnomemm-website the two documentation images are pointed to by broken links. In the file docs/C/index.docbook the search path ../images/gtk-logo.png is shown, but there is no /docs/images folder to contain the images. 


As an example one could look at https://l10n.gnome.org/module/gnomemm-website/site/master/en_GB/images/ to see that the links to gtk-logo.png and GNOME-logo.png are broken.


Regards,
Anders Jonsson
Comment 1 Kjell Ahlstedt 2015-05-20 11:30:54 UTC
The gnomemm-website module contains the code for the www.gtkmm.org website.
The links to the images are correct there. I suspect that the links were broken
when some information was copied to the l10n.gnome.org website.
I don't know how that website is built, or how information is copied there from
Gnome modules.

When I strolled around a bit on the l10n.gnome.org website, I couldn't find a
link to https://l10n.gnome.org/module/gnomemm-website/site/master/en_GB/images/.
Is it an active page? But of course I looked at just a tiny fraction of the
whole site.
Comment 2 Kjell Ahlstedt 2015-05-20 13:27:55 UTC
I've found links to similar pages with the same broken links.
Starting at l10n.gnome.org, click Modules, click gnomemm-website, click any of
the icons with two tiny windows in the list of languages.

The broken links point to the git repository.
http://git.gnome.org/browse/gnomemm-website/plain/docs/images/gtk-logo.png?h=master
http://git.gnome.org/browse/gnomemm-website/plain/docs/images/GNOME-logo.png?h=master

The images are in fact stored in the html/images directory. The links should be
   .../docs/html/images/...

gnomemm-website/docs/C/index.docbook contains
  <imagedata fileref="../images/gtk-logo.png"/>
and
  <imagedata fileref="../images/GNOME-logo.png"/>

Let me guess what causes the broken links.

Someone (or some tool) assumes that the images are stored at ../images/*.png
relative to the location of index.docbook. They are not. They are stored at
../images/*.png relative to the location where the generated index.html file is
stored, i.e. relative to html/<language>/index.html.
Comment 3 Kjell Ahlstedt 2015-06-08 08:18:05 UTC
Created attachment 304751 [details] [review]
patch: Mark images as non-translatable (gnomemm-website)

These images don't contain text. I doubt that any translator would like to
localize them. The easiest fix is to mark them as non-translatable.

I have checked that they don't appear in the pot file that itstool generates.
I'm almost certain that they will then also disappear from l10n.gnome.org.
That site is maintained by the strangely named module damned-lies.

I have never before made a change to gnomemm-website. I will not push this
patch until Murray has had a chance to comment.
Comment 4 Murray Cumming 2015-06-09 11:38:38 UTC
It's a workaround but it's fine wth me. Thanks.
Comment 5 Kjell Ahlstedt 2015-06-09 17:22:00 UTC
Review of attachment 304751 [details] [review]:

I have pushed the patch.
https://git.gnome.org/browse/gnomemm-website/commit/?id=af9244178c1f0bf17dac38a9f10652d81624f570

Within minutes after I pushed it, the pot file at
https://l10n.gnome.org/POT/gnomemm-website.master/docs/site.master.pot
was updated and the broken links disappeared.