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 650490 - Reference documentation should use xhtml.
Reference documentation should use xhtml.
Status: RESOLVED OBSOLETE
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other All
: Normal enhancement
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2011-05-18 14:22 UTC by Mark Pustjens
Modified: 2018-05-22 13:04 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Patch which changes html to xhtml for generated reference documentation. (763 bytes, patch)
2011-05-18 14:22 UTC, Mark Pustjens
none Details | Review

Description Mark Pustjens 2011-05-18 14:22:03 UTC
Created attachment 188028 [details] [review]
Patch which changes html to xhtml for generated reference documentation.

The currently generated reference documentation using html.
The attached patch changes this to be xhtml. This seems to work just fine for me. I did not put much effort in checking if this is the right way to do it.
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2011-05-18 17:50:31 UTC
Out of curiosity have you compared the html and the xhtml docs, e.g. in size? Does the syntax-high-lighting and the links between books still work (gtkdoc-fixxref does postprocessing of the generated pages)?
Comment 2 Mark Pustjens 2011-05-19 09:36:33 UTC
> Out of curiosity have you compared the html and the xhtml docs, e.g. in size?

I had not. Here is the output from du.
html: 18416
xhtml: 18896

> Does the syntax-high-lighting and the links between books still work
> (gtkdoc-fixxref does postprocessing of the generated pages)?

I did not check this either. I assume you mean going from the gtk doc (e.g. GtkWidget) to the gdk doc (e.g. clicking GtkModifierType). This works.
Comment 3 Mark Pustjens 2011-05-19 09:39:19 UTC
PS: syntax highlighting is broken with this patch.
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2011-05-19 09:42:29 UTC
mark, thanks for the quick check. I wonder why the xhtml gets larger, I was hoping for smaller pages and less quirks.

The reason for broken syntax highlighting is probably different tags around the code snippets :/. Should be easy to fix though.

Besides xhtml being more modern than classic html, is there any other motivation for doing it?
Comment 5 Mark Pustjens 2011-05-19 10:53:09 UTC
I have tried also with unmodified gtk-doc.xsl, and then for me the syntax highlighting is also broken. This seems to be an issue with my setup. Therefore I cannot compare it further.

My main motivation for wanting xml is that it is easily parsable using python. I am working on a script which generates a theme template. Since on gnome-look there are only a few themes yet I though it would be nice to have an extensive template for others to use.
Comment 6 Stefan Sauer (gstreamer, gtkdoc dev) 2014-02-16 14:07:26 UTC
For the syntax highlighting to work you need to have 'highlight' or 'source-highlight' installed.
Comment 7 GNOME Infrastructure Team 2018-05-22 13:04:41 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/gtk-doc/issues/15.