ikiwiki/doc/plugins/underlay.mdwn

15 lines
731 B
Plaintext
Raw Normal View History

2009-01-18 17:43:07 +01:00
[[!template id=plugin name=underlay author="[[Simon_McVittie|smcv]]"]]
2010-02-12 09:38:00 +01:00
[[!tag type/special-purpose]]
2009-01-18 17:43:07 +01:00
2010-02-12 09:38:00 +01:00
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.
2009-01-18 17:43:07 +01:00
Multiple underlays are normally set up automatically by other plugins (for
2010-02-12 09:38:00 +01:00
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.
2009-01-18 17:43:07 +01:00
2010-02-12 09:38:00 +01:00
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.