Naar de inhoud

De tijdlijn op uw eigen site tonen

De tijdlijn lezen is gratis en vraagt geen account, feeds inbegrepen: de aankondigingen van een uitgever of een project op uw eigen site tonen vraagt geen registratie, geen token en geen toestemming.

De aankondigingen worden gepubliceerd onder de licentie CC BY-SA 4.0. Een overname noemt dus de naam van de uitgever, verwijst naar de aankondiging en noemt de licentie: de plugin en de feeds hieronder dragen deze drie elementen, en ze weghalen maakt de kopie ongeoorloofd.

WordPress, in één bestand

Een plugin van één enkel bestand, zonder afhankelijkheden: geen Composer, geen plugin van derden, geen JavaScript. Kopieer hem naar wp-content/plugins/dolinews-feed/ en activeer hem, of plak de inhoud aan het einde van de functions.php van uw child theme - het een of het ander, nooit beide.

De plugin downloaden (dolinews-feed.php)

De shortcode zet u daarna in elk blok, tekstwidget of template:

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

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

[dolinews focus="security" dolibarr="22" title="Beveiligingscorrecties"]

De slug van een uitgever of een project staat in het adres van zijn pagina op deze site. De beschikbare attributen:

  • editor, project, focus, dolibarr, q - dezelfde filters als de tijdlijn.
  • maturity - een lijst gescheiden door komma's, bijvoorbeeld beta,rc. Zonder dit attribuut worden alleen stabiele versies vermeld.
  • locale - de leestaal, als inhoudslocale: fr_FR, es_ES, de_DE...
  • limit, layout, summary, title, link_text - de presentatie: aantal aankondigingen, lijst of kaarten, samenvatting wel of niet, titel en linktekst.
  • cache - de duur van de lokale cache in seconden, standaard 900. Het laatst bekende antwoord blijft een week bewaard en wordt gebruikt als deze site onbereikbaar wordt.

De labels - Dolibarr-bereik, maturiteit en hoe lang geleden die werd aangekondigd, aard van de publicatie, taal van de aankondiging - worden door de dienst geschreven in de gevraagde taal. De plugin vertaalt er geen enkel en blijft correct in de tien talen.

De feeds, voor al het andere

Buiten WordPress leveren de twee algemene feeds hetzelfde en nemen ze dezelfde filters als adresparameters.

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

De RSS-feed wordt door elke aggregator gelezen. De JSON-feed volgt het JSON Feed-formaat, en elk item draagt daarnaast een lid _dolinews: de ruwe waarden van de aankondiging - versie, maturiteit, Dolibarr-bereik, aard, uitgever, project - en hun al vertaalde labels. Dat lid leest de WordPress-plugin, en dat is wat u moet lezen om een aankondiging elders te tonen.

Een laatste punt, dat een ontgoocheling voorkomt: de API antwoordt op dezelfde vragen maar houdt een strikt taalfilter, omdat haar contract vastligt. Een aankondiging die niemand naar de gevraagde taal heeft vertaald staat er niet in, terwijl de feed de oorspronkelijke versie levert en de taal ervan vermeldt. Om te tonen neemt u de feed, om te verwerken de API.

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

API-documentatie - Broncode van de dienst en van de plugin

Wat uw site niet zal tonen

Deze dienst zegt wat is aangekondigd, en wanneer; nooit de huidige staat van een module. Een integratie die "module compatibel met versie 22" zou schrijven, beweert wat niemand heeft verklaard: het weergegeven bereik is dat van de aankondiging, op haar datum, en de datum staat ernaast.

Om dezelfde reden wordt een maturiteit nooit getoond zonder hoe lang geleden ze werd aangekondigd - niemand komt terug om te zeggen dat een versie haar testfase heeft verlaten - en testversies ontbreken zolang er niet om wordt gevraagd.