diff options
| author | Simon McVittie <smcv@ http://smcv.pseudorandom.co.uk/> | 2009-01-18 16:43:07 +0000 |
|---|---|---|
| committer | Simon McVittie <smcv@ http://smcv.pseudorandom.co.uk/> | 2009-01-18 16:43:07 +0000 |
| commit | 2fd1857a527303f529274a229596dd6eb64b0a48 (patch) | |
| tree | e0997c99643947eccd56e73b73b3f95256327b12 /doc/plugins/underlay.mdwn | |
| parent | b7cd40c1bb0e0c88155c0948f8475db3479153c8 (diff) | |
| download | ikiwiki-2fd1857a527303f529274a229596dd6eb64b0a48.tar ikiwiki-2fd1857a527303f529274a229596dd6eb64b0a48.tar.gz | |
Document underlay plugin as included
Diffstat (limited to 'doc/plugins/underlay.mdwn')
| -rw-r--r-- | doc/plugins/underlay.mdwn | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/plugins/underlay.mdwn b/doc/plugins/underlay.mdwn new file mode 100644 index 000000000..09d096a6e --- /dev/null +++ b/doc/plugins/underlay.mdwn @@ -0,0 +1,14 @@ +[[!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 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. + +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. |