X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/ffc99f5904934e6e7532bb8cfdebb44ad9ecd913..29cb940f7765dddd46f97b218a2a1f2446e2a27c:/doc/plugins/write/tutorial.mdwn diff --git a/doc/plugins/write/tutorial.mdwn b/doc/plugins/write/tutorial.mdwn index 94b72c763..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 ]] + [[!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=@_; @@ -98,7 +98,7 @@ And let's change the `preprocess` sub to use it: Feel free to try it out with a simple page like this: - [[fib ]], [[fib ]], [[fib ]], [[fib ]], [[fib ]] + [[!fib ]], [[!fib ]], [[!fib ]], [[!fib ]], [[!fib ]] Looks like it works ok, doesn't it? That creates a page that lists: @@ -139,7 +139,7 @@ Ok, one more enhancement. Just incrementing the numbers is pretty boring. It would be nice to be able to jump directly to a given point in the sequence: - \[[fib seed=20]], [[fib ]], [[fib ]] + \[[!fib seed=20]], [[!fib ]], [[!fib ]] Just insert these lines of code inside `preprocess`, in the appropriate spot: