DocumentRelationsPlugin

short description here

Syntax Rules

Tag	Desciption
%RELATIONS{...}%	add document relations for the current topic see below for further elaboration
%NODEFAULTRELATIONS%	disable the default relations being generated for the current topic
%NEXTDOC{...}%	...
%PREVDOC{...}%	...

One or more relations are defined by %RELATIONS{<rel>="<target>" <rel>title="<titlestring>" ...}% where

• <rel> is one of the relations alternate, appendix, author, bookmark, chapter, section, subsection, begin, collection, contents, copyright, disclamer, end, first, footnote, glossary, help, index, last, meta, navigate, next, parent, up, prev, previous, publisher, search, sibling, top, trademark or translation
• <target> is the related topic name
• <rel>title specifies the title string that is to be added to the relation

Example: %RELATIONS{subsection="BlackMusicCollection" subsectiontitle="Come to where the Funk is"}%

These are the default relations generated for each topic

• parent: points to the topic's parent topic or WebHome if there's none or Main.WebHome if the current topic is a WebHome
• top: WebHome of Main.WebHome if the current topic is a WebHome
• author: the author of the last topic change
• alternate: printable skin and rss feed of the current web
• search: points to WebSearch
• contents: points to the SiteMap
• help: points to %TWIKIWEB%.UsersGuide
• index: points to WebIndex
• appendix: WebTopicList, WebChanges, WebNotify, WebStatistics, WebPreferences; on the TWikiWeb a pointer to the TWiki.TWikiPreferences is added
• bookmark: links to the edit, rename, attach, view, diff etc. topic actions

Disable these default relations using %NODEFAULTRELATIONS% per topic.

Examples

Plugin Settings

• Set SHORTDESCRIPTION = Adds document relations to TWiki pages

Plugin Installation Instructions

• Download the ZIP file from the Plugin web (see below)
• Unzip DocumentRelationsPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/DocumentRelationsPlugin.txt	Plugin topic
  data/TWiki/DocumentRelationsPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/DocumentRelationsPlugin.pm	Plugin Perl module

• Test if the installation was successful:
  • enter samples here

Plugin Info

Plugin Author:	TWiki:Main.MichaelDaum
Plugin Version:	22 Aug 2005 (v0.9)
Change History:
22 Aug 2005:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.024
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
License:	GPL (GNU General Public License)
TWiki:Plugins/Benchmark:	GoodStyle nn%, FormattedSearch nn%, DocumentRelationsPlugin nn%
Plugin Home:	TWiki:Plugins/DocumentRelationsPlugin
Feedback:	TWiki:Plugins/DocumentRelationsPluginDev
Appraisal:	TWiki:Plugins/DocumentRelationsPluginAppraisal

-- TWiki:Main.MichaelDaum - 22 Aug 2005