From e3713772f76fa9cc3587e48d0326035a352270d9 Mon Sep 17 00:00:00 2001 From: Enrico Zini Date: Sat, 26 Jul 2008 23:24:11 +0100 Subject: Added cutpaste plugin. I'm wondering if cutandpaste wouldn't be a better name. --- doc/plugins/cutpaste.mdwn | 55 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 doc/plugins/cutpaste.mdwn (limited to 'doc') diff --git a/doc/plugins/cutpaste.mdwn b/doc/plugins/cutpaste.mdwn new file mode 100644 index 000000000..578502988 --- /dev/null +++ b/doc/plugins/cutpaste.mdwn @@ -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! + """]] -- cgit v1.2.3 From ecc40d1769c84a2cca3070e848adfd8710f27d8b Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Sat, 26 Jul 2008 23:15:50 -0400 Subject: changelog and tweaks --- debian/changelog | 1 + debian/copyright | 2 +- doc/plugins/cutpaste.mdwn | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/debian/changelog b/debian/changelog index 5ed125d8f..77a08c456 100644 --- a/debian/changelog +++ b/debian/changelog @@ -30,6 +30,7 @@ ikiwiki (2.55) UNRELEASED; urgency=low * bzr: Add support for rename and delete. (Jelmer Vernooij) * attachment: Use relative paths when inserting links. * toggle: Fix for when html got tidied. Closes: #492529 (Enrico Zini) + * cutpaste: New plugin by Enrico Zini -- Joey Hess Mon, 21 Jul 2008 11:35:46 -0400 diff --git a/debian/copyright b/debian/copyright index d25e0861a..d22edb03b 100644 --- a/debian/copyright +++ b/debian/copyright @@ -76,7 +76,7 @@ Files: htmltidy.pm Copyright: © 2006 Faidon Liambotis License: GPL-2+ -Files: polygen.pm, pagestats.pm +Files: polygen.pm, pagestats.pm, cutpaste.pm Copyright: © 2006 Enrico Zini License: GPL-2+ diff --git a/doc/plugins/cutpaste.mdwn b/doc/plugins/cutpaste.mdwn index 578502988..a5dff08ab 100644 --- a/doc/plugins/cutpaste.mdwn +++ b/doc/plugins/cutpaste.mdwn @@ -50,6 +50,6 @@ nest directive that require multiline parameters inside each other: \[[!toggleable id=bar text="\[[!paste id=baz]]"]] """]] - [[!cut id=baz text=""" + \[[!cut id=baz text=""" multiline parameter! """]] -- cgit v1.2.3