Modify

Opened 6 weeks ago

Closed 4 weeks ago

Last modified 4 weeks ago

#16923 closed enhancement (fixed)

Add some optional appdata XML tags

Reported by: anonymous Owned by: anonymous
Priority: normal Milestone: 18.11
Component: Core Version:
Keywords: linux appstream Cc:

Description (last modified by simon04)

Coming from https://github.com/flathub/flathub/pull/697#issuecomment-434481241 it seems that the appdata.xml JOSM provides is not standards compliant enough.

It'd be great if you could provide a decent appdata file s.t. the app can be shipped through Flathub.

Attachments (0)

Change History (19)

comment:1 Changed 6 weeks ago by simon04

Description: modified (diff)

Would you like to work on a "decent" AppData file that fulfils your needs? We happily accept patches (or in this case a new version of the XML file) … :-)

comment:2 Changed 6 weeks ago by Don-vip

Owner: changed from team to anonymous
Status: newneedinfo

It would be great if you could provide a decent bug report too. The link states "The desktop file from upstream is looking fine."

comment:3 Changed 6 weeks ago by anonymous

It's not so much about the desktop file as it is about the appstream.xml.

Quoting https://github.com/flathub/flathub/pull/697#issuecomment-434481241:

The current appdata file (the one from upstream, are you a maintainer/contributor?) is lacking a lot of tags.

<?xml version="1.0" encoding="UTF-8"?>
<component type="desktop-application">
  <id>josm.desktop</id>
  <metadata_license>CC-BY-SA-3.0</metadata_license>
  <project_license>GPL-2.0+</project_license>
  <name>JOSM</name>
  <summary>Java OpenStreetMap Editor</summary>
  <description>
    <p>
    JOSM is an extensible off-line editor for ​OpenStreetMap (OSM) written in ​Java.
    </p>
    <p>
    It supports loading stand-alone GPX tracks and GPX track data from the OSM database as well as loading and 
    editing existing nodes, ways, metadata tags and relations from the OSM database.
    </p>
  </description>
  <categories>
    <category>Education</category>
    <category>Geoscience</category>
    <category>Maps</category>
  </categories>
  <screenshots>
    <screenshot type="default" width="1024" height="576">https://josm.openstreetmap.de/svn/trunk/linux/josm-screenshot.png</screenshot>
  </screenshots>
  <url type="homepage">https://josm.openstreetmap.de</url>
  <updatecontact>josm-dev_at_openstreetmap.org</updatecontact>
</component>

The id is incorrect, should be josm.openstreetmap.de
The categories must be put on the desktop file only.
The oars tags are missing
The launchable tag is missing
The releases tags are missing too
You could also add the developer_name tag.
See the specs: https://www.freedesktop.org/software/appstream/docs/chap-Quickstart.html#sect-Quickstart-DesktopApps

The desktop file from upstream is looking fine. It just need to be renamed upstream to use the APP-ID for the filename & the icon name.
If you could update those files to use the correct names, you won't need the rename-appdata & rename-desktop anymore. You should ship the same files in whatever package, so it's better to push those upstream.

Last edited 6 weeks ago by Don-vip (previous) (diff)

comment:4 in reply to:  3 ; Changed 6 weeks ago by Don-vip

Keywords: linux appstream added
Milestone: 18.11
Type: defectenhancement

Replying to anonyme:

The current appdata file (the one from upstream, are you a maintainer/contributor?) is lacking a lot of tags.

It was accepted by Debian, so it is unlikely we lack "a lot of" tags.

The id is incorrect, should be josm.openstreetmap.de

Wrong. It should match our java package / maven artifact id: org.openstreetmap.josm

The categories must be put on the desktop file only.

I disagree. The spec doesn't say that. I won't remove them.

The oars tags are missing

I guess you mean <content_rating/> ? OK to add it but it's an optional tag in the spec, so it is not "missing".

The launchable tag is missing

OK to add it, but same comment, it is an optional tag.

The releases tags are missing too

No way we maintain the list of JOSM releases in this file!

You could also add the developer_name tag.

The added value is poor ("JOSM developers") but OK to add it.

The desktop file from upstream is looking fine. It just need to be renamed upstream to use the APP-ID for the filename & the icon name.
If you could update those files to use the correct names, you won't need the rename-appdata & rename-desktop anymore. You should ship the same files in whatever package, so it's better to push those upstream.

I assume this is not a message for us, but for you...

So basically you're asking us in a rude way to add some optional tags. This is not even a defect.

comment:5 Changed 6 weeks ago by Don-vip

Summary: appdata XML is missing many tagsAdd some optional appdata XML tags

comment:6 Changed 6 weeks ago by Don-vip

Resolution: fixed
Status: needinfoclosed

In 14400/josm:

fix #16923 - Fix appstream ID and add optional appdata XML tags: developer_name, content_rating, launchable

comment:7 in reply to:  4 ; Changed 5 weeks ago by anonymous

Replying to Don-vip:

The desktop file from upstream is looking fine. It just need to be renamed upstream to use the APP-ID for the filename & the icon name.
If you could update those files to use the correct names, you won't need the rename-appdata & rename-desktop anymore. You should ship the same files in whatever package, so it's better to push those upstream.

I assume this is not a message for us, but for you...

Not necessarily.
Renaming the appstream and the desktop file is still best done upstream.

So basically you're asking us in a rude way to add some optional tags.

I did not intend to be rude.

This is not even a defect.

Are you saying this because you think this trac ticket is not the appropriate place to ask for these changes? If so, I'll gladly take pointers to other venues and I'll try to remember for the next time.

comment:8 in reply to:  7 ; Changed 5 weeks ago by Don-vip

Replying to anonyme:

I did not intend to be rude.

Sorry I over-reacted.

Replying to Don-vip:

The desktop file from upstream is looking fine. It just need to be renamed upstream to use the APP-ID for the filename & the icon name.
If you could update those files to use the correct names, you won't need the rename-appdata & rename-desktop anymore. You should ship the same files in whatever package, so it's better to push those upstream.

I assume this is not a message for us, but for you...

Not necessarily.
Renaming the appstream and the desktop file is still best done upstream.

Please explain better. Why would we need to rename the files, and to what name? I don't understand. The current names looks fine to me and I don't see why it is an issue for downstream projects.

comment:9 in reply to:  8 Changed 5 weeks ago by anonymous

Replying to Don-vip:

and to what name?

AFAIU, to the appid, i.e. "org.openstreetmap.josm{,.svg,.desktop,.appstream.xml}"

The current names looks fine to me and I don't see why it is an issue for downstream projects.

I can't really say why, but it seems reasonable to occupy the name that you claim rather than any arbitrary name. And in this case, the name, i.e. appid, claimed is different from what the files reflect. I guess it makes everybody's life easier if the files corresponding to an app (which is identified by its ID) carry the respective name. But again: I don't know *technical* details.

comment:10 Changed 5 weeks ago by Don-vip

In 14405/josm:

see #16923 - rename files and ids to org.openstreetmap.josm[-latest]

comment:11 Changed 5 weeks ago by anonymous

thanks! :)

comment:12 Changed 5 weeks ago by anonymous

I can imagine the icon to be the next candidate ;-)

comment:13 Changed 5 weeks ago by Don-vip

In 14407/josm:

see #16923 - rename icons to org.openstreetmap.josm[-latest]

comment:14 Changed 4 weeks ago by anonymous

https://github.com/flathub/flathub/pull/697#issuecomment-436615324

Would changing <content_rating/> to <content_rating type="oars-1.1" /> be an option? "The tag must have a type property" as per the spec: https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-content_rating.

Also, release tags would make the app show up nicely on flathub, GNOME software, and other consumers of appstream data. How about

<releases>
<release version="14382" date="2018-10-28" >
    <description>
    Option to display object version in lists 
    </description>
</release>
<release version="14289" date="2018-10-02" >
    <description>
    Various enhancements for the correlation of images to gpx tracks 
    </description>
</release>

<release version="14178" date="2018-08-22" >
    <description>
    Display the language the abbreviation in name:xx keys stands for in the Tags/Membership dialog
    </description>
</release>
</releases>

cf. https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-releases

Last edited 4 weeks ago by Don-vip (previous) (diff)

comment:15 Changed 4 weeks ago by anonymous

Resolution: fixed
Status: closedreopened

comment:16 Changed 4 weeks ago by Don-vip

Resolution: fixed
Status: reopenedclosed

In 14422/josm:

fix #16923 - fix content_rating tag

comment:17 in reply to:  14 ; Changed 4 weeks ago by Don-vip

Replying to anonyme:

Would changing <content_rating/> to <content_rating type="oars-1.1" /> be an option? "The tag must have a type property" as per the spec: https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-content_rating.

Fixed, it was indeed a mistake from me.

Also, release tags would make the app show up nicely on flathub, GNOME software, and other consumers of appstream data.

Sure, but we won't maintain the list of JOSM releases in our SCM. If you need this information, please fill it in downstream projects. It's up to each downstream project to update this file when they pick a new JOSM version. See upstream file as a template you can improve to fit your needs.

comment:18 in reply to:  17 Changed 4 weeks ago by anonymous

Replying to Don-vip:

Sure, but we won't maintain the list of JOSM releases in our SCM

You wouldn't have to, I guess. You could generate the release information each time you make a release and include the file in the release tarball.

Are you interested in maintaining the Flathub version of JOSM? It makes most sense to have upstream people involved in keeping the versions up to date. The overhead per release is surprisingly low.

comment:19 Changed 4 weeks ago by Don-vip

Not interested, sorry. But anyone can step up to maintain this file at Flathub, like all the Linux distro packages that we don't manage.

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain anonymous.
as The resolution will be set.
The resolution will be deleted.

Add Comment


E-mail address and name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.