aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-08-25 14:19:39 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-08-25 14:19:39 -0400
commitd6fd1f1cc878b5dffdfae30f6dfee77c235c438e (patch)
treeae0e8d689bec3a0471385864056d68b6629427f7 /doc/plugins
parent9867806c13b97c0f4ce1850ee4d43c6fe3a926e7 (diff)
downloadikiwiki-d6fd1f1cc878b5dffdfae30f6dfee77c235c438e.tar
ikiwiki-d6fd1f1cc878b5dffdfae30f6dfee77c235c438e.tar.gz
rename preprocessordirective to directive
Reasons include: - easier to type - might want postprocessor directives again sometime, and listdirectives can then use the directive/* files for either - that it's done as a preprocessor step is an internal detail (and not a very accurate one, really :-)
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/creole.mdwn2
-rw-r--r--doc/plugins/edittemplate.mdwn2
-rw-r--r--doc/plugins/inline.mdwn2
-rw-r--r--doc/plugins/listdirectives.mdwn11
-rw-r--r--doc/plugins/meta/discussion.mdwn2
-rw-r--r--doc/plugins/pagecount.mdwn2
-rw-r--r--doc/plugins/rst.mdwn2
-rw-r--r--doc/plugins/txt.mdwn2
-rw-r--r--doc/plugins/write.mdwn6
-rw-r--r--doc/plugins/write/tutorial.mdwn10
10 files changed, 26 insertions, 15 deletions
diff --git a/doc/plugins/creole.mdwn b/doc/plugins/creole.mdwn
index ed347e2c5..4b0adb4f1 100644
--- a/doc/plugins/creole.mdwn
+++ b/doc/plugins/creole.mdwn
@@ -12,5 +12,5 @@ wiki markup formats, so should be fairly easy to guess at. There is also a
[CheatSheet](http://www.wikicreole.org/wiki/CheatSheet).
Links are standard [[WikiLinks|ikiwiki/WikiLink]]. Links and
-[[ikiwiki/PreProcessorDirectives]] inside `{{{ }}}` blocks are still expanded,
+[[ikiwiki/directives]] inside `{{{ }}}` blocks are still expanded,
since this happens before the creole format is processed.
diff --git a/doc/plugins/edittemplate.mdwn b/doc/plugins/edittemplate.mdwn
index a68f7f0a1..674bdc863 100644
--- a/doc/plugins/edittemplate.mdwn
+++ b/doc/plugins/edittemplate.mdwn
@@ -3,7 +3,7 @@
This plugin allows registering template pages, that provide default
content for new pages created using the web frontend. To register a
-template, insert a [[Preprocessor_Directive|/ikiwiki/preprocessordirective]] on some other page.
+template, insert a [[ikiwiki/directive]] on some other page.
\[[!edittemplate template="bugtemplate" match="bugs/*"]]
diff --git a/doc/plugins/inline.mdwn b/doc/plugins/inline.mdwn
index e66c9103f..1ea401c6a 100644
--- a/doc/plugins/inline.mdwn
+++ b/doc/plugins/inline.mdwn
@@ -1,6 +1,6 @@
[[!template id=plugin name=inline core=1 author="[[Joey]]"]]
-This is a [[ikiwiki/PreProcessorDirective]] that allows including one wiki page
+This is a [[ikiwiki/directive]] that allows including one wiki page
inside another. For example:
\[[!inline pages="blog/*"]]
diff --git a/doc/plugins/listdirectives.mdwn b/doc/plugins/listdirectives.mdwn
new file mode 100644
index 000000000..3645813b8
--- /dev/null
+++ b/doc/plugins/listdirectives.mdwn
@@ -0,0 +1,11 @@
+[[!template id=plugin name=listdirectives author="Will"]]
+[[!tag type/meta]]
+
+This plugin generates a list of available
+[[directives|ikiwiki/directive]].
+
+ \[[!listdirectives]]
+
+Each directive links to a wiki page with the same name. The location of the
+pages in the wiki can be controlled via the `directive_description_dir`
+setting in the setup file.
diff --git a/doc/plugins/meta/discussion.mdwn b/doc/plugins/meta/discussion.mdwn
index 8388a1172..814b93a41 100644
--- a/doc/plugins/meta/discussion.mdwn
+++ b/doc/plugins/meta/discussion.mdwn
@@ -11,7 +11,7 @@ Now I've work-arounded it using apostrophes in another way
--[[Paweł|ptecza]]
-> As with any other parameter in a [[ikiwiki/preprocessordirective]], you can
+> As with any other parameter in a [[ikiwiki/directive]], you can
> triple-quote, and then include quotation marks inside. --[[Joey]]
>> Thanks for the hint! Toggle plugin is probably my favourite ikiwiki
diff --git a/doc/plugins/pagecount.mdwn b/doc/plugins/pagecount.mdwn
index 790f033ca..84a02c3f1 100644
--- a/doc/plugins/pagecount.mdwn
+++ b/doc/plugins/pagecount.mdwn
@@ -1,7 +1,7 @@
[[!template id=plugin name=pagecount author="[[Joey]]"]]
[[!tag type/meta]]
-Provides a \\[[!pagecount ]] [[ikiwiki/PreProcessorDirective]] that is
+Provides a \\[[!pagecount ]] [[ikiwiki/directive]] that is
replaced with the total number of pages currently in the wiki.
The optional parameter "pages" can be a [[ikiwiki/PageSpec]] specifying the
diff --git a/doc/plugins/rst.mdwn b/doc/plugins/rst.mdwn
index b415ecdb9..9355597ac 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|ikiwiki/WikiLink]] and many
- [[PreprocessorDirectives|ikiwiki/PreprocessorDirective]].
+ preprocessor [[directives|ikiwiki/directive]].
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/txt.mdwn b/doc/plugins/txt.mdwn
index c27728929..1b7e7821b 100644
--- a/doc/plugins/txt.mdwn
+++ b/doc/plugins/txt.mdwn
@@ -9,6 +9,6 @@ txt files is done; the file contents is displayed to the user as-is,
with html markup characters such as ">" escaped.
The only exceptions are that [[WikiLinks|WikiLink]] and
-[[PreprocessorDirectives|PreprocessorDirective]] are still expanded by
+[[directives|directive]] are still expanded by
ikiwiki, and that, if the [[!cpan URI::Find]] perl module is installed, URLs
in the txt file are converted to hyperlinks.
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index b9601ea57..cde0b50fd 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -123,7 +123,7 @@ make arbitrary changes. The function is passed named parameters "page",
### preprocess
-Adding a [[ikiwiki/PreProcessorDirective]] is probably the most common use
+Adding a preprocessor [[ikiwiki/directive]] is probably the most common use
of a plugin.
hook(type => "preprocess", id => "foo", call => \&preprocess);
@@ -158,7 +158,7 @@ can assume it's being run in scan mode, and avoid doing expensive things at
that point.)
Note that if the [[htmlscrubber]] is enabled, html in
-[[ikiwiki/PreProcessorDirective]] output is sanitised, which may limit what
+preprocessor [[ikiwiki/directive]] 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
@@ -500,7 +500,7 @@ function that is called after the error message is printed, to do any final
cleanup.
If called inside a preprocess hook, error() does not abort the entire
-wiki build, but instead replaces the [[ikiwiki/PreProcessorDirective]] with
+wiki build, but instead replaces the preprocessor [[ikiwiki/directive]] with
a version containing the error message.
In other hooks, error() is a fatal error, so use with care. Try to avoid
diff --git a/doc/plugins/write/tutorial.mdwn b/doc/plugins/write/tutorial.mdwn
index 5b810a18f..2823c47b7 100644
--- a/doc/plugins/write/tutorial.mdwn
+++ b/doc/plugins/write/tutorial.mdwn
@@ -5,9 +5,9 @@ What should the plugin do? Let's make it calculate and output the Fibonacci
sequence. To output the next number in the sequence, all a user has to do
is write this on a wiki page:
- [[!fib ]]
+ [[!fib]]
-When the page is built, the [[ikiwiki/PreProcessorDirective]] will be
+When the page is built, the [[ikiwiki/directive]] will be
replaced by the next number in the sequence.
Most of ikiwiki's plugins are written in Perl, and it's currently easiest
@@ -39,16 +39,16 @@ register hooks that ikiwiki will call later.
}
This has hooked our plugin into the preprocess hook, which ikiwiki uses to
-expand [[PreprocessorDirectives|ikiwiki/preprocessordirective]]. Notice
+expand preprocessor [[directives|ikiwiki/directive]]. 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:
+kind of preprocessor directive to handle, namely one that looks like this:
[[!fib ]]
Notice the `\&preprocess`? This is how you pass a reference to a function,
and the `preprocess` function is the one that ikiwiki will call to expand
-the PreprocessorDirective. So, time to write that function:
+the preprocessor directive. So, time to write that function:
sub preprocess {
my %params=@_;