Merge commit 'smcv/htmlbalance'

diff --git a/doc/plugins/contrib/htmlbalance.mdwn b/doc/plugins/contrib/htmlbalance.mdwn
new file mode 100644 (file)
index 0000000..728e6af
--- /dev/null
+++ b/doc/plugins/contrib/htmlbalance.mdwn
@@ -0,0 +1,12 @@
+[[!template id=plugin name=htmlbalance author="[[Simon_McVittie|smcv]]"]]
+[[!tag type/html]]
+
+This plugin ensures that the HTML emitted by ikiwiki contains well-balanced
+HTML tags, by parsing it with [[!cpan HTML::TreeBuilder]] and re-serializing it. This
+acts as a lighter-weight alternative to [[plugins/htmltidy]]; it doesn't
+ensure validity, but it does at least ensure that formatting from a
+blog post pulled in by the [[ikiwiki/directive/inline]] directive doesn't
+leak into the rest of the page.
+
+htmlbalance is available from the 'htmlbalance' branch in [[smcv]]'s git repository.
+I'd like to get this plugin included in ikiwiki - any code review is welcome.

diff --git a/doc/plugins/contrib/postcomment.mdwn b/doc/plugins/contrib/postcomment.mdwn
new file mode 100644 (file)
index 0000000..9875fea
--- /dev/null
+++ b/doc/plugins/contrib/postcomment.mdwn
@@ -0,0 +1,55 @@
+[[!template id=plugin name=postcomment author="[[Simon_McVittie|smcv]]"]]
+[[!tag type/useful]]
+
+This plugin adds "blog-style" comments. The intention is that on a non-wiki site
+(like a blog) you can lock all pages for admin-only access, then allow otherwise
+unprivileged (or perhaps even anonymous) users to comment on posts.
+
+Comments are saved as internal pages, so they can never be edited through the CGI,
+only by direct committers. Currently, comments are always in [[ikiwiki/markdown]].
+Directives and raw HTML are filtered out by default, and comment authorship should
+hopefully be unforgeable by CGI users.
+
+When comments have been enabled generally, you still need to mark which pages
+can have comments, by including the `\[[!postcomment]]` directive in them. By default,
+this directive expands to a "post a comment" link plus an `\[[!inline]]` with
+the comments.
+
+The plugin adds a new [[ikiwiki/PageSpec]] match type, `postcomment`, for use
+with `anonok_pagespec` from the [[plugins/anonok]] plugin or `locked_pages` from
+the [[plugins/lockedit]] plugin. Typical usage would be something like:
+
+    locked_pages => "!postcomment(*)"
+
+to allow non-admin users to comment on pages, but not edit anything. You can also do
+
+    anonok_pages => "postcomment(*)"
+
+to allow anonymous comments (the IP address will be used as the "author").
+
+Optional parameters to the postcomment directive:
+
+* `commit=no`: by default, comments are committed to version control. Use this to
+  disable commits.
+* `allowhtml=yes`: by default, raw HTML is filtered out. Use this to allow HTML
+  (you should enable [[plugins/htmlscrubber]] and either [[plugins/htmltidy]] or
+  [[plugins/contrib/htmlbalance]] if you do this).
+* `allowdirectives=yes`: by default, IkiWiki directives are filtered out. Use this
+  to allow directives (avoid enabling any [[plugins/type/slow]] directives if you
+  do this).
+* `closed=yes`: use this to prevent new comments while still displaying existing ones.
+* `atom`, `rss`, `feeds`, `feedshow`, `timeformat`, `feedonly`: the same as for [[plugins/inline]]
+
+This plugin aims to close the [[todo]] item "[[todo/supporting_comments_via_disussion_pages]]",
+and is currently available from [[smcv]]'s git repository on git.pseudorandom.co.uk.
+
+Known issues:
+
+* Needs code review
+* The access control via postcomment() is rather strange
+* There is some common code cargo-culted from other plugins (notably inline and editpage) which
+  should probably be shared
+* If the postcomment directive is removed from a page, comments can still be made on that page,
+  and will be committed but not displayed; to disable comments properly you have to set the
+  closed="yes" directive parameter (and refresh the wiki), *then* remove the directive if
+  desired

diff --git a/doc/todo/supporting_comments_via_disussion_pages.mdwn b/doc/todo/supporting_comments_via_disussion_pages.mdwn
index e0495c8c25e16d5d0c81882f9a0eb3831d630ecf..88effdfd51eb4fd3d42d6c18a57d1a051218e2dc 100644 (file)
--- a/doc/todo/supporting_comments_via_disussion_pages.mdwn
+++ b/doc/todo/supporting_comments_via_disussion_pages.mdwn
@@ -213,3 +213,5 @@ do you think so far? Known issues include:
   un-wikiish).
 
 --[[smcv]]
+
+I've updated smcvpostcomment and publicised it as [[plugins/contrib/postcomment]]. --[[smcv]]

diff --git a/doc/users/smcv.mdwn b/doc/users/smcv.mdwn
index 33ae450b24de704c8cc6b6ec80856138bc9155c8..c1cc62a81d3f1a8f66d052b8a8d56a0a64ea73d1 100644 (file)
--- a/doc/users/smcv.mdwn
+++ b/doc/users/smcv.mdwn
@@ -1 +1,10 @@
-I'm trying to add enough features/fix enough bugs to convert [smcv.pseudorandom.co.uk](http://smcv.pseudorandom.co.uk/) from Django + Python + misc hacks to ikiwiki.
+Website: [pseudorandom.co.uk](http://www.pseudorandom.co.uk/)
+
+Blog: [smcv.pseudorandom.co.uk](http://smcv.pseudorandom.co.uk/)
+
+My repository containing ikiwiki branches:
+
+* gitweb: http://git.pseudorandom.co.uk/smcv/ikiwiki.git
+* anongit: git://git.pseudorandom.co.uk/git/smcv/ikiwiki.git
+
+I'm working on the [[plugins/contrib/htmlbalance]] and [[plugins/contrib/postcomment]] plugins.