summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/aggregate.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ikiwiki/directive/aggregate.mdwn')
-rw-r--r--ikiwiki/directive/aggregate.mdwn61
1 files changed, 61 insertions, 0 deletions
diff --git a/ikiwiki/directive/aggregate.mdwn b/ikiwiki/directive/aggregate.mdwn
new file mode 100644
index 0000000..fd48172
--- /dev/null
+++ b/ikiwiki/directive/aggregate.mdwn
@@ -0,0 +1,61 @@
+La directive `aggregate` est fournie par le module d'extension [[!iki
+plugins/aggregate desc=aggregate]]. Ce greffon demande une configuration
+particulière, à savoir une tâche `cron`. Consultez la documention du greffon
+pour des précisions.
+
+Cette directive permet d'assembler les contenus d'autres flux dans le
+wiki. Ainsi :
+
+ \[[!aggregate name="example blog" dir="example"
+ feedurl="http://example.com/index.rss"
+ url="http://example.com/" updateinterval="15"]]
+
+Dans cet exemple, les messages du flux RSS indiqué sont assemblés dans le
+répertoire example/ du wiki, une page par message. La fréquence de mise à
+jour est de 15 minutes (mais moins fréquemment si la tâche cron est exécutée
+moins fréquemment).
+
+Vous pouvez utiliser la directive [[inline]] d'ikiwiki pour créer un blog
+avec un ou plusieurs flux assemblés. Par exemple :
+
+ \[[!inline pages="internal(example/*)"]]
+
+Notez l'utilisation de la fonction `internal()` de [[ikiwiki/PageSpec]] pour
+trouver les pages assemblées. Par défaut, les pages assemblées sont des
+pages internes, ce qui empêche qu'elles apparaissent directement dans le
+wiki. C'est pourquoi la fonction `internal()` est nécessaire dans la
+spécification [[PageSpec]] pour les trouver.
+
+## Usage
+
+Voici la description de tous les paramètres acceptés par cette directive :
+
+* `name` - Le nom du flux. Chaque flux doit avoir un nom unique. Paramètre
+ obligatoire.
+* `url` - L'URL de la page web contenant le flux assemblé. Paramètre
+ obligatoire.
+* `dir` - Le répertoire du wiki où seront sauvegardées les pages. Paramètre
+ facultatif. S'il n'est pas indiqué, le répertoire est construit à partir
+ du nom du flux.
+* `feedurl` - L'URL du flux. Paramètre facultatif. S'il n'est pas indiqué,
+ ikiwiki cherchera le flux avec le paramètre `url`. Les flux RSS et Atom
+ sont reconnus.
+* `updateinterval` - Fréquence, en minutes, de la recherche des nouveaux
+ messages. Par défaut, 15 minutes.
+* `expireage` - Éliminer les anciens messages du flux si leur ancienneté
+ est plus grande qu'un nombre de jours donné. Par défaut, aucune
+ élimination ne se fait sur l'ancienneté.
+* `expirecount` - Éliminer les anciens messages du flux si leur nombre est
+ plus grand qu'un nombre donné. Les messages les plus anciens sont éliminés
+ en premier. Par défaut, aucune élimination ne se fait sur le nombre.
+* `tag` - Représente une étiquette avec laquelle étiqueter chaque message
+ du flux. Le nom du flux est une bonne étiquette. Ce paramètre peut être
+ répété. Le greffon [[tag]] doit être activé.
+* `template` - Modèle de page à utiliser pour la création des pages
+ assemblées. Par défaut, c'est "aggregatepost".
+
+Notez que même si vous utilisez subversion ou un autre système de
+versionnement, les pages créées par assemblage *ne* seront *pas* prises en
+compte par le système de contrôle de versions.
+
+[[!meta robots="noindex, follow"]]