GNOME Bugzilla – Bug 398471
gnome-games manuals does not use the gnome-doc-utils format
Last modified: 2007-04-26 22:01:57 UTC
Documentation Section: This GNOME module should switch from using the old XML based documentation format to using the new gnome-doc-utils format. This allows translators to use the GNU gettext format (PO files) and to include the documentation into the statistics at http://progress.gnome.org/ See http://live.gnome.org/GnomeDocUtilsMigration and http://live.gnome.org/GnomeDocUtilsMigrationHowTo for details on how to do it. Correct version: Other information:
*** Bug 369538 has been marked as a duplicate of this bug. ***
Created attachment 81818 [details] [review] port aisleriot help to gdu This patch ports the aisleriot help to gdu (it does not move the one and only existing translation (fr) over, however). It also removes the useless acinclude.m4 from svn and fixes a misnamed configure check ("AC_CHECK_DEFINE") in configure (I had to do that so the macros from m4/ were used correctly.) [Btw, I have svn commit access, so if this patch is accepted, I'd prefer to commit it myself.]
It's good that someone is finally working on porting gnome-games to use gnome-doc-utils! The docs of gnome-games are maintained by the gnome documentation project, but I would think that you could commit the patch yourself. And if you want to migrate any of the other games, that would be splendid also! However, make sure that 'make distcheck' works also after you have committed your changes :-)
Running 'make distcheck' with your patch applied, gives the following error messages: (Note that I don't know if it's your patch, or the changes that joachimn just committed to klondike.xml): ../../../aisleriot/help/C/klondike.xml:106: parser error : Entity 'mdash' not defined <listitem><para>Three card deals — Cards are dealt from the stock three ^ ../../../aisleriot/help/C/klondike.xml:109: parser error : Entity 'mdash' not defined <listitem><para>Single card deals — Cards are dealt from the stock one a ^ ../../../aisleriot/help/C/klondike.xml:112: parser error : Entity 'mdash' not defined <listitem><para>No redeals — Cards are dealt one at a time from the ^ ../../../aisleriot/help/C/klondike.xml:142: parser error : chunk is not well balanced ^ ../../../aisleriot/help/C/aisleriot.xml:321: parser error : chunk is not well balanced &klondike; ^ xsltproc -o aisleriot-C.omf --stringparam db2omf.basename aisleriot --stringparam db2omf.format 'docbook' --stringparam db2omf.dtd --stringparam db2omf.lang C --stringparam db2omf.omf_dir "/home/andreas/gnome/gnome-games/gnome-games-2.17.90/_inst/share/omf" --stringparam db2omf.help_dir "/home/andreas/gnome/gnome-games/gnome-games-2.17.90/_inst/share/gnome/help" --stringparam db2omf.omf_in "`pwd`/../../../aisleriot/help/aisleriot.omf.in" `/usr/bin/pkg-config --variable db2omf gnome-doc-utils` ../../../aisleriot/help/C/aisleriot.xml warning: failed to load external entity "db2omf.lang" cannot parse db2omf.lang make[4]: *** [aisleriot-C.omf] Error 4 make[4]: Leaving directory `/home/andreas/gnome/gnome-games/gnome-games-2.17.90/_build/aisleriot/help'
The "mdash" entity warnings were fixed by Joachim just now. However, distcheck still doesn't pass, because of bug 370394 (because gdu validates on "make distcheck").
Created attachment 81868 [details] [review] port glines to gdu With this patch, the glines manual validates, so I think this should pass distcheck.
Created attachment 81869 [details] [review] port gnect to gdu
Created attachment 81871 [details] [review] port same-gnome to gdu Validates, so should pass distcheck too.
Looks fine, though the entries for <abstract role="description"> could do with a bit of work: - gnect: shorten it a bit. Using parentheses in a two-sentence paragraph really takes some doing. 'Build a line of four of your marbles while trying to stop your opponent from doing the same. Play against another person or the computer.' - glines: ARG! BAD COMMA ALERT! ALso, I've never heard of 'Color Lines' in 15 years of using Windows. And I think we can safely drop 'and be #1 in the High Scores' by saying well, DUH! Keep it short and simple: 'Align balls of the same color to make them disappear and prevent the board from filling up.'
Created attachment 82282 [details] [review] combined patch for same-gnome, gnect and glines Thanks, Joachim, for fixing the docs to validate. I also changed my patch to use your descriptions from comment 9. Omitting the aisleriot part (i.e. using only the glines, gnect and same-gnome changes), distcheck passes. Ok to commit this patch?
it looks good, and if it passes distcheck, then I think you can commit it.
Committed. You need to rerun autogen.sh (or use jhbuild buildone -a) so the changed macro configuration gets picked up correctly. Leaving this bug open since there are move games to convert to gdu. * Makefile.am: R acinclude.m4: * autogen.sh: * configure.in: R glines/help/C/Makefile.am: R glines/help/C/glines-C.omf: * glines/help/C/glines.xml: * glines/help/Makefile.am: A glines/help/glines.omf.in: R gnect/help/C/Makefile.am: R gnect/help/C/gnect-C.omf: * gnect/help/C/gnect.xml: * gnect/help/Makefile.am: A gnect/help/gnect.omf.in: R same-gnome/help/C/Makefile.am: R same-gnome/help/C/same-gnome-C.omf: * same-gnome/help/C/same-gnome.xml: * same-gnome/help/Makefile.am: A same-gnome/help/same-gnome.omf.in: Port gnect, glines and same-gnome to gnome-doc-utils. Bug #398471.
Created attachment 82340 [details] [review] port remaining manuals to gdu This ports the remaining manuals to gdu. It builds, but until the manuals validate, it doesn't pass distcheck. The descriptions are just taken from the old *-C.omf files, and can probably use lots of improvements; preferably to be done after this patch lands. Also I just added role="maintainer" to the first author; this needs to be checked if that's really the case (I suspect not :)
With the docs patches from bug 406816 applied and the above patch, make check passes, which means that distcheck should be ok too. Ok to commit the docs patches and this patch?
I'm OK to commit patches from bug 406816 as soon as a gnome-games maintainer accept them formally (status accepted-commit_now).
The patches in bug 406816 are accepted. 'Make distcheck' passes with the patches in 406816 and the above patch in 398471#c13. However, before these patches can be committed, changelog entries will have to be written. The above patch also has some changes which fails to apply to the current SVN version, whivh will have to be fixed before it is appied. Once this is fixed, then go ahead and commit the patches.
I had the patch already updated in my tree, so I only had to write the ChangeLog entry. Committed to trunk. I'll notify gnome-i18n of the change. * aisleriot/help/C/Makefile.am: R aisleriot/help/C/aisleriot-C.omf: * aisleriot/help/Makefile.am: A aisleriot/help/aisleriot.omf.in: * blackjack/help/C/Makefile.am: R blackjack/help/C/blackjack-C.omf: * blackjack/help/C/blackjack.xml: * blackjack/help/Makefile.am: A blackjack/help/blackjack.omf.in: * configure.in: * glchess/help/glchess.omf.in: A glines/help/glines.omf.in: * gnect/help/gnect.omf.in: * gnibbles/help/C/Makefile.am: R gnibbles/help/C/gnibbles-C.omf: * gnibbles/help/C/gnibbles.xml: * gnibbles/help/Makefile.am: A gnibbles/help/gnibbles.omf.in: * gnobots2/help/C/Makefile.am: R gnobots2/help/C/gnobots2-C.omf: * gnobots2/help/C/gnobots2.xml: * gnobots2/help/Makefile.am: A gnobots2/help/gnobots2.omf.in: * gnome-sudoku/help/C/Makefile.am: R gnome-sudoku/help/C/gnome-sudoku-C.omf: * gnome-sudoku/help/C/gnome-sudoku.xml: * gnome-sudoku/help/Makefile.am: A gnome-sudoku/help/gnome-sudoku.omf.in: * gnometris/help/C/Makefile.am: R gnometris/help/C/gnometris-C.omf: * gnometris/help/C/gnometris.xml: * gnometris/help/Makefile.am: A gnometris/help/gnometris.omf.in: * gnomine/help/C/Makefile.am: R gnomine/help/C/gnomine-C.omf: * gnomine/help/C/gnomine.xml: * gnomine/help/Makefile.am: A gnomine/help/gnomine.omf.in: * gnotravex/help/C/Makefile.am: R gnotravex/help/C/gnotravex-C.omf: * gnotravex/help/C/gnotravex.xml: * gnotravex/help/Makefile.am: A gnotravex/help/gnotravex.omf.in: * gnotski/help/C/Makefile.am: R gnotski/help/C/gnotski-C.omf: * gnotski/help/C/gnotski.xml: * gnotski/help/Makefile.am: A gnotski/help/gnotski.omf.in: * gtali/help/C/Makefile.am: R gtali/help/C/gtali-C.omf: * gtali/help/C/gtali.xml: * gtali/help/Makefile.am: A gtali/help/gtali.omf.in: * iagno/help/C/Makefile.am: R iagno/help/C/iagno-C.omf: * iagno/help/C/iagno.xml: * iagno/help/Makefile.am: A iagno/help/iagno.omf.in: * mahjongg/help/C/Makefile.am: R mahjongg/help/C/mahjongg-C.omf: * mahjongg/help/C/mahjongg.xml: * mahjongg/help/Makefile.am: A mahjongg/help/mahjongg.omf.in: * same-gnome/help/same-gnome.omf.in: