GNOME Bugzilla – Bug 650490
Reference documentation should use xhtml.
Last modified: 2018-05-22 13:04:41 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.
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)?
> 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.
PS: syntax highlighting is broken with this patch.
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?
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.
For the syntax highlighting to work you need to have 'highlight' or 'source-highlight' installed.
-- 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.