Wyświetlanie strumienia na własnej stronie

Czytanie strumienia jest darmowe i nie wymaga konta, łącznie z kanałami: wyświetlanie ogłoszeń wydawcy lub projektu na własnej stronie nie wymaga rejestracji, tokenu ani zezwolenia.

Ogłoszenia są publikowane na licencji CC BY-SA 4.0. Ponowne użycie podaje więc nazwę wydawcy, odsyła do ogłoszenia i nazywa licencję: wtyczka i kanały poniżej zawierają te trzy elementy, a ich usunięcie czyni kopię niedozwoloną.

WordPress, w jednym pliku

Wtyczka w jednym pliku, bez zależności: bez Composera, bez wtyczek innych firm, bez JavaScriptu. Skopiuj ją do wp-content/plugins/dolinews-feed/ i włącz, albo wklej jej treść na koniec pliku functions.php motywu potomnego - jedno albo drugie, nigdy oba.

Pobierz wtyczkę (dolinews-feed.php)

Kod skrócony wpisuje się następnie w dowolnym bloku, widżecie tekstowym lub szablonie:

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

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

[dolinews focus="security" dolibarr="22" title="Poprawki bezpieczeństwa"]

Slug wydawcy lub projektu znajduje się w adresie jego karty na tej stronie. Dostępne atrybuty:

editor, project, focus, dolibarr, q - te same filtry co strumień.
maturity - lista rozdzielona przecinkami, na przykład beta,rc. Bez tego atrybutu wyświetlane są tylko wersje stabilne.
locale - język odczytu, jako ustawienie regionalne treści: fr_FR, es_ES, de_DE...
limit, layout, summary, title, link_text - prezentacja: liczba ogłoszeń, lista lub karty, streszczenie widoczne lub nie, tytuł i tekst odnośnika.
cache - czas życia lokalnej pamięci podręcznej w sekundach, domyślnie 900. Ostatnia znana odpowiedź jest przechowywana tydzień i jest podawana, jeśli ta strona stanie się nieosiągalna.

Plakietki - zakres Dolibarr, dojrzałość i jej wiek, charakter publikacji, język ogłoszenia - są pisane przez serwis w żądanym języku. Wtyczka nie tłumaczy żadnej z nich i pozostaje poprawna w dziesięciu językach.

Kanały, do wszystkiego pozostałego

Poza WordPressem dwa ogólne kanały podają to samo i przyjmują te same filtry jako parametry adresu.

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

Kanał RSS czyta dowolny agregator. Kanał JSON używa formatu JSON Feed, a każdy wpis nosi dodatkowo element _dolinews: surowe wartości ogłoszenia - wersja, dojrzałość, zakres Dolibarr, charakter, wydawca, projekt - oraz ich już przetłumaczone etykiety. Ten element czyta wtyczka WordPressa i to jego należy czytać, aby wyświetlić ogłoszenie gdzie indziej.

Ostatnia uwaga, która oszczędza rozczarowania: API odpowiada na te same pytania, ale zachowuje ścisły filtr języka, ponieważ jego kontrakt jest zamrożony. Ogłoszenie, którego nikt nie przetłumaczył na żądany język, nie pojawia się w nim, podczas gdy kanał podaje wersję źródłową i wskazuje jej język. Do wyświetlania weź kanał, do przetwarzania API.

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

Dokumentacja API - Kod źródłowy serwisu i wtyczki

Czego Twoja strona nie pokaże

Ten serwis mówi, co zostało ogłoszone i kiedy; nigdy bieżącego stanu modułu. Integracja, która napisałaby "moduł zgodny z wersją 22", twierdziłaby to, czego nikt nie zadeklarował: pokazany zakres jest tym, który nosiło ogłoszenie, w swojej dacie, a data jest pokazana obok.

Z tego samego powodu dojrzałość nigdy nie jest pokazywana bez jej wieku - nikt nie wraca, by powiedzieć, że wersja wyszła z fazy prób - a wersje próbne są nieobecne, dopóki się o nie nie poprosi.