<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>trail</title> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="stylesheet" href="../style.css" type="text/css" /> <link rel="stylesheet" href="../local.css" type="text/css" /> </head> <body> <div class="page"> <div class="pageheader"> <div class="header"> <span> <span class="parentlinks"> <a href="../index.html">ikiwiki</a>/ <a href="../plugins.html">plugins</a>/ </span> <span class="title"> trail </span> </span> </div> </div> <div id="pagebody"> <div id="content" role="main"> <p><span class="infobox"> Plugin: trail<br /> Author: <span class="createlink">Simon McVittie</span><br /> Included in ikiwiki: yes<br /> Enabled by default: no<br /> Included in <a href="./goodstuff.html">goodstuff</a>: no<br /> Currently enabled: no<br /> </span></p> <p>This plugin provides the <a href="../ikiwiki/directive/trailoptions.html">trailoptions</a>, <a href="../ikiwiki/directive/traillink.html">traillink</a>, <a href="../ikiwiki/directive/trailitem.html">trailitem</a>, and <a href="../ikiwiki/directive/trailitems.html">trailitems</a> <a href="../ikiwiki/directive.html">directives</a>.</p> <p>It's sometimes useful to have "trails" of pages in a wiki where each page links to the next and/or previous page. For instance, you could use this for a guided tour, sequence of chapters, or sequence of blog posts.</p> <p>In this plugin, a trail is represented by a page, and the pages in the trail are indicated by specially marked links within that page, or by including groups of pages with a <a href="../ikiwiki/directive.html">directive</a>.</p> <p>If using the default <code>page.tmpl</code>, each page automatically displays the trails that it's a member of (if any), with links to the trail and to the next and previous members. HTML <code><link></code> tags with the <code>prev</code>, <code>next</code> and <code>up</code> relations are also generated.</p> <p>The <a href="../ikiwiki/directive/trailoptions.html">trailoptions</a> directive sets options for the entire trail.</p> <p>Pages can be included in a trail in various ways:</p> <ul> <li><p>The <a href="../ikiwiki/directive/inline.html">inline</a> directive with <code>trail="yes"</code> sets up an <a href="./inline.html">inline</a>, and at the same time adds the matching pages (from <code>pages</code> or <code>pagenames</code>) to the trail. One use is to navigate through all posts in a blog:</p> <pre><code>[[!inline pages="page(./posts/*) and !*/Discussion" archive=yes feedshow=10 quick=yes trail=yes]] </code></pre> <p>This only works if the trail and <a href="http://ikiwiki.info/plugins/inline/">inline</a> plugins are both enabled.</p></li> <li><p>The <a href="../ikiwiki/directive/trailitems.html">trailitems</a> directive has optional <code>pages</code> and <code>pagenames</code> options which behave the same as in <a href="./inline.html">inline</a>, but don't produce any output in the page, so you can have trails that don't list all their pages.</p></li> <li><p>The <a href="../ikiwiki/directive/traillink.html">traillink</a> directive makes a visible link and also adds the linked page to the trail. This will typically be used in a bullet list, but could also be in paragraph text:</p> <pre><code>* [[!traillink Introduction]] * [[!traillink "Chapter 1"]] * [[!traillink Chapter_2]] * [[!traillink Appendix_A]] </code></pre> <p>or</p> <pre><code>To use this software you must [[!traillink install]] it, [[!traillink configuration text="configure it"]], and finally [[!traillink running|run_it]]. </code></pre> <p>This also counts as a <a href="../ikiwiki/wikilink.html">WikiLink</a> for things like the <code>link()</code> <a href="../ikiwiki/pagespec.html">PageSpec</a> item.</p></li> <li><p>The <a href="../ikiwiki/directive/trailitem.html">trailitem</a> directive adds a page to the trail like <code>traillink</code>, but produces an invisible link, rather like <code>[[!tag ]]</code>:</p> <pre><code>To use this software you must [[!traillink install]] it, [[!trailitem installing_from_packages]] [[!trailitem installing_from_source]] [[!traillink configuration text="configure it"]], and finally [[!traillink running|run_it]]. [[!trailitem troubleshooting]] </code></pre> <p>Like <code>[[!tag ]]</code>, this still counts as a <a href="../ikiwiki/wikilink.html">WikiLink</a> even though there's no visible link.</p></li> </ul> <p>You can mix several of these directives in one page. The resulting trail will contain all of the pages matched by any of the directives, in the same order that the directives appear (unless you use the <code>sort</code> or <code>reverse</code> options on <code>[[!trailoptions ]]</code>).</p> </div> </div> <div id="footer" class="pagefooter" role="contentinfo"> <div id="pageinfo"> <div class="tags"> Tags: <a href="./type/chrome.html" rel="tag">type/chrome</a> </div> <div id="backlinks"> Links: <a href="./contrib/album.html">contrib/album</a> <a href="./write.html">write</a> </div> <div class="pagedate"> Last edited <span class="date">Tue Feb 26 23:01:54 2019</span> <!-- Created <span class="date">Tue Feb 26 23:01:54 2019</span> --> </div> </div> <!-- from ikiwiki --> </div> </div> </body> </html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
d8544620e4ac7bee48ddb48c85d55709
>
files
>
412
