summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/aggregate.mdwn4
-rw-r--r--doc/plugins/brokenlinks.mdwn4
-rw-r--r--doc/plugins/calendar.mdwn2
-rw-r--r--doc/plugins/conditional.mdwn14
-rw-r--r--doc/plugins/inline.mdwn4
-rw-r--r--doc/plugins/linkmap.mdwn2
-rw-r--r--doc/plugins/map.mdwn2
-rw-r--r--doc/plugins/mdwn.mdwn2
-rw-r--r--doc/plugins/orphans.mdwn4
-rw-r--r--doc/plugins/pagecount.mdwn8
-rw-r--r--doc/plugins/postsparkline.mdwn4
-rw-r--r--doc/plugins/rst.mdwn2
-rw-r--r--doc/plugins/sidebar.mdwn12
-rw-r--r--doc/plugins/tag.mdwn2
-rw-r--r--doc/plugins/testpagespec.mdwn13
-rw-r--r--doc/plugins/write.mdwn33
-rw-r--r--doc/plugins/write/tutorial.mdwn8
17 files changed, 61 insertions, 59 deletions
diff --git a/doc/plugins/aggregate.mdwn b/doc/plugins/aggregate.mdwn
index 398da4b5e..d224516df 100644
--- a/doc/plugins/aggregate.mdwn
+++ b/doc/plugins/aggregate.mdwn
@@ -12,8 +12,8 @@ That example aggregates posts from the specified RSS feed, updating no
more frequently than once every 15 minutes, and puts a page per post under
the example/ directory in the wiki.
-You can then use ikiwiki's [[blog]] support to create a blog of one or more
-aggregated feeds.
+You can then use ikiwiki's [[ikiwiki/blog]] support to create a blog of one or
+more aggregated feeds.
## setup
diff --git a/doc/plugins/brokenlinks.mdwn b/doc/plugins/brokenlinks.mdwn
index 69aa54086..23fa04d7c 100644
--- a/doc/plugins/brokenlinks.mdwn
+++ b/doc/plugins/brokenlinks.mdwn
@@ -5,8 +5,8 @@ This plugin generates a list of broken links on pages in the wiki. This is
a useful way to find pages that still need to be written, or links that
are written wrong.
-The optional parameter "pages" can be a [[PageSpec]] specifying the pages
-to search for broken links, default is search them all.
+The optional parameter "pages" can be a [[ikiwiki/PageSpec]] specifying the
+pages to search for broken links, default is search them all.
If this plugin is turned on, here's a list of broken links on this wiki:
diff --git a/doc/plugins/calendar.mdwn b/doc/plugins/calendar.mdwn
index 99e2ab126..784e949a0 100644
--- a/doc/plugins/calendar.mdwn
+++ b/doc/plugins/calendar.mdwn
@@ -33,7 +33,7 @@ the given time frame.
* `type` - Used to specify the type of calendar wanted. Can be one of
"month" or "year". The default is a month view calendar.
-* `pages` - Specifies the [[PageSpec]] of pages to link to from the
+* `pages` - Specifies the [[ikiwiki/PageSpec]] of pages to link to from the
month calendar. Defaults to "*".
* `archivebase` - Configures the base of the archives hierarchy. The
default is "archives". Note that this default can also be overridden
diff --git a/doc/plugins/conditional.mdwn b/doc/plugins/conditional.mdwn
index ba1cf9bb2..7a230fbae 100644
--- a/doc/plugins/conditional.mdwn
+++ b/doc/plugins/conditional.mdwn
@@ -15,17 +15,17 @@ The `then` and `else` values can include any markup that would be allowed
in the wiki page outside the template. Triple-quoting the values even allows
quotes to be included.
-The `test` is a [[PageSpec]]; if it matches any page in the wiki then it
-succeeds. So you can do things like testing for the existence of a page or
-pages, testing to see if any pages were created in a given month, and so
-on.
+The `test` is a [[ikiwiki/PageSpec]]; if it matches any page in the wiki
+then it succeeds. So you can do things like testing for the existence of a
+page or pages, testing to see if any pages were created in a given month,
+and so on.
-If you want the [[PageSpec]] to only match against the page that
+If you want the [[ikiwiki/PageSpec]] to only match against the page that
contains the conditional, rather than matching against all pages in the
wiki, set the "all" parameter to "no".
-The regular [[PageSpec]] syntax is expanded with the following additional
-tests:
+The regular [[ikiwiki/PageSpec]] syntax is expanded with the following
+additional tests:
* enabled(plugin)
diff --git a/doc/plugins/inline.mdwn b/doc/plugins/inline.mdwn
index d0d4eb66a..fc6f9e8af 100644
--- a/doc/plugins/inline.mdwn
+++ b/doc/plugins/inline.mdwn
@@ -1,10 +1,10 @@
[[template id=plugin name=inline core=1 author="[[Joey]]"]]
-This is a [[PreProcessorDirective]] that allows including one wiki page
+This is a [[ikiwiki/PreProcessorDirective]] that allows including one wiki page
inside another. For example:
\[[inline pages="blog/*"]]
The most common use of inlining is generating blogs and RSS or Atom feeds.
-See [[blog]] for details.
+See [[ikiwiki/blog]] for details.
diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn
index e85f1bde6..6cd23b5cb 100644
--- a/doc/plugins/linkmap.mdwn
+++ b/doc/plugins/linkmap.mdwn
@@ -17,7 +17,7 @@ wiki a bit slow.
Here are descriptions of all the supported parameters to the `linkmap`
directive:
-* `pages` - A [[PageSpec]] of the pages to map.
+* `pages` - A [[ikiwiki/PageSpec]] of the pages to map.
* `height`, `width` - Limit the size of the map to a given height and width,
in inches. Both must be specified for the limiting to take effect, otherwise
the map's size is not limited.
diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 7afc915d6..44ce9edd4 100644
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -9,7 +9,7 @@ If the pages to include are not specified, all pages (and other files) in
the wiki are mapped.
Hint: To limit the map to displaying pages less than a certain level deep,
-use a [[PageSpec]] like this: `pages="* and !*/*/*"`
+use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"`
[[if test="enabled(map)" then="""
Here's an example map, for the plugins section of this wiki:
diff --git a/doc/plugins/mdwn.mdwn b/doc/plugins/mdwn.mdwn
index c4de0cff9..c7c0ac7ce 100644
--- a/doc/plugins/mdwn.mdwn
+++ b/doc/plugins/mdwn.mdwn
@@ -2,7 +2,7 @@
[[tag type/format]]
This plugin lets ikwiki convert files with names ending in ".mdwn" to html.
-It uses the [[markdown]] minimal markup language.
+It uses the [[ikiwiki/markdown]] minimal markup language.
This is the standard markup language used by ikiwiki, although some others
are also available in other plugins.
diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn
index f40a4a1b9..798a5c8c2 100644
--- a/doc/plugins/orphans.mdwn
+++ b/doc/plugins/orphans.mdwn
@@ -4,8 +4,8 @@
This plugin generates a list of possibly orphaned pages -- pages that no
other page links to.
-The optional parameter "pages" can be a [[PageSpec]] specifying the pages
-to check for orphans, default is search them all.
+The optional parameter "pages" can be a [[ikiwiki/PageSpec]] specifying the
+pages to check for orphans, default is search them all.
Note that it takes [[BackLinks]] into account, but does not count inlining a
page as linking to it, so will generally count many blog-type pages as
diff --git a/doc/plugins/pagecount.mdwn b/doc/plugins/pagecount.mdwn
index 34b871262..9a9768277 100644
--- a/doc/plugins/pagecount.mdwn
+++ b/doc/plugins/pagecount.mdwn
@@ -1,11 +1,11 @@
[[template id=plugin name=pagecount author="[[Joey]]"]]
[[tag type/meta]]
-Provides a \\[[pagecount ]] [[PreProcessorDirective]] that is replaced with
-the total number of pages currently in the wiki.
+Provides a \\[[pagecount ]] [[ikiwiki/PreProcessorDirective]] that is
+replaced with the total number of pages currently in the wiki.
-The optional parameter "pages" can be a [[PageSpec]] specifying the pages
-to count, default is to count them all.
+The optional parameter "pages" can be a [[ikiwiki/PageSpec]] specifying the
+pages to count, default is to count them all.
This plugin is included in ikiwiki, but is not enabled by default.
diff --git a/doc/plugins/postsparkline.mdwn b/doc/plugins/postsparkline.mdwn
index d799f0a0c..d716022e1 100644
--- a/doc/plugins/postsparkline.mdwn
+++ b/doc/plugins/postsparkline.mdwn
@@ -21,8 +21,8 @@ options are passed on to the sparkline plugin.
You don't need to specify any data points (though you can if you want to).
Instead, data points are automatically generated based on the creation
-times of pages matched by the specified `pages` [[PageSpec]]. A maximum of
-`max` data points will be generated.
+times of pages matched by the specified `pages` [[ikiwiki/PageSpec]]. A
+maximum of `max` data points will be generated.
The `formula` parameter controls the formula used to generate data points.
Available forumlae:
diff --git a/doc/plugins/rst.mdwn b/doc/plugins/rst.mdwn
index 1f8073517..6a6606f20 100644
--- a/doc/plugins/rst.mdwn
+++ b/doc/plugins/rst.mdwn
@@ -11,7 +11,7 @@ ikiwiki. Limitations include:
* There are issues with inserting raw html into documents, as ikiwiki
does with [[WikiLinks|WikiLink]] and many
- [[PreprocessorDirectives|PreprocessorDirective]].
+ [[PreprocessorDirectives|ikiwiki/PreprocessorDirective]].
So while you may find this useful for importing old files into your wiki,
using this as your main markup language in ikiwiki isn't recommended at
diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn
index 7e0ad5cf6..fd792400e 100644
--- a/doc/plugins/sidebar.mdwn
+++ b/doc/plugins/sidebar.mdwn
@@ -6,13 +6,13 @@ The content of the sidebar is simply the content of a page named
"sidebar" (ie, create a "sidebar.mdwn").
Typically this will be a page in the root of the wiki, but it can also be a
-[[SubPage]]. In fact, this page, [[plugins/sidebar|plugins/sidebar]], will
-be treated as a sidebar for the [[plugins]] page, and of all of its
-SubPages, if the plugin is enabled.
+[[ikiwiki/SubPage]]. In fact, this page,
+[[plugins/sidebar|plugins/sidebar]], will be treated as a sidebar for the
+[[plugins]] page, and of all of its SubPages, if the plugin is enabled.
-Note that to disable a sidebar for a [[SubPage]] of a page that has a sidebar,
-you can create a sidebar page that is completely empty. This will turn off
-the sidebar altogether.
+Note that to disable a sidebar for a [[ikiwiki/SubPage]] of a page that has
+a sidebar, you can create a sidebar page that is completely empty. This
+will turn off the sidebar altogether.
Warning: Any change to the sidebar will cause a rebuild of the whole wiki,
since every page includes a copy that has to be updates. This can
diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index caffaa692..98990973b 100644
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -6,7 +6,7 @@ This plugin allows tagging pages. List tags as follows:
\[[tag tech life linux]]
The tags work the same as if you had put a (hidden) [[WikiLink]] on the page
-for each tag, so you can use a [[PageSpec]] match all pages that are
+for each tag, so you can use a [[ikiwiki/PageSpec]] match all pages that are
tagged with a given tag, for example. The tags will also show up on blog
entries and at the bottom of the tagged pages, as well as in RSS and Atom
feeds.
diff --git a/doc/plugins/testpagespec.mdwn b/doc/plugins/testpagespec.mdwn
index 3d35d70ad..9a13ab590 100644
--- a/doc/plugins/testpagespec.mdwn
+++ b/doc/plugins/testpagespec.mdwn
@@ -1,22 +1,23 @@
[[template id=plugin name=testpagespec author="[[Joey]]"]]
[[tag type/useful]]
-This plugin allows testing a [[PageSpec]] to see if it matches a page, and
-to see the part that matches, or causes the match to fail.
+This plugin allows testing a [[ikiwiki/PageSpec]] to see if it matches a
+page, and to see the part that matches, or causes the match to fail.
Example uses:
\[[testpagespec pagespec="foopage and barpage" match="foopage"]]
-This will print out something like "no match: barpage does not match foopage",
-highlighting which part of the [[PageSpec]] is causing the match to fail.
+This will print out something like "no match: barpage does not match
+foopage", highlighting which part of the [[ikiwiki/PageSpec]] is causing
+the match to fail.
\[[testpagespec pagespec="foopage or !bar*" match="barpage"]]
This will print out something like "no match: bar* matches barpage", since
-the part of the [[PageSpec]] that fails is this negated match.
+the part of the [[ikiwiki/PageSpec]] that fails is this negated match.
\[[testpagespec pagespec="foopage or barpage" match="barpage"]]
This will print out something like "match: barpage matches barpage",
-indicating the part of the [[PageSpec]] that caused it to match.
+indicating the part of the [[ikiwiki/PageSpec]] that caused it to match.
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index beaa25125..3ed0a3017 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -101,8 +101,8 @@ make arbitrary changes. The function is passed named parameters "page",
### preprocess
-Adding a [[PreProcessorDirective]] is probably the most common use of a
-plugin.
+Adding a [[ikiwiki/PreProcessorDirective]] is probably the most common use
+of a plugin.
hook(type => "preprocess", id => "foo", call => \&preprocess);
@@ -126,11 +126,11 @@ the hook modifies data in `%links`. Note that doing so will make the hook
be run twice per page build, so avoid doing it for expensive hooks.
Note that if the [[htmlscrubber]] is enabled, html in
-[[PreProcessorDirective]] output is sanitised, which may limit what your
-plugin can do. Also, the rest of the page content is not in html format at
-preprocessor time. Text output by a preprocessor directive will be
-linkified and passed through markdown (or whatever engine is used to htmlize
-the page) along with the rest of the page.
+[[ikiwiki/PreProcessorDirective]] output is sanitised, which may limit what
+your plugin can do. Also, the rest of the page content is not in html
+format at preprocessor time. Text output by a preprocessor directive will
+be linkified and passed through markdown (or whatever engine is used to
+htmlize the page) along with the rest of the page.
### htmlize
@@ -351,9 +351,10 @@ cleanup.
Note that while any plugin can use this for a fatal error, plugins should
try to avoid dying on bad input, as that will halt the entire wiki build
-and make the wiki unusable. So for example, if a [[PreProcessorDirective]]
-is passed bad parameters, it's better to return an error message, which can
-appear on the wiki page, rather than calling error().
+and make the wiki unusable. So for example, if a
+[[ikiwiki/PreProcessorDirective]] is passed bad parameters, it's better to
+return an error message, which can appear on the wiki page, rather than
+calling error().
#### `template($;@)`
@@ -368,12 +369,12 @@ page created from it. (Ie, it appends ".html".)
#### `add_depends($$)`
-Makes the specified page depend on the specified [[PageSpec]].
+Makes the specified page depend on the specified [[ikiwiki/PageSpec]].
#### `pagespec_match($$;@)`
-Passed a page name, and [[PageSpec]], returns true if the [[PageSpec]]
-matches the page.
+Passed a page name, and [[ikiwiki/PageSpec]], returns true if the
+[[ikiwiki/PageSpec]] matches the page.
Additional named parameters can be passed, to further limit the match.
The most often used is "location", which specifies the location the
@@ -386,7 +387,7 @@ Given a page and the text of a link on the page, determine which
existing page that link best points to. Prefers pages under a
subdirectory with the same name as the source page, failing that
goes down the directory tree to the base looking for matching
-pages, as described in [[SubPage/LinkingRules]].
+pages, as described in [[ikiwiki/SubPage/LinkingRules]].
#### `htmllink($$$;@)`
@@ -514,9 +515,9 @@ See [[RCS_details|rcs/details]] for some more info.
## PageSpec plugins
It's also possible to write plugins that add new functions to
-[[PageSpecs|PageSpec]]. Such a plugin should add a function to the
+[[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the
IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
-how it will be accessed in a [[PageSpec]]. The function will be passed
+how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
two parameters: The name of the page being matched, and the thing to match
against. It may also be passed additional, named parameters. It should return
a IkiWiki::SuccessReason object if the match succeeds, or an
diff --git a/doc/plugins/write/tutorial.mdwn b/doc/plugins/write/tutorial.mdwn
index b4705fe31..8c2e986b8 100644
--- a/doc/plugins/write/tutorial.mdwn
+++ b/doc/plugins/write/tutorial.mdwn
@@ -39,10 +39,10 @@ register hooks that ikiwiki will call later.
}
This has hooked our plugin into the preprocess hook, which ikiwiki uses to
-expand [[PreprocessorDirectives|preprocessordirective]]. Notice that "fib"
-has shown up again. It doesn't actually have to match the module name this
-time, but it generally will. This "fib" is telling ikiwiki what kind of
-PreprocessorDirective to handle, namely one that looks like this:
+expand [[PreprocessorDirectives|ikiwiki/preprocessordirective]]. Notice
+that "fib" has shown up again. It doesn't actually have to match the module
+name this time, but it generally will. This "fib" is telling ikiwiki what
+kind of PreprocessorDirective to handle, namely one that looks like this:
[[fib ]]