]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/write.mdwn
style.css: Use relative, not absolute font sizes. Thanks, Giuseppe Bilotta.
[ikiwiki.git] / doc / plugins / write.mdwn
index a2b954bd43115677d23680e77d3e219cdc88c15e..10b4df835f9fde4eac70f6980727fbad8a7aa562 100644 (file)
@@ -198,8 +198,8 @@ value is ignored.
 
        hook(type => "filter", id => "foo", call => \&filter);
 
-Runs on the raw source of a page, before anything else touches it, and can
-make arbitrary changes. The function is passed named parameters "page",
+Runs on the full raw source of a page, before anything else touches it, and
+can make arbitrary changes. The function is passed named parameters "page",
 "destpage", and "content". It should return the filtered content.
 
 ### preprocess
@@ -595,7 +595,17 @@ describes the plugin as a whole. For example:
        hook(type => "genwrapper", id => "foo", call => \&genwrapper);
 
 This hook is used to inject C code (which it returns) into the `main`
-function of the ikiwiki wrapper when it is being generated.
+function of the ikiwiki wrapper when it is being generated. 
+
+The code runs before anything else -- in particular it runs before
+the suid wrapper has sanitized its environment.
+
+### disable
+
+       hook(type => "disable", id => "foo", call => \&disable);
+
+This hook is only run when a previously enabled plugin gets disabled
+during ikiwiki setup. Plugins can use this to perform cleanups.
 
 ## Exported variables
 
@@ -1108,7 +1118,7 @@ The data structure returned for each change is:
        {
                rev => # the RCSs id for this commit
                user => # user who made the change (may be an openid),
-               usershort => # short name of user (optional; not an openid),
+               nickname => # short name for user (optional; not an openid),
                
                committype => # either "web" or the name of the rcs,
                when => # time when the change was made,