doc/plugins/underlay.mdwn

   1 [[!template id=plugin name=underlay author="[[Simon_McVittie|smcv]]"]]
   2 [[!tag type/special-purpose]]
   3
   4 This plugin adds an `add_underlays` option to the setup file. Its value is
   5 a list of underlay directories whose content is added to the wiki.
   6
   7 Multiple underlays are normally set up automatically by other plugins (for
   8 instance, the images used by the [[plugins/smiley]] plugin), but they can
   9 also be used as a way to pull in external files that you don't want in
  10 revision control, like photos or software releases.
  11
  12 Directories in `add_underlays` should usually be absolute. If relative,
  13 they're interpreted as relative to the parent directory of the basewiki
  14 underlay, which is probably not particularly useful in this context.
  15
  16 --
  17
  18 This plugin also adds an `add_templates` option to the setup file.
  19 Its value is a list of template directories to look for template files in,
  20 if they are not present in the `templatedir`.