RSS i Atom

Z JoggerWiki
Wersja z dnia 21:20, 8 kwi 2009 autorstwa Minio (dyskusja | edycje) (doidanie informacji że short może skracać do <EXCERPT>)

(różn.) ← poprzednia wersja | przejdź do aktualnej wersji (różn.) | następna wersja → (różn.)
Skocz do: nawigacji, wyszukiwania

RSS i Atom

Swój prywatny dziennik możesz łatwo udostępniać innym przy pomocy kanałów informacyjnych (feedów) w formacie RSS 2.0 lub nowszym Atom. Kanały te służą do rozpowszechniania nagłówków wiadomości lub całych wiadomości i są używane przez usługi agregacji informacji oraz serwisy internetowe na całym świecie. Odbiór treści z tych kanałów zapewniają specjalne czytniki.

Domyślnie w kanałach dostępna jest treść wpisów zamieszczonych na zerowym i pierwszym poziomie. Dostęp do treści z wyższych poziomów zapewnia autoryzacja użytkowników.

Wygenerowanie adresu specyficznego kanału ułatwia specjalny generator.

Kanały RSS wpisów

Aby udostępnić kanał RSS wpisów wystarczy w szablonie wstawić odpowiedni tag wskazujący adres kanału, np. &RSS; lub &HOME;/rss/. Do tak określonego adresu kanału można dodać różne parametry, pozwalające na konfigurację dodatkowych związanych z nim opcji. Wszystkie podawane są po adresie kanału RSS Twojego joggera (np. http://sparrow.jogger.pl/) (Te parametry w większości można również zastosować do kanału RSS dla strony głównej joggera http://jogger.pl/rss/).

/rss/                             same tematy wpisów, domyślna liczba (10)
/rss/liczba_wpisow/               liczba wpisów dostępnych w kanale (maksymalnie 50), parametr podawany jako ostatni
/rss/content/liczba_wpisow/       całe wpisy, tekstowo bez fromatowania, ustalona liczba wpisów
/rss/short/liczba_wpisow/         treść wpisów skrócona do 300 znaków lub znacznika <EXCERPT>, tekstowo bez formatowania, ustalona liczba wpisów
/rss/content/html/liczba_wpisow/  całe wpisy w formacie html, ustalona liczba wpisów
/rss/short/html/liczba_wpisow/    treść wpisów w formacie HTML skrócona do 300 znaków lub znacznika <EXCERPT>, ustalona liczba wpisów
/rss/cat/permalink_kategorii1/    kanał zawierający tylko wpisy ze wskazanych kategorii
/rss/auth/identyfikator/          wpisy dostępne również dla użytkownika mającego dostęp do wyższych poziomów

Kanały Atom wpisów

Aby udostępnić kanał Atom dla wpisów wystarczy w szablonie wstawić odpowiedni tag wskazujący adres kanału, np. &HOME;/atom/ (brak specjalnego znacznika dla kanału Atom). Do tak określonego adresu kanału można dodać różne parametry, pozwalające na konfigurację dodatkowych związanych z nim opcji. Wszystkie podawane są po adresie kanału RSS Twojego joggera (np. http://sparrow.jogger.pl/) (Te parametry w większości można również zastosować do kanału Atom dla strony głównej joggera http://jogger.pl/atom/).

W opisie treści kanału zawarte jest określenie kategorii do jakich należą wpisy.

/atom/                             same tematy wpisów, domyślna liczba (10)
/atom/liczba_wpisow/               liczba wpisów dostępnych w kanale (maksymalnie 50), parametr podawany jako ostatni
/atom/content/liczba_wpisow/       całe wpisy, tekstowo bez fromatowania, ustalona liczba wpisów
/atom/short/liczba_wpisow/         treść wpisów skrócona do 300 znaków lub znacznika <EXCERPT>, tekstowo bez formatowania, ustalona liczba wpisów
/atom/content/html/liczba_wpisow/  całe wpisy w formacie html, ustalona liczba wpisów
/atom/short/html/liczba_wpisow/    treść wpisów w formacie HTML skrócona do 300 znaków lub znacznika <EXCERPT>, ustalona liczba wpisów
/atom/cat/permalink_kategorii1/    kanał zawierający tylko wpisy ze wskazanych kategorii
/atom/auth/identyfikator/          wpisy dostępne również dla użytkownika mającego dostęp do wyższych poziomów

Kanały z wpisami z wyższych poziomów

Dodanie /auth/identyfikator/ bezpośrednio po określeniu typu kanału umożliwia również dostęp do treści wpisów zamieszczonych na wyższych poziomach.

identyfikator w /auth/identyfikator/ określa się w panelu administracyjnym Użytkownicy poziomów, długość identyfikatora może wynosić od 1 do 32 dowolnych znaków, wstępnie generowany jest losowy identyfikator.

/auth/identyfikator/, o ile ma występować, powinno być podane jako pierwsze w kolejności, później ewentualne określenie kategorii i dopiero dodatkowe parametry dotyczące zawartości kanału.

/rss/auth/abcdef…/

O ten identyfikator należy oczywiście poprosić właściciela danego joggera...

Kanały z Miniblogiem

Domyślnie w kanałach RSS/Atom z wpisami nie są wyświetlane wpisy kategorii specjalnej Miniblog. Aby włączyć ich treść do URL kanału należy dodać /miniblog/, na przykład:

/rss/content/html/miniblog/liczba_wpisow/

lub

/atom/content/html/miniblog/liczba_wpisow/

Kanały dla kategorii

Można określić więcej niż jedną kategorię dostępną w kanale, podając kolejne po znaku plusa:

/rss/cat/identyfikator_kategorii1+identyfikator_kategorii2+identyfikator_kategorii3/

lub

/atom/cat/identyfikator_kategorii1+identyfikator_kategorii2+identyfikator_kategorii3/

Uwaga! Jeżeli występują kategorie zagnieżdżone, to należy podawać ostatni człon permalinku kategorii, na przykład przy http://jakis.jogger.pl/internet/blogi/ należy użyć samego blogi.

Kanał dla kategorii Miniblog

Postać URL kanału dla kategorii Miniblog wygląda następująco:

/rss/cat/miniblog/miniblog/

lub

/atom/cat/miniblog/miniblog/

Kanały komentarzy

Dostępne są również kanały komentarzy dla poszczególnych wpisów.

Dodanie do permalinku wpisu /rss/ tworzy kanał RSS z komentarzami do danego wpisu. Na przykład:

<a href="&ENTRY_COMMENT_HREF;rss/">RSS komentarzy</a>

Dodanie do permalinku wpisu /atom/ tworzy kanał Atom z komentarzami do danego wpisu. Na przykład:

<a href="&ENTRY_COMMENT_HREF;atom/">Atom komentarzy</a>

Dodatkowo dodanie /auth/identyfikator/ umożliwia dostęp do komentarzy wpisów na poziomie wyższym niż 1, podobnie jak dla kanału wpisów.

Stary format adresów

/syndication.php jest już nieaktywny, proszę używać nowej wersji.