GNOME Bugzilla – Bug 707809
Provide AppData
Last modified: 2013-10-23 14:26:00 UTC
Created attachment 254526 [details] [review] Generate the .xml AppData provides the metadata for gnome-software. This is supposed to need a string break exception since I use .in
Comment on attachment 254526 [details] [review] Generate the .xml I don't like the proposed description, I don't think it's relevant to write about gtk-doc; and the second sentence makes it look like the public is people developing projects using gtk-doc, while the public is developers in general. The screenshot URL should point to a gnome.org server, not your personal one. Is address munging necessary for updatecontact? Is an email required? Could the bugzilla page be used instead?
The specification (sorry for not pointing to it, http://people.freedesktop.org/~hughsient/appdata/) says udpatecontact is used when the specification changes, "We're not expecting to do this more than 4 times a year". So bz mail does not appear fine for this. About the screenshot URL: I used this to show up-to-date screenshot. Quoting Richard Hughes "I think it's okay to use any-old server URL. When we parse that data on compose we'll probably download the screenshot once, and rewrite the URL to point to something like mirrors.fedoraproject.org -- otherwise we'll start generating boatloads of traffic to small projects that might be on a virtual server somewhere." However if you prefer gnome.org, an alternative is to use for example https://help.gnome.org/misc/release-notes/3.8/figures/devhelp.png About the core of the AppData, the description: I'll look for this but would appreciate some tip. BTW i used https://wiki.gnome.org/Apps/Devhelp but i think too, devhelp is more than this.
Hum, the specification says AppData is a subset of the AppStream schema but the only schema I found is at http://gitorious.org/appstream/resources/source/e108bc4c86bf6b7f400c55ed25191f7fe3d8b10d:appdata.xsd and it doesn't match at all. So I can't say it's legal but the real effective way to update the file will be by filing a bug here, not by mailing me. About the screenshot, I'm fine with that one, but as it loaded in my language I came to wonder if that tag shouldn't also be translated, so translators can point to screenshots in their languages. For the descriptions, I looked at Fedora, Mageia, and Debian, and they're not terrible :/
we can skip "updatecontact" node. Bugs would be filled manually here when someone discovers it. But i don't think we can translate screenshots yet, we would have to wait for this feature - however an API reader has a fair chance to understand english ;) A little effort on the description below: <_p>Devhelp is an API documentation browser.</_p> <_p>It provides an easy way to navigate through libraries, search by function, struct, or macro. It provides tabbed interface and allows to print results.</_p> <_p>Devhelp integrates with other applications such as Glade, Anjuta, or Geany.</_p>
Patch looks ok for me so, if you agree with the description text, please modify it and commit, to try to close the GNOME Goal. Thanks for your work!
Please attach an updated patch, with support for translating the screenshot, andI would still prefer the screenshot URL to point to a gnome.org server (you could just upload the screenshot to live.gnome.org).
Hi Fred, Is there any place in live gnome to upload files just to link them externally (i.e. not to show them in the page)? And another question... to make the screenshot translatable, using the underscore in the <screenshot> is enough or I should do anything more? Thanks in advance!
(In reply to comment #7) > Is there any place in live gnome to upload files just to link them externally > (i.e. not to show them in the page)? Actually you could add it to https://wiki.gnome.org/Apps/Devhelp and it wouldn't be a problem if it was displayed. (alternatively I think they are just displayed as attachments, not embedded in the page, unless some markup is used). > And another question... to make the screenshot translatable, using the > underscore in the <screenshot> is enough or I should do anything more? That's it.
Created attachment 257909 [details] [review] Patch updated Here is the patch updated with a translatable screenshot located in live.gnome.org
That patch is missing the devhelp.appdata.xml.in file.
Created attachment 257912 [details] [review] Added the xml.in file Sorry... forgot the git add
Sorry to bother you again, it should include the description that Pierre-Yves proposed in comment 4: <_p>Devhelp is an API documentation browser. It provides an easy way to navigate through libraries, search by function, struct, or macro. It provides a tabbed interface and allows to print results.</_p> <_p>Devhelp integrates with other applications such as Glade, Anjuta, or Geany.</_p>
Oh, and remove the <updatecontact>, and then just push so I don't nitpick on something else :)
Done: https://git.gnome.org/browse/devhelp/commit/?id=c4cbc390511581000f6c148de7e59ffe95842349 Thanks for your feedback!