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" limit="10" rootpage="blog"]]

Any pages that match the specified PageSpec (in the example, any SubPage of "blog") will be part of the blog, and the newest 10 of them will appear in the page. Note that if files that are not pages match the PageSpec, they will be included in the feed using RSS enclosures, which is useful for simple podcasting; for fuller-featured podcast feeds, enclose media files in blog posts using meta.

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.
  • limit - Specify the maximum number of matching pages to inline. Default is 10, unless archiving, when the default is to show all. Set to 0 to show all matching pages. In older versions of IkiWiki this parameter was called show, which also still works.
  • 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.
  • title - Sets the title of the rss feed if one is generated. Defaults to the name of the page.
  • 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'option allowrss, 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'option allowatom, 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ètre rootpage ou le paramètre postform est activé.
  • id - Set to specify the value of the HTML id 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 the inlinepage template is used, while the archivepage template is used for archives. Set this parameter to use some other, custom template, such as the titlepage template that only shows post titles or the microblog template, optimised for microblogging. Note that you should still set archive=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, and if pages were created in the same commit, sort them by the name of the page (equivalent to sort="age title").
  • reverse - If set to "yes", causes the sort order to be reversed.
  • feedlimit - Specify the maximum number of matching pages to include in the rss/atom feeds. The default is the same as the limit value above. In older versions of IkiWiki this parameter was called feedshow, which also still works.
  • 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 the pages 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 with urn:uuid:), the Atom feed will have this as its <id>. The default is to use the URL of the page containing the inline 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 generate page/feed.atom and/or page/feed.rss. This option is not supported if the wiki is configured not to use usedirs.
  • pagenames - If given instead of pages, 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: the sort and pages 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. The skip and limit options are ignored by the trail, so the next/previous links traverse through all matching pages.