1# MediaList Plugin for DokuWiki
2
3![example](https://github.com/ssahara/dokuwiki-plugin-medialist/raw/master/sample1.png)
4
5This plugin shows a list of media files referred in a given wikipage or
6stored in a given namespace.
7Note, the plugin is aware of your ACLs.
8
9In the namespace mode list, the button to open the namespace by the Fullscreen
10Media Manager is shown at the upper-right corner of the list area.
11
12## Usage
13
14Specify a scope parameter that defines the output of the list of media files. The scope can be a “page id” or a “namespace”.
15
16  1. **Page id** : look up media files linked in the page (i.e. curly brackets `{{...}}` in page text).
17  2. **namespace** : look up media files stored in the namespace. The parameter ends by `:` or `:*`,
18
19Some replacement patterns for namespace templates --- `@ID@`, `@NS@`, `@PAGE@` --- are available
20in order to specify the scope parameter.
21
22
23To list media files linked in the current page use:
24
25    {{medialist>@ID@}} or {{medialist>@NS@:@PAGE@}}
26
27To list media files stored in the current namespace use:
28
29    {{medialist>@NS@:}}
30
31To list media files stored in the current namespace and its sub-namesapces use:
32
33    {{medialist>@NS@:*}}
34
35More examples:
36
37    {{medialist>wikipage}}
38    {{medialist>ns1:ns2:*}}
39    {{medialist>@NS@:start}}
40    {{medialist>@ID@:}}
41
42#### legacy syntax support
43
44In ehe older release 2009-05-21 version, the scope parameter could be one of literal keywords, `@PAGE@`, `@NAMESPACE@` and `@ALL`.
45These literal keywords must be used as is, and are not kind of replacement pattens.
46
47* `{{medialist>@PAGE@}}` shows files linked in the current page.
48* `{{medialist>@NAMESPACE@}}` shows files stored in the current namespace and sub namecpaces.
49* `{{medialist>@ALL@}}` shows all files when `@PAGE@` and `@NAMESPACE@` keywords given.
50
51Legacy literal keywords should be corrected using replacement patterns:
52
53    {{medialist>@PAGE@}} is same as {{medialist>@ID@}}
54    {{medialist>@NAMESPACE@}} is same as {{medialist>@NS@:}}
55
56
57----
58
59See the MediList plugin page on DokuWiki.org for further information:
60
61  * http://dokuwiki.org/plugin:medialist
62
63(c) 2005 - 2009 by Michael Klier (chi@chimeric\.de)
64(c) 2016        by Satoshi Sahara (sahara\.satoshi@gmail\.com)
65
66This program is free software; you can redistribute it and/or modify
67it under the terms of the GNU General Public License as published by
68the Free Software Foundation; version 2 of the License
69
70This program is distributed in the hope that it will be useful,
71but WITHOUT ANY WARRANTY; without even the implied warranty of
72MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
73See the GNU General Public License for more details.
74
75