Descriptions, graphiques et captures d'écrans

Les applications disponibles sur F-Droid peuvent proposer plus de contenu pour rendre leur page de présentation plus intéressante et informative.

Cela est supporté à partir de la version 0.103 de F-Droid et la version 0.8 de fdroidserver.

Dernier critère pour l’onglet

Dans F-Droid, depuis la version 1.6, seules les applications qui ont toutes les mentions suivantes peuvent être listées dans l’onglet Récent:

  • Nom
  • Résumé
  • Description
  • Licence
  • une note de mise à jour pour au moins une version
  • au moins un élément graphique (capture d’écran ou fonctionnalité visuelle)
  • au moins un des éléments au dessus traduit

Plus d’informations sur l’annonce.

Format des données

formats des fichiers images

Les images peuvent être au format PNG ou JPEG. Elles doivent avoir png, jpg ou jpeg comme extension.

Il est important de noter que les métadonnées dangereuses et inutiles sont enlevées des fichiers d’image avant d’être incluses au dépôt. Par exemple les données EXIF des JPEG ont des problèmes de sécurité, et ne sont pas requises pour afficher les images. Cela veut aussi dire que les images peuvent être recompressées.

Descriptions HTML

La description détaillée de l’application peut utiliser les balises HTML. Att,ention, toutes les balises ne sont pas supportées par l’outil de rendu.

  • Les balises communément supportées sont li, a avec un href, ul, ol, li, b, u et i.
  • Certaines balises sont volontairement interdites, telles que applet, base, body, button, embed, form, head, html, iframe, img, input, link, object, picture, script, source, style, svg et video.
  • À noter que un retour à la ligne sera automatiquement remplacé par une balise br.
  • Vous ne pouvez pas utiliser JavaScript.

Moyens de proposer des méta-informations

Les méta-informations peuvent être ajoutées de trois façons différentes.

Dans le dépôt source de l’application

Pour le dépôt F-Droid officiel, il est fortement recommandé d’ajouter les métadonnées dans le dépôt source de l’application pour les raisons suivantes :

  • Les méta-informations de l’application est sous le contrôle direct des propriétaires du dépôt
  • Les métadonnées du dépôt est copié automatiquement dans le dépôt de F-Droid (sans avoir besoin de l’utilisation de requêtes de fusion)

F-Droid supporte deux structures de fichiers distinctes. Elles visent à être compatibles avec des logiciels gratuits déjà existants permettant de publier des applications sur Google Play. Il n’est pas nécessaire d’installer l’un de ces outils, la structure de fichiers peut, à la place, facilement être créée manuellement.

Dernier détail important, les textes dans le fichier de métadonnées de l’application prendront le pas sur les textes descriptifs fourni par les structures décrites ci-dessous . Cela affecte Name, Summary et Description. Une fois que les champs de métadonnées précédemment dans le fichier de métadonnées ont été déplacés dans le dépôt source de l’application, veuillez effectuer une demande de fusion ou issue pour supprimer Summary et Description du fichier de métadonnées de l’application.

Pour plus de détails, voir les règles de précédence décrites à la fin de ce document.

F-Droid n’utilisera que les fichiers de métadonnées de la dernière version. Cela signifie que le serveur fdroid va récupérer la dernière version à sa connaissance et scanner le dossier de cette version à la recherche de fichiers de métadonnées.

All metadata files are completely optional, except for the short summary description as well as the longer full description. However, apps which do not fulfill certain criteria will not be shown on the Latest tab.

la structure fastlane

La première des deux structures vise à être compatible avec l’outil fastlane supply.

La structure de fichier de base se présente comme suit. Faites attention aux notes sur la droite. Quand cette structure est créée, elle a besoin d’être placée au bon endroit comme décrit ci-dessous.

├── en-US                       (en-US est le langage de secours de F-Droid)
│   ├── short_description.txt   (description courte, max 80 caractères, obligatoire)
│   ├── full_description.txt    (description de l'application complète, obligatoire)
│   ├── title.txt               (nom de l'application)
│   ├── video.txt               (URL de la vidéo d'introduction de l'app)
│   ├── images
│   │   ├── icon.png            (icône de l'application, obligatoire si votre application n'inclue aucun icône en png)
│   │   ├── featureGraphic.png  (Banière de promotion, affichée en haut de la descrition de l'application dans le client F-Droid ; format paysage)
│   │   ├── tvBanner.png        ("icône" pour les Télévisions, actuellement non utilisée)
│   │   ├── phoneScreenshots
│   │   │   ├── 1.png
│   │   │   ├── 2.png
│   │   │   ...
│   │   ├── sevenInchScreenshots/
│   │   ├── tenInchScreenshots/ (Vous pouvez ajouter différentes captures d'écran pour différentes tailles d'écran)
│   │   ├── tvScreenshots/
│   │   └── wearScreenshots/
│   └── changelogs
│       ├── 100000.txt          (doit correspondre avec versionCode, exactement)
│       ├── 100100.txt          (si le code de version est exactement 100100)
│       └── 100101.txt          (taille maximum : 500 caractères)
└── ru                          (autres codes de langue)
    ...                         (les métadonnées des langues sont toujours préférées par le client)
    └── changelogs
        └── 100100.txt

Cette structure doit être placée dans un des emplacements suivants de la racine du dépôt :

  • metadata/
  • fastlane/metadata/android/

À noter que placer cette structure ailleurs, comme à la racine du module gradle, ne fonctionnera pas.

version de build et plusieurs applications dans un référentiel n’est actuellement pas correctement supporté. (Suivez cette erreur pour traquer cette implémentation.)

Structure Triple-T

La deuxième structure supporté est compatible avec cet outil Triple-T Gradle Play Publisher.

Placez la structure suivante dans <module>/src/main/play/ ou, pour le support de build flavor, dans <module>/src/<buildFlavor>/play/, où <module> est le module gradle de votre application (souvent, c’est juste le dossier app) :

├── contact-email.txt                   (Adresse couriel du développeur / Adresse couriel de l'auteur)
├── contact-website.txt                 (Site internet du développeur / Site internet de l'auteur)
├── release-notes
│   └── en-US
│       └── default.txt                 (dernières modifications)
└── listings
    ├── en-US                           (en-US est la langue par default de F-Droid)
    │   ├── title.txt                   (Nom de l'application)
    │   ├── short-description.txt       (Courte description, 80 caractères maximun, obligatoire)
    │   ├── full-description.txt        (Description complète de l'application, obligatoire)
    │   ├── video-url.txt               (Liens vers une vidéo présentant l'application)
    │   ├── whatsnew                    (Fichier alternatif du journal des modifications ; seulement le fichier, sans le .txt)
    │   └── graphics
    │       ├── icon                    (Icon de l'application ; obligatoire si votre application ne contient aucun icon png)
    │       │   └── *.(png|jpg)         1 image, généralement 512x512
    │       ├── feature-graphic         (promo banner, shown on top of the app desc in F-Droid client)
    │       │   └── *.(png|jpg)         1 image, généralement 1024x500
    │       ├── phone-screenshots
    │       │   └── *.(png|jpg)
    │       ├── tablet-screenshots
    │       │   └── *.(png|jpg)
    │       ├── large-tablet-screenshots
    │       │   └── *.(png|jpg)
    │       ├── tv-banner               ("icon" pour les télévision, pas utilisé pour l'instant)
    │       │   └── *.(png|jpg)
    │       ├── tv-screenshots
    │       │   └── *.(png|jpg)
    │       └── wear-screenshots
    │           └── *.(png|jpg)
    ├── de                              (autres)
        ├── ...

Dans les métadonnées de construction de l’application dans la collection fdroiddata

Note : Cette option n’est destinée qu’à ceux qui gèrent leurs propres dépôts. Si vous êtes un développeur qui veut avoir une appli dans le dépôt F-Droid principal, ne choisissez pas cette option. De plus, les captures d’écrans peuvent être ajoutées au dépôt fdroiddata.

Les fichiers de métadonnées peut aussi être ajoutée dans n’importe quel dépôt de métadonnée de compilation dfroiddata. La structure du fichier est définie d’après fastlane et ressemble à celle au-dessus, avec les notes additionnelles suivantes.

  • Placez la structure dans l’emplacement : <fdroiddata>/metadata/<packageId>/
    • Par exemple, pour fr-FR, title.txt sera placer dans : <fdroiddata>/metadata/<packageId>/fr-FR/title.txt
  • Au lieu de short_description.txt, le fichier de résumé devra être nommé summary.txt.
  • Au lieu de full_description.txt, le fichier de description devra être nommé description.txt.
  • Ne pas suivre ces deux règles fera échouer le linter.

Dans le dépôt F-Droid

*Note : Cette option n’est seulement disponible pour ceux qui gèrent leurs propres dépôts.

La destination finale des fichiers du dépôt source de l’application et des sous répertoires de métadonnées fdroiddata, est le dépôt F-Droid. Le texte entier est inclus dans le fichier index (c’est à dire index-v1.json). Toutes les images peuvent être directement inclues dans le dépôt.

Si des images sont aussi placées dans la source de l’appli ou dans fdroiddata, les fichiers du dépôt sera directement remplacées.

Vous ne pourrez peut-être pas placer des fichiers texte directement dans le dépôt.

Pour référence, les fichiers image peuvent être ajoutés dans le dépôt aux emplacements suivants :

- fdroid
  └── repo
      └── <package-id>
          └── <locale>
              ├── featureGraphic.png
              ├── icon.png
              ├── tvBanner.png
              ├── phoneScreenshots
              │   └── *.png
              ├── sevenInchScreenshots
              │   └── *.png
              ├── tenInchScreenshots
              │   └── *.png
              ├── tvScreenshots
              │   └── *.png
              └── wearScreenshots
                  └── *.png

Priorité

Les règles générales de préséance suivantes sont appliquées lorsque plusieurs des options ci-dessus fournissent des métadonnées :

  • Le fichier de métadonnées(i. e. <fdroiddata>/metadata/<packageId>.yml)écrase les fichiers fdroiddata, même ceux qui sont localisés.
  • Les fichiers fdroiddata écrasent les métadonnées de la source de l’application.
  • Pour les données qui sont contenues dans le fichier APK tels que le nom de l’application, les deux options précédentes écrasent toutes deux les données du fichier APK.

Cependant, la règle suivante, plus précise, s’applique :

  • Les fichiers graphiques de la source de l’application de fdroiddata écrase les fichiers dans le dépôt.