Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Appdata related patches #232

Merged
merged 2 commits into from
Apr 2, 2024
Merged

Appdata related patches #232

merged 2 commits into from
Apr 2, 2024

Conversation

yakushabb
Copy link
Contributor

appdata: translate=no properties

It appears that the appstream project no longer supports
translatable=no properties, and gettext extract them as translatable.

I opened an issue to inform about the situation, but translatable=no
properties are not accepted by developers. You can find the issue
here: `ximion/appstream#623

Please test your script or string extraction process before merging this PR.

In MetaInfo files, each individual paragraph of a description
(or enumerated entry) is translated individually, however,
you can only exclude the complete block from being translated
by adding translate="no" to the description element.

Source: https://freedesktop.org/software/appstream/docs/sect-Quickstart-Translation.html

appdata: Add developer ID

Flathub requires a developer tag and developer ID. Also Appstream decided to use rdns structure for developer ID.

It allows reverse-dns IDs like sh.cozy, de.geigi or Fediverse handle (like @[email protected])

A developer tag with a name child tag must be present.
Only one developer tag is allowed and the name tag also must be present only once in untranslated form.

<developer id="tld.vendor">
  <name>Developer name</name>
</developer>

Source: https://docs.flathub.org/docs/for-app-authors/metainfo-guidelines/#name-summary-and-developer-name

The element should have a id property, containing a unique ID to identify the component developer / development team. It is recommended to use a reverse-DNS name, like org.gnome or io.github.ximion, or a Fediverse handle (like @[email protected]) as ID to achieve a higher chance of uniqueness.

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

It appears that the appstream project no longer supports
`translatable=no` properties, and gettext extract them as translatable.

I opened an issue to inform about the situation, but `translatable=no`
properties are not accepted by developers. You can find the issue
here: `https://github.com/ximion/appstream/issues/623`

**Please test your script or string extraction process before merging this PR.**

> In MetaInfo files, each individual paragraph of a description
> (or enumerated entry) is translated individually, however,
> you can only exclude the complete block from being translated
> by adding `translate="no"` to the description element.

Source: https://freedesktop.org/software/appstream/docs/sect-Quickstart-Translation.html
Flathub requires a developer tag and developer ID. Also Appstream decided to use rdns structure for developer ID.

It allows reverse-dns IDs like sh.cozy, de.geigi or Fediverse handle (like @user@example.org)

> A developer tag with a name child tag must be present.
> Only one developer tag is allowed and the name tag also must be present only once in untranslated form.

```
<developer id="tld.vendor">
  <name>Developer name</name>
</developer>
```
Source: https://docs.flathub.org/docs/for-app-authors/metainfo-guidelines/#name-summary-and-developer-name

> The element should have a id property, containing a unique ID to identify the component developer / development team. It is recommended to use a reverse-DNS name, like org.gnome or io.github.ximion, or a Fediverse handle (like @user@example.org) as ID to achieve a higher chance of uniqueness.

Source: https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-developer
@MightyCreak
Copy link
Owner

Thanks @yakushabb !

At first I thought it wasn't possible to tag blocks as "not translatable", I was surprised as it is a nice feature (especially for small apps like Diffuse that don't have an army of translators to translate each and every release). But it's just a renaming, so it's a-ok!

Also ok for the dev ID (I actually don't really know what to put here). And how about removing developer_name as it is officially deprecated now?

@yakushabb
Copy link
Contributor Author

If you remove the 'developer_name' tag, LTS releases cannot display the developer name.

bib

@MightyCreak
Copy link
Owner

Gotcha! Thanks 😉

@MightyCreak MightyCreak merged commit c2c40f2 into MightyCreak:main Apr 2, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants