====== PGList Plugin ======

---- plugin ----
description: List a pages or directories inside the current namespace or selected namespace.
author     : Zaher Dirkey 
email      : zaherdirkey@yahoo.com 
type       : syntax
lastupdate : 2020-11-15
compatible : Detritus, Hogfather
depends    : 
conflicts  : 
similar    : dir, pagelist, nspages
tags       : file, listing

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 =====

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.

I prefer to use ''useheading = 1'' ((see [[config:useheading|Configuration Setting: useheading]])) in your config to get a good title.

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

===== Syntax =====

Use this syntax

  {{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=====

<code>
  {{pglist>}}  
</code>

List all files inside the current directory, only files and exclude the current page.

<code>
  {{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>
  {{pglist> dirs}}  
</code>

List all **directories** inside the current directory, only directories and exclude the current page.
<code>
  {{pglist> files dirs}}  
</code>

List all **files** and **directories** inside the current directory.
<code>
  {{pglist> files dirs me}}  
</code>

List all **files** and **directories** inside the current directory, **with** the current page that have this list, it is do not exclude me.

<code>
  {{pglist> files dirs nostart}}  
</code>

List all **files** and **directories** inside the current directory, **exclude** the current page and the **start** page also.