summaryrefslogtreecommitdiff
path: root/doc/plugins/write
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/write
parent9867806c13b97c0f4ce1850ee4d43c6fe3a926e7 (diff)
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/write')
-rw-r--r--doc/plugins/write/tutorial.mdwn10
1 files changed, 5 insertions, 5 deletions
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=@_;