de.tuberlin.cs.flp.jspwiki.plugin


Class Category

All known Subclassifier:
WikiArchive

All known implemented Interfaces:
WikiPlugin


public class Category
Namespace: plugin


[{Category
[page=".."]
format="_list_|gallery"
sort="_alphabetic_|none"
headlines="_alphabetic_lnone|"
attachments="yes|_no_"
gallery-width=n (default: 4)
thumbnails="yes|_no_"
thumbnailWidth=n
thumbnailHeight=n
pagesize=n (maximum number of entries to be displayed per page, default: no limit) }]

Lists all pages that are associated with the current page as their Category. The output format can be configured in several ways according to the parameters. Special (unlike ReferringPagesPlugin): Only those pages are considered members of the category which contain a link where the category name is seperated from the prefix "Category" WITH A BLANK. This way it becomes possible to link to the category page without declaring the referring page a member of the category, by NOT using a blank between "Category" and the category name. Examples: using "[Category Glossary]" DOES mark a page as a member of the category, using [CategoryGlossary] simply is a link to the category page without declaring the page in which it appears as a member of the category. Note that "Category" is not necessarily word that marks a page a category page, simply the first uppercase part of the page's name is used.

Authors:
Jens Gulden


Attribute Summary
public static int  DEFAULT_GALLERY_COLUMNS
 
public static int  DEFAULT_PAGE
 
public static int  DEFAULT_PAGESIZE
 
public static String  DEFAULT_THUMBNAIL_SIZE
 
public static int  FORMAT_GALLERY
 
public static int  FORMAT_LIST
 
public static int  HEADLINES_ALPHABETIC
 
public static int  HEADLINES_NONE
 
public static String  HTTP_PARAM_PAGE
 
public static String  PARAM_ATTACHMENTS
 
public static String  PARAM_FORMAT
 
public static String  PARAM_GALLERY_COLUMNS
 
public static String  PARAM_HEADLINES
 
public static String  PARAM_PAGE
 
public static String  PARAM_PAGESIZE
 
public static String  PARAM_SORT
 
public static String  PARAM_THUMBNAILS
 
public static String  PARAM_THUMBNAIL_SIZE
 
public static int  SORT_ALPHABETIC
 
public static int  SORT_NONE
 
public static String  VALUE_FORMAT_GALLERY
 
public static String  VALUE_HEADLINES_ALPHABETIC
 
public static String  VALUE_SORT_ALPHABETIC
 

Method Summary
public static String   categoryPageLink(String category)
 
protected String   deriveFullTitle(String name, WikiPage wikipage, WikiEngine engine)
 
public String   execute(WikiContext context, Map params)
Executes the plugin.  
protected static String   heading(String s)
Formats a string as HTML-heading.  

Tagged Values
static false
documentation#author Jens Gulden

Attribute Detail

DEFAULT_GALLERY_COLUMNS

public static final int DEFAULT_GALLERY_COLUMNS

Multiplicity: 1..1
Ordering: unspecified



DEFAULT_PAGE

public static final int DEFAULT_PAGE

Multiplicity: 1..1
Ordering: unspecified



DEFAULT_PAGESIZE

public static final int DEFAULT_PAGESIZE

Multiplicity: 1..1
Ordering: unspecified



DEFAULT_THUMBNAIL_SIZE

public static final String DEFAULT_THUMBNAIL_SIZE

Multiplicity: 1..1
Ordering: unspecified



FORMAT_GALLERY

public static final int FORMAT_GALLERY

Multiplicity: 1..1
Ordering: unspecified



FORMAT_LIST

public static final int FORMAT_LIST

Multiplicity: 1..1
Ordering: unspecified



HEADLINES_ALPHABETIC

public static final int HEADLINES_ALPHABETIC

Multiplicity: 1..1
Ordering: unspecified



HEADLINES_NONE

public static final int HEADLINES_NONE

Multiplicity: 1..1
Ordering: unspecified



HTTP_PARAM_PAGE

public static final String HTTP_PARAM_PAGE

Multiplicity: 1..1
Ordering: unspecified



PARAM_ATTACHMENTS

public static final String PARAM_ATTACHMENTS

Multiplicity: 1..1
Ordering: unspecified



PARAM_FORMAT

public static final String PARAM_FORMAT

Multiplicity: 1..1
Ordering: unspecified



PARAM_GALLERY_COLUMNS

public static final String PARAM_GALLERY_COLUMNS

Multiplicity: 1..1
Ordering: unspecified



PARAM_HEADLINES

public static final String PARAM_HEADLINES

Multiplicity: 1..1
Ordering: unspecified



PARAM_PAGE

public static final String PARAM_PAGE

Multiplicity: 1..1
Ordering: unspecified



PARAM_PAGESIZE

public static final String PARAM_PAGESIZE

Multiplicity: 1..1
Ordering: unspecified



PARAM_SORT

public static final String PARAM_SORT

Multiplicity: 1..1
Ordering: unspecified



PARAM_THUMBNAILS

public static final String PARAM_THUMBNAILS

Multiplicity: 1..1
Ordering: unspecified



PARAM_THUMBNAIL_SIZE

public static final String PARAM_THUMBNAIL_SIZE

Multiplicity: 1..1
Ordering: unspecified



SORT_ALPHABETIC

public static final int SORT_ALPHABETIC

Multiplicity: 1..1
Ordering: unspecified



SORT_NONE

public static final int SORT_NONE

Multiplicity: 1..1
Ordering: unspecified



VALUE_FORMAT_GALLERY

public static final String VALUE_FORMAT_GALLERY

Multiplicity: 1..1
Ordering: unspecified



VALUE_HEADLINES_ALPHABETIC

public static final String VALUE_HEADLINES_ALPHABETIC

Multiplicity: 1..1
Ordering: unspecified



VALUE_SORT_ALPHABETIC

public static final String VALUE_SORT_ALPHABETIC

Multiplicity: 1..1
Ordering: unspecified

Method Detail

categoryPageLink

public static String categoryPageLink(String category)

Parameters:
category -
Returns:


deriveFullTitle

protected String deriveFullTitle(String name, WikiPage wikipage, WikiEngine engine)

Parameters:
name -
wikipage -
engine -
Returns:


execute

public String execute(WikiContext context, Map params)


Executes the plugin.
Method Tagged Values
documentation#throws PluginException if an error occurs

Parameters:
context - The WikiContext.
params - Parameters specified at plugin inclusion.
Returns:
HTML to be inserted into page
Exceptions:
PluginException if an error occurs


heading

protected static String heading(String s)


Formats a string as HTML-heading.
Parameters:
s - The string to be formatted.
Returns:
The formatted HTML string.

previous   TOC   next

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in the USA and other countries. Copyright 2003-2006 Gentleware AG, Ludwigstr. 12, 20357 Hamburg, Germany. All Rights Reserved.
UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.