Ir para o conteúdo

Mostrar o fluxo no seu site

A leitura do fluxo é gratuita e sem conta, fluxos incluídos: mostrar os anúncios de um editor ou de um projeto no seu próprio site não exige registo, nem token, nem autorização.

Os anúncios são publicados sob a licença CC BY-SA 4.0. Uma reutilização cita portanto o nome do editor, remete para o anúncio e nomeia a licença: a extensão e os fluxos abaixo levam estes três elementos, e retirá-los torna a cópia não autorizada.

WordPress, num único ficheiro

Uma extensão de um único ficheiro, sem dependências: sem Composer, sem extensão de terceiros, sem JavaScript. Copie-a para wp-content/plugins/dolinews-feed/ e ative-a, ou cole o seu conteúdo no fim do functions.php do seu tema filho - uma ou outra, nunca as duas.

Descarregar a extensão (dolinews-feed.php)

O código curto escreve-se depois em qualquer bloco, widget de texto ou modelo:

[dolinews editor="mon-editeur" limit="5"]

[dolinews project="mon-module" limit="3" layout="cards"]

[dolinews focus="security" dolibarr="22" title="Correções de segurança"]

O slug do editor ou do projeto lê-se no endereço da sua ficha neste site. Os atributos disponíveis:

  • editor, project, focus, dolibarr, q - os mesmos filtros do fluxo.
  • maturity - uma lista separada por vírgulas, por exemplo beta,rc. Sem este atributo, apenas as versões estáveis são listadas.
  • locale - a língua de leitura, como localidade de conteúdo: fr_FR, es_ES, de_DE...
  • limit, layout, summary, title, link_text - a apresentação: número de anúncios, lista ou cartões, resumo mostrado ou não, título e texto da ligação.
  • cache - a duração da cache local em segundos, 900 por omissão. A última resposta conhecida é conservada durante uma semana e é servida se este site ficar inacessível.

As etiquetas - intervalo Dolibarr, maturidade e a sua antiguidade, natureza da publicação, língua do anúncio - são escritas pelo serviço na língua pedida. A extensão não traduz nenhuma e permanece correta nas dez línguas.

Os fluxos, para todo o resto

Fora do WordPress, os dois fluxos genéricos servem a mesma coisa e aceitam os mesmos filtros como parâmetros de endereço.

https://dolinews.com/feeds.xml?editor=mon-editeur

https://dolinews.com/feeds.json?project=mon-module&focus=security

https://dolinews.com/feeds.xml?dolibarr=22&maturity[]=beta

O fluxo RSS é lido por qualquer agregador. O fluxo JSON segue o formato JSON Feed, e cada entrada leva ainda um membro _dolinews: os valores brutos do anúncio - versão, maturidade, intervalo Dolibarr, natureza, editor, projeto - e as suas etiquetas já traduzidas. É esse membro que a extensão WordPress lê, e é o que há que ler para mostrar um anúncio noutro lugar.

Um último ponto, que evita uma deceção: a API responde às mesmas perguntas mas mantém um filtro de língua estrito, porque o seu contrato está fixado. Um anúncio que ninguém traduziu para a língua pedida não figura nela, enquanto o fluxo serve a sua versão de origem indicando a sua língua. Para mostrar, use o fluxo; para tratar, use a API.

https://dolinews.com/api/v1/articles?editor=mon-editeur&per_page=10

Documentação da API - Código-fonte do serviço e da extensão

O que o seu site não mostrará

Este serviço diz o que foi anunciado, e quando; nunca o estado atual de um módulo. Uma integração que escrevesse "módulo compatível com a versão 22" afirmaria o que ninguém declarou: o intervalo mostrado é o que o anúncio levava, na sua data, e a data é mostrada ao lado.

Pela mesma razão, uma maturidade nunca é mostrada sem a sua antiguidade - ninguém volta para dizer que uma versão saiu da fase de ensaio - e as versões de ensaio estão ausentes enquanto não forem pedidas.