---- plugin ----
description: Provides a syntax for adding linked and sorted lists of files as selected by wildcard based glob patterns to a wiki page
author     : Dokufreaks (previous author: Gina Häußge)
email      : freaks@dokuwiki.org
type       : syntax
lastupdate : 2016-09-10
compatible : Binky, Ponder Stibbons, "Hrun",detritus,"Elenor of Tsort", "Frusterick Manners", "Greebo"
depends    : 
conflicts  : 
similar    : medialist
tags       : file, listing, download, media, filter, odt

downloadurl: https://github.com/dokufreaks/plugin-filelist/archive/master.zip
bugtracker : https://github.com/dokufreaks/plugin-filelist/issues
sourcerepo : https://github.com/dokufreaks/plugin-filelist/
donationurl: 
screenshot_img : https://github.com/dokufreaks/plugin-filelist/raw/master/FilelistScreenshot.png

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 additionalfilename 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.

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 usesome/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.

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

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

{{filelist>lib/images/*&style=olist&direct=1&recursive=1&sort=iname}}

The links to the details description and syntax seem to be not working, so we're not able to work out how this plugin works — Simon, 29 May 2015

Works with my DokuWiki version 2010-11-07. A problem was discovered, which is the filelist does not display the files for unregistered user. The ACL is correctly set for ALL and using normal syntax the file is displayed and accessible. — Münchener, 14 Feb 2011

I played around with getting this to work for a while, before realising that, under Windows, the case of the drive letter does actually matter! So, both savedir and this plugin's allowed_absolute_paths I had to change from d:/www-data/wiki/ to D:/www-data/wiki/ — samwilson 2011-10-05 05:46

I had no end of trouble getting this to work on Bitnami WAMPStack Server (Windows, Apache, MySQL, PHP). I finally discovered that not only is the case of the path important, the mix of \ and / path separators used in the dokuwiki config path is important. It works now that I used the exact path specified in the dokuwiki “savedir” config, eg C:\Program Files\Bitnami WAMPStack\apps/dokuwiki/data/ (and no quotes). Obvious once stated. — alan 2012-12-04 11:58

In my judgement this plugin does not work with Rincewind. At least not in my configuration. In Rincewind I could this only get working with the direct-option and absolute paths, not the namespace notation. The namespace-notation resulted in Access-denied. And 'working' means only display, clicking on a file-link in the list resulted in a server-error

The medialist-plugin is a working alternative (if using a patch somebody provided in the dokuwiki-documentation).

Examples: So this displayed a list

{{filelist>data/media/natuurlijk/documents/*.*&style=table&direct=1&tableheader=1&tableshowdate=1&tableshowsize=1&sort=iname}}

This did NOT:

{{filelist>:natuurlijk:documents:*.*&style=table&direct=1&tableheader=1&tableshowdate=1&tableshowsize=1&sort=iname}}

Omission of &direct won't work either.

There seems to be no real alternative to this plugin, it would be nice if this could be repaired (or my mistake in the usage of it be clarified) The bug-report link on the owner's list points to nirvana

It works with Rincewind and Angua.

I had to go to Admin > Configuration Settings > Filelist Plugin Settings and give values like the following:

/home/myuser/        

file:///home/myuser/ 

More information from Wikipedia.

I also had to consider this. Firefox blocks links to local files for security purposes. So I added the LocalLink extension to Firefox, as described in that page.

With this modifications, I can use something like this:

{{filelist>/home/myuser/Desktop/*&direct=1}}

or like this:

{{filelist>/home/myuser/Desktop/*&direct=1&style=olist&recursive=1&sort=iname}}

to list the contents of my file system.

In Firefox with the LocalLink extension, one may right-click on a link/element from that list and select Open Link In Local Context.

I have tested this in Mac OS X and Ubuntu. I have made a trial in Windows 7 with the following values (also trying lower case c:) but I could not make it work and I got [n/a: Access denied].

C:/Users/Myuser/ 

file:///C:/Users/Myuser/ 

{{filelist>C:/Users/Myuser/Desktop/*&direct=1}}

This

{{filelist>:wiki:asorted:pcard:201203:*.*&style=list&direct=0}}

works without any modification as expected in Rincewind

After upgrading to Binky, previously working code now displays:

[n/a: Access denied]

I am logged in as admin and have made no changes to ACL rules.

The configuration settings have not changed, path on server & url are correct:

My previously working entries were of different format to discussion above (as follows):

/home/users/web/ourmockseverpath/htdocs/

http://www.ourmockseverurl.org.au/

Has anyone got this very useful plugin working on Binky?

— charles.minto 2014/01/24 00:44

All these:

{{filelist>:playground:test:*.*&style=table&tableheader=1
  &tableshowdate=1&tableshowsize=1&sort=iname}}

{{filelist>:playground:test:*.doc*&style=table&tableheader=1
  &tableshowdate=1&tableshowsize=1&sort=iname}}

{{filelist>:playground:test:*.pdf&style=table&tableheader=1
  &tableshowdate=1&tableshowsize=1&sort=iname}}

work as expected on Binky.

JohnG 2014-02-12

Thanks. I finally figured out the problem, my mistake. I had to change my entry in the configuration settings from DOKU_INC to:

/home/users/web/ourmockseverpath/htdocs/subfolder/

as the weburl.com.au points to the subfolder.

— charles.minto 2014/03/19 11:55

Actually after tracing through the file list code using basically print statements, I found out what wasn't working for me. I thought I should post that by default out of the box if you haven't changed paths much, then you want the allowed_absolute_paths to point to your sites dokuwiki/data/media directory and you want your URL to be to your site. So for us we have something like

/home/deploy/rubystack-bitnami/apps/dokuwiki/data/media

http://www.yourserver.com/

Then in the actual code, to for example list all files in the media director of the form Notes*.pdf for the name space project, we use something like:

{{filelist>:project:Notes*.pdf&style=list&sort=iname}}

— jasonharris 2014/04/27

It still doesn't work for me in Hrun. I set

/usr/local/dokuwiki/data/media/

http://our.server.tld/

but I get Access denied when I use the filelist plugin on my pages

— Hana Skoumalová 2014/12/18

The default setting DOKU_INC for the absolute path did not seem to work. It just got me the dreaded access denied message. However, I was able to get the plugin working by:

• set the absolute path to /usr/local/doku/data on a server administrated by me.
• set the absolute path to / on a shared space hosted by an ISP. In this case I also set the DOKU_URL to the URL this wiki can be reached.

— KaiMartin 2015-02-09 03:16

on my dokuwiki hrun on a synology NAS and using multiple animals, i only got it working with:

• plugin»filelist»allowed_absolute_paths = /var/services/web/wiki/dokumente/data/media/
• plugin»filelist»defaults = /wiki/dokumente/_media/

where

• /var/services/web is the path given by _SERVER[“HOME”] using phpinfo
• /wiki/dokumente is the path for the animal. in generell i think it will be just /dokuwiki

by using the direct parameter and absolute path like this: {{filelist>/var/services/web/wiki/dokumente/data/media/*&direct=1&recursive=1}}

The setting DOKU_INC works as expected in Detritus. If you still get access denied messages, the cause may be an inappropriate setting of the direct= parameter. — KaiMartin 2015-10-12 23:24

Great plug-in but seems old and a bit unstable now and then? Our intranet depends on it because of the great real-time connection between file actions in 'windows explorer' and the file lists in the wiki (indirect via mounting of certain directories on a Windows server). Is there anything a non-coding user like me could do to keep an essential plugin like this one future-proof?
—-2016.03.31 17:05 - MartinNL

You can always pay someone to maintain this plugin. See bounties and professional support and services (although you might be more successful finding someone elsewhere). — Anika Henke 2016-04-03 19:23

Thank you, I am going to discuss this here.

—-2016.04.04 08:15 - MartinNL

I have copied the essentials from the developer's web site, since the links are broken.
— Myron Turner 2015-06-09 03:39

The original page with illustrated examples is here: http://web.archive.org/web/20150411215519/http://www.foosel.org/snippets/dokuwiki/filelist. This link was provided in a post on the forum (https://forum.dokuwiki.org/thread/12665). Please make any necessary changes.

The original git repository of the plugin can be found at Github.