Parameters #

page='<pagename>'

The name of the root page. Default is the name of the calling page.

type='local|external|attachment'

Local shows all local wiki links.
External shows all external links of the root page.
Attachment shows the referred attachments of the root page. You can combine the different types like in type='local attachment' Default is local.

depth='1..8'

Number of levels of wiki links to be expanded. Default is one.

include='<pattern>'

Only show links matching the include pattern[1]. (eg. 'BUG.*|CHANGE.*')

exclude='pattern'

Never show links matching the exclude pattern[1]. (eg. 'LeftMenu.*|Main')

format='full|sort'

Format full will display all referred page links with duplicate links as normal text but are expanded as normal. Default format will suppress duplicate page links.
Format sort will sort the referred page links alphabetically. Default format shows all referred page links in order of appearance.

Example#

Some valid examples :

 
    [{ReferredPagesPlugin depth='2'}]
    [{ReferredPagesPlugin page='Main' depth='2' format='sort' }]
    [{ReferredPagesPlugin page='Main' depth='2' include='JSP.*|.*Tag' format='full'}]
    [{ReferredPagesPlugin page='About' type='external' include='.*\.com.*'}]

The output of the plugin may look like this[2][3] :

<pagename>

• Page1
  • Page12
  • Page21
  • Page 1
• Page 2

Notes#

[#1] This plugin uses the PERL regular expression syntax, which is more powerful than the standard unix globbing syntax.
The main difference is that any char is matched by means of a explicit dot "." ; multiple occurences of any char are thus matched by means of ".*", ".+" or ".?".
See also overview of regular expression syntax

[#2]Hover your mouse over the <pagename> link and you will see all the settings of the called plugin.

[#3]The whole output of the plugin is enclosed in a <div class='ReferredPagesPlugin'> tag, so you can do any special formatting you want via the jspwiki.css.

[Why]
Although JSPWiki pages are by nature organised as a set of flat files, it is still very natural to organise related information in a more or less hierarchical way. Typically you start of with an overview page, adding links to detailed sub sections and sub sub sections.
I find myself often doing this using a page prefix (sometimes delimitted by a .) to keep related stuff together.