XML Syndication

DokuWiki rende disponibili alcuni dei suoi dati come feed XML attraverso il file feed.php. Il feed può essere sottoscritto in un lettore feed.

La funzionalità di XML Syndication è stata implementata usando l'eccellente Feed Creator Class di Kai Blankenhorn.

Il modo in cui i feed sono prodotti può essere impostato attraverso alcune opzioni di configurazione. Quando feed.php è chiamato senza alcun argomento userà queste opzioni per creare il feed. Tutte le opzioni possono anche essere modificate da parametri aggiunti nell'URL

Ogni elemento nel feed creato avrà un collegamento; questa opzione specifica dove punta il collegamento.

• Opzione di configurazione: rss_linkto
• Parametro URL: linkto
• Predefinito: diff
• Valori possibili:

Ciò che è mostrato nel corpo degli elementi del feed è controllato da questa opzione.

• Opzione di configurazione: rss_content
• Parametro URL: content
• Default: abstract
• Valori possibili:

DokuWiki può creare feed in diversi formati.

• Opzione di configurazione: rss_type
• Parametro URL: type
• Predefinito: rss1
• Valori possibili:

feed.php può essere usato per elencare una lista delle ultime modifiche (predefinito) ma può essere usato anche per altri elenchi.

• Opzione di configurazione: nessuna
• Parametro URL: mode
• Predefinito: recent
• Valori possibili:

Il feed può essere limitato ad includere le pagine di una sola categoria.

• Opzione di configurazione: nessuna
• Parametro URL: ns
• Predefinito: *
• Valori possibili: qualsiasi categoria valida

In modalità elenco list, il feed contiene pagine solo della categoria data, non le sotto categorie.

In modalità elenco recent, le sotto categorie sono icluse.

Limitazioni di categorie non sono direttamente supportate dalla modalità elenco search. Si possono invece fornire limitazioni ad una categoria nell'interrogazione una (usando la sintassi @) – questo però include le sottocategorie.

Anche il numero di pagine elencate nel feed può essere controllato.

• Opzione di configurazione: recent
• Parametro URL: num
• Predefinito: 20
• Valori possibili: qualsiasi numero intero

Per impostazione predefinita le modifiche minori non saranno mostrate nei feed. Questo può essere modificato da un argomento URL.

• Opzione di configurazione: nessuna
• Parametro URL: minor
• Predefinito: 0
• Valori possibili: 0 o 1

I feed XML sono memorizzate nella cache per ridurre il carico sul wiki. Questa opzione controlla l'intervallo di aggiornamento dei feed nella cache.

• Opzione di configurazione: rss_update
• Parametro URL: nessuno
• Predefinito: 5*60
• Possibili valori: tempo in secondi

L'oggetto della modifica di una pagina cambiata sarà solitamente incluso nell'elemento titolo del feed. Questo potrebbe non essere voluto a volte e può essere disabilitato.

• Opzione di configurazione: rss_show_summary
• URL Parameter: nessuno
• Predefinito: 1
• Valori possibili: 0 o 1

• feed.php?type=rss2&num=5 restituisce un feed RSS 2.0 delle ultime 5 più recenti modifiche
• feed.php?mode=list&type=atom&linkto=page&ns=wiki elenca tutte le pagine della categoria del wiki come un feed ATOM 0.3 con tutti gli elementi che si collegano alla pagina direttamente

Quando ACL è abilitato, le pagine che hanno restrizioni di lettura non saranno incluse nei feed pubblici.

Se si vuole accedere ai feed che includono pagine con restrizioni si deve inserire il proprio nome utente e password nell'URL come: ''http://example.com/dokuwiki/feed.php?u=nomeutente&p=password''.

Questo non è molto sicuro e potrebbe portare alla perdita delle credenziali utente. Quando DokuWiki è in esecuzione in cima a mod_php passare le credenziali di accesso tramite HTTP Basic Auth come supportato da alcuni lettori feed potrebbe pure funzionare.

• Aggregazione feed RSS/ATOM per aggiungere feed esterni alle pagine di DokuWiki
• Il feed plugin per ulteriori modi di esportare gli articoli del proprio blog tramite RSS
• Suggerimenti su feed setup quando si blogga con DokuWiki