GNOME Bugzilla – Bug 618342
Convert documentation to Mallard format
Last modified: 2011-12-30 03:53:09 UTC
Robert, can I push some stub pages for these docs to master, or should I put them on a branch. Or attach them here? The possibilities are endless :-)
Attach them here. A branch would be easier but the convention is to put them here as patches for now.
Created attachment 200862 [details] [review] Mallard stub pages Okay, here are some stub pages. No actual content yet, just an index guide page with a bunch of stubbed out topic pages for now.
Created attachment 201334 [details] [review] six topic pages completed and additional topic stubs added. This patch is in addition to the previous. I also have these docs on gitorous (https://gitorious.org/sudoku-help). This patch is an up-to-date version of the gitorious version.
Review of attachment 200862 [details] [review]: Pushed to master as per irc conversation with Robert Ancell.
Review of attachment 201334 [details] [review]: Pushed to master as per irc conversation with Robert Ancell.
The completion of this documentation has been added to google-code-in tasks: https://live.gnome.org/GoogleCodeIn/Tasks#Help_create_documentation_for_gnome-sudoku Anyone interested is welcome to contact me (gci or otherwise). I will post a link to the web version of these docs as soon as library.gnome updates.
Additional work on these docs has been completed as part of gci by Chris Beiser pushed to master. http://git.gnome.org/browse/gnome-games/commit/?id=7ac98b5819131649a0bbd473c38ca6715d38cf0b
There are errors in the new files, that are shown up when running 'make check' in the help directory. i.e. xmllint --noout --noent --path C:./C --xinclude --relaxng /usr/share/xml/mallard/1.0/mallard.rng ./C/basics.page ./C/basics.page:1: element page: Relax-NG validity error : Expecting element title, got info ./C/basics.page:1: element page: Relax-NG validity error : Element page failed to validate content ./C/basics.page fails to validate This seems to be due to the <include> tag in <info> which isn't valid Mallard afaict and the <comment> section which seems valid but is failing for some reason.
Pushed the fix for validation issues to master.
Created attachment 204008 [details] [review] Patch with editing credits Credits for a recent patch
Review of attachment 204008 [details] [review]: pushed to master
This conversion is complete.