Differences

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

--- plugin:pglist [2012-06-25 19:35] – zaher
+++ plugin:pglist [2020-11-15 18:16] (current) – update compatible zaher
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description: List a pages or dirs inside the current namespace or selected namespace.
+description: List a pages or directories inside the current namespace or selected namespace.
 author     : Zaher Dirkey
 email      : zaherdirkey@yahoo.com
 type       : syntax
-lastupdate : 2012-06-09
+lastupdate : 2020-11-15
-compatible : >2009-02-14, 2008-05-05
+compatible : Detritus, Hogfather
 depends    :
 conflicts  :
@@ Line 13: / Line 13: @@
 tags       : file, listing
-downloadurl: https://github.com/parmaja/pglist
+downloadurl: https://github.com/parmaja/pglist/archive/master.zip
 bugtracker : https://github.com/parmaja/pglist/issues
 sourcerepo : https://github.com/parmaja/pglist
 ----
 ===== Installation =====
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
+===== Usage =====
-Download the archive and unpack it into ''<dokuwiki>/lib/plugins''.
+List a pages or directories inside the current namespace or selected namespace, but exclude the current page that have this list or you can exclude the start page.
+pglist also when list the directories, it checks if this directory has "start" page if no, it is will not listed, if exists it listed by the title of the start page in this directory.
+Also directories always sorted at the top of the list.
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
+I prefer to use ''useheading = 1'' ((see [[config:useheading|Configuration Setting: useheading]])) in your config to get a good title.
-===== Usage =====
+**Note: When use "dirs", it list directories only that have start.txt page and list the title of this page.
+If you like to list it even not have start.txt you need to add "any" to your parameters.**
-List a pages or dirs inside the current namespace or selected namespace, but execlude the current page that have this list or you can execlude the start page.
-pglist also when list the direcotryes indide check if this directory has "start" page if no, it is not listed, if exiest it listed by title of start page in this direnctory.
-also dirs always sorted on the top of list.
 ===== Syntax =====
@@ Line 35: / Line 35: @@
 Use this syntax
-  {{pglist> ns:selected_namespace files dirs me nostart fsort dsort}}
+  {{pglist>selected_namespace files dirs me nostart fsort dsort}}
+**Be sure there is NO space before namespace**
+If the namespace started with / it will takes as full name space, if it not started with / it will be relative to current namespace that the page exists in it
+for example: current page is dev/start
+  /dev/components
+is same with
+  components
+  dev/components  (bad)
+it is point to "dev/dev/components"
 =====Examples=====
@@ Line 46: / Line 57: @@
 <code>
-  {{pglist> ns:my_namespace}}
+  {{pglist>my_namespace}}
 </code>
 List all files inside the selected directory/namespace, only files and exclude the current page.
+<code>
+  {{pglist>/my_namespace}}
+</code>
+Same, List all files inside the selected directory/namespace, only files and exclude the current page.
+But it take the full path to namespace, i meant from the root.
 <code>