plugin:filelist
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:filelist [2024-03-14 15:37] – annda | plugin:filelist [2024-05-09 13:02] (current) – no for Igor 2003:ea:ef05:526:2c8d:691d:8e6e:1f88 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
---- plugin ---- | ---- plugin ---- | ||
- | description: | + | description: |
- | author | + | author |
- | email : dokuwiki@cosmocode.de | + | email : freaks@dokuwiki.org |
- | type : | + | type : |
- | lastupdate : 2024-03-12 | + | lastupdate : 2024-04-03 |
- | compatible : Jack Jackrum, Kaos | + | compatible : !Igor, |
depends | depends | ||
conflicts | conflicts | ||
- | similar | + | similar |
- | tags : | + | tags : |
- | downloadurl: | + | updatemessage: |
- | bugtracker : https:// | + | |
- | sourcerepo : https:// | + | downloadurl: |
+ | bugtracker : https:// | ||
+ | sourcerepo : https:// | ||
donationurl: | donationurl: | ||
- | screenshot_img : | + | screenshot_img : https:// |
---- | ---- | ||
- | This plugin | + | The filelist |
- | * Anonymous users (users that have not logged in) are always denied access regardless of the ACL configuration | + | ===== Installation ===== |
- | * The '' | + | |
- | Exceptions can be defined in the plugin | + | Search and install |
- | [[https:// | ||
- | ===== Installation ===== | + | ==== Upgrade from older Versions |
- | Search | + | Release 2024-02-27 is a complete refactoring of the old plugin. The following features have been removed: |
+ | |||
+ | * all handling of media files including the various preview options | ||
+ | * This is better served by other plugins like the [[filelisting]] or [[gallery]] plugins | ||
+ | * output of single links | ||
+ | * page style output | ||
+ | * paging options (offset, limit, index) | ||
+ | |||
+ | If you accidentally updated | ||
+ | |||
+ | Path configuration differs from previous releases. Please see below to set up your paths again. | ||
+ | |||
+ | Some more info is available in the [[https:// | ||
+ | |||
+ | ===== Path Configuration ===== | ||
+ | |||
+ | To use this plugin, you need to configure one or more **paths** that should be allowed for listings. | ||
+ | |||
+ | These paths need to be available on the same server your wiki is running on. This can be a local directory, a file system mount or a UNC path to a file share (Windows only). | ||
+ | |||
+ | All files and directories below the configured paths will be available to the plugin for listing. The PHP process running your DokuWiki needs to be allowed to read these files and directories! | ||
+ | |||
+ | > Note: in older plugin versions the paths were configured in the '' | ||
+ | |||
+ | For each configured path an optional **alias** may be configured. This alias will simplify the syntax when using the plugin (see examples below). | ||
+ | |||
+ | For each configured path you may configure how the listed files are to be accessed via the web. Eg. how the full URL to download a file is to be constructed. By default files will be delivered by DokuWiki itself, without any additional permission checks - if PHP can read the file, a user may download it. By configuring your own **web prefix**, you can implement your own mechanism of file delivery. | ||
+ | |||
+ | For example custom web prefixes could be used for using your web server to deliver the files without involving PHP or to redirect all links to a document management system. | ||
+ | |||
+ | > Note: in older plugin versions the web prefixes were configured in the '' | ||
+ | |||
+ | All the above things are configured in the '' | ||
+ | |||
+ | **Example** | ||
+ | |||
+ | < | ||
+ | \\somewindows.server\with\a\share | ||
+ | W> https:// | ||
+ | A> fileserver | ||
+ | / | ||
+ | A> local | ||
+ | </ | ||
+ | |||
+ | Forward or backward slashes are mostly interchangeable. Only UNC paths have to start with two backslashes. | ||
+ | |||
+ | > Important: the plugin will never list or give access to files in the DokuWiki or data directories, | ||
+ | ===== Other Config Options ===== | ||
+ | |||
+ | There are a few more options you can set in the [[plugin:config|Configuration Manager]]. | ||
+ | |||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | |||
+ | ===== Usage ===== | ||
+ | |||
+ | The filelist plugin provides a new syntax to list files. The general command syntax is the following: | ||
+ | |||
+ | < | ||
+ | {{filelist> | ||
+ | </ | ||
+ | |||
+ | The **pattern** defines what files to list. It uses the [[man> | ||
+ | |||
+ | For example, with the example path configuration from above, the following would list all files ending | ||
+ | |||
+ | {{filelist> | ||
+ | |||
+ | |||
+ | The **parameterlist** | ||
+ | |||
+ | ==== Parameters ==== | ||
+ | |||
+ | ^Name ^Description ^Possible values ^Default | | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
- | ==== Configuration ===== | ||
- | In the '' | ||
plugin/filelist.1710427070.txt.gz · Last modified: 2024-03-14 15:37 by annda