]> sipb.mit.edu Git - ikiwiki.git/commitdiff
Added cutpaste plugin.
authorEnrico Zini <enrico@enricozini.org>
Sat, 26 Jul 2008 22:24:11 +0000 (23:24 +0100)
committerJoey Hess <joey@kodama.kitenet.net>
Sun, 27 Jul 2008 03:08:17 +0000 (23:08 -0400)
I'm wondering if cutandpaste wouldn't be a better name.

IkiWiki/Plugin/cutpaste.pm [new file with mode: 0644]
doc/plugins/cutpaste.mdwn [new file with mode: 0644]

diff --git a/IkiWiki/Plugin/cutpaste.pm b/IkiWiki/Plugin/cutpaste.pm
new file mode 100644 (file)
index 0000000..1737775
--- /dev/null
@@ -0,0 +1,68 @@
+#!/usr/bin/perl
+package IkiWiki::Plugin::cutpaste;
+
+use warnings;
+use strict;
+use IkiWiki 2.00;
+use UNIVERSAL;
+
+my %savedtext;
+
+sub import { #{{{
+       hook(type => "preprocess", id => "cut", call => \&preprocess_cut, scan => 1);
+       hook(type => "preprocess", id => "copy", call => \&preprocess_copy, scan => 1);
+       hook(type => "preprocess", id => "paste", call => \&preprocess_paste);
+} # }}}
+
+sub preprocess_cut (@) { #{{{
+       my %params=@_;
+
+       foreach my $param (qw{id text}) {
+               if (! exists $params{$param}) {
+                       return "[[cut ".sprintf(gettext('%s parameter is required'), $param)."]]";
+               }
+       }
+
+       $savedtext{$params{page}} = {} if not exists $savedtext{$params{"page"}};
+       $savedtext{$params{page}}->{$params{id}} = $params{text};
+
+       return "" if defined wantarray;
+} # }}}
+
+sub preprocess_copy (@) { #{{{
+       my %params=@_;
+
+       foreach my $param (qw{id text}) {
+               if (! exists $params{$param}) {
+                       return "[[copy ".sprintf(gettext('%s parameter is required'), $param)."]]";
+               }
+       }
+
+       $savedtext{$params{page}} = {} if not exists $savedtext{$params{"page"}};
+       $savedtext{$params{page}}->{$params{id}} = $params{text};
+
+       return IkiWiki::preprocess($params{page}, $params{destpage}, 
+               IkiWiki::filter($params{page}, $params{destpage}, $params{text})) if defined wantarray;
+} # }}}
+
+sub preprocess_paste (@) { #{{{
+       my %params=@_;
+
+       foreach my $param (qw{id}) {
+               if (! exists $params{$param}) {
+                       return "[[paste ".sprintf(gettext('%s parameter is required'), $param)."]]";
+               }
+       }
+
+       if (! exists $savedtext{$params{page}}) {
+               return "[[paste ".gettext('no text was copied in this page')."]]";
+       }
+       if (! exists $savedtext{$params{page}}->{$params{id}}) {
+               return "[[paste ".sprintf(gettext('no text was copied in this page with id %s'), $params{id})."]]";
+       }
+
+       return IkiWiki::preprocess($params{page}, $params{destpage}, 
+               IkiWiki::filter($params{page}, $params{destpage}, $savedtext{$params{page}}->{$params{id}}));
+} # }}}
+
+1;
diff --git a/doc/plugins/cutpaste.mdwn b/doc/plugins/cutpaste.mdwn
new file mode 100644 (file)
index 0000000..5785029
--- /dev/null
@@ -0,0 +1,55 @@
+[[!template id=plugin name=toggle author="[[Enrico]]"]]
+[[!tag type/chrome]]
+
+With this plugin you can store and recall pieces of text.  It defines three
+preprocessing commands:
+
+ * `\[[!cut id=name text="text"]]` memorizes the text allowing to recall it
+   using the given ID.  The text being cut is not included in the output.
+ * `\[[!copy id=name text="text"]]` memorizes the text allowing to recall it
+   using the given ID.  The text being cut *is* included in the output.
+ * `\[[!paste id=name]]` is replaced by the previously memorized text.
+
+The text being cut, copied and pasted can freely include wiki markup, including
+more calls to cut, copy and paste.
+
+You do not need to memorize the text before using it: a cut directive can
+follow the paste directive that uses its text.  In fact, this is quite useful
+to postpone big blocks of text like long annotations and have a more natural
+flow.  For example:
+
+       This plugin provides three directives:
+
+        * \[[!toggle id="cut" text="cut"]] that cuts text
+        * \[[!toggle id="copy" text="copy"]] that copies text
+        * \[[!toggle id="paste" text="paste"]] that pastes text
+
+       \[[!toggleable id="cut" text="\[[!paste id=cutlongdesc]]"]]
+       \[[!toggleable id="copy" text="\[[!paste id=copylongdesc]]"]]
+       \[[!toggleable id="paste" text="\[[!paste id=pastelongdesc]]"]]
+
+       \[...some time later...]
+
+       \[[!cut id=cutlongdesc text="""
+          blah blah blah
+       """]]
+       \[[!cut id=copylongdesc text="""
+          blah blah blah
+       """]]
+       \[[!cut id=pastelongdesc text="""
+          blah blah blah
+       """]]
+
+This can potentially be used to create loops, but ikiwiki is clever and breaks
+them.
+
+Since you can paste without using double quotes, copy and paste can be used to
+nest directive that require multiline parameters inside each other:
+
+       \[[!toggleable id=foo text="""
+         \[[!toggleable id=bar text="\[[!paste id=baz]]"]]
+       """]]
+
+       [[!cut id=baz text="""
+       multiline parameter!
+       """]]