Differences

This shows you the differences between two versions of the page.

--- plugin:medialist [2016-06-08 17:46] – [MediaList Plugin] s.sahara
+++ plugin:medialist [2018-05-28 21:32] (current) – [Installation] Klap-in
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description: Show a list of media files (images/archives ...) referred in a given page using curly brackets "{{...}}", or stored in a given namespace.
+description: Show a list of media files (images/archives...) referred in a given page or stored in a given namespace
-author     : S.Sahara (previou author: Michael Klier)
+author     : S.Sahara (previous author: Michael Klier)
 email      : sahara.satoshi@gmail.com
 type       : syntax
-lastupdate : 2016-06-09
+lastupdate : 2016-08-24
-compatible : > 2009-02-14, 2008-05-05, "Detritus"
+compatible : > 2009-02-14, 2008-05-05, "Detritus", 2016-06-26, 2017-02-19
 depends    :
-conflicts  :
+conflicts  : pdfjs
 similar    : filelist
 tags       : media, images, namespace, listing, file, download
-downloadurl: https://github.com/ssahara/dokuwiki-plugin-medialist/zipball/master
-bugtracker : https://github.com/ssahara/dokuwiki-plugin-medialist/issues
-sourcerepo : https://github.com/ssahara/dokuwiki-plugin-medialist/
-----
-:!: **If you're looking for a really versatile/flexible solution for listing media files I suggest you give the [[plugin:filelist]] plugin a try!** :!:
+downloadurl: https://github.com/ssahara/dw-plugin-medialist/zipball/master
+bugtracker : https://github.com/ssahara/dw-plugin-medialist/issues
+sourcerepo : https://github.com/ssahara/dw-plugin-medialist
+donationurl:
+screenshot_img: https://raw.githubusercontent.com/ssahara/dw-plugin-medialist/master/sample1.png
+----
 ===== Description =====
+{{ https://raw.githubusercontent.com/ssahara/dw-plugin-medialist/master/sample1.png?recache|an example}}
 This plugin shows a list of media files for a given wikipage which are either linked in the page itself or belong to its namespace. Note, the plugin is aware of your ACLs.
-The original plugin author Michael Klier <chi@chimeric.de> does not provide any support since 2009-05-21 release. This plugin has adopted for further development to catch up newer DokuWiki and PHP 7 series.
+In the namespace mode, a button to open the namespace by the [[:fullscreen_mediamanager|Fullscreen Media Manager]] is shown at upper-right corner of the list area; it may be helpful to upload or delete files in the namespace.
+If you're looking for a really versatile/flexible solution for listing media files, see the [[plugin:filelist]] plugin.
 ===== Installation =====
-Install the plugin through the [[plugin:extension|Extension Manager]] or [[plugin:plugin|Plugin Manager]] using the download URL above, which points to latest version of the plugin. Refer to [[:plugin_installation_instructions|plugin installation instructions]].
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:plugin_installation_instructions|plugin installation instructions]] on how to install plugins manually.
-===== Syntax =====
+===== Usage / Example =====
-To list the media files linked in the given page use:
-  {{medialist>wikipage}}
+Specify a scope parameter that defines the output of the list of media files. The scope can be a "page id" or a "namespace".
+  - **page id**: look up media files linked in the page (i.e. curly brackets ''%%{{...}}%%'' in page text).
+  - **namespace**: look up media files stored the namespace. The parameter ends by ''%%:%%'' or ''%%:*%%'' ,
+Some replacement patterns for [[:namespace templates]] -- ''@ID@'', ''@NS@'', ''@PAGE@'' -- are available in order to specify the scope parameter.
 To list the media files linked in the current page use:
-  {{medialist>@PAGE@}}
+  {{medialist>@ID@}} or {{medialist>@NS@:@PAGE@}}
-To list the media files contained in the current namespace use:
+To list media files stored in the current namespace use:
-  {{medialist>@NAMESPACE@}}
+  {{medialist>@NS@:}}
-To list both, media files linked in the current page and contained in the current namespace use:
+To list media files stored in the current namespace and its sub-namesapces use:
-  {{medialist>@ALL@}}
+  {{medialist>@NS@:*}}
-:!: NOTE: ''@ALL@'' keyword will be obsoleted in future release.  --- [[user>s.sahara|s.sahara]] //2016-06-06 14:42//
+More examples:
-===== Demo =====
-<del>You can see the plugin in action [[http://www.chimeric.de/_demo/plugin:medialist|here]].</del> - link is dead (404)
-New demo (work in progress): [[http://ryan.gulix.cl/tests_anteater/doku.php/start|here]].
+  {{medialist>wikipage}}
+  {{medialist>ns1:ns2:*}}
+  {{medialist>@NS@:start}}
+  {{medialist>@ID@:}}
-===== Changelog =====
+==== Legacy Syntax Support ====
-A complete changelog is available [[https://github.com/ssahara/dokuwiki-plugin-medialist/commits/|here]].
-{{rss>https://github.com/ssahara/dokuwiki-plugin-medialist/commits/master.atom 10 1d date}}
+In the older release 2009-05-21 version, the scope parameter could be one of literal keywords, ''%%@PAGE@%%'', ''%%@NAMESPACE@%%'' and ''%%@ALL@%%''. These literal keywords must be used as is, and are not replacement pattens.
-===== Bugs / Feature Requests =====
+  * ''%%{{medialist>@PAGE@}}%%'' shows files linked in the current page.
-Please report bugs and feature requests at the [[https://github.com/ssahara/dokuwiki-plugin-medialist/issues|bug tracker]].
+  * ''%%{{medialist>@NAMESPACE@}}%%'' shows files stored in the current namespace and sub namecpaces.
+  * ''%%{{medialist>@ALL@}}%%'' shows all files when ''%%@PAGE@%%'' and ''%%@NAMESPACE@%%'' keywords given.
-==== ToDO ====
+  {{medialist>@PAGE@}} is same as {{medialist>@ID@}}
-  * support ''@ID@'' and ''@NS@'' keywords, same as [[:namespace templates#replacement_patterns|replacement patterns]] for namespace templates
+  {{medialist>@NAMESPACE@}} is same as {{medialist>@NS@:}}
-  * show full media id in the list (namespace mode only)
-  * discontinue ''@ALL@'' keyword
+:!: NOTE: ''%%@ALL@%%'' keyword will be obsoleted in future release. --- [[user>s.sahara|s.sahara]] //2016-06-06 14:42//
+===== Development =====
+The medialist plugin was developed by [[https://github.com/chimeric|Michael Klier]] %%<chi@chimeric.de>%%, who does not provide any support after 2009-05-21 release. This plugin has adopted for further development to catch up newer DokuWiki and PHP 7 series.
+==== Change Log ====
+-06-30: added two config options: **emptyInfo** (default off), **checkboxes** (default off)
+A complete changelog is available [[https://github.com/ssahara/dw-plugin-medialist/commits/|here]].
+{{rss>https://github.com/ssahara/dw-plugin-medialist/commits/master.atom date}}
+==== Bugs / Feature Requests ====
+Please report bugs and feature requests at the [[https://github.com/ssahara/dokuwiki-plugin-medialist/issues|bug tracker]].