summaryrefslogtreecommitdiff
path: root/doc/plugins/contrib
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-05-21 14:59:21 -0400
committerJoey Hess <joey@gnu.kitenet.net>2009-05-21 14:59:21 -0400
commitfb955a49456545774e8d434049e76c7231e28194 (patch)
tree1afb414a3a6dfa43b5fa2a2b141372f7ee80fd0c /doc/plugins/contrib
parent285ef010c440a4c83093fbf0d2ac922849a873a4 (diff)
add contrib plugin page for postal plugin
Diffstat (limited to 'doc/plugins/contrib')
-rw-r--r--doc/plugins/contrib/postal.mdwn39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/plugins/contrib/postal.mdwn b/doc/plugins/contrib/postal.mdwn
new file mode 100644
index 000000000..b14c80d3b
--- /dev/null
+++ b/doc/plugins/contrib/postal.mdwn
@@ -0,0 +1,39 @@
+[[!template id=plugin name=postal author="[[DavidBremner]]"]]
+[[!tag type/useful]]
+
+The `postal` plugin allows users to send mail to
+a special address to comment on a page. It uses the [[mailbox]]
+plugin to display their comments in the wiki.
+
+This plugin is not in ikiwiki yet, but can be downloaded
+from <http://pivot.cs.unb.ca/git/ikipostal.git>
+
+Details:
+
+ * Adds a mailto: url to each page matching some pagespec
+ (currently every page gets a comment footer)
+
+ * This mailto url goes to an address identifying the page (something like
+ user-iki-blog~I\_hate\_markdown@host.fqdn.tld).
+ [more details](http://www.cs.unb.ca/~bremner/blog/posts/encoding)
+
+ * on the mail receiving end, these messages are either deleted, or ran through
+ a filter to be turned into blog posts. As a first step, I have
+[written](http://pivot.cs.unb.ca/git/?p=ikipostal.git;a=blob_plain;f=filters/postal-filer.pl;hb=010357a08e9)
+a filter that decodes the address and writes the message into an appropriate
+mailbox. I would be interested in any ideas people have about security.
+
+ * the same plugin can check for comments on a particular page next time the wiki
+ is generated, and add a link. (more or less done)
+ > If the filter just checks in the posts into revision control, the
+ > post-commit hook would handle updating the wiki to include those
+ > posts as they come in. --[[Joey]]
+ * work in progress can be
+
+ - [cloned](http://pivot.cs.unb.ca/git/ikipostal.git), or
+ - [browsed](http://pivot.cs.unb.ca/git/?p=ikipostal.git;a=summary)
+
+The current version of this plugin is now running on my home page. See for example
+[a recent post in my blog](http://www.cs.unb.ca/~bremner/blog/posts/can-i-haz-a-distributed-rss/).
+Unfortunately although the [[mailbox|todo/mbox]] renderer supports threading, I haven't had
+a chance to implement comments on comments yet. --[[DavidBremner]]