From 5f80ac3202e61440d3a0fbcc486e13c16309d5ad Mon Sep 17 00:00:00 2001
From: "http://smcv.pseudorandom.co.uk/" <http://smcv.pseudorandom.co.uk/@web>
Date: Sun, 18 Jan 2009 09:52:51 -0500
Subject: underlay plugin, a command-line interface for add_underlay()

---
 doc/plugins/contrib/underlay.mdwn | 55 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 doc/plugins/contrib/underlay.mdwn

(limited to 'doc/plugins/contrib/underlay.mdwn')

diff --git a/doc/plugins/contrib/underlay.mdwn b/doc/plugins/contrib/underlay.mdwn
new file mode 100644
index 000000000..94651f1d3
--- /dev/null
+++ b/doc/plugins/contrib/underlay.mdwn
@@ -0,0 +1,55 @@
+[[!template id=plugin name=underlay author="[[Simon_McVittie|smcv]]"]]
+[[!tag type/useful]]
+
+This plugin adds an `add_underlays` option to the `.setup` file.
+Its value is a list of underlay directories whose content is added to the wiki.
+
+Multiple underlays are normally set up automatically by other plugins (for
+instance, the smiley images used by [[plugins/smileys]]), but they can also be
+used as a way to pull in external files that you don't want in revision control,
+like photos or software releases.
+
+Directories in `add_underlays` should usually be absolute. If relative, they're
+interpreted as relative to the parent directory of the basewiki underlay, which
+is probably not particularly useful in this context.
+
+    #!/usr/bin/perl
+    package IkiWiki::Plugin::underlay;
+    # Copyright © 2008 Simon McVittie <http://smcv.pseudorandom.co.uk/>
+    # Licensed under the GNU GPL, version 2, or any later version published by the
+    # Free Software Foundation
+
+    use warnings;
+    use strict;
+    use IkiWiki 2.00;
+
+    sub import {
+    	hook(type => "getsetup", id => "underlay",  call => \&getsetup);
+    	hook(type => "checkconfig", id => "underlay", call => \&checkconfig);
+    }
+
+    sub getsetup () {
+    	return
+    		plugin => {
+    			safe => 0,
+    			rebuild => undef,
+    		},
+    		add_underlays => {
+    			type => "string",
+    			default => [],
+    			description => "extra underlay directories to add",
+    			advanced => 1,
+    			safe => 0,
+    			rebuild => 1,
+    		},
+    }
+
+    sub checkconfig () {
+    	return unless exists $config{add_underlays};
+
+    	foreach my $dir (@{$config{add_underlays}}) {
+    		add_underlay($dir);
+    	}
+    }
+
+    1;
-- 
cgit v1.2.3


From e98f1b246a91f499d332f2d6e42d45a88d368681 Mon Sep 17 00:00:00 2001
From: "http://smcv.pseudorandom.co.uk/" <http://smcv.pseudorandom.co.uk/@web>
Date: Sun, 18 Jan 2009 11:40:57 -0500
Subject: fix typo, mention git branch

---
 doc/plugins/contrib/underlay.mdwn | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'doc/plugins/contrib/underlay.mdwn')

diff --git a/doc/plugins/contrib/underlay.mdwn b/doc/plugins/contrib/underlay.mdwn
index 94651f1d3..72893c992 100644
--- a/doc/plugins/contrib/underlay.mdwn
+++ b/doc/plugins/contrib/underlay.mdwn
@@ -5,7 +5,7 @@ This plugin adds an `add_underlays` option to the `.setup` file.
 Its value is a list of underlay directories whose content is added to the wiki.
 
 Multiple underlays are normally set up automatically by other plugins (for
-instance, the smiley images used by [[plugins/smileys]]), but they can also be
+instance, the images used by the [[plugins/smiley]] plugin), but they can also be
 used as a way to pull in external files that you don't want in revision control,
 like photos or software releases.
 
@@ -13,6 +13,9 @@ Directories in `add_underlays` should usually be absolute. If relative, they're
 interpreted as relative to the parent directory of the basewiki underlay, which
 is probably not particularly useful in this context.
 
+Please feel free to add this plugin to ikiwiki if it seems like a good
+thing to have. See the 'underlay' branch in my git repository.
+
     #!/usr/bin/perl
     package IkiWiki::Plugin::underlay;
     # Copyright © 2008 Simon McVittie <http://smcv.pseudorandom.co.uk/>
-- 
cgit v1.2.3