Plug Four Welcome, Registration, & other StartingPoints	View r1
Home ThePlug

PaginationPlugin 1 - 20 Jul 2007 - People.TWikiGuest

Line: 1 to 1

Added:

>
>

<--

PLEASE DO NOT EDIT THIS TOPIC

It is automatically generated from the subversion repository, and any changes you make will simply be overwritten the next time a release is generated.

Instead, you could check your fix in, raise a bug in the Bugs web, or mail the author. -->

PaginationPlugin

Syntax Rules
- PREVDOC, NEXTDOC
Plugin Installation Instructions
Plugin Info

Syntax Rules

PREVDOC, NEXTDOC

Display the previous/next topic in an ordered set. These tags can be used to page within a set of topics to the preceding or succeeding one. The set of topics, that we want to navigate in, is defined using a "where" and an "order" clause which the given topic is supposed to be part of.

Syntax:

%PREVDOC{"<topic" where="..." ...}%, %NEXTDOC{"<topic" where="..." ...}%
`"<topic>"`	topic which we search the predecessor/successor of
`web="..."`	web where to search for related topics; defaults to the web given with the <topic> parameter or the current one
`where="..."`	search clause, see documentation of the DBCacheContrib
`order="..."`	document property used to sort the hit set; defaults to "created"
`reverse="on,off"`	if set to on the sorting will be reversed, that is the logic of PREV and NEXT is inverted
`format="..."`	format string to render the navigation bar

Plugin Installation Instructions

Download and install all additionally required plugins listed in the dependencies information below
Unzip PaginationPlugin.zip in your twiki installation directory. Content:

File: Description:

%$MANIFEST%

Open the TWiki configuration dialog and enable the plugin
Optionally, run PaginationPlugin_installer to automatically check and install other TWiki modules that this module depends on.
Alternatively, manually make sure the dependencies listed in the table below are resolved. %$DEPENDENCIES%

Plugin Info

Plugin Author:	Main.MichaelDaum
Copyright:	© 2007 Michael Daum http://wikiring.com
License:	GPL (GNU General Public License)
Plugin Version:	0.10
Change History:
30 Jan 2007:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
Plugins/Benchmark:	GoodStyle 99%, FormattedSearch 99%, PaginationPlugin 99%
Plugin Home:	Plugins/PaginationPlugin
Feedback:	Plugins/PaginationPluginDev
Appraisal:	Plugins/PaginationPluginAppraisal

-- Main.MichaelDaum - 30 Jan 2007

Revision 1

r1 - 20 Jul 2007 - 11:05:27 - TWikiGuest