summaryrefslogtreecommitdiff
path: root/doc/plugins/write.mdwn
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2009-01-19 19:44:39 +0100
committerintrigeri <intrigeri@boum.org>2009-01-19 19:44:39 +0100
commita3726968bc13f19f458c372cbd7cf92ae4c6fce5 (patch)
tree9c0d302b2dd1b452a8849a8a74c414b69e8dccde /doc/plugins/write.mdwn
parent14b49376dc03672f896e5f1df3945a718a39d5a0 (diff)
make checkcontent compatible with hooks that need the full content
Always pass the full (modified) content in `content` named parameter. When the user edits an existing wiki page, also pass a `diff` named parameter, which includes only the lines that they added to the page, or modified. Signed-off-by: intrigeri <intrigeri@boum.org>
Diffstat (limited to 'doc/plugins/write.mdwn')
-rw-r--r--doc/plugins/write.mdwn5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index ef14f18db..7ba01ae53 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -368,8 +368,9 @@ the content the user has entered is a comment, it may also be passed some
additional parameters: `author`, `url`, and `subject`. The `subject`
parameter may also be filled with the user's comment about the change.
-Note: When the user edits an existing wiki page, the passed `content` will
-include only the lines that they added to the page, or modified.
+Note: When the user edits an existing wiki page, this hook is also
+passed a `diff` named parameter, which will include only the lines
+that they added to the page, or modified.
The hook should return `undef` on success. If the content is disallowed, it
should return a message stating what the problem is, or a function