DokuWiki

It's better when it's simple

Strumenti Utente

Strumenti Sito


it:syndication

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.

Opzione di configurazione/URL

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

Collegamenti

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:
Valori Collegamenti a
page la revisione della pagina quando il feed è stato creato
current la più recente revisione della pagina
rev pagina delle revisioni precendenti
diff pagina delle differenze

Contenuto dei Feed

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:
Valore Contenuto elementi
abstract la prima frase della pagina
diff un semplice testo delle diff modifiche della pagina
htmldiff tabella delle diff modifiche pagine formattata in HTML
html l'intero contenuto della pagina formattato in HTML

Formato Feed

DokuWiki può creare feed in diversi formati.

  • Opzione di configurazione: rss_type
  • Parametro URL: type
  • Predefinito: rss1
  • Valori possibili:
Valore Formato Feed
rss RSS 0.91
rss1 RSS 1.0
rss2 RSS 2.0
atom ATOM 0.3
atom1 ATOM 1.0

Modalità elenco

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:
Valore Modalità elenco
recent elenca le ultime modifiche con le più recenti in cima
list elenca semplicemente tutte la pagine di una categoria (si veda sotto per selezionare quale)
search elenco di pagine corrispondenti ad una determinata interrogazione di ricerca data attraverso un parametro aggiuntivo q

Filtro categorie

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.

Limiti elementi

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

Includere Modifiche Minori

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

Cache

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

Oggetto della modifica

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

Esempi

Feed e ACL

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.

Si veda anche

it/syndication.txt · Ultima modifica: 2010-11-21 21:52 da supportovip

Ad eccezione da dove è diversamente indicato, il contenuto di questo wiki è soggetto alla seguente licenza: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki