Author: jalkanen
Date: Sat Aug 16 03:38:36 2008
New Revision: 686472
URL: http://svn.apache.org/viewvc?rev=686472&view=rev
Log:
JSPWIKI-325: Patch to fix the parameter names.
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/AbstractReferralPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/BugReportHandler.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Counter.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/CurrentTimePlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Denounce.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Groups.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IfPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Image.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IndexPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/InsertPage.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/ListLocksPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Note.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/PluginManager.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/RPCSamplePlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/RecentChangesPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/ReferredPagesPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Search.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/SessionsPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/TableOfContents.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/UndefinedPagesPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/UnusedPagesPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogArchivePlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogEntryPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogPlugin.java
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/AbstractReferralPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/AbstractReferralPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/AbstractReferralPlugin.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/AbstractReferralPlugin.java
Sat Aug 16 03:38:36 2008
@@ -39,15 +39,17 @@
/**
* This is a base class for all plugins using referral things.
*
- * <p>Parameters also valid for all subclasses.</p>
+ * <p>Parameters (also valid for all subclasses of this class) : </p>
* <ul>
- * <li><b>maxwidth</b>: maximum width of generated links</li>
- * <li><b>separator</b>: separator between generated links (wikitext)</li>
- * <li><b>after</b>: output after the link</li>
- * <li><b>before</b>: output before the link</li>
- * <li><b>show</b>: Either "pages" (default) or "count". When "count", shows
only the count
- * of pages which match. (Since 2.8)</li>
- * <li><b>showLastModified</b>: When show=count, shows also the last modified
date. (Since 2.8)</li>
+ * <li><b>maxwidth</b> - maximum width of generated links</li>
+ * <li><b>separator</b> - separator between generated links (wikitext)</li>
+ * <li><b>after</b> - output after the link</li>
+ * <li><b>before</b> - output before the link</li>
+ * <li><b>exclude</b> - a regular expression of pages to exclude from the
list. </li>
+ * <li><b>include</b> - a regular expression of pages to include in the
list. </li>
+ * <li><b>show</b> - value is either "pages" (default) or "count". When
"count" is specified, shows only the count
+ * of pages which match. (since 2.8)</li>
+ * <li><b>showLastModified</b> - When show=count, shows also the last
modified date. (since 2.8)</li>
* </ul>
*
*/
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/BugReportHandler.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/BugReportHandler.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/BugReportHandler.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/BugReportHandler.java
Sat Aug 16 03:38:36 2008
@@ -39,9 +39,13 @@
/**
* Provides a handler for bug reports. Still under construction.
*
+ * <p>Parameters : </p>
* <ul>
- * <li>"title" = title of the bug. This is required. If it is empty (as in
"")
- * it is a signal to the handler to return quietly.</li>
+ * <li><b>title</b> - title of the bug, this is required. If it is empty
(as in "") it is a signal to the handler to return quietly.</li>
+ * <li><b>description</b> - description of the bug.</li>
+ * <li><b>version</b> - version</li>
+ * <li><b>map</b> - I have no idea </li>
+ * <li><b>page</b> - The name of the page to be created for this bug report
</li>
* </ul>
*
*/
@@ -50,11 +54,16 @@
{
private static Logger log = Logger.getLogger( BugReportHandler.class );
- public static final String TITLE = "title";
- public static final String DESCRIPTION = "description";
- public static final String VERSION = "version";
- public static final String MAPPINGS = "map";
- public static final String PAGE = "page";
+ /** Parameter name for setting the title. Value is <tt>[EMAIL
PROTECTED]</tt>. */
+ public static final String PARAM_TITLE = "title";
+ /** Parameter name for setting the description. Value is <tt>[EMAIL
PROTECTED]</tt>. */
+ public static final String PARAM_DESCRIPTION = "description";
+ /** Parameter name for setting the version. Value is <tt>[EMAIL
PROTECTED]</tt>. */
+ public static final String PARAM_VERSION = "version";
+ /** Parameter name for setting the map. Value is <tt>[EMAIL
PROTECTED]</tt>. */
+ public static final String PARAM_MAPPINGS = "map";
+ /** Parameter name for setting the page. Value is <tt>[EMAIL
PROTECTED]</tt>. */
+ public static final String PARAM_PAGE = "page";
private static final String DEFAULT_DATEFORMAT = "dd-MMM-yyyy HH:mm:ss
zzz";
@@ -71,9 +80,9 @@
SimpleDateFormat format = new SimpleDateFormat( DEFAULT_DATEFORMAT );
ResourceBundle rb =
context.getBundle(WikiPlugin.CORE_PLUGINS_RESOURCEBUNDLE);
- title = (String) params.get( TITLE );
- description = (String) params.get( DESCRIPTION );
- version = (String) params.get( VERSION );
+ title = (String) params.get( PARAM_TITLE );
+ description = (String) params.get( PARAM_DESCRIPTION );
+ version = (String) params.get( PARAM_VERSION );
Principal wup = context.getCurrentUser();
@@ -88,7 +97,7 @@
if( description == null ) description = "";
if( version == null ) version = "unknown";
- Properties mappings = parseMappings( (String) params.get( MAPPINGS ) );
+ Properties mappings = parseMappings( (String) params.get(
PARAM_MAPPINGS ) );
//
// Start things
@@ -104,9 +113,9 @@
//
// Outputting of basic data
//
- out.println("|"+mappings.getProperty(TITLE,"Title")+"|"+title);
+
out.println("|"+mappings.getProperty(PARAM_TITLE,"Title")+"|"+title);
out.println("|"+mappings.getProperty("date","Date")+"|"+format.format(d));
-
out.println("|"+mappings.getProperty(VERSION,"Version")+"|"+version);
+
out.println("|"+mappings.getProperty(PARAM_VERSION,"Version")+"|"+version);
if( submitter != null )
{
out.println("|"+mappings.getProperty("submitter","Submitter")+
@@ -120,11 +129,11 @@
{
Map.Entry entry = (Map.Entry) i.next();
- if( entry.getKey().equals( TITLE ) ||
- entry.getKey().equals( DESCRIPTION ) ||
- entry.getKey().equals( VERSION ) ||
- entry.getKey().equals( MAPPINGS ) ||
- entry.getKey().equals( PAGE ) ||
+ if( entry.getKey().equals( PARAM_TITLE ) ||
+ entry.getKey().equals( PARAM_DESCRIPTION ) ||
+ entry.getKey().equals( PARAM_VERSION ) ||
+ entry.getKey().equals( PARAM_MAPPINGS ) ||
+ entry.getKey().equals( PARAM_PAGE ) ||
entry.getKey().toString().startsWith("_") )
{
// Ignore this
@@ -154,7 +163,7 @@
// Now create a new page for this bug report
//
String pageName = findNextPage( context, title,
- (String)params.get( PAGE ) );
+ (String)params.get( PARAM_PAGE ) );
WikiPage newPage = new WikiPage( context.getEngine(), pageName );
WikiContext newContext = (WikiContext)context.clone();
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Counter.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Counter.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Counter.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Counter.java Sat Aug
16 03:38:36 2008
@@ -24,17 +24,16 @@
import java.util.*;
/**
- * Provides a page-specific counter.
- * <P>Parameters
- * <UL>
- * <LI>name - Name of the counter. Optional.
- * <LI>increment - The amount to increment, may be a negative value,
default is 1. Optional.
- * <LI>showResult - Should the counter value be visible on the page,
default is true. Optional.
- * </UL>
+ * Provides a page-specific counter, it is reset every time a page is
rendered, so it is not usable as a hitcounter.
+ * <br>Stores a variable in the WikiContext called "counter", with the name
of the optionally specified variable "name".
+ * <br>For example: If name is "thispage", then the variable name is called
"counter-thispage".
*
- * Stores a variable in the WikiContext called "counter", with the name of the
- * optionally attached. For example:<BR>
- * If name is "thispage", then the variable name is called "counter-thispage".
+ * <p>Parameters : </p>
+ * <ul>
+ * <li><b>name</b> - Name of the counter. Optional.</li>
+ * <li><b>increment</b> - The amount to increment, may be a negative value,
default is 1. Optional.</li>
+ * <li><b>showResult</b> - Should the counter value be visible on the page,
default is true. Optional.</li>
+ * </ul>
*
* @since 1.9.30
*/
@@ -43,9 +42,13 @@
{
// private static Logger log = Logger.getLogger( Counter.class );
+ /** Parameter name for setting the name. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_NAME = "name";
+ /** Parameter name for setting the increment. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_INCREMENT = "increment";
+ /** Parameter name for setting the showResult. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_SHOW_RESULT = "showResult";
+ /** Parameter name for setting the start. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_START = "start";
public static final String DEFAULT_NAME = "counter";
private static final int DEFAULT_INCREMENT = 1;
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/CurrentTimePlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/CurrentTimePlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/CurrentTimePlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/CurrentTimePlugin.java
Sat Aug 16 03:38:36 2008
@@ -32,7 +32,9 @@
/**
* Just displays the current date and time.
* The time format is exactly like in the java.text.SimpleDateFormat class.
- *
+ *
+ * <p>Parameters : </p>
+ * NONE
* @since 1.7.8
* @see java.text.SimpleDateFormat
*/
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Denounce.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Denounce.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Denounce.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Denounce.java Sat Aug
16 03:38:36 2008
@@ -34,8 +34,14 @@
import javax.servlet.http.HttpServletRequest;
/**
- * Denounces a link by removing it from any search engine. The bots are
listed
- * in com/ecyrd/jspwiki/plugin/denounce.properties.
+ * Denounces a link by removing it from any search engine.
+ * <br> The bots are listed in com/ecyrd/jspwiki/plugin/denounce.properties.
+ *
+ * <p>Parameters : </p>
+ * <ul>
+ * <li><b>link</b> - The link to be denounced, this parameter is required</li>
+ * <li><b>text</b> - The text to use, defaults to the link</li>
+ * </ul>
*
* @since 2.1.40.
*/
@@ -43,7 +49,9 @@
{
private static Logger log = Logger.getLogger(Denounce.class);
+ /** Parameter name for setting the link. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_LINK = "link";
+ /** Parameter name for setting the text. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_TEXT = "text";
private static final String PROPERTYFILE =
"com/ecyrd/jspwiki/plugin/denounce.properties";
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Groups.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Groups.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Groups.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Groups.java Sat Aug 16
03:38:36 2008
@@ -32,8 +32,12 @@
/**
* <p>Prints the groups managed by this wiki, separated by commas.
- * The groups are sorted in ascending order, and are hyperlinked
- * to the page that displays the group's members.</p>
+ * <br>The groups are sorted in ascending order, and are hyperlinked to the
page that displays the group's members.
+ * </p>
+ * <p>Parameters : </p>
+ * NONE
+ *
+ *
* @since 2.4.19
* @author Andrew Jaquith
*/
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IfPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IfPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IfPlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IfPlugin.java Sat Aug
16 03:38:36 2008
@@ -36,14 +36,14 @@
* You can also use shorthand "If" to run it.
* Parameters:
* <ul>
- * <li>group - A "|" -separated list of group names.
- * <li>user - A "|" -separated list of user names.
- * <li>ip - A "|" -separated list of ip addresses.
- * <li>var - A wiki variable
- * <li>page - A page name
- * <li>contains - A Perl5 regexp pattern
- * <li>is - A Perl5 regexp pattern
- * <li>exists - "true" or "false".
+ * <li><b>group</b> - A "|" -separated list of group names.
+ * <li><b>user</b> - A "|" -separated list of user names.
+ * <li><b>ip</b> - A "|" -separated list of ip addresses.
+ * <li><b>var</b> - A wiki variable
+ * <li><b>page</b> - A page name
+ * <li><b>contains</b> - A Perl5 regexp pattern
+ * <li><b>is</b> - A Perl5 regexp pattern
+ * <li><b>exists</b> - "true" or "false".
* </ul>
*
* <p>If any of them match, the body of the plugin is executed. You can
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Image.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Image.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Image.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Image.java Sat Aug 16
03:38:36 2008
@@ -27,9 +27,24 @@
import com.ecyrd.jspwiki.providers.ProviderException;
/**
- * Provides an image plugin for better control than is possible with
- * a simple image inclusion.
+ * Provides an image plugin for better control than is possible with a simple
image inclusion.
+ * <br> Most parameters are equivalents of the html image attributes.
*
+ * <p>Parameters : </p>
+ * <ul>
+ * <li><b>src</b> - the source (a URL) of the image (required parameter)</li>
+ * <li><b>align</b> - the alignment of the image</li>
+ * <li><b>height</b> - the height of the image</li>
+ * <li><b>width</b> - the width of the image</li>
+ * <li><b>alt</b> - alternate text</li>
+ * <li><b>caption</b> - the caption for the image</li>
+ * <li><b>link</b> - the hyperlink for the image</li>
+ * <li><b>target</b> - the target (frame) to be used for opening the
image</li>
+ * <li><b>style</b> - the style attribute of the image</li>
+ * <li><b>class</b> - the associated class for the image</li>
+ * <li><b>border</b> - the border for the image</li>
+ * </ul>
+ *
* @since 2.1.4.
*/
// FIXME: It is not yet possible to do wiki internal links. In order to
@@ -38,17 +53,28 @@
public class Image
implements WikiPlugin
{
+ /** The parameter name for setting the src. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_SRC = "src";
+ /** The parameter name for setting the align. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_ALIGN = "align";
+ /** The parameter name for setting the height. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_HEIGHT = "height";
+ /** The parameter name for setting the width. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_WIDTH = "width";
+ /** The parameter name for setting the alt. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_ALT = "alt";
+ /** The parameter name for setting the caption. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_CAPTION = "caption";
+ /** The parameter name for setting the link. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_LINK = "link";
+ /** The parameter name for setting the target. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_TARGET = "target";
+ /** The parameter name for setting the style. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_STYLE = "style";
+ /** The parameter name for setting the class. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_CLASS = "class";
// public static final String PARAM_MAP = "map";
+ /** The parameter name for setting the border. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_BORDER = "border";
/**
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IndexPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IndexPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IndexPlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IndexPlugin.java Sat
Aug 16 03:38:36 2008
@@ -32,22 +32,18 @@
import com.ecyrd.jspwiki.providers.ProviderException;
/**
- * A plugin which creates an index of pages according to a certain
- * pattern.
+ * A plugin that creates an index of pages according to a certain pattern.
+ * <br>The default is to include all pages.
* <p>
* This is a complete rewrite of the old IndexPlugin under an Apache license.
- * <p>
- * Usage:
+ * <p>Parameters (From AbstractReferralPlugin) : </p>
* <ul>
* <li><b>include</b> - A regexp pattern for marking which pages should be
included.</li>
* <li><b>exclude</b> - A regexp pattern for marking which pages should be
excluded.</li>
* </ul>
- * The default is to include all pages.
*/
-public class IndexPlugin implements WikiPlugin
+public class IndexPlugin extends AbstractReferralPlugin implements WikiPlugin
{
- public static final String PARAM_INCLUDE = "include";
- public static final String PARAM_EXCLUDE = "exclude";
private static Logger log = Logger.getLogger( IndexPlugin.class );
/**
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/InsertPage.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/InsertPage.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/InsertPage.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/InsertPage.java Sat
Aug 16 03:38:36 2008
@@ -29,17 +29,33 @@
/**
* Inserts page contents. Muchos thanks to Scott Hurlbert for the initial
code.
*
+ * <p>Parameters : </p>
+ * <ul>
+ * <li><b>page</b> - the name of the page to be inserted</li>
+ * <li><b>style</b> - the style to use</li>
+ * <li><b>maxlength</b> - the maximum length of the page to be inserted (page
contents)</li>
+ * <li><b>class</b> - the class to use</li>
+ * <li><b>section</b> - the section of the page that has to be inserted
(separated by "----"</li>
+ * <li><b>default</b> - the text to insert if the requested page does not
exist</li>
+ * </ul>
+ *
* @since 2.1.37
* @author Scott Hurlbert
*/
public class InsertPage
implements WikiPlugin
{
+ /** Parameter name for setting the page. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_PAGENAME = "page";
+ /** Parameter name for setting the style. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_STYLE = "style";
+ /** Parameter name for setting the maxlength. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_MAXLENGTH = "maxlength";
+ /** Parameter name for setting the class. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_CLASS = "class";
+ /** Parameter name for setting the section. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_SECTION = "section";
+ /** Parameter name for setting the default. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_DEFAULT = "default";
private static final String DEFAULT_STYLE = "";
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/ListLocksPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/ListLocksPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/ListLocksPlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/ListLocksPlugin.java
Sat Aug 16 03:38:36 2008
@@ -27,6 +27,8 @@
* This is a plugin for the administrator: It allows him to see in a single
* glance who is editing what.
*
+ * <p>Parameters : </p>
+ * NONE
* @since 2.0.22.
*/
public class ListLocksPlugin
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Note.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Note.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Note.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Note.java Sat Aug 16
03:38:36 2008
@@ -39,6 +39,11 @@
* his concept.
* <p>
*
+ * <p>Parameters : </p>
+ * <ul>
+ * <li><b>_cmdline</b> - the commentText</li>
+ * </ul>
+ *
* @author John Volkar
* @author Scott Hulbert
*/
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/PluginManager.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/PluginManager.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/PluginManager.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/PluginManager.java Sat
Aug 16 03:38:36 2008
@@ -74,7 +74,7 @@
* The class name can be shortened, and marked without the package.
* For example, "FunnyPlugin" would be expanded to
* "com.ecyrd.jspwiki.plugin.FunnyPlugin" automatically. It is also
- * possible to defined other packages, by setting the
+ * possible to define other packages, by setting the
* "jspwiki.plugin.searchPath" property. See the included
* jspwiki.properties file for examples.
* <P>
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/RPCSamplePlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/RPCSamplePlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/RPCSamplePlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/RPCSamplePlugin.java
Sat Aug 16 03:38:36 2008
@@ -29,6 +29,9 @@
/**
* Simple plugin which shows how to add JSON calls to your plugin.
*
+ * <p>Parameters : </p>
+ * NONE
+ *
* @since 2.5.4
*/
public class RPCSamplePlugin implements WikiPlugin, RPCCallable
@@ -39,6 +42,9 @@
* @param echo The parameter
* @return the string <code>JSON says:</code>, plus the value
* supplied by the <code>echo</code> parameter
+ *
+ * <p>Parameters : </p>
+ * NONE
*/
public String myFunction(String echo)
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/RecentChangesPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/RecentChangesPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/RecentChangesPlugin.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/RecentChangesPlugin.java
Sat Aug 16 03:38:36 2008
@@ -37,21 +37,31 @@
import com.ecyrd.jspwiki.preferences.Preferences.TimeFormat;
/**
- * Returns the Recent Changes.
- *
- * Parameters: since=number of days,
- * format=(compact|full)
+ * Returns the Recent Changes in the wiki being a date-sorted list of page
names.
*
+ * <p>Parameters : </p>
+ * <ul>
+ * <li><b>since</b> - show changes from the last n days, for example since=5
shows only the pages that were changed in the last five days</li>
+ * <li><b>format</b> - (full|compact) : if "full", then display a long
version with all possible info. If "compact", then be as compact as
possible.</li>
+ * <li><b>timeFormat</b> - the time format to use, the default is
"HH:mm:ss"</li>
+ * <li><b>dateFormat</b> - the date format to use, the default is
"dd.MM.yyyy"</li>
+ * </ul>
+ *
*/
public class RecentChangesPlugin
implements WikiPlugin
{
+ /** Parameter name for the separator format. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_FORMAT = "format";
+ /** Parameter name for the separator timeFormat. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_TIME_FORMAT = "timeFormat";
+ /** Parameter name for the separator dateFormat. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_DATE_FORMAT = "dateFormat";
/** How many days we show by default. */
private static final int DEFAULT_DAYS = 100*365;
+ public static final String DEFAULT_TIME_FORMAT ="HH:mm:ss";
+ public static final String DEFAULT_DATE_FORMAT ="dd.MM.yyyy";
private static Logger log = Logger.getLogger( RecentChangesPlugin.class );
@@ -231,7 +241,7 @@
// something like: dateFormat='' timeformat='' which is a odd, but
probably okay.
private DateFormat getTimeFormat( WikiContext context, Map params )
{
- String formatString = get(params, "HH:mm:ss", PARAM_TIME_FORMAT);
+ String formatString = get(params, DEFAULT_TIME_FORMAT,
PARAM_TIME_FORMAT);
if ("".equals(formatString.trim()))
return Preferences.getDateFormat( context, TimeFormat.TIME );
@@ -243,7 +253,7 @@
private DateFormat getDateFormat( WikiContext context, Map params )
{
- String formatString = get(params, "dd.MM.yyyy", PARAM_DATE_FORMAT);
+ String formatString = get(params, DEFAULT_DATE_FORMAT,
PARAM_DATE_FORMAT);
if ("".equals(formatString.trim()))
return Preferences.getDateFormat( context, TimeFormat.DATE );
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/ReferredPagesPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/ReferredPagesPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/ReferredPagesPlugin.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/ReferredPagesPlugin.java
Sat Aug 16 03:38:36 2008
@@ -31,16 +31,15 @@
/**
* Displays the pages referring to the current page.
*
- * <P>Parameters</P>
- * <UL>
- * <LI>name: Name of the root page. Default name of calling page
- * <LI>type: local|externalattachment
- * <LI>depth: How many levels of pages to be parsed.
- * <LI>include: Include only these pages. (eg. include='UC.*|BP.*' )
- * <LI>exclude: Exclude with this pattern. (eg. exclude='LeftMenu' )
- * <LI>format: full|compact
- * <br>FULL now expands all levels correctly
- * </UL>
+ * <p>Parameters</p>
+ * <ul>
+ * <li><b>name</b> - Name of the root page. Default name of calling page
+ * <li><b>type</b> - local|externalattachment
+ * <li><b>depth</b> - How many levels of pages to be parsed.
+ * <li><b>include</b> - Include only these pages. (eg. include='UC.*|BP.*' )
+ * <li><b>exclude</b> - Exclude with this pattern. (eg. exclude='LeftMenu' )
+ * <li><b>format</b> - full|compact, FULL now expands all levels correctly
+ * </ul>
*
* @author Dirk Frederickx
*/
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Search.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Search.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Search.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Search.java Sat Aug 16
03:38:36 2008
@@ -34,7 +34,15 @@
import com.ecyrd.jspwiki.providers.ProviderException;
/**
- *
+ * The "Search" plugin allows you to access the JSPWiki search routines and
show the displays in an array on your page.
+ *
+ * <p>Parameters : </p>
+ * <ul>
+ * <li><b>query</b> - String. A standard JSPWiki search query.</li>
+ * <li><b>set</b> - String. The JSPWiki context variable that will hold the
results of the query. This allows you to pass your queries to other plugins on
the same page as well. </li>
+ * <li><b>max</b> - Integer. How many search results are shown at
maximum.</li>
+ * </ul>
+ *
* @since
*/
public class Search implements WikiPlugin
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/SessionsPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/SessionsPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/SessionsPlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/SessionsPlugin.java
Sat Aug 16 03:38:36 2008
@@ -33,14 +33,17 @@
* <p>Displays information about active wiki sessions. The parameter
* <code>property</code> specifies what information is displayed.
* If omitted, the number of sessions is returned.
- * Valid values for the <code>property</code> parameter
- * include:</p>
+ *
+ * <p>Parameters : </p>
+ * <ul>
+ * <li><b>property</b> - specify what output to display, valid values
are:</li>
* <ul>
* <li><code>users</code> - returns a comma-separated list of
* users</li>
* <li><code>distinctUsers</code> - will only show
* distinct users.
* </ul>
+ * </ul>
* @since 2.3.84
* @author Andrew Jaquith
*/
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/TableOfContents.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/TableOfContents.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/TableOfContents.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/TableOfContents.java
Sat Aug 16 03:38:36 2008
@@ -31,7 +31,8 @@
import java.io.IOException;
/**
- * Provides a table of contents. Possible parameters are:
+ * Provides a table of contents.
+ * <p>Parameters : </p>
* <ul>
* <li><b>title</b> - The title of the table of contents.</li>
* <li><b>numbered</b> - if true, generates automatically numbers for the
headings.</li>
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/UndefinedPagesPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/UndefinedPagesPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/UndefinedPagesPlugin.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/UndefinedPagesPlugin.java
Sat Aug 16 03:38:36 2008
@@ -26,11 +26,12 @@
/**
* Plugin that enumerates the pages in the wiki that have not yet been
defined.
- * Parameters: none.<BR>
- * From AbstractReferralPlugin:<BR>
- * separator: How to separate generated links; default is a wikitext line
break,
- * producing a vertical list.<BR>
- * maxwidth: maximum width, in chars, of generated links.
+ *
+ * Parameters (from AbstractReferralPlugin):
+ * <ul>
+ * <li><b>separator</b> - how to separate generated links; default is a
wikitext line break, producing a vertical list</li>
+ * <li><b> maxwidth</b> - maximum width, in chars, of generated links.</li>
+ * </ul>
*
*/
public class UndefinedPagesPlugin
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/UnusedPagesPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/UnusedPagesPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/UnusedPagesPlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/UnusedPagesPlugin.java
Sat Aug 16 03:38:36 2008
@@ -27,11 +27,11 @@
* Plugin for displaying pages that are not linked to in other pages.
* Uses the ReferenceManager.
* <p>
- * Parameters: none. <BR>
- * From AbstractReferralPlugin:<BR>
- * separator: How to separate generated links; default is a wikitext line
break,
- * producing a vertical list.<BR>
- * maxwidth: maximum width, in chars, of generated links.
+ * Parameters (from AbstractReferralPlugin):
+ * <ul>
+ * <li><b>separator</b> - how to separate generated links; default is a
wikitext line break, producing a vertical list</li>
+ * <li><b> maxwidth</b> - maximum width, in chars, of generated links.</li>
+ * </ul>
*
*/
public class UnusedPagesPlugin
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogArchivePlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogArchivePlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogArchivePlugin.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogArchivePlugin.java
Sat Aug 16 03:38:36 2008
@@ -30,12 +30,18 @@
/**
* Creates a list of all weblog entries on a monthly basis.
*
+ * <p>Parameters : </p>
+ * <ul>
+ * <li><b>page</b> - the page name</li>
+ * </ul>
+ *
* @since 1.9.21
*/
public class WeblogArchivePlugin implements WikiPlugin
{
private static Logger log =
Logger.getLogger(WeblogArchivePlugin.class);
+ /** Parameter name for setting the page. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_PAGE = "page";
private SimpleDateFormat m_monthUrlFormat;
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogEntryPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogEntryPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogEntryPlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogEntryPlugin.java
Sat Aug 16 03:38:36 2008
@@ -30,6 +30,12 @@
/**
* Builds a simple weblog.
*
+ * <p>Parameters : </p>
+ * <ul>
+ * <li><b>entrytext</b> - text of the link </li>
+ * <li><b>page</b> - if set, the entry is added to the named blog page. The
default is the current page. </li>
+ * </ul>
+ *
* @since 1.9.21
*/
public class WeblogEntryPlugin implements WikiPlugin
@@ -38,6 +44,7 @@
private static final int MAX_BLOG_ENTRIES = 10000; // Just a precaution.
+ /** Parameter name for setting the entrytext Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_ENTRYTEXT = "entrytext";
/**
* Optional parameter: page that actually contains the blog.
@@ -45,6 +52,7 @@
* somewhere else than on the page itself.
*/
// "page" for uniform naming with WeblogPlugin...
+ /** Parameter name for setting the page Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_BLOGNAME = "page";
/**
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogPlugin.java?rev=686472&r1=686471&r2=686472&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogPlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogPlugin.java Sat
Aug 16 03:38:36 2008
@@ -51,17 +51,17 @@
* <p>%p - Page name</p>
* <p>Parameters:</p>
* <ul>
- * <li>page - which page is used to do the blog; default is the current
page.</li>
- * <li>entryFormat - how to display the date on pages, using the J2SE
SimpleDateFormat
+ * <li><b>page</b> - which page is used to do the blog; default is the
current page.</li>
+ * <li><b>entryFormat</b> - how to display the date on pages, using the
J2SE SimpleDateFormat
* syntax. Defaults to the current locale's DateFormat.LONG format
* for the date, and current locale's DateFormat.SHORT for the time.
* Thus, for the US locale this will print dates similar to
* this: September 4, 2005 11:54 PM</li>
- * <li>days - how many days the weblog aggregator should show. If set to
+ * <li><b>days</b> - how many days the weblog aggregator should show. If
set to
* "all", shows all pages.</li>
- * <li>pageformat - What the entry pages should look like.</li>
- * <li>startDate - Date when to start. Format is "ddMMyy."</li>
- * <li>maxEntries - How many entries to show at most.</li>
+ * <li><b>pageformat</b> - What the entry pages should look like.</li>
+ * <li><b>startDate</b> - Date when to start. Format is "ddMMyy."</li>
+ * <li><b>maxEntries</b> - How many entries to show at most.</li>
* </ul>
* <p>The "days" and "startDate" can also be sent in HTTP parameters,
* and the names are "weblog.days" and "weblog.startDate", respectively.</p>
@@ -87,11 +87,17 @@
/** The default date format used in the blog entry page names. */
public static final String DEFAULT_DATEFORMAT = "ddMMyy";
+ /** Parameter name for the startDate. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_STARTDATE = "startDate";
+ /** Parameter name for the entryFormat. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_ENTRYFORMAT = "entryFormat";
+ /** Parameter name for the days. Value is <tt>[EMAIL PROTECTED]</tt>. */
public static final String PARAM_DAYS = "days";
+ /** Parameter name for the allowComments. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_ALLOWCOMMENTS = "allowComments";
+ /** Parameter name for the maxEntries. Value is <tt>[EMAIL
PROTECTED]</tt>. */
public static final String PARAM_MAXENTRIES = "maxEntries";
+ /** Parameter name for the page. Value is <tt>[EMAIL PROTECTED]</tt>. */
public static final String PARAM_PAGE = "page";
/** The attribute which is stashed to the WikiPage attributes to check if
a page
