doc/plugins/underlay.mdwn

   1 [[!template id=plugin name=underlay author="[[Simon_McVittie|smcv]]"]]
   2 [[!tag type/useful]]
   3
   4 This plugin adds an `add_underlays` option to the `.setup` file.
   5 Its value is 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 also be
   9 used as a way to pull in external files that you don't want in revision control,
  10 like photos or software releases.
  11
  12 Directories in `add_underlays` should usually be absolute. If relative, they're
  13 interpreted as relative to the parent directory of the basewiki underlay, which
  14 is probably not particularly useful in this context.