From 285ef010c440a4c83093fbf0d2ac922849a873a4 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 21 May 2009 14:51:57 -0400 Subject: add contrib plugin page for the mailbox plugin --- doc/plugins/contrib/mailbox.mdwn | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 doc/plugins/contrib/mailbox.mdwn (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/mailbox.mdwn b/doc/plugins/contrib/mailbox.mdwn new file mode 100644 index 000000000..b7a9f81c7 --- /dev/null +++ b/doc/plugins/contrib/mailbox.mdwn @@ -0,0 +1,18 @@ +[[!template id=plugin name=mailbox author="[[DavidBremner]]"]] +[[!tag type/format]] + +The `mailbox` plugin adds support to ikiwiki for +rendering mailbox file into a page displaying the mails +in the mailbox. It supports mbox, maildir, and MH folders, +does threading, and deals with MIME. + +One hitch I noticed was that it is not currently possible to treat a +maildir or an MH directory as a page (i.e. just call it foo.mh and have it +transformed to page foo). I'm not sure if this is possible and worthwhile +to fix. It is certainly workable to use a [[!mailbox ]] directive. +-- [[DavidBremner]] + +This plugin is not in ikiwiki yet, but can be downloaded +from + + -- cgit v1.2.3 From fb955a49456545774e8d434049e76c7231e28194 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 21 May 2009 14:59:21 -0400 Subject: add contrib plugin page for postal plugin --- doc/plugins/contrib/postal.mdwn | 39 +++++++++++++++++++++++++++++++ doc/todo/comment_by_mail.mdwn | 52 +---------------------------------------- 2 files changed, 40 insertions(+), 51 deletions(-) create mode 100644 doc/plugins/contrib/postal.mdwn (limited to 'doc/plugins/contrib') 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 + +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]] diff --git a/doc/todo/comment_by_mail.mdwn b/doc/todo/comment_by_mail.mdwn index bf934176a..87e57417e 100644 --- a/doc/todo/comment_by_mail.mdwn +++ b/doc/todo/comment_by_mail.mdwn @@ -1,53 +1,3 @@ I would like to allow comments on ikiwiki pages without CGI. -I have in mind something like - * Use a pagetemplate hook - in a plugin (DONE) - * add 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). (DONE) - [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) - - -Any comments? Write them here or send them to [[DavidBremner]] - -> I don't want to derail this with too much blue-skying, but I was thinking -> earlier that it would be nice if ikiwiki could do something sensible with -> mailbox files, such as turning them into a (threaded?) blog display. -> -> One reason I was thinking about that was just that it would be nice to -> be able to use ikiwiki for mailing list archives. But another reason was -> that it would be nice to solve the problem described in -> [[discussion_page_as_blog]]. For that you really want a threaded system, -> and mailbox file formats already have threading. -> -> If that were done, it would tie into what you're working on in an -> interesting way, since the incoming mail would only need to be committed to -> the appropriate mailbox file, with ikiwiki then running to process it. -> --[[Joey]] ->> It is an interesting idea. I like that it uses an arbitrary MUA ->> as a "moderation" interface. After I killed a debian BTS entry with ->> clumsy pseudoheader editing I think any ->> reference info should also be encoded into the address. - -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]] +> [[done]], see [[plugins/contrib/postal]] -- cgit v1.2.3 From e7bad274894fec38e03f99f54aa73586729e6798 Mon Sep 17 00:00:00 2001 From: bremner Date: Thu, 21 May 2009 15:54:55 -0400 Subject: update postal plugin page to reflect the fact I implement Joey's suggestion about checking new posts in to VCS --- doc/plugins/contrib/postal.mdwn | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/postal.mdwn b/doc/plugins/contrib/postal.mdwn index b14c80d3b..b2f875393 100644 --- a/doc/plugins/contrib/postal.mdwn +++ b/doc/plugins/contrib/postal.mdwn @@ -18,21 +18,17 @@ Details: [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]] + a filter to be turned into blog posts. I have +[written](http://pivot.cs.unb.ca/git/?p=ikipostal.git;a=blob_plain;f=filters/postal-accept.pl;hb=HEAD) + a filter that decodes the address and writes the message into an appropriate +mailbox. The changes are then checked into version control; typically a hook then updates the html version of the wiki. * 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) + * I would be interested in any ideas people have about security. + 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 -- cgit v1.2.3 From 3c68de2e1786d75f2dc4610163a881116958ac30 Mon Sep 17 00:00:00 2001 From: "http://dr.jones.dk/" Date: Mon, 25 May 2009 18:29:16 -0400 Subject: Mention bug#530574: improved po4a Markdown support --- doc/plugins/contrib/po.mdwn | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/po.mdwn b/doc/plugins/contrib/po.mdwn index 5b33f6716..265f37fd2 100644 --- a/doc/plugins/contrib/po.mdwn +++ b/doc/plugins/contrib/po.mdwn @@ -423,3 +423,5 @@ daring a timid "please pull"... or rather, please review again :) >> --[[intrigeri]] >> >>> Did you get a chance to? --[[Joey]] + +Related to this is [bug#530574](http://bugs.debian.org/530574) with improved po4a Markdown support. -- [[JonasSmedegaard]] -- cgit v1.2.3 From 817a40b7812d8bb5eacf2d0a265ef175ac74e1ea Mon Sep 17 00:00:00 2001 From: "http://dr.jones.dk/" Date: Thu, 28 May 2009 04:13:33 -0400 Subject: Move po4a patch note up close to "translated basewiki", and expand with note on danish translation. --- doc/plugins/contrib/po.mdwn | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/po.mdwn b/doc/plugins/contrib/po.mdwn index 265f37fd2..364d8e6b2 100644 --- a/doc/plugins/contrib/po.mdwn +++ b/doc/plugins/contrib/po.mdwn @@ -153,6 +153,14 @@ Any thoughts on this? >> basewiki, which seems like it should be pretty easy to do, and would be >> a great demo! --[[Joey]] >> +>>> I have a complete translation of basewiki into danish, and am working with +>>> others on preparing one in german. For a complete translated user +>>> experience, however, you will also need templates translated (there are a few +>>> translatable strings there too). My not-yet-merged po4a Markdown improvements +>>> (see [bug#530574](http://bugs.debian.org/530574)) correctly handles multiple +>>> files in a single PO which might be relevant for template translation handling. +>>> --[[JonasSmedegaard]] +>> >>> I've merged your changes into my own branch, and made great >>> progress on the various todo items. Please note my repository >>> location has changed a few days ago, my user page was updated @@ -423,5 +431,3 @@ daring a timid "please pull"... or rather, please review again :) >> --[[intrigeri]] >> >>> Did you get a chance to? --[[Joey]] - -Related to this is [bug#530574](http://bugs.debian.org/530574) with improved po4a Markdown support. -- [[JonasSmedegaard]] -- cgit v1.2.3 From e90adc56c38ebac42baddd05d68c9590465498ae Mon Sep 17 00:00:00 2001 From: "http://dr.jones.dk/" Date: Thu, 28 May 2009 13:20:52 -0400 Subject: Mention need for localized templates, and separation of system and page locales. --- doc/plugins/contrib/po.mdwn | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/po.mdwn b/doc/plugins/contrib/po.mdwn index 364d8e6b2..51dca4bf4 100644 --- a/doc/plugins/contrib/po.mdwn +++ b/doc/plugins/contrib/po.mdwn @@ -431,3 +431,21 @@ daring a timid "please pull"... or rather, please review again :) >> --[[intrigeri]] >> >>> Did you get a chance to? --[[Joey]] + + * As discussed at [[todo/l10n]] the templates needs to be translatable too. They + should be treated properly by po4a using the markdown option - at least with my + later patches in [bug#530574](http://bugs.debian.org/530574)) applied. + + * It seems to me that the po plugin (and possibly other parts of ikiwiki) wrongly + uses gettext. As I understand it, gettext (as used currently in ikiwiki) always + lookup a single language, That might make sense for a single-language site, but + multilingual sites should emit all strings targeted at the web output in each own + language. + + So generally the system language (used for e.g. compile warnings) should be separated + from both master language and slave languages. + + Preferrably the gettext subroutine could be extended to pass locale as optional + secondary parameter overriding the default locale (for messages like "N/A" as + percentage in po plugin). Alternatively (with above mentioned template support) + all such strings could be externalized as templates that can then be localized. -- cgit v1.2.3 From f902bedd322b1e64d50444d21c2b753240d7dc01 Mon Sep 17 00:00:00 2001 From: intrigeri Date: Wed, 3 Jun 2009 18:31:41 +0200 Subject: po: fixed one of the last Joey's concerns Signed-off-by: intrigeri --- doc/plugins/contrib/po.mdwn | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/po.mdwn b/doc/plugins/contrib/po.mdwn index 51dca4bf4..665e48343 100644 --- a/doc/plugins/contrib/po.mdwn +++ b/doc/plugins/contrib/po.mdwn @@ -391,6 +391,9 @@ daring a timid "please pull"... or rather, please review again :) >>> "discussion". Also, I consider `$config{cgi}` and `%links` (etc) >>> documented parts of the plugin interface, which won't change; po could >>> rely on them to avoid this minor problem. --[[Joey]] +>>>> +>>>> Done in my branch. --[[intrigeri]] +>>>> > > * Is there any real reason not to allow removing a translation? > I'm imagining a spammy translation, which an admin might not -- cgit v1.2.3 From 2e48da19a29d6c06dbdb8c1e0a00a2c3528cf8ee Mon Sep 17 00:00:00 2001 From: "http://lj.rossia.org/users/imz/" Date: Thu, 4 Jun 2009 10:53:15 -0400 Subject: Reporting minor problems with cvonnecting to the remote repo. --- doc/plugins/contrib/mailbox/discussion.mdwn | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 doc/plugins/contrib/mailbox/discussion.mdwn (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/mailbox/discussion.mdwn b/doc/plugins/contrib/mailbox/discussion.mdwn new file mode 100644 index 000000000..00fb0c05f --- /dev/null +++ b/doc/plugins/contrib/mailbox/discussion.mdwn @@ -0,0 +1,5 @@ +# The remote repo + +For some reason, `git fetch` from http://pivot.cs.unb.ca/git/ikimailbox.git/ didn't work very smoothly for me: it hung, and I had to restart it 3 times before the download was complete. + +I'm writing this just to let you know that there might be some problems with such connections to your http-server. --Ivan Z. -- cgit v1.2.3 From 62bec4f47b6c447f38428bfeaf19d383b43ed922 Mon Sep 17 00:00:00 2001 From: "http://lj.rossia.org/users/imz/" Date: Fri, 5 Jun 2009 14:50:53 -0400 Subject: Added a keyword to the description, so that this plugin can be found by searching. --- doc/plugins/contrib/headinganchors.mdwn | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/headinganchors.mdwn b/doc/plugins/contrib/headinganchors.mdwn index c80cc0b49..0b007f00e 100644 --- a/doc/plugins/contrib/headinganchors.mdwn +++ b/doc/plugins/contrib/headinganchors.mdwn @@ -1,6 +1,6 @@ [[!template id=plugin name=headinganchors author="[[PaulWise]]"]] -This is a simple plugin to add ids to all headings, based on their text. It +This is a simple plugin to add ids (which will server as [[ikiwiki/anchor]]s) to all headings, based on their text. It works as a postprocessing filter, allowing it to work on mdwn, wiki, html, rst and any other format that produces html. The code is available here: -- cgit v1.2.3 From 91edfd285126e832812e027cea60b87f808cb4aa Mon Sep 17 00:00:00 2001 From: "http://lj.rossia.org/users/imz/" Date: Fri, 5 Jun 2009 14:55:27 -0400 Subject: A suggestion to simply extract/merge this functionality from/with another plugin. --- doc/plugins/contrib/headinganchors/discussion.mdwn | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/plugins/contrib/headinganchors/discussion.mdwn (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/headinganchors/discussion.mdwn b/doc/plugins/contrib/headinganchors/discussion.mdwn new file mode 100644 index 000000000..a5e4dd54f --- /dev/null +++ b/doc/plugins/contrib/headinganchors/discussion.mdwn @@ -0,0 +1 @@ +Isn't this functionality a part of what [[plugins/toc]] needs and does? Then probably the [[plugins/toc]] plugin's code could be split into the part that implements the [[plugins.contrib/headinganchors]]'s functionality and the TOC generation itself. That will bring more order into the code and the set of available plugins. --Ivan Z. -- cgit v1.2.3 From 30d23b969ea85a4a4472d6c64d3e99060b79d7f3 Mon Sep 17 00:00:00 2001 From: "http://lj.rossia.org/users/imz/" Date: Fri, 5 Jun 2009 14:56:41 -0400 Subject: Fixed a wikilink target. --- doc/plugins/contrib/headinganchors/discussion.mdwn | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/headinganchors/discussion.mdwn b/doc/plugins/contrib/headinganchors/discussion.mdwn index a5e4dd54f..91fe04a6d 100644 --- a/doc/plugins/contrib/headinganchors/discussion.mdwn +++ b/doc/plugins/contrib/headinganchors/discussion.mdwn @@ -1 +1 @@ -Isn't this functionality a part of what [[plugins/toc]] needs and does? Then probably the [[plugins/toc]] plugin's code could be split into the part that implements the [[plugins.contrib/headinganchors]]'s functionality and the TOC generation itself. That will bring more order into the code and the set of available plugins. --Ivan Z. +Isn't this functionality a part of what [[plugins/toc]] needs and does? Then probably the [[plugins/toc]] plugin's code could be split into the part that implements the [[plugins/contrib/headinganchors]]'s functionality and the TOC generation itself. That will bring more order into the code and the set of available plugins. --Ivan Z. -- cgit v1.2.3 From df20a91bc9efe48cb96ecb7efd39643a816dd489 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Fri, 5 Jun 2009 16:24:46 -0400 Subject: move anchor page out of ikiwiki subdir Since this page is not in the basewiki, it is confusing to put it in the ikiwiki subdir, which is intended for basewiki and other underlay pages that are used to document ikiwiki on other wikis. --- doc/anchor.mdwn | 3 +++ doc/ikiwiki/anchor.mdwn | 3 --- doc/ikiwiki/wikilink/discussion.mdwn | 4 ++-- doc/plugins/contrib/headinganchors.mdwn | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) create mode 100644 doc/anchor.mdwn delete mode 100644 doc/ikiwiki/anchor.mdwn (limited to 'doc/plugins/contrib') diff --git a/doc/anchor.mdwn b/doc/anchor.mdwn new file mode 100644 index 000000000..012e52fa0 --- /dev/null +++ b/doc/anchor.mdwn @@ -0,0 +1,3 @@ +ikiwiki works with anchors in various situations. + +This page accumulates links to the concept of anchors. diff --git a/doc/ikiwiki/anchor.mdwn b/doc/ikiwiki/anchor.mdwn deleted file mode 100644 index 012e52fa0..000000000 --- a/doc/ikiwiki/anchor.mdwn +++ /dev/null @@ -1,3 +0,0 @@ -ikiwiki works with anchors in various situations. - -This page accumulates links to the concept of anchors. diff --git a/doc/ikiwiki/wikilink/discussion.mdwn b/doc/ikiwiki/wikilink/discussion.mdwn index ac32834b2..b146c9447 100644 --- a/doc/ikiwiki/wikilink/discussion.mdwn +++ b/doc/ikiwiki/wikilink/discussion.mdwn @@ -1,6 +1,6 @@ -# Creating an [[ikiwiki/anchor]] in Markdown +# Creating an [[anchor]] in Markdown -Is it a native Markdown "tag" for creating an [[ikiwiki/anchor]]? Unfortunately, +Is it a native Markdown "tag" for creating an [[anchor]]? Unfortunately, I haven't any information about it at [Markdown syntax](http://daringfireball.net/projects/markdown/syntax) page. diff --git a/doc/plugins/contrib/headinganchors.mdwn b/doc/plugins/contrib/headinganchors.mdwn index 0b007f00e..becbf89a5 100644 --- a/doc/plugins/contrib/headinganchors.mdwn +++ b/doc/plugins/contrib/headinganchors.mdwn @@ -1,6 +1,6 @@ [[!template id=plugin name=headinganchors author="[[PaulWise]]"]] -This is a simple plugin to add ids (which will server as [[ikiwiki/anchor]]s) to all headings, based on their text. It +This is a simple plugin to add ids (which will serve as [[anchor]]s) to all headings, based on their text. It works as a postprocessing filter, allowing it to work on mdwn, wiki, html, rst and any other format that produces html. The code is available here: -- cgit v1.2.3