Tudo sobre Descrições, Gráficos e Capturas de tela

As aplicações no F-Droid podem fornecer conteúdo para que a loja de aplicações torne sua página mais interessante e informativa.

Isto é suportado pelo F-Droid versão 0.103 e fdroidserver versão 0.8.

Critérios de aba mais recente

No cliente F-Droid, desde a versão 1.6, somente as aplicações que têm todas as seguintes características são mostradas na aba mais recente:

  • Nome
  • Icon
  • Resumo
  • Descrição
  • Licença
  • O que há de novo em pelo menos um lançamento
  • pelo menos uma imagem (captura de tela ou um recurso gráfico)
  • pelo menos uma das traduções acima

Saiba mais no posto de anúncios.

Formato dos dados

Formatos dos arquivos de imagem

As imagens podem ser fornecidas em formato PNG ou JPEG. Devem ter as terminações png, jpg ou jpeg.

É importante notar que metadados perigosos e desnecessários são removidos dos arquivos de imagem antes de serem incluídos no repositório. Por exemplo, os dados JPEG EXIF têm questões de segurança, e não é necessário exibir imagens. Isto também significa que as imagens podem ser recompactadas.

Descrições em HTML

A descrição detalhada do aplicativo pode usar tags HTML. Note que nem todas as tags são suportadas pelo renderizador.

  • Tags comuns como li, a com href, ul, ol, li, b, u e i são suportadas.
  • Certas tags são explicitamente proibidas, a saber: applet, base, body, button, embed, form, head, html, iframe, img, input, link, object, picture, script, source, style, svg e video.
  • Observe que uma quebra de linha será automaticamente convertida para uma tag br.
  • Você não pode fazer uso do JavaScript.

Formas de fornecer metadados

A adição de metadados pode ser feita das três maneiras a seguir.

No repositório de fontes do aplicativo

Para o repositório oficial F-Droid, é fortemente encorajado a adicionar metadados no repositório fonte do aplicativo pelas seguintes razões:

  • Os metadados do aplicativo estão sob controle direto dos proprietários do repositório
  • Metadados do repositório são copiados automaticamente para o repositório do F-Droid (assim não são necessários pedidos de fusão)

O F-Droid suporta duas estruturas de arquivo distintas. Estas visam ser compatíveis com as ferramentas de software livre existentes que permitem a publicação de aplicativos para o Google Play. Não é necessário instalar nenhuma destas ferramentas, a estrutura de arquivo pode ser facilmente criada manualmente.

Por favor, esteja ciente de que os textos no arquivo de metadados do aplicativo substituirão todos os outros textos descritivos fornecidos através das estruturas explicadas abaixo. Isto afeta Nome, Resumo, e Description. Uma vez que os campos de metadados que estavam anteriormente no arquivo de metadados tenham sido movidos para o repositório fonte do aplicativo, favor arquivar uma solicitação de fusão ou edição para remover Resumo e Descrição do arquivo de metadados do aplicativo.

Para mais detalhes, consulte as regras de precedência descritas no final deste arquivo.

F-Droid apenas utilizará arquivos de metadados do release mais recente. Isso significa que fdroidserver apenas checará a versão mais recente que tem conhecimento e escanear o repositório no estado daquela versão em busca de arquivos de metadados.

Todos os arquivos de metadados são completamente opcionais, exceto por o resumo curto da descrição, além da descrição completa. No entanto, apps que não cumprirem certos critérios não serão exibidos na aba Recentes.

Estrutura Fastlane

A primeira das duas estruturas busca ser compatível com a ferramenta de fastlane supply.

A estrutura de arquivos básica é a seguinte. Preste atenção às notas a direita. Quando esta estrutura é criada, ela precisa ser colocada na posição correta, como demonstrado abaixo.

├── en-US (en-US é a linguagem F-Droid de apoio)
│ ├── short_description.txt (breve descrição, máximo 80 caracteres, obrigatória)
│ ├── full_description.txt (descrição completa da aplicação, obrigatória)
│ ├── title.txt (nome do aplicativo)
│ ├── video.txt (URL para um vídeo de apresentação do aplicativo)
│ ├── imagens
│ │ ─ ├── icon.png (ícone do aplicativo, obrigatório se o seu aplicativo não incluir nenhum ícone png)
│ │ ─ ├── featureGraphic.png (banner promocional, mostrado no alto da descrição do aplicativo no cliente F-Droid; formato paisagem)
│ │ ─ ├── tvBanner.png ("ícone" para dispositivos de TV, atualmente não utilizado)
│ │ ─ ├─── phoneScreenshots
│ │ │ ─ ├── 1.png
│ │ │ ─ ─ ├── 2.png
│ │ │ ...
│ │ ─ ├── sevenInchScreenshots/
│ │ ─ ├── tenInchScreenshots/ (você pode adicionar diferentes capturas de tela para diferentes tamanhos de tela)
│ │ ─ ├── tvScreenshots/
│ │ └ └── wearScreenshots/
│ └ └── changelogs
│ ├── 100000.txt (deve corresponder à versão do código, literalmente, sem preenchimento)
│ ├── 100100.txt (se o código da versão foi definido como 100100)
│ └ └── 100101.txt (tamanho máximo: 500 caracteres)
└── ru (outros códigos de línguas)
    ...                         (os metadados localizados são sempre preferidos pelo cliente)
    └── changelogs
        └── 100100.txt

Esta estrutura deve ser colocada em um dos seguintes locais da raíz do repositório:

  • metadata/
  • fastlane/metadata/android/

Note que a posicionar a estrutura em outro lugar, como na raiz do módulo de gradação, não vai funcionar.

Construir sabores e múltiplas aplicações dentro de um repositório não são atualmente suportados corretamente. (Siga este problema para acompanhar a implementação disto).

Estrutura Triplo-T

A segunda estrutura suportada é compatível com a ferramenta Triple-T Gradle Play Publisher.

Ponha a estrutura seguinte em <módulo>/src/main/play/ ou, para suporte de build flavor, em <módulo>/src/<buildFlavor>/play/, onde <módulo> é o módulo gradle da sua app em muitos casos, esta é apenas a pasta app):

├── contact-email.txt (e-mail do programador / AuthorEmail)
├── contact-website.txt (site do desenvolvedor / AuthorWebSite)
├── notas de lançamento
│  └── en-US
│  └── default.txt (último changelog)
└── listings
    ├── en-US (en-US é o local predefinido no F-Droid)
    │   ├── title.txt (nome da app)
    │   ├── shortdescription.txt (descrição breve, máximo 80 caracteres, obrigatória)
    │   ├── full-description.txt (descrição completa da app, obrigatória)
    │   ├── video-url.txt (URL para um vídeo de apresentação da app)
    │   ├── whatsnew (localização alternativa do changelog; ficheiro único, sem .txt)
    │   └── graphics
    │       ├── icon (ícone da app; obrigatório se a sua app não incluir nenhum ícone de png)
    │       │    └── *.(png|jpg) 1 imagem, geralmente 512x512
    │       ├── feature-graphic (banner promocional, mostrado na parte superior da descrição da app no cliente F-Droid)
    │       │    └── *.(png|jpg) 1 imagem, geralmente 1024x500
    │       ├── phone-screenshots
    │       │    └── *.(png|jpg)
    │       ├── tablet-screenshots
    │       │    └── *.(png|jpg)
    │       ├── large-tablet-screenshots
    │       │    └── *.(png|jpg)
    │       ├── tv-banner ("ícone" para aparelhos de TV, atualmente não utilizado)
    │       │    └── *.(png|jpg)
    │       ├── tv-screenshots
    │       │    └── *.(png|jpg)
    │       └── wear-screenshots
    │              └── *.(png|jpg)
    ├── pt (outros idiomas)
         ├── ...

Nos metadados de compilação de um aplicativo em uma coleção de fdroiddata

Nota: Esta opção é apenas para os que hospedam os próprios repositórios. Se é um programador que quer obter uma app no repositório principal do F-Droid, não escolha esta opção. Especificamente, capturas de tela não podem ser adicionadas ao repositório fdroiddata.

Os arquivos de metadados também podem ser adicionados a todos os repositórios fdroiddata de metadados de compilação. A estrutura do arquivo é modelada após o fastlane também e parece a mesma como mostrado acima, com as seguintes notas adicionais.

  • Ponha a estrutura no local a seguir: <fdata>/metadata/<packageId>/
    • Por exemplo, para en-US, title.txt ficaria neste local: `/metadata//en-US/title.txt
  • Ao invés de short_description.txt, o arquivo de resumo deve ser nomeado summary.txt.
  • Ao invés de full_description.txt, o arquivo de descrição deve ser nomeado description.txt.
  • Não cumprir com os dois pontos acima faz com que o linter falhe.

No repositório do F-Droid

Nota: Esta opção só está disponível para aqueles que hospedam os próprios repositórios.

O destino final dos arquivos dos repositório fonte do aplicativo e dos subdiretórios de metadados fdroiddata está no repositório do F-Droid. O texto é incluído no arquivo de índice (conhecido como index-v1.json). Todos os arquivos gráficos podem ser incluídos diretamente no repositório.

Se os arquivos de gráficos também estiverem na fonte da aplicação ou fdroiddata, os arquivos diretamente no repo serão sobrescritos.

Você não pode pôr arquivos de texto diretamente no repositório.

Para referência, os arquivos de imagens podem ser postos dentro do repositório nos seguintes locais:

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

Precedência

As seguintes regras gerais de precedência são aplicadas quando múltiplas das opções acima fornecem metadados:

  • O arquivo de metadados (i.e. <fdroiddados>/metadados/<packageId>.yml) sobrescreve arquivos fdroiddata, mesmo os traduzidos.
  • Os fdroiddata arquivos sobrescrevem a metadata da fonte do aplicativo.
  • Para dados que também estão contidos no arquivo APK, como o nome do app, as duas opções anteriores substituem os dados do arquivo APK.

No entanto, a seguinte regra mais específica também se aplica:

  • Arquivos de gráfico da fonte do aplicativo de fdroiddata sobrescrevem os arquivos no repositório.