Filelist Plugin

The filelist plugin provides a syntax for adding linked and sorted lists of files as selected by wildcard based glob patterns to a wiki page and thus allows dynamically including file listings of arbitrary filesystem locations and media namespaces. Using the additional filename command, one can also add a single link to a file out of a list anywhere in the text, which can be used to automatically keep download links for software releases up to date with the most recent upload.

In case you come across any bugs in this plugin, don't hesitate to report them.

The Darcs repository of the plugin can be found here.

Last updated: 2008/04/04

• 2008/04/04:
  • Now respects ACLs in media mode and file permissions in direct mode. Files need to be readable in order to be displayed.
  • Users of Dokuwiki version up to 2007-06-26b: With the release of Dokuwiki version 2007-05-05, the date format got changed¹⁾. The filelist plugin incorporates this change, thus dates will not be displayed properly on versions below 2008-05-05.
• 2008/03/13:
  • Should fix 24
• 2008/03/02:
  • Fixes 21, 22
  • Implements 23 (filelist output is now enclosed in an additional div with class filelist-plugin which can be used to apply specific css to anything contained inside)
• 2008/01/24:
  • (Hopefully ) fixes 19
  • tested with Linux only as I currently have no access to a Windows-box, so Windows-users please give feedback!
• 2007/11/05:
  • Initial release

Based on an idea by demod.

Let the manager do the dirty work, just give him this link to eat: plugin-filelist.tar.gz

1. Download the plugin: plugin-filelist.tar.gz
2. Extract it into your dokuwiki plugin folder (eg lib/plugins)

The filelist plugin has three configurable options:

The filelist plugin provides two new commands to be used in wiki pages, filelist and filename. The general command syntax for both is the following:

{{[ command ]>[ pattern ][ parameterlist ]}}

• command must be either filelist or filename.
• pattern is a searching pattern for files to include in the generated list, defined using the pattern syntax of the unix fnmatch function. An example: If you want to include all files ending on .txt in the folder some/path/²⁾, you would use some/path/*.txt as the pattern (and the parameter direct=1, see parameters below). Analogue to this, to include all jpeg media files in :some:namespace, you'd use :some:namespace:*.jpg.
• parameterlist can be used to define optional, & separated parameters (defined as key-value-pairs). For a list of supported parameters, see below.

The filelist plugin supports both absolute as well as relative paths into the filesystem or Dokuwiki media namespaces. All paths are checked against a whitelist of allowed paths for scanning (as defined via the configuration setting ''allowed_absolute_paths''). Paths which are not located below these whitelisted paths are not allowed for globbing and thus filelist/filename calls to such paths fail. Per default, the Dokuwiki basedir as defined in DOKU_INC is included in this whitelist and mapped to the Dokuwiki base-URL, DOKU_URL.

Relative paths into the filesystem are interpreted relative to the Dokuwiki basedir. Relative media paths (without a leading : that is) are interpreted relative to the namespace of the currently active page. Thus, :snippets:dokuwiki:* and * would be interpreted the same on the current page :snippets:dokuwiki:filelist.

{{filename>:snippets:dokuwiki:*filelist*}}

turns into

{{filelist>:snippets:dokuwiki:plugin-*.tar.gz&style=table&tableheader=1&tableshowdate=1&tableshowsize=1}}

turns into

{{filelist>lib/images/*&style=list&direct=1}}

turns into