Die inline-Anweisung wird durch die inline-Erweiterung bereitgestellt.

Diese Anweisung erlaubt das Einbinden einer Wiki-Seite in eine andere. Die häufigste Verwendung ist das Erzeugen von Blogs und RSS- oder Atom-Feeds.

Beispiel:

[[!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.

Der optionale Parameter rootpage teilt dem Wiki mit, dass neue Einträge in diesem Blog Unterseiten von "blog" sein sollen; in diesem Fall wird ein Formular zum Hinzufügen neuer Beiträge am Anfang der Seite angezeigt.

Wenn es zu einem Blog eine Archivseite mit allen bisherigen Einträgen geben soll, kann dies wie folgt erreicht werden:

[[!inline  pages="blog/* and !*/Discussion" archive="yes"]]

Mit dem folgenden Code kann man sogar eine automatisch erzeugte Liste mit allen Seiten des Wikis erstellen (die neuesten erscheinen oben):

[[!inline  pages="* and !*/Discussion" archive="yes"]]

Es ist auch möglich, dass Seiten durch das Hinzufügen eines Tags Teil des Blogs werden. Hierzu kann auf der betreffenden Seite einfach ein Link auf die Seite (oder die Seiten) erstellt, die die Tags repräsentieren. Dann kann die spezielle link()-PageSpec verwendet werden, um alle Seiten mit einem gegebenen Tag zu erfassen:

[[!inline  pages="link(life)"]]

Es ist auch möglich, bestimmte Tags inzuschließen, während andere ausgeschlossen werden:

[[!inline  pages="link(debian) and !link(social)"]]

Verwendung

Es gibt viele Parameter, die man mit der inline-Anweisung verwenden kann. Dies sind die am häufigsten benutzten:

• pages - Eine PageSpec der einzubindenden Seiten.
• 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 - Hat dieser Parameter den Wert yes, werden nur der Titel und einige Metadaten angezeigt, aber nicht der komplette Inhalt.
• title - Sets the title of the rss feed if one is generated. Defaults to the name of the page.
• description - Setzt die Beschreibung des RSS-Feeds, wenn einer erzeugt wird. Voreingestellt ist der Name des Wikis.
• skip - Gibt die Anzahl von Seiten an, die bei der Anzeige übersprungen werden. Dies kann nützlich sein, um einen Feed zu erstellen, der nur archivierte Seiten enthält.
• postform - Bei dem Wert yes, wird ein Formular zum Erstellen neuer Einträge in dem Blog angezeigt.
• postformtext - Gibt an, welcher Text im 'postform' angezeigt wird.
• rootpage - Aktiviert postform und erlaubt gleichzeitig die Kontrolle darüber, wo neu erstellte Seiten landen sollen, indem eine Seite angegeben wird, deren Unterseite die neuen Seiten werden sollen.

Hier sind einige weniger häufig benötigte Parameter:

• actions - Wenn yes, füge Links zum Bearbeiten und zur Diskussion am unteren Ende jeder eingebundenen Seite ein (wenn sie im Kopf der jeweiligen Seite angezeigt werden würden).
• rss - Steuert die Erzeugung eines RSS-Feeds. Wenn das Wiki so konfiguriert ist, dass es standardmäßig RSS-Feeds erzeugt, kann dies durch den Wert no verhindert werden. Wenn das Wiki RSS erlaubt (allowrss in der Konfigurationsdatei), dann kann der RSS-Feed mit yes aktiviert werden.
• atom - Steuert die Erzeugung eines Atom-Feeds. Wenn das Wiki so konfiguriert ist, dass es standardmäßig Atom-Feeds erzeugt, kann dies durch den Wert no verhindert werden. Wenn das Wiki Atom erlaubt (allowatom in der Konfigurationsdatei), dann kann der Atom-Feed mit yes aktiviert werden.
• feeds - Steuert die Erzeugung aller Feed-Typen. Ein Wert von no unterdrückt alle Feeds.
• emptyfeeds - Bei no werden keine leeren Feeds erzeugt. Dies hat keine Auswirkung, wenn rootpage oder postform aktiv sind.
• 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.