Finds and lists all pages that are referred to by the current page.
(twin sister of ReferringPagesPlugin)
The depth parameter allows to display a recursive tree of referred pages.
--DF Aug 2004 , ([Rationale]) , Jan 2005 (added sorting)
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] :
[#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.
This plugin helps me to automatically keep an overview of such related pages an the tree of links which have been setup.
I am using it in combination with collapsable list tags, to navigate more easily longer lists.
I modified the code to allow the duplicates to have active links (fulllink option). Quick way to get a full site map at level=4. Thanks for the code! -- Foster Schucker
What version of JSPWiki did you test this against? It still compiles against the version I'm using (2.1.103-alpha), but I'm getting a misbehavior in the plugin: the WikiEngine is reporting too few attachments up to the plugin. The problem seems to occur after the WikiEngine.textToHTML() call on line 200. -GM
The plugin was developped on 2.1.86. So far, I didn't notice any problems on later versions, but never tried a recompilation.
--DF
This plugin is now included in 2.3.25 (with some simplifications, the new ReferenceManager allows direct queries to page reference lists, so it is now a lot faster, too).
-- JanneJalkanen
I want to list all the tips from page Wiki.Help.Tips, so I have this in a page [{ReferredPagesPlugin page='Wiki.Help.Tips'}]
However I get a list like
* Wiki.Help.Tip1 * Wiki.Help.Tip2 * Wiki.Help.Tip3 * Wiki.Help.Tip4
so, I would like to get rid of "Wiki.Help." :) What about something like: [{ReferredPagesPlugin page='Wiki.Help.Tips' domain='Wiki.Help.'}] so the ReferredPagesPlugin knows it shouldn't show the domain in the list of links... (other words instead of 'domain': context, hide, ignore,... In fact 'hide' might be useful and used in other places to hide parts of the link.) --Adler
what about adding this parameter before='#' so we can list items with other thing than bullets... it could be possible to not have bullets at all and make them separated wither by <br> or something else. --Adler
Still it doesn't work. What I get is just the name of the page, 'Home' although I have the option exclude='Home'
If I understood correctly this plugin should create an index of all the 'links' on the page where this plugin is used. or?... --Adler
thank you for the reality check :) however it doesn't work for me :( my code [{ReferredPagesPlugin page='Category Projects' include='Project.*' depth='3'}] and I get one link "Category Projects"... instead of the links on that page that start with "Project". The page "Category Projects" has a few links to projects (these links are generated by using [{ReferringPagesPlugin}], is that problem?). I also created several links starting by "Project" but not even those appear here. --Adler!Reality check:
[{ReferredPagesPlugin page='BrushedTemplate' include='Brushed.*' exclude='JSPWikiCSSDesign' depth='2'}]
This will list all pages referred to by the BrushedTemplate page; if following condition matches: the links should start with Brushed and may not be match the JSPWikiCSSDesign link.
----
Back to JSPWikiPlugins