web commit by joey

[www/ikiwiki.git] / doc / plugins / write.mdwn

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index e09ca35104303cb0afdf326f2406d8f9317413cd..c4f668373024d2a18fce28ed264c4c412e8e89a9 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -27,11 +27,10 @@ ikiwiki. The function takes four parameters:
 
 ## Writing a [[PreProcessorDirective]]
 
-For preprocessor commands, the subroutine is passed named parameters. A
-"page" parameter gives the name of the page that embedded the preprocessor
-command. All parameters included in the preprocessor command are included
+For preprocessor directives, the subroutine is passed named parameters. A
+"page" parameter gives the name of the page that embedded the preprocessor directive. All parameters included in the directive are included
 as named parameters as well. Whatever the subroutine returns goes onto the
-page in place of the command.
+page in place of the directive.
 
 ## Error handing in plugins
 
@@ -45,7 +44,7 @@ return the error message as the output of the plugin.
 Note that if [[HTMLSanitization]] 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.
+preprocessor time. Text output by a preprocessor directive will be passed through markdown along with the rest of the page.
 
 ## Wiki configuration
 
@@ -59,9 +58,9 @@ If your plugin needs to access data about other pages in the wiki. It can
 use the following hashes, using a page name as the key:
 
 * `%IkiWiki::links` lists the names of each page
-  that is linked to from that page in an array reference.
+  that a page links to, in an array reference.
 * `%IkiWiki::pagemtime` contains the last modification time of each page
-* `%IkiWiki::pagectime` contains the creation time of each page`
+* `%IkiWiki::pagectime` contains the creation time of each page
 * `%IkiWiki::renderedfiles` contains the name of the file rendered by a
   page
 * `%IkiWiki::pagesources` contains the name of the source file for a page.