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 707809 - Provide AppData
Provide AppData
Status: RESOLVED FIXED
Product: devhelp
Classification: Applications
Component: General
unspecified
Other Linux
: Normal normal
: ---
Assigned To: devhelp-maint
devhelp-maint
Depends on:
Blocks:
 
 
Reported: 2013-09-09 22:47 UTC by Pierre-Yves Luyten
Modified: 2013-10-23 14:26 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Generate the .xml (2.87 KB, patch)
2013-09-09 22:47 UTC, Pierre-Yves Luyten
needs-work Details | Review
Patch updated (1.85 KB, patch)
2013-10-23 12:24 UTC, Daniel Mustieles
none Details | Review
Added the xml.in file (2.86 KB, patch)
2013-10-23 12:37 UTC, Daniel Mustieles
none Details | Review

Description Pierre-Yves Luyten 2013-09-09 22:47:46 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 1 Frederic Peters 2013-09-10 07:05:46 UTC
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?
Comment 2 Pierre-Yves Luyten 2013-09-10 08:32:46 UTC
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.
Comment 3 Frederic Peters 2013-09-10 09:07:11 UTC
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 :/
Comment 4 Pierre-Yves Luyten 2013-09-10 23:18:46 UTC
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>
Comment 5 Daniel Mustieles 2013-10-23 09:35:37 UTC
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!
Comment 6 Frederic Peters 2013-10-23 10:56:43 UTC
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).
Comment 7 Daniel Mustieles 2013-10-23 11:38:25 UTC
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!
Comment 8 Frederic Peters 2013-10-23 11:44:58 UTC
(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.
Comment 9 Daniel Mustieles 2013-10-23 12:24:26 UTC
Created attachment 257909 [details] [review]
Patch updated

Here is the patch updated with a translatable screenshot located in live.gnome.org
Comment 10 Frederic Peters 2013-10-23 12:34:23 UTC
That patch is missing the devhelp.appdata.xml.in file.
Comment 11 Daniel Mustieles 2013-10-23 12:37:12 UTC
Created attachment 257912 [details] [review]
Added the xml.in file

Sorry... forgot the git add
Comment 12 Frederic Peters 2013-10-23 13:01:08 UTC
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>
Comment 13 Frederic Peters 2013-10-23 13:02:39 UTC
Oh, and remove the <updatecontact>, and then just push so I don't nitpick on something else :)
Comment 14 Daniel Mustieles 2013-10-23 14:26:00 UTC
Done: https://git.gnome.org/browse/devhelp/commit/?id=c4cbc390511581000f6c148de7e59ffe95842349

Thanks for your feedback!