aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/contrib
diff options
context:
space:
mode:
authorSimon McVittie <smcv@debian.org>2012-03-18 17:01:45 +0000
committerSimon McVittie <smcv@debian.org>2012-03-18 17:01:45 +0000
commitdc3b9934d5660a085d9b5e041b7e8749493b9360 (patch)
treede7504672f148cf2476f82b11ed97e8fc4011d6d /doc/plugins/contrib
parent4e54fa1144065b7ff99e88e6c61ff1fdcf6175c9 (diff)
downloadikiwiki-dc3b9934d5660a085d9b5e041b7e8749493b9360.tar
ikiwiki-dc3b9934d5660a085d9b5e041b7e8749493b9360.tar.gz
Move trail out of the contrib directory in preparation for eventual merge
Diffstat (limited to 'doc/plugins/contrib')
-rw-r--r--doc/plugins/contrib/ikiwiki/directive/trailinline.mdwn11
-rw-r--r--doc/plugins/contrib/ikiwiki/directive/trailitem.mdwn9
-rw-r--r--doc/plugins/contrib/ikiwiki/directive/trailitems.mdwn24
-rw-r--r--doc/plugins/contrib/ikiwiki/directive/traillink.mdwn16
-rw-r--r--doc/plugins/contrib/ikiwiki/directive/trailoptions.mdwn18
-rw-r--r--doc/plugins/contrib/trail.mdwn133
6 files changed, 0 insertions, 211 deletions
diff --git a/doc/plugins/contrib/ikiwiki/directive/trailinline.mdwn b/doc/plugins/contrib/ikiwiki/directive/trailinline.mdwn
deleted file mode 100644
index 91d8a4edf..000000000
--- a/doc/plugins/contrib/ikiwiki/directive/trailinline.mdwn
+++ /dev/null
@@ -1,11 +0,0 @@
-The `trailinline` directive is provided by the
-[[!iki plugins/contrib/trail desc=trail]]
-plugin. It is equivalent to combining [[ikiwiki/directive/trailitems]] and
-[[ikiwiki/directive/inline]] directives with the same options.
-
-A typical use is to navigate through all posts in a blog:
-
- \[[!trailinline pages="page(./posts/*) and !*/Discussion" archive=yes
- feedshow=10 quick=yes]]
-
-[[!meta robots="noindex, follow"]]
diff --git a/doc/plugins/contrib/ikiwiki/directive/trailitem.mdwn b/doc/plugins/contrib/ikiwiki/directive/trailitem.mdwn
deleted file mode 100644
index 73b1985a5..000000000
--- a/doc/plugins/contrib/ikiwiki/directive/trailitem.mdwn
+++ /dev/null
@@ -1,9 +0,0 @@
-The `trailitem` directive is supplied by the
-[[!iki plugins/contrib/trail desc=trail]] plugin. It is used like this:
-
- \[[!trailitem some_other_page]]
-
-to add `some_other_page` to the trail represented by this page, without
-generating a visible hyperlink.
-
-[[!meta robots="noindex, follow"]]
diff --git a/doc/plugins/contrib/ikiwiki/directive/trailitems.mdwn b/doc/plugins/contrib/ikiwiki/directive/trailitems.mdwn
deleted file mode 100644
index 4106ed33b..000000000
--- a/doc/plugins/contrib/ikiwiki/directive/trailitems.mdwn
+++ /dev/null
@@ -1,24 +0,0 @@
-The `trailitems` directive is supplied by the
-[[!iki plugins/contrib/trail desc=trail]] plugin. It adds pages
-to the trail represented by the current page, without producing any output
-on that page.
-
- \[[!trailitems pages="posts/*" sort="age"]]
-
- \[[!trailitems pagenames="a b c"]]
-
-Options are similar to [[!iki ikiwiki/directive/inline desc=inline]]:
-
-* `pages`: adds pages that match a [[ikiwiki/PageSpec]] to the trail
- (cannot be used with `pagenames`)
-
-* `pagenames`: adds a space-separated list of pages to the trail,
- with the same [[ikiwiki/SubPage/LinkingRules]] as for a [[ikiwiki/WikiLink]]
- (cannot be used with `pages`)
-
-* `sort`: add the pages matched by `pages` to the trail in this
- [[ikiwiki/pagespec/sorting]] order (cannot be used with `pagenames`)
-
-* `reverse`: reverse the order of `sort` (cannot be used with `pagenames`)
-
-[[!meta robots="noindex, follow"]]
diff --git a/doc/plugins/contrib/ikiwiki/directive/traillink.mdwn b/doc/plugins/contrib/ikiwiki/directive/traillink.mdwn
deleted file mode 100644
index 0e40e2411..000000000
--- a/doc/plugins/contrib/ikiwiki/directive/traillink.mdwn
+++ /dev/null
@@ -1,16 +0,0 @@
-The `traillink` directive is supplied by the
-[[!iki plugins/contrib/trail desc=trail]]
-plugin. It generates a visible [[ikiwiki/WikiLink]], and also adds the
-linked page to the trail represented by the page containing the directive.
-
-In its simplest form, the first parameter is like the content of a WikiLink:
-
- \[[!traillink some_other_page]]
-
-The displayed text can also be overridden, either with a `|` symbol or with
-a `text` parameter:
-
- \[[!traillink Click_here_to_start_the_trail|some_other_page]]
- \[[!traillink some_other_page text="Click here to start the trail"]]
-
-[[!meta robots="noindex, follow"]]
diff --git a/doc/plugins/contrib/ikiwiki/directive/trailoptions.mdwn b/doc/plugins/contrib/ikiwiki/directive/trailoptions.mdwn
deleted file mode 100644
index e1603f11b..000000000
--- a/doc/plugins/contrib/ikiwiki/directive/trailoptions.mdwn
+++ /dev/null
@@ -1,18 +0,0 @@
-The `trailoptions` directive is supplied by the
-[[!iki plugins/contrib/trail desc=trail]] plugin. It sets options for the
-trail represented by this page.
-
- \[[!trailoptions sort="meta(title)" circular="no"]]
-
-Options available:
-
-* `sort`: sets a [[ikiwiki/pagespec/sorting]] order for the entire trail,
- overriding the order in which they were added
-
-* `reverse`: reverses the order of the trail
-
-* `circular`: if set to `yes` or `1`, the trail is made into a loop by
- making the last page's "next" link point to the first page, and the first
- page's "previous" link point to the last page
-
-[[!meta robots="noindex, follow"]]
diff --git a/doc/plugins/contrib/trail.mdwn b/doc/plugins/contrib/trail.mdwn
deleted file mode 100644
index bfd4d3d0b..000000000
--- a/doc/plugins/contrib/trail.mdwn
+++ /dev/null
@@ -1,133 +0,0 @@
-[[!tag patch]]
-[[!template id=gitbranch branch=smcv/trail3 author="[[smcv]]"]]
-
-Available from [[smcv]]'s git repository, in the `trail3` branch. This
-plugin aims to solve [[todo/wikitrails]] in a simpler way; it can also be
-used for [[navigation through blog posts|todo/Pagination_next_prev_links]].
-
-If you don't want to use a branch of ikiwiki, manual installation requires
-these files (use the "raw" link in gitweb to download):
-
-* [trail.pm](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/IkiWiki/Plugin/trail.pm)
- in an `IkiWiki/Plugin` subdirectory of your configured `plugindir`
-* [page.tmpl](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/templates/page.tmpl)
- and
- [trails.tmpl](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/templates/trails.tmpl)
- in your configured `templatedir`, or a `templates` subdirectory of your wiki repository
-* the trail-related bits from the end of the
- [stylesheet](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/doc/style.css)
- (put them in your local.css)
-* the trail-related bits at the end of the
- [actiontabs](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/themes/actiontabs/style.css)
- or [blueview/goldtype](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/themes/blueview/style.css)
- stylesheets, if you use one of those themes (again, put them in your local.css)
-
-The branch also includes [[todo/test_coverage]] machinery.
-
-Demo:
-
-* [in use on entries in my blog](http://smcv.pseudorandom.co.uk/)
-* [a demo trail based on links](http://demo.hosted.pseudorandom.co.uk/trail/)
-* [a demo hybrid trail/inline](http://demo.hosted.pseudorandom.co.uk/trail2/)
-
-The page `e` is in both demo trails, to demonstrate how a page in more than
-one trail looks.
-
-The `smcv/trail2` branch is an older version of `trail3` which used typed links
-as its data structure, resulting in timing-related limitations (it couldn't
-select pages for the trail by using pagespecs, because pagespecs can't be
-evaluated correctly until the scan stage has finished).
-
-Updated, November 2011:
-
-* reinstated `inline` integration ([[report]] integration would probably be
- pretty easy too, if this gets merged)
-* switched from typed links back to a custom data structure to avoid
- chicken/egg problems with ordering
-* create typed links too, as a side-effect, but not when using an inline
-* regression test with nearly full coverage
-* CSS for the default anti-theme and all built-in themes (it looks nicest
- in the default anti-theme and in actiontabs - the demo uses actiontabs)
-
-Known bugs:
-
-* the blueview and goldtype CSS nearly work, but the alignment is a bit off
-
-----
-
-[[!template id=plugin name=trail author="[[Simon_McVittie|smcv]]"]]
-[[!tag type/chrome]]
-
-This plugin provides the [[ikiwiki/directive/trailoptions]],
-[[ikiwiki/directive/traillink]], [[ikiwiki/directive/trailitem]],
-[[ikiwiki/directive/trailitems]]
-and [[ikiwiki/directive/trailinline]] [[directives|ikiwiki/directive]].
-
-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.
-
-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 [[ikiwiki/directive]].
-
-If using the default `page.tmpl`, 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 `<link>` tags with the `prev`,
-`next` and `up` relations are also generated.
-
-The [[ikiwiki/directive/trailoptions]] directive sets options for the
-entire trail.
-
-Pages can be included in a trail in various ways:
-
-* The [[ikiwiki/directive/trailinline]] directive sets up an [[inline]],
- and at the same time adds the matching pages (from `pages` or `pagenames`)
- to the trail. One use is to navigate through all posts in a blog:
-
- \[[!trailinline pages="page(./posts/*) and !*/Discussion" archive=yes
- feedshow=10 quick=yes]]
-
- This directive only works if the [[!iki plugins/inline desc=inline]]
- plugin is also enabled.
-
-* The [[ikiwiki/directive/trailitems]] directive has optional `pages` and
- `pagenames` options which behave the same as in [[inline]], but don't
- produce any output in the page, so you can have trails that don't list
- all their pages.
-
-* The [[ikiwiki/directive/traillink]] 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:
-
- * [[!traillink Introduction]]
- * [[!traillink "Chapter 1"]]
- * [[!traillink Chapter_2]]
- * [[!traillink Appendix_A]]
-
- or
-
- To use this software you must \[[!traillink install]] it,
- \[[!traillink configuration text="configure it"]],
- and finally \[[!traillink running|run_it]].
-
- This also counts as a [[ikiwiki/WikiLink]] for things like the `link()`
- [[ikiwiki/PageSpec]] item.
-
-* The [[ikiwiki/directive/trailitem]] directive adds a page to the trail
- like `traillink`, but produces an invisible link, rather like `\[[!tag]]`:
-
- 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]]
-
- Like `\[[!tag]]`, this still counts as a [[ikiwiki/WikiLink]] even though
- there's no visible link.
-
-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 `sort` or
-`reverse` options on `\[[!trailoptions]]`).