From 801c59b535e9a1501ac40e8ad2a0423d506c5276 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 30 Aug 2010 14:25:49 -0400 Subject: response --- doc/plugins/contrib/ymlfront/discussion.mdwn | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/ymlfront/discussion.mdwn b/doc/plugins/contrib/ymlfront/discussion.mdwn index b1fd65fff..bf9780048 100644 --- a/doc/plugins/contrib/ymlfront/discussion.mdwn +++ b/doc/plugins/contrib/ymlfront/discussion.mdwn @@ -4,3 +4,9 @@ Now that I have implemented a \[[!ymlfront ...]] directive, I would like to remo * it is non-standard Any objections? + +> Well, I don't have much standing since I have been too lame to integrate +> ymlfront into ikiwiki yet. Buy, my opinion is, I liked the old +> format of putting the YAML literally at the front of the file. It +> seemed to allow parsing the file as YAML, using any arbitrary YAML +> processer. And it was nice how it avoided boilerplate. --[[Joey]] -- cgit v1.2.3 From d085d1ac5db888e95de5a43f818a13570bc4771b Mon Sep 17 00:00:00 2001 From: "http://oblomov.myopenid.com/" Date: Mon, 30 Aug 2010 19:29:31 +0000 Subject: ymlfront vs MMD --- doc/plugins/contrib/ymlfront/discussion.mdwn | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/ymlfront/discussion.mdwn b/doc/plugins/contrib/ymlfront/discussion.mdwn index bf9780048..03af5e634 100644 --- a/doc/plugins/contrib/ymlfront/discussion.mdwn +++ b/doc/plugins/contrib/ymlfront/discussion.mdwn @@ -10,3 +10,9 @@ Any objections? > format of putting the YAML literally at the front of the file. It > seemed to allow parsing the file as YAML, using any arbitrary YAML > processer. And it was nice how it avoided boilerplate. --[[Joey]] + +>> The old delimited format also has the advantage of being remarkably similar to the +>> [MultiMarkDown](http://fletcherpenney.net/multimarkdown/users_guide/multimarkdown_syntax_guide/) +>> way of including metadata in documents. The only difference is that MMD doesn't expect the +>> triple-dash separators, but I'm thinking about submitting a patch to MMD to actually support +>> that syntax. --GB -- cgit v1.2.3 From 2eb04d8b4178f920996b0f74c953e956761a8f0b Mon Sep 17 00:00:00 2001 From: "http://kerravonsen.dreamwidth.org/" Date: Tue, 31 Aug 2010 12:36:50 +0000 Subject: keeping triple-dash as default, but making it configurable --- doc/plugins/contrib/ymlfront/discussion.mdwn | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/ymlfront/discussion.mdwn b/doc/plugins/contrib/ymlfront/discussion.mdwn index 03af5e634..b30c2da37 100644 --- a/doc/plugins/contrib/ymlfront/discussion.mdwn +++ b/doc/plugins/contrib/ymlfront/discussion.mdwn @@ -16,3 +16,6 @@ Any objections? >> way of including metadata in documents. The only difference is that MMD doesn't expect the >> triple-dash separators, but I'm thinking about submitting a patch to MMD to actually support >> that syntax. --GB + +>>> Yes, the idea was to allow the file to be parsed as YAML, you're right. I just found that I tended to have problems when people used "---" for horizontal rules. However, I have also found that trying to keep it solely as an IkiWiki directive doesn't work either, since sometimes the meta-data I need also contained "]]" which broke the parsing of the directive. +>>> So I have decided to go for a compromise, and make the delimiter configurable, rather than hardcoded as "---"; the triple-dash is the default, but it can be configured to be something else instead. I haven't pushed the change yet, but I have written it, and it seems to work. -- [[KathrynAndersen]] -- cgit v1.2.3 From 3e7605d146c73ae283b6a00c1d6d84448805a121 Mon Sep 17 00:00:00 2001 From: Giuseppe Bilotta Date: Tue, 31 Aug 2010 19:39:03 +0200 Subject: more on ymlfront vs MMD --- doc/plugins/contrib/ymlfront/discussion.mdwn | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/ymlfront/discussion.mdwn b/doc/plugins/contrib/ymlfront/discussion.mdwn index b30c2da37..0b58982ff 100644 --- a/doc/plugins/contrib/ymlfront/discussion.mdwn +++ b/doc/plugins/contrib/ymlfront/discussion.mdwn @@ -19,3 +19,11 @@ Any objections? >>> Yes, the idea was to allow the file to be parsed as YAML, you're right. I just found that I tended to have problems when people used "---" for horizontal rules. However, I have also found that trying to keep it solely as an IkiWiki directive doesn't work either, since sometimes the meta-data I need also contained "]]" which broke the parsing of the directive. >>> So I have decided to go for a compromise, and make the delimiter configurable, rather than hardcoded as "---"; the triple-dash is the default, but it can be configured to be something else instead. I haven't pushed the change yet, but I have written it, and it seems to work. -- [[KathrynAndersen]] + +>>>> I'm not sure about what kind of problems you're meeting with "---" being used +>>>> for horizontal rules: isn't it sufficient to just check that (1) the triple-dash +>>>> is the first thing in the page and (2) there are only YAML-style assignments +>>>> (and no blank lines) between the two markers? Check #2 would also be enough to +>>>> support MMD-style metadata, which means (a) no start marker and (b) empty line +>>>> to mark the end of the metadata block. Would this be supported by the plugin? +>>>> --GB -- cgit v1.2.3 From 2a1077f8869ca65b49e09d99a76b595d90b28499 Mon Sep 17 00:00:00 2001 From: "http://kerravonsen.dreamwidth.org/" Date: Wed, 1 Sep 2010 10:09:44 +0000 Subject: YAML is YAML --- doc/plugins/contrib/ymlfront/discussion.mdwn | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/ymlfront/discussion.mdwn b/doc/plugins/contrib/ymlfront/discussion.mdwn index 0b58982ff..b122294bb 100644 --- a/doc/plugins/contrib/ymlfront/discussion.mdwn +++ b/doc/plugins/contrib/ymlfront/discussion.mdwn @@ -27,3 +27,5 @@ Any objections? >>>> support MMD-style metadata, which means (a) no start marker and (b) empty line >>>> to mark the end of the metadata block. Would this be supported by the plugin? >>>> --GB + +>>>>> Since I allow all legal YAML, the only way to check if it is legal YAML is to use the YAML parser, by which time one is already parsing the YAML, so it seems a bit pointless to check before one does so. -- KA -- cgit v1.2.3 From edb256d2d8c59754e074f71f24644d57442a24e9 Mon Sep 17 00:00:00 2001 From: Changaco Date: Sat, 4 Sep 2010 14:04:51 +0000 Subject: added a patch to make it more like MediaWiki --- doc/plugins/contrib/headinganchors/discussion.mdwn | 32 ++++++++++++++++++++++ 1 file changed, 32 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/headinganchors/discussion.mdwn b/doc/plugins/contrib/headinganchors/discussion.mdwn index 91fe04a6d..151af8d92 100644 --- a/doc/plugins/contrib/headinganchors/discussion.mdwn +++ b/doc/plugins/contrib/headinganchors/discussion.mdwn @@ -1 +1,33 @@ 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. + +--- + +A patch to make it more like MediaWiki: + +
--- headinganchors.pm
++++ headinganchors.pm
+@@ -5,6 +5,7 @@
+ use warnings;
+ use strict;
+ use IkiWiki 2.00;
++use URI::Escape;
+ 
+ sub import {
+         hook(type => "sanitize", id => "headinganchors", call => \&headinganchors);
+@@ -14,9 +15,11 @@
+         my $str = shift;
+         $str =~ s/^\s+//;
+         $str =~ s/\s+$//;
+-        $str = lc($str);
+-        $str =~ s/[&\?"\'\.,\(\)!]//mig;
+-        $str =~ s/[^a-z]/_/mig;
++        $str =~ s/\s/_/g;
++        $str =~ s/"//g;
++        $str =~ s/^[^a-zA-Z]/z-/; # must start with an alphabetical character
++        $str = uri_escape_utf8($str);
++        $str =~ s/%/./g;
+         return $str;
+ }
+
+ +--Changaco -- cgit v1.2.3 From 9a0d1862f4ffc6c6958d2133881b3984224a11c7 Mon Sep 17 00:00:00 2001 From: "https://www.google.com/accounts/o8/id?id=AItOawnZyXrBJHCbhjyf69drmoWxbsEex_bQhEk" Date: Tue, 28 Sep 2010 19:01:50 +0000 Subject: initial page --- doc/plugins/contrib/imailhide.mdwn | 60 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 doc/plugins/contrib/imailhide.mdwn (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/imailhide.mdwn b/doc/plugins/contrib/imailhide.mdwn new file mode 100644 index 000000000..7e9a3f995 --- /dev/null +++ b/doc/plugins/contrib/imailhide.mdwn @@ -0,0 +1,60 @@ +[[!template id=plugin name=imailhide author="Peter Vizi"]] +[[!tag mailhide]] + +# Mailhide plugin for Ikiwiki + +This plugin provides the directive mailhide, that uses the [Mailhide +API][1] to protect email addresses from spammers. + +## Dependencies + +The [Captcha::reCAPTCHA::Mailhide][2] perl module is required for this +plugin. + +## Download + +You can get the source code from [github][3]. + +## Installation + +Copy `imailhide.pm` to `/usr/share/perl/5.10.0/IkiWiki/Plugin` or +`~/.ikiwiki/IkiWiki/Plugin`, and enable it in your `.setup` file + + add_plugins => [qw{goodstuff imailhide ....}], + mailhide_public_key => "8s99vSA99fF11mao193LWdpa==", + mailhide_private_key => "6b5e4545326b5e4545326b5e45453223", + mailhide_default_style => "short", + +## Configuration + +### `mailhide_public_key` + +This is your personal public key that you can get at [Google][4]. + +### `mailhide_private_key` + +This is your personal private key that you can get at [Google][4]. + +### `mailhide_default_style` + +As per the recommendation of the [Mailhide API documentation][5], you +can define this as `short` or `long`. The `short` parameter will +result in `john` links, while the `long` parameter +will result in `joh...@example.com`. + +## Parameters + +### `email` + +*Required.* This is the email addres that you want to hide. + +### `style` + +*Optional.* You can set the style parameter individually for each + `mailhide` call. See `mailhide_default_style` for details. + +[1]: http://www.google.com/recaptcha/mailhide/ +[2]: http://search.cpan.org/perldoc?Captcha::reCAPTCHA::Mailhide +[3]: http://github.com/petervizi/imailhide +[4]: http://www.google.com/recaptcha/mailhide/apikey +[5]: http://code.google.com/apis/recaptcha/docs/mailhideapi.html -- cgit v1.2.3 From 219f057e5857c952289fcacd14cf0da91c5262b2 Mon Sep 17 00:00:00 2001 From: "https://www.google.com/accounts/o8/id?id=AItOawnZyXrBJHCbhjyf69drmoWxbsEex_bQhEk" Date: Tue, 28 Sep 2010 19:24:07 +0000 Subject: better tags --- doc/plugins/contrib/imailhide.mdwn | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/imailhide.mdwn b/doc/plugins/contrib/imailhide.mdwn index 7e9a3f995..3aacef57a 100644 --- a/doc/plugins/contrib/imailhide.mdwn +++ b/doc/plugins/contrib/imailhide.mdwn @@ -1,5 +1,5 @@ [[!template id=plugin name=imailhide author="Peter Vizi"]] -[[!tag mailhide]] +[[!tag type/widget type/html]] # Mailhide plugin for Ikiwiki -- cgit v1.2.3 From 64c3c0d0deb80c5af69154d0bc06419a2232fb8f Mon Sep 17 00:00:00 2001 From: "https://www.google.com/accounts/o8/id?id=AItOawnZyXrBJHCbhjyf69drmoWxbsEex_bQhEk" Date: Wed, 29 Sep 2010 10:12:52 +0000 Subject: --- doc/plugins/contrib/imailhide.mdwn | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/imailhide.mdwn b/doc/plugins/contrib/imailhide.mdwn index 3aacef57a..3247f57bf 100644 --- a/doc/plugins/contrib/imailhide.mdwn +++ b/doc/plugins/contrib/imailhide.mdwn @@ -1,7 +1,4 @@ -[[!template id=plugin name=imailhide author="Peter Vizi"]] -[[!tag type/widget type/html]] - -# Mailhide plugin for Ikiwiki +# Mailhide Plugin for Ikiwiki This plugin provides the directive mailhide, that uses the [Mailhide API][1] to protect email addresses from spammers. @@ -53,8 +50,13 @@ will result in `joh...@example.com`. *Optional.* You can set the style parameter individually for each `mailhide` call. See `mailhide_default_style` for details. +## Known Issues + +1. [opening new window when displaying email address][6] + [1]: http://www.google.com/recaptcha/mailhide/ [2]: http://search.cpan.org/perldoc?Captcha::reCAPTCHA::Mailhide [3]: http://github.com/petervizi/imailhide [4]: http://www.google.com/recaptcha/mailhide/apikey [5]: http://code.google.com/apis/recaptcha/docs/mailhideapi.html +[6]: http://github.com/petervizi/imailhide/issues#issue/1 -- cgit v1.2.3 From b0483974f5f71bc75f5a4df3e636af246371cbf6 Mon Sep 17 00:00:00 2001 From: "https://www.google.com/accounts/o8/id?id=AItOawnZyXrBJHCbhjyf69drmoWxbsEex_bQhEk" Date: Wed, 29 Sep 2010 10:15:04 +0000 Subject: --- doc/plugins/contrib/imailhide.mdwn | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/imailhide.mdwn b/doc/plugins/contrib/imailhide.mdwn index 3247f57bf..6009aa012 100644 --- a/doc/plugins/contrib/imailhide.mdwn +++ b/doc/plugins/contrib/imailhide.mdwn @@ -1,3 +1,6 @@ +[[!template id=plugin name=imailhide author="Peter_Vizi"]] +[[!tag type/widget type/html]] + # Mailhide Plugin for Ikiwiki This plugin provides the directive mailhide, that uses the [Mailhide -- cgit v1.2.3 From 577e185b63c6703df1045a7109882e5c3548ab4d Mon Sep 17 00:00:00 2001 From: Anonymous Date: Tue, 26 Oct 2010 17:42:51 +0200 Subject: signal dead link to 'default content for *copyright* and *license*' plugin --- ...fault_content_for___42__copyright__42___and___42__license__42__.mdwn | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn b/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn index b9ad3cc8e..7b7cd9ccd 100644 --- a/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn +++ b/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn @@ -10,6 +10,8 @@ so I'm now publishing them here. and [`license.pm`](http://www.schwinge.homeip.net/~thomas/tmp/license.pm) +> These links are dead + Usage instructions are found inside the two plugin files. --[[tschwinge]] -- cgit v1.2.3 From 616767191759281cf6c3abdfedaa649a8147761a Mon Sep 17 00:00:00 2001 From: tschwinge Date: Wed, 27 Oct 2010 12:39:34 +0000 Subject: Fix links. DynDNS (which was resolving *.schwinge.homeip.net to my server at home) stopped supporting wildcard CNAMEs *.schwinge.homeip.net, so I now always have to use the canonical name (or pay for getting this back, or go looking for another service provider)... --- ...t_content_for___42__copyright__42___and___42__license__42__.mdwn | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn b/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn index 7b7cd9ccd..ce2779db1 100644 --- a/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn +++ b/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn @@ -6,11 +6,9 @@ Someone was just asking for it and I had written these two plugins already some months ago, so I'm now publishing them here. -[`copyright.pm`](http://www.schwinge.homeip.net/~thomas/tmp/copyright.pm) +[`copyright.pm`](http://schwinge.homeip.net/~thomas/tmp/copyright.pm) and -[`license.pm`](http://www.schwinge.homeip.net/~thomas/tmp/license.pm) - -> These links are dead +[`license.pm`](http://schwinge.homeip.net/~thomas/tmp/license.pm) Usage instructions are found inside the two plugin files. -- cgit v1.2.3 From a12dd235ea6afff3540da3f5e66e7abbadaa6944 Mon Sep 17 00:00:00 2001 From: Thomas Schwinge Date: Wed, 27 Oct 2010 14:49:21 +0200 Subject: Fix some more links. DynDNS (which was resolving *.schwinge.homeip.net to my server at home) stopped supporting wildcard CNAMEs *.schwinge.homeip.net, so I now always have to use the canonical name (or pay for getting this back, or go looking for another service provider)... --- ..._no_text_was_copied_in_this_page_--_missing_page_dependencies.mdwn | 2 +- doc/bugs/cutpaste.pm:_missing_filter_call.mdwn | 4 ++-- doc/forum/cutpaste.pm_not_only_file-local.mdwn | 2 +- doc/plugins/contrib/texinfo.mdwn | 2 +- .../__42__forward__42__ing_functionality_for_the_meta_plugin.mdwn | 2 +- doc/todo/passwordauth:_sendmail_interface.mdwn | 2 +- doc/users/tschwinge.mdwn | 4 ++-- 7 files changed, 9 insertions(+), 9 deletions(-) (limited to 'doc/plugins/contrib') diff --git a/doc/bugs/Error:_no_text_was_copied_in_this_page_--_missing_page_dependencies.mdwn b/doc/bugs/Error:_no_text_was_copied_in_this_page_--_missing_page_dependencies.mdwn index 6996a9fbf..0082eed4d 100644 --- a/doc/bugs/Error:_no_text_was_copied_in_this_page_--_missing_page_dependencies.mdwn +++ b/doc/bugs/Error:_no_text_was_copied_in_this_page_--_missing_page_dependencies.mdwn @@ -2,7 +2,7 @@ That one has bitten me for some time; here is the minimal testcase. There is also an equivalent (I suppose) problem when using another plugin, but I hope it's enough to track it down for this one. - $ tar -xj < [bug-dep_order.tar.bz2](http://www.thomas.schwinge.homeip.net/tmp/bug-dep_order.tar.bz2) + $ tar -xj < [bug-dep_order.tar.bz2](http://schwinge.homeip.net/~thomas/tmp/bug-dep_order.tar.bz2) $ cd bug-dep_order/ $ ./render_locally [...] diff --git a/doc/bugs/cutpaste.pm:_missing_filter_call.mdwn b/doc/bugs/cutpaste.pm:_missing_filter_call.mdwn index f7138cba0..4b22fd06c 100644 --- a/doc/bugs/cutpaste.pm:_missing_filter_call.mdwn +++ b/doc/bugs/cutpaste.pm:_missing_filter_call.mdwn @@ -1,7 +1,7 @@ Consider this: - $ wget http://www.thomas.schwinge.homeip.net/tmp/cutpaste_filter.tar.bz2 - $ wget http://www.thomas.schwinge.homeip.net/tmp/cutpaste_filter.patch + $ wget http://schwinge.homeip.net/~thomas/tmp/cutpaste_filter.tar.bz2 + $ wget http://schwinge.homeip.net/~thomas/tmp/cutpaste_filter.patch $ tar -xj < cutpaste_filter.tar.bz2 $ cd cutpaste_filter/ diff --git a/doc/forum/cutpaste.pm_not_only_file-local.mdwn b/doc/forum/cutpaste.pm_not_only_file-local.mdwn index 3563e3e01..0c5221cc9 100644 --- a/doc/forum/cutpaste.pm_not_only_file-local.mdwn +++ b/doc/forum/cutpaste.pm_not_only_file-local.mdwn @@ -3,7 +3,7 @@ has \[[!cut id=foo text="foo"]], and fileB does \[[!absorb pagenames=fileA]], and can then use \[[!paste id=foo]]. Therefore, I've written an [*absorb* directive / -plugin](http://www.thomas.schwinge.homeip.net/tmp/absorb.pm), which is meant to +plugin](http://schwinge.homeip.net/~thomas/tmp/absorb.pm), which is meant to absorb pages in order to get hold of their *cut* and *copy* directives' contents. This does work as expected. But it also absorbs page fileA's *meta* values, like a *meta title*, etc. How to avoid / solve this? diff --git a/doc/plugins/contrib/texinfo.mdwn b/doc/plugins/contrib/texinfo.mdwn index 595bd27aa..a2769166d 100644 --- a/doc/plugins/contrib/texinfo.mdwn +++ b/doc/plugins/contrib/texinfo.mdwn @@ -8,7 +8,7 @@ This plugin is not neccessarily meant to enable people to write arbitrary wiki pages in the Texinfo format (even though that is possible, of course), but rather to ease collaboration on existing Texinfo documents. -The plugin is available at . +The plugin is available at . It's very basic at the moment, but will be improved over time. diff --git a/doc/todo/__42__forward__42__ing_functionality_for_the_meta_plugin.mdwn b/doc/todo/__42__forward__42__ing_functionality_for_the_meta_plugin.mdwn index 61b19d302..b3804d652 100644 --- a/doc/todo/__42__forward__42__ing_functionality_for_the_meta_plugin.mdwn +++ b/doc/todo/__42__forward__42__ing_functionality_for_the_meta_plugin.mdwn @@ -4,7 +4,7 @@ to the [[`meta`_plugin|plugins/meta]]. > [[done]], with some changes --[[Joey]] Find the most recent version at -. +. I can't use `scrub(...)`, as that will strip out the forwarding HTML command. How to deal with that? diff --git a/doc/todo/passwordauth:_sendmail_interface.mdwn b/doc/todo/passwordauth:_sendmail_interface.mdwn index 29f28ca32..556240964 100644 --- a/doc/todo/passwordauth:_sendmail_interface.mdwn +++ b/doc/todo/passwordauth:_sendmail_interface.mdwn @@ -35,7 +35,7 @@ in the ikiwiki source code, where emailing is done. OK, so I'll have a look at replacing all email handling with *Email::Send*. [[!tag patch]] -** +** Remaining TODOs: diff --git a/doc/users/tschwinge.mdwn b/doc/users/tschwinge.mdwn index 944105349..435208a71 100644 --- a/doc/users/tschwinge.mdwn +++ b/doc/users/tschwinge.mdwn @@ -1,8 +1,8 @@ [[!meta title="Thomas Schwinge"]] # Thomas Schwinge - - + + I have converted the [GNU Hurd](http://www.gnu.org/software/hurd/)'s previous web pages and previous wiki pages to a *[[ikiwiki]]* system; and all that while -- cgit v1.2.3 From 9ffa87671062eecfcd042a9501032d441def7ce1 Mon Sep 17 00:00:00 2001 From: "http://kerravonsen.dreamwidth.org/" Date: Thu, 28 Oct 2010 00:19:43 +0000 Subject: tweaking docs --- doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn b/doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn index bb4a58fc6..1a01834f8 100644 --- a/doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn +++ b/doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn @@ -14,4 +14,4 @@ There is one argument to this directive. The YAML-format data. This should be enclosed inside triple-quotes to preserve the data correctly. If more than one ymlfront directive is given per page, the result is undefined. -Likewise, it is inadvisable to try to mix the "---" ymlfront format with the directive form of the data. +Likewise, it is inadvisable to try to mix the non-directive ymlfront format with the directive form of the data. -- cgit v1.2.3 From f2f41d680a841813fb3b75e0311793afc956ffd2 Mon Sep 17 00:00:00 2001 From: "http://kerravonsen.dreamwidth.org/" Date: Thu, 28 Oct 2010 00:21:47 +0000 Subject: new version of ymlfront finally documented --- doc/plugins/contrib/ymlfront.mdwn | 65 ++++++++++++++++++++++++++++++--------- 1 file changed, 51 insertions(+), 14 deletions(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/ymlfront.mdwn b/doc/plugins/contrib/ymlfront.mdwn index a2c649044..2805be04f 100644 --- a/doc/plugins/contrib/ymlfront.mdwn +++ b/doc/plugins/contrib/ymlfront.mdwn @@ -10,6 +10,9 @@ IkiWiki::Plugin::ymlfront - add YAML-format data to a page # activate the plugin add_plugins => [qw{goodstuff ymlfront ....}], + # configure the plugin + ymlfront_delim => [qw(--YAML-- --YAML--)], + ## DESCRIPTION This plugin provides a way of adding arbitrary meta-data (data fields) to any @@ -25,23 +28,57 @@ This plugin is meant to be used in conjunction with the [[field]] plugin. ## DETAILS -If one is not using the ymlfront directive, the YAML-format data in a page -must be placed at the start of the page and delimited by lines containing -precisely three dashes. The "normal" content of the page then follows. +There are three formats for adding YAML data to a page. These formats +should not be mixed - the result is undefined. -For example: +1. ymlfront directive + + See [[ikiwiki/directive/ymlfront]] for more information. - --- - title: Foo does not work - Urgency: High - Status: Assigned - AssignedTo: Fred Nurk - Version: 1.2.3 - --- - When running on the Sprongle system, the Foo function returns incorrect data. +2. default YAML-compatible delimiter + + By default, the YAML-format data in a page is placed at the start of + the page and delimited by lines containing precisely three dashes. + This is what YAML itself uses to delimit multiple documents. + The "normal" content of the page then follows. + + For example: + + --- + title: Foo does not work + Urgency: High + Status: Assigned + AssignedTo: Fred Nurk + Version: 1.2.3 + --- + When running on the Sprongle system, the Foo function returns incorrect data. + + What will normally be displayed is everything following the second line of dashes. That will be htmlized using the page-type of the page-file. + +3. user-defined delimiter + + Instead of using the default "---" delimiter, the user can define, + in the configuration file, the **ymlfront_delim** value, which is an + array containing two strings. The first string defines the markup for + the start of the YAML data, and the second string defines the markip + for the end of the YAML data. These two strings can be the same, or + they can be different. In this case, the YAML data section is not + required to be at the start of the page, but as with the default, it + is expected that only one data section will be on the page. + + For example: + + --YAML-- + title: Foo does not work + Urgency: High + Status: Assigned + AssignedTo: Fred Nurk + Version: 1.2.3 + --YAML-- + When running on the Sprongle system, the Foo function returns incorrect data. -What will normally be displayed is everything following the second line of dashes. -That will be htmlized using the page-type of the page-file. + What will normally be displayed is everything outside the delimiters, + both before and after. That will be htmlized using the page-type of the page-file. ### Accessing the Data -- cgit v1.2.3 From fa71b0e6aa08b0e3b274a0b939bf657f2576e482 Mon Sep 17 00:00:00 2001 From: "http://smcv.pseudorandom.co.uk/" Date: Mon, 1 Nov 2010 18:23:43 +0000 Subject: added to git --- ..._content_for___42__copyright__42___and___42__license__42__.mdwn | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn b/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn index ce2779db1..c13114360 100644 --- a/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn +++ b/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn @@ -45,3 +45,10 @@ by ikiwiki are likewise fine. --[[tschwinge]] > and can extend beyond just copyright and license, but has the disadvantage > that it doesn't support setting defaults for a given "subdirectory" > only. --[[smcv]] + +[[!template id=gitbranch name=smcv/contrib/defcopyright author="[[tschwinge]]"]] + +> For `./gitremotes` convenience (taking the Linus approach to backups :-) ) +> I've added this to my git repository as a branch. No review, approval or +> ownership is implied, feel free to replace this with a branch in any other +> repository --[[smcv]] -- cgit v1.2.3 From e68f29eebb3917909b939869e57b985add724598 Mon Sep 17 00:00:00 2001 From: "http://smcv.pseudorandom.co.uk/" Date: Mon, 1 Nov 2010 18:24:46 +0000 Subject: ugh, now with better syntax --- ...fault_content_for___42__copyright__42___and___42__license__42__.mdwn | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn b/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn index c13114360..16c147b68 100644 --- a/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn +++ b/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn @@ -46,7 +46,7 @@ by ikiwiki are likewise fine. --[[tschwinge]] > that it doesn't support setting defaults for a given "subdirectory" > only. --[[smcv]] -[[!template id=gitbranch name=smcv/contrib/defcopyright author="[[tschwinge]]"]] +[[!template id=gitbranch branch=smcv/contrib/defcopyright author="[[tschwinge]]"]] > For `./gitremotes` convenience (taking the Linus approach to backups :-) ) > I've added this to my git repository as a branch. No review, approval or -- cgit v1.2.3 From 3f4ec334df4cc2c169edfbcef3fa530cbae0d7f1 Mon Sep 17 00:00:00 2001 From: "http://kerravonsen.dreamwidth.org/" Date: Mon, 6 Dec 2010 02:02:30 +0000 Subject: updating the docs in keeping with latest version - multi-page reports --- .../contrib/report/ikiwiki/directive/report.mdwn | 24 +++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn b/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn index 8f8e6b4e8..df88b33ad 100644 --- a/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn +++ b/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn @@ -30,6 +30,11 @@ them work as wiki pages. **pages**: A PageSpec to determine the pages to report on. +**pagenames**: If given instead of pages, this is interpreted as a +space-separated list of links to pages, and they are shown in exactly the order +given: the sort and pages parameters cannot be used in conjunction with this +one. If they are used, they will be ignored. + **trail**: A page or pages to use as a "trail" page. When a trail page is used, the matching pages are limited to (a subset @@ -45,6 +50,11 @@ For example: This will take the links from both the "animals/cats" page and the "animals/dogs" page as the set of pages to apply the PageSpec to. +**start**: Start the report at the given page-index; the index starts +from zero. + +**count**: Report only on N pages where count=N. + **sort**: A SortSpec to determine how the matching pages should be sorted. **here_only**: Report on the current page only. @@ -86,7 +96,19 @@ The "mood_summary" template might be like this: ### () \[[]] - + +### Multi-page Reports + +Reports can now be split over multiple pages, so that there aren't +too many items per report-page. + +**per_page**: how many items to show per report-page. + +**first_page_is_index**: If true, the first page of the report is just +an index which contains links to the other report pages. +If false, the first page will contain report-content as well as links +to the other pages. + ### Advanced Options The following options are used to improve efficiency when dealing -- cgit v1.2.3 From 20df2ee6fe0b9cbde72f47193ede4ac7f971d617 Mon Sep 17 00:00:00 2001 From: Giuseppe Bilotta Date: Mon, 6 Dec 2010 14:06:37 +0100 Subject: Some comments on fields namespacing --- doc/plugins/contrib/field/discussion.mdwn | 45 +++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/field/discussion.mdwn b/doc/plugins/contrib/field/discussion.mdwn index 191f8b27d..80d0b2b71 100644 --- a/doc/plugins/contrib/field/discussion.mdwn +++ b/doc/plugins/contrib/field/discussion.mdwn @@ -327,6 +327,51 @@ smcv's discuission of field author vs meta author above. --[[Joey]] ----- +I think the main point is: what is (or should be) the main point of the +field plugin? If it's essentially a way to present a consistent +interface to access page-related structured information, then it makes +sense to have it very general. Plugins registering with fields would +then present ways for recovering the structure information from the page +(`ymlfront`, `meta`, etc), ways to manipulate it (like `meta` does), +etc. + +In this sense, security should be entirely up to the plugins, although +the fields plugin could provide some auxiliary infrastructure (like +determining where the data comes from and raise or lower the security +level accoringly). + +Namespacing is important, and it should be considered at the field +plugin interface level. A plugin should be able to register as +responsible for the processing of all data belonging to a given +namespace, but plugins should be able to set data in any namespace. So +for example, `meta` register are `meta` fields processing, and whatever +method is used to set the data (`meta` directive, `ymlfront`, etc) it +gets a say on what to do with data in its namespace. + +What I'm thinking of is something you could call fieldsets. The nice +thing about them is that, aside from the ones defined by plugins (like +`meta`), it would be possible to define custom ones (with a generic, +default processor) in an appropriate file (like smileys and shortcuts) +with a syntax like: + + [[!fieldset book namespace=book + fields="author title isbn" + fieldtype="text text text"]] + +after which, you coude use + + [[!book author="A. U. Thor" + title="Fields of Iki"]] + +and the data would be available under the book namespace, and thus +as BOOK_AUTHOR, BOOK_TITLE etc in templates. + +Security, in this sense, would be up to the plugin responsible for the +namespace processing (the default handler would HTML-escape text fields +scrub, html fields, safeurl()ify url fields, etc.) + +----- + I was just looking at HTML5 and wondered if the field plugin should generate the new Microdata tags (as well as the internal structures)? -- [[Will]] > This could just as easily be done as a separate plugin. Feel free to do so. --[[KathrynAndersen]] -- cgit v1.2.3 From 5d6c604bdc03d5009378273cb4e465319dff4b58 Mon Sep 17 00:00:00 2001 From: "http://kerravonsen.dreamwidth.org/" Date: Wed, 8 Dec 2010 03:12:35 +0000 Subject: namespaces are othogonal to the issue of security --- doc/plugins/contrib/field/discussion.mdwn | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/field/discussion.mdwn b/doc/plugins/contrib/field/discussion.mdwn index 80d0b2b71..cd479263a 100644 --- a/doc/plugins/contrib/field/discussion.mdwn +++ b/doc/plugins/contrib/field/discussion.mdwn @@ -370,6 +370,18 @@ Security, in this sense, would be up to the plugin responsible for the namespace processing (the default handler would HTML-escape text fields scrub, html fields, safeurl()ify url fields, etc.) +> So, are you saying that getting a field value is sort of a two-stage process? Get the value from anywhere, and then call the "security processor" for that namespace to "secure" the value? I think "namespaces" are really orthogonal to this issue. What the issue seems to be is: + + * what form do we expect the raw field to be in? (text, URL, HTML) + * what form do we expect the "secured" output to be in? (raw HTML, scrubbed HTML, escaped HTML, URL) + +> Only if we know both these things will we know what sort of security processing needs to be done. +> There is also a difference between field values that are used inside pagetemplate, and field values which are used as part of a page's content (e.g. with ftemplate). If you have a TITLE, you want it to be HTML-escaped if you're using it inside pagetemplate, but you don't want it to be HTML-escaped if you're using it inside a page's content. On the other hand, if you have, say, FEEDLINKS used inside pagetemplate, you don't wish it to be HTML-escaped at all, or your page content will be completely stuffed. + +> So, somehow, we have to know the meaning of a field before we can use it properly, which kind of goes against the idea of having something generic. + +> --[[KathrynAndersen]] + ----- I was just looking at HTML5 and wondered if the field plugin should generate the new Microdata tags (as well as the internal structures)? -- [[Will]] -- cgit v1.2.3 From d0fdc973d3c793fa6f315014fcfa6823d057372a Mon Sep 17 00:00:00 2001 From: Giuseppe Bilotta Date: Thu, 16 Dec 2010 18:47:38 +0100 Subject: reply to KA about fieldsets and field types --- doc/plugins/contrib/field/discussion.mdwn | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'doc/plugins/contrib') diff --git a/doc/plugins/contrib/field/discussion.mdwn b/doc/plugins/contrib/field/discussion.mdwn index cd479263a..6161f80df 100644 --- a/doc/plugins/contrib/field/discussion.mdwn +++ b/doc/plugins/contrib/field/discussion.mdwn @@ -376,10 +376,28 @@ scrub, html fields, safeurl()ify url fields, etc.) * what form do we expect the "secured" output to be in? (raw HTML, scrubbed HTML, escaped HTML, URL) > Only if we know both these things will we know what sort of security processing needs to be done. + +>> Fieldsets are orthogonal to the security issue in the sense that you can use +>> them without worrying about the field security issue, but they happen to be +>> a rather clean way of answering those two questions, by allowing you to +>> attach preprocessing attributes to a field in a way that the user +>> (supposedly) cannot mingle with. + > There is also a difference between field values that are used inside pagetemplate, and field values which are used as part of a page's content (e.g. with ftemplate). If you have a TITLE, you want it to be HTML-escaped if you're using it inside pagetemplate, but you don't want it to be HTML-escaped if you're using it inside a page's content. On the other hand, if you have, say, FEEDLINKS used inside pagetemplate, you don't wish it to be HTML-escaped at all, or your page content will be completely stuffed. +>> Not to talk about the many different ways date-like fields might be need +>> processing. It has already been proposed to solve this problem by exposing +>> the field values under different names depending on the kind or amout of +>> postprocessing they had (e.g. RAW_SOMEFIELD, SOMEFIELD, to which we could add +>> HTML_SOMEFIELD, URL_SOMEFIELD or whatever). Again, fieldsets offer a simple way +>> of letting Ikiwiki know what kind of postprocessing should be offered for +>> that particular field. + > So, somehow, we have to know the meaning of a field before we can use it properly, which kind of goes against the idea of having something generic. +>> We could have a default field type (text, for example), and a way to set a +>> different field type (which is what my fieldset proposal was about). + > --[[KathrynAndersen]] ----- -- cgit v1.2.3