[Gimp-developer] AppData additions required for the software center

2016-08-13 Thread Richard Hughes (semi-automated)
Hi again!

First, apologies for the direct email. I'm emailing you directly as you've been 
listed as the update contact in one or more AppData files.

We've been busy building an awesome software center, and we've been adding more 
and more metadata fields that upstream authors can set. The software center is 
now being used in Fedora, Opensuse, Ubuntu, Debian and Arch, with many millions 
of happy users.

Some of the newest features include a way to make it easy for translators to 
contribute new translations of your applications by specifying a URL in the 
gimp.appdata.xml AppData file that tells them where to start looking. This can 
be specified by adding:

http://the-web-site-with-translation-instructions/

Another useful tag to add is to tell end-users where to donate, for instance:

http://www.gnome.org/friends/

Also, by including keywords into either the desktop file or the AppData file 
you can increase the number of search matches you get in the software center. 
Adding application-specific keywords like "editor" or "vhdl" means that we can 
provide better search results for common queries. Keywords are also stemmed, so 
searching for "edit" will also match "editor" and "edits" so there's no need to 
add every variant. You can add keywords using:


  something
  anotherthing


If it's been some time since you updated the AppData file (and hey, you've got 
an app to write!) you can get add the latest metadata fields by doing 
`appstream-util upgrade gimp.appdata.xml` and then replacing any FIXMEs in the 
file with actual data. We'll be putting more functionality into the software 
center in the future that uses this extra data, but we need more upstream 
software to opt-in before we can enable features, for instance, providing a 
button for users to donate to specific apps.

You can also use `appstream-util validate-relax` on your AppData file to check 
the various fields meet our style guidelines. If you disagree with any of the 
validation warnings, please let me know!

Of course, you don't have to do a release with these enhancements straight 
away, and if you have a stable branch it would be a good thing to backport this 
as well if it does not add translated strings or you have no string freeze 
policy.

When you've changed the file(s) and committed, please email me back and I'll 
mark your application as completed. If you don't want to hear from me ever 
again just edit the  in the AppData file and change it to 
somebody else. I'm not planning on emailing more than once every 6 months, so 
don't worry about me spamming you with even more work to do.

Thanks,

Richard


___
gimp-developer-list mailing list
List address:gimp-developer-list@gnome.org
List membership: https://mail.gnome.org/mailman/listinfo/gimp-developer-list
List archives:   https://mail.gnome.org/archives/gimp-developer-list


[Gimp-developer] Keywords required for the software center

2016-01-08 Thread Richard Hughes (semi-automated)
Hi!

First, apologies for the direct email. I'm emailing you directly as you've been 
listed as the update contact in one or more AppData files. In the software 
center we allow the user to search using case-insensitive keywords, for 
instance searching for 'excel' could match Libreoffice Calc or many other free 
software spreadsheet applications. At the moment we use the translated keywords 
set in the desktop file, any extra  entries in the AppData file, and 
then fall back to generating tokens from the name, summary and description 
using a heuristic. This heuristic works most of the time, but a human can often 
do much better when we know what the most important words are. I've noticed 
your application does not have any manually set keywords and thought I should 
bring this to your attention.

So, what do I want you to do? Basically, I would like you to add some keywords 
in the gimp.desktop file or the gimp.appdata.xml AppData file. If you want the 
keywords to be used by GNOME Shell as well (which you probably do), the best 
place to put any search terms is in the keywords section [1] of the desktop 
file. This can also be marked as translatable so non-English users can search 
in their own language. This would looks something like Keywords=3D;printer; 
(remember the trailing semicolon!)

The alternative is to put the keywords in the AppData file so that they are 
only used by the software center and not the desktop shell. You can of course 
combine putting keywords in both places. The AppData keywords can also be 
translated, and would look like this:


3D
printer


Of course, you don't have to do a release with this fix straight away, and if 
you have a stable branch it would be a good thing to backport this as well if 
it does not add translated strings or you have no string freeze policy. Nothing 
bad will happen if you ignore this email, but please be aware that matches from 
keywords are ordered higher in the search results than other partial matches 
from the name or summary. You also don't have to add keywords that are the same 
as the application name or package name, as these are automatically added as 
case insensitive search tokens.

When you've changed the file(s) and committed, please email me back and I'll 
mark your application as completed. If you don't want to hear from me ever 
again just edit the  in the AppData file and change it to 
somebody else. I'm not planning on emailing more than once every 6 months, so 
don't worry about me spamming you with even more work to do. If you don't add 
the keywords then your application will still be visible in the various 
software centers, but it may be harder to find.

Thanks,

Richard

[1] 
http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#recognized-keys


___
gimp-developer-list mailing list
List address:gimp-developer-list@gnome.org
List membership: https://mail.gnome.org/mailman/listinfo/gimp-developer-list
List archives:   https://mail.gnome.org/archives/gimp-developer-list