Skip to content
DoliNews
Menu
The feed Publish The review Commitments Rules API Integrate the feed
Sign in Register

Show the feed on your own site

Reading the feed is free and needs no account, feeds included: showing the announcements of an editor or of a project on your own site requires no sign-up, no token and no permission.

Announcements are published under the CC BY-SA 4.0 licence. A copy therefore names the editor, links back to the announcement and names the licence: the plugin and the feeds below carry all three, and removing them makes the copy unauthorised.

WordPress, in one file

A plugin of one single file, with no dependency: no Composer, no third-party plugin, no JavaScript. Copy it into wp-content/plugins/dolinews-feed/ and activate it, or paste its contents at the end of the functions.php of your child theme - one or the other, never both.

Download the plugin (dolinews-feed.php)

The shortcode then goes into any block, text widget or template:

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

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

[dolinews focus="security" dolibarr="22" title="Security fixes"]

The slug of an editor or a project is read from the address of its page on this site. The available attributes:

  • editor, project, focus, dolibarr, q - the same filters as the feed.
  • maturity - a comma-separated list, for instance beta,rc. Without this attribute, only stable versions are listed.
  • locale - the reading language, as a content locale: fr_FR, es_ES, de_DE...
  • limit, layout, summary, title, link_text - the presentation: how many announcements, list or cards, summary shown or not, heading and link wording.
  • cache - how long the local cache lives, in seconds, 900 by default. The last known answer is kept for a week and is served if this site becomes unreachable.

The badges - Dolibarr range, maturity and how long ago it was announced, nature of the publication, language of the announcement - are written by the service in the language asked for. The plugin translates none of them and stays correct in all ten languages.

The feeds, for everything else

Outside WordPress, the two generic feeds serve the same thing and take the same filters as address parameters.

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

The RSS feed is read by any aggregator. The JSON feed follows the JSON Feed format, and every entry carries an extra _dolinews member: the raw values of the announcement - version, maturity, Dolibarr range, nature, editor, project - and their wording, already translated. That member is what the WordPress plugin reads, and what to read to show an announcement anywhere else.

One last point, which saves a disappointment: the API answers the same questions but keeps a strict language filter, because its contract is frozen. An announcement nobody translated into the language asked for is absent from it, where the feed serves its original version and says which language that is. To display, take the feed; to process, take the API.

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

API documentation - Source code of the service and of the plugin

What your site will not say

This service says what was announced, and when; never the current state of a module. An integration writing "module compatible with version 22" would state what nobody declared: the range shown is the one the announcement carried, on its date, and the date is shown next to it.

For the same reason, a maturity is never shown without how long ago it was announced - nobody ever comes back to say a version left its test phase - and test versions are absent until they are asked for.