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 681994 - Port to new documentation infrastructure
Port to new documentation infrastructure
Product: gnome-dictionary
Classification: Core
Component: general
git master
Other All
: Normal normal
: ---
Assigned To: gnome-dictionary-maint
Depends on:
Blocks: 681609
Reported: 2012-08-16 12:13 UTC by Oliver Propst
Modified: 2012-08-21 15:37 UTC
See Also:
GNOME target: ---
GNOME version: ---

patch (2.34 KB, patch)
2012-08-16 12:16 UTC, Oliver Propst
needs-work Details | Review
patchV2 (2.33 KB, patch)
2012-08-17 14:44 UTC, Oliver Propst
needs-work Details | Review
patchV3 (4.44 KB, patch)
2012-08-20 10:07 UTC, Oliver Propst
needs-work Details | Review
patchV4 (4.45 KB, patch)
2012-08-20 11:08 UTC, Oliver Propst
committed Details | Review

Description Oliver Propst 2012-08-16 12:13:09 UTC
Use yelp-tools instead of gnome-doc-utils.
Comment 1 Oliver Propst 2012-08-16 12:16:35 UTC
Created attachment 221361 [details] [review]

Port to new documentation infrastructure
Comment 2 Emmanuele Bassi (:ebassi) 2012-08-16 12:17:47 UTC
Review of attachment 221361 [details] [review]:

looks good to me, and I assume you've tested it. :-)
Comment 3 Oliver Propst 2012-08-16 12:40:30 UTC
Actually I don't (sorry about that), but could do it tonight or tomorrow, need to setup a dev environment fist. Will test my patches before I send them next time.
Comment 4 Javier Jardón (IRC: jjardon) 2012-08-16 16:35:12 UTC
Review of attachment 221361 [details] [review]:

Hey Oliver! thanks for the patch

Im not the maintainer of this module, but a little comment:

::: help/
@@ +4,3 @@
+	   gnome-dictionary.xml

gnome-dictionary.xml is a docbook file, so should be renamed to index.docbook
Comment 5 Oliver Propst 2012-08-17 14:44:34 UTC
Created attachment 221618 [details] [review]

Thanks for the review Javier, it's fixed now.
Comment 6 Javier Jardón (IRC: jjardon) 2012-08-20 04:20:14 UTC
Review of attachment 221618 [details] [review]:

Looks good, only a little comment

::: help/
@@ +15,3 @@
+	figures/gnome-dictionary-lookup.png
+	figures/gnome-dictionary-preferences-print.png	
+	figures/gnome-dictionary-preferences-source.png	

I think you forgot to add the "\" to the end of each line here
Comment 7 Jeremy Bicha 2012-08-20 04:22:23 UTC
Review of attachment 221618 [details] [review]:

In help/ you need to use \ at the end of each line (except for the last line) of HELP_FILES and HELP_MEDIA. Otherwise, only the first file will be installed and the other files won't be.

You need to actually rename gnome-dictionary.xml to index.docbook

You missed two ghelp: references. For instance, change ghelp:gnome-dictionary#gnome-dictionary-preferences to help:gnome-dictionary/gnome-dictionary-preferences

I think you can also rm help/ as I believe scrollkeeper isn't really used any more.
Comment 8 Oliver Propst 2012-08-20 10:07:13 UTC
Created attachment 221797 [details] [review]
Comment 9 Javier Jardón (IRC: jjardon) 2012-08-20 10:45:17 UTC
Review of attachment 221797 [details] [review]:

We are getting there, only a minor comment

::: help/
@@ +9,3 @@
+	figures/gnome-dictionary-add-source.png\	
+	figures/\g	

typo here, also separe \ from the name file
Comment 10 Oliver Propst 2012-08-20 11:08:17 UTC
Created attachment 221817 [details] [review]
Comment 11 Emmanuele Bassi (:ebassi) 2012-08-21 15:22:55 UTC
Review of attachment 221817 [details] [review]:

if this has been tested, it's fine for me to go in.
Comment 12 Javier Jardón (IRC: jjardon) 2012-08-21 15:37:01 UTC
Comment on attachment 221817 [details] [review]

I finally commit this with some changes:
- rename help/C/gnome-dictionary.xml to help/C/index.docbook
- use / instead # in the ghelp: uris

commit 4f27e243eb1ac92c5ad93220031d508ba18ca0b9
Comment 13 Javier Jardón (IRC: jjardon) 2012-08-21 15:37:54 UTC
Thanks Olivier for the patch!