La directive inline
est fournie par le module d'extension inline.
Cette directive permet l'inclusion d'une page de wiki dans une autre. L'utilisation la plus fréquente de cette directive est la création de blog ou de flux Atom ou RSS.
Exemple :
[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
Toute page correspondant à la spécification, ?PageSpec, (dans l'exemple, toute ?SubPage de "blog") fera partie du blog et les dix dernières pages apparaîtront dans la page. Notez que les fichiers qui, sans être des pages, correspondent à la spécification, seront inclus dans la diffusion par RSS, ce qui est utile pour le « podcasting ».
Le paramètre facultatif rootpage
indique que les nouveaux messages de ce
blog seront des sous-pages ?SubPages de "blog". Il active aussi
un formulaire en haut de la page du blog qui permet l'écriture de nouveaux
messages.
Si vous voulez que le blog possède une page d'archive, listant tous les messages déjà envoyés, voici ce qu'il faut faire :
[[!inline pages="blog/* and !*/Discussion" archive="yes"]]
Vous pouvez même créer une liste de toutes les pages du wiki, les plus récentes en tête, comme cela :
[[!inline pages="* and !*/Discussion" archive="yes"]]
Vous pouvez aussi ajouter des pages à un blog donné en les étiquetant. Pour
étiqueter une page, il suffit de la lier à une ou plusieurs pages qui
représentent cette étiquette. Puis, il faut utiliser une spécification
?PageSpec avec la fonction spéciale link()
pour trouver toutes les
pages correspondant à cette étiquette.
[[!inline pages="link(rugby)"]]
Vous pouvez aussi inclure certaines étiquettes et en exclure d'autres :
[[!inline pages="link(debian) and !link(social)"]]
Usage
Il est possible d'utiliser beaucoup de paramètres avec la directive
inline
. Voici les plus communs :
pages
- Une spécification ?PageSpec des pages à relier.show
- Indique le nombre maximun de pages correspondantes à relier. Par défaut, ce nombre vaut 10 sauf pour l'archivage où toutes les pages sont reliées. La valeur 0 permet d'afficher toutes les pages correspondantes.archive
- Quand ce paramètre vaut "yes", on ne liste que le titre des pages et certaines métadonnées, pas tout le contenu des pages.description
- donne le nom du flux RSS créé. Par défaut, c'est le nom du wiki.skip
- Indique un nombre de pages à ne pas afficher. C'est utile pour produire un flux qui ne montre que les pages archivées.postform
- Quand ce paramètre vaut "yes", le formulaire qui permet de créer de nouvelles pages sur un blog est activé.postformtext
- Spécifie le texte affiché par le formulaire.rootpage
- Active le formulaire et indique l'endroit où les nouveaux messages seront placés, en donnant la page dont ils seront des sous-pages.
Voici quelques paramètres moins nécessaires :
actions
- Quand ce paramètre vaut "yes", des liens permettant la modification et la discussion sont ajoutés au bas des pages reliées plutôt qu'en haut.rss
- Contrôler la création d'un flux RSS. Si le wiki est configuré par défaut pour créer des flux rss, le mettre à "no" désactive la création de flux. Si le wiki est configuré avec l'optionallowrss
, le mettre à "yes" active la création de flux rss.atom
- Contrôler la création d'un flux Atom. Si le wiki est configuré par défaut pour créer des flux Atom, le mettre à "no" désactive la création de flux. Si le wiki est configuré avec l'optionallowatom
, le mettre à "yes" active la création de flux Atom.feeds
- Contrôler la création de tout type de flux. Le mettre à "no" pour désactiver la création de flux.emptyfeeds
- Mettre ce paramètre à "no" pour désactiver toute création de flux vides. N'a aucun effet si le paramètrerootpage
ou le paramètrepostform
est activé.id
- Set to specify the value of the HTMLid
attribute for the feed links or the post form. Useful if you have multiple forms in the same page.template
- Specifies the template to fill out to display each inlined page. By default theinlinepage
template is used, while thearchivepage
template is used for archives. Set this parameter to use some other, custom template, such as thetitlepage
template that only shows post titles or themicroblog
template, optimised for microblogging. Note that you should still setarchive=yes
if your custom template does not include the page content.raw
- Rather than the default behavior of creating a blog, if raw is set to "yes", the page will be included raw, without additional markup around it, as if it were a literal part of the source of the inlining page.sort
- Controls how inlined pages are ?sorted. The default is to sort the newest created pages first.reverse
- If set to "yes", causes the sort order to be reversed.feedshow
- Specify the maximum number of matching pages to include in the rss/atom feeds. The default is the same as theshow
value above.feedonly
- Only generate the feed, do not display the pages inline on the page.quick
- Build archives in quick mode, without reading page contents for metadata. This also turns off generation of any feeds.timeformat
- Use this to specify how to display the time or date for pages in the blog. The format string is passed to the strftime(3) function.feedpages
- A ?PageSpec of inlined pages to include in the rss/atom feeds. The default is the same as thepages
value above, and only pages matched by that value are included, but some of those can be excluded by specifying a tighter ?PageSpec here.guid
- If a URI is given here (perhaps a UUID prefixed withurn:uuid:
), the Atom feed will have this as its<id>
. The default is to use the URL of the page containing theinline
directive.feedfile
- Can be used to change the name of the file generated for the feed. This is particularly useful if a page contains multiple feeds. For example, set "feedfile=feed" to cause it to generatepage/feed.atom
and/orpage/feed.rss
. This option is not supported if the wiki is configured not to useusedirs
.pagenames
- If given instead ofpages
, this is interpreted as a space-separated list of absolute page names (?LinkingRules are not taken into account), and they are inlined in exactly the order given: thesort
andpages
parameters cannot be used in conjunction with this one.trail
- If set to "yes" and the trail plugin is enabled, turn the inlined pages into a trail with next/previous links, by passing the same options to trailitems. Theskip
andshow
options are ignored by the trail, so the next/previous links traverse through all matching pages.