Listings explained
Introduction
This page explains how to fill out the template to add or edit an app.
TOML values and contents
No matter whether you edit or add a listing, here's what kind of contents is supposed to go into the different columns (if you prefer living examples, the listing for Tuba is a good starting point):
__Please note:
| frontmatter value | type / form | note |
|---|---|---|
| title = "" | string | name of the app, make sure to write it as it's written on its project page, mandatory |
| description = "" | string | app summary, keep it short mandatory |
| aliases = ["",] | array of strings | optional, only use when name or app id changes, keeps incoming links from breaking |
| date = | date, yyyy-mm-dd | date that you are adding the app listing, don't change it later mandatory. |
| updated = | date, yyyy-mm-dd | optional, date of the latest update to the app listing, add line on first update, don't include while still empty |
| [taxonomies] | section start | mandatory, don't change please! |
| project_licenses = [ "",] | array of strings | SPDX 3 identifier,mandatory |
| metadata_licenses = [ "",] | array of strings | SPDX 3 identifier, optionalrepository = "" |
| app_author = [ "",] | array of strings | optional, fill with nick name or self-description from metainfo.xml, existing values |
| categories = [ "",] | array of strings | mandatory, fill with value from metainfo.xml or something fitting, use existing values for reference |
| mobile_compatibility = [ "",] | array of strings | mandatory, see existing values for reference |
| status = [ "",] | array of strings | optional, see existing values for reference |
| frameworks = [ "", ] | array of strings | recommended, see existing values for reference |
| backends = ["",] | array of strings | optional, see existing values for reference |
| services = [ "",] | array of strings | optional, see existing values for reference |
| packaged_in = [ "",] | array of strings | optional, see existing values for reference |
| freedesktop_categories = [ "",] | array of strings | optional, see existing values for reference, see the spec for allowed values |
| programming_languages = [ "",] | array of strings | recommended, see existing values for reference, write "Cpp" for C++ |
| build_systems = [] | array of strings | recommended, see existing values for reference |
| requires_internet = [] | array of strings | recommended, but values still need to be defined, see existing values for reference |
| tags = [] | array of strings | leave empty |
| [extra] | section start | mandatory, don't change please! |
| repository = "" | string, URL | mandatory, URL of the apps repository |
| homepage = "" | string, URL | optional, URL of the apps homepage |
| bugtracker = "" | string, URL | recommended, URL of the apps bug tracker |
| donations = "" | string, URL | optional, URL of donation page |
| translations = "" | string, URL | optional, URL of translation page |
| more_information = [] | array of strings, URLs | optional, links with helpful additional info about the app, e.g. app reviews |
| summary_source_url = "" | string, URL | optional, source URL of the apps description/summary (see above) |
| screenshots = [] | array of strings, URLs | optional, links to screenshots (will not be hot-linked) |
| screenshots_img = [] | array of strings, URLs | optional, links to screenshots, will be displayed - make sure hot-linking is allowed or send by mail for upload to 1peter10 |
| all_features_touch = "" | boolean | optional, set to true (if true) or false (if some features require other input measures), no quotes! |
| intended_for_mobile = "" | boolean | optional, set to true (no quotes!) if the apps descriptions or metadata makes it obvious that the app is intended for mobile and does not just work accidentally |
| app_id = "" | string | e.g. org.gnome.GHex |
| scale_to_fit = "" | string | value that needs to be used with scale-to-fit on Phosh to make the app fit the screen |
| flathub = "" | string, URL | link to Flathub listing (only if aarch64 is supported, check beta.flathub.org when in doubt) |
| flatpak_link = "" | string, URL | link to other flatpak source/repository (only if repo provides aarch64 builds) |
| flatpak_recipe = "" | string, URL | link to .json to build a flatpak, please use RAW/plaintext not blob view for Github/Gitlab |
| snapcraft = "" | string, URL | link to Snapcraft listing (only if aarch64 is supported) |
| snap_link = "" | string, URL | link to other Snap build (only if aarch64 build is provided) |
| snap_recipe = "" | string, URL | link to snapcraft.yml to build a Snap, please use RAW/plaintext not blob view for Github/Gitlab |
| appimage_x86_64_url = "" | string, URL | link to an appimage to download (for x86_64) |
| appimage_aarch64_url = "" | string, URL | link to an appimage to download (for aarch64 = 64bit ARM) |
| repology = [ "",] | array of strings | package name as found in repology.org url (e.g., tuba in https://repology.org/project/tuba/versions), multiple if applicable |
| appstream_xml_url = "" | string, URL | appdata.xml or metainfo.xml url, please use RAW/plaintext not blob view for Github/Gitlab |
| reported_by = "" | string | mandatory your nickname |
| updated_by = "" | string | optional, your nickname, only fill when updating a listing |
| verified = "" | ✅ or ❎ | game list only: legacy value marking whether you have checked that the game actually works. Please do! |
Markdown bits and contents (optional)
Zola supports CommonMark (spec), here's an example for the Markdown bits of a listing:
### Description
Explore the federated social web with Tuba for GNOME. Stay connected to your favorite communities, family and friends with support for popular Fediverse platforms like Mastodon, GoToSocial, Akkoma & more! The Fediverse is a decentralized social network that consists of multiple interconnected platforms and communities, allowing users to communicate and share content across different networks and servers. It promotes user privacy and data ownership, and offers an alternative to centralized social media platforms. [Source](https://raw.githubusercontent.com/GeopJr/Tuba/main/data/dev.geopjr.Tuba.appdata.xml.in)
### Notice
Continuation of [Tootle](https://linuxphoneapps.org/apps/com.github.bleakgrey.tootle/), was called Tooth before its initial release.
Description
Important: If you copy a description (can be lengthy), please make sure to add a link to your source at the end.
Notice
Notice can be filled with additional information detailing how well the app works/its limitations, where to get the app (if not in repos, etc.) if you assume this to be helpful.