Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 36B31200CC2 for ; Tue, 20 Jun 2017 18:19:45 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 35BF6160BFE; Tue, 20 Jun 2017 16:19:45 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 3714D160BE1 for ; Tue, 20 Jun 2017 18:19:42 +0200 (CEST) Received: (qmail 67841 invoked by uid 500); 20 Jun 2017 16:19:41 -0000 Mailing-List: contact commits-help@jspwiki.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jspwiki.apache.org Delivered-To: mailing list commits@jspwiki.apache.org Received: (qmail 67298 invoked by uid 99); 20 Jun 2017 16:19:40 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 20 Jun 2017 16:19:40 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 6E3C4DFF9F; Tue, 20 Jun 2017 16:19:39 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: juanpablo@apache.org To: commits@jspwiki.apache.org Date: Tue, 20 Jun 2017 16:20:01 -0000 Message-Id: <55a23334c7c14e8f8aeaa6dbbd2a9746@git.apache.org> In-Reply-To: <14ae8e698c93460fb84035fc8f60e577@git.apache.org> References: <14ae8e698c93460fb84035fc8f60e577@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [24/51] [partial] jspwiki-site git commit: Manual testing of new & upcoming ci.sh / mvn-ci.sh on jbake branch archived-at: Tue, 20 Jun 2017 16:19:45 -0000 http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/plugin/WikiPlugin.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/plugin/WikiPlugin.html b/apidocs/2.10.1/org/apache/wiki/api/plugin/WikiPlugin.html new file mode 100755 index 0000000..edc2810 --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/api/plugin/WikiPlugin.html @@ -0,0 +1,300 @@ + + + + + + + +WikiPlugin (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.wiki.api.plugin +
+Interface WikiPlugin

+
+
All Known Implementing Classes:
AbstractReferralPlugin, BugReportHandler, Counter, CurrentTimePlugin, Denounce, FormClose, FormElement, FormInput, FormOpen, FormOutput, FormSelect, FormSet, FormTextarea, Groups, IfPlugin, Image, IndexPlugin, InsertPage, ListLocksPlugin, Note, PageViewPlugin, RecentChangesPlugin, ReferredPagesPlugin, ReferringPagesPlugin, ReferringUndefinedPagesPlugin, RPCSamplePlugin, Search, SessionsPlugin, TableOfContents, UndefinedPagesPlugin, UnusedPagesPlugin, WeblogArchivePlugin, WeblogEntryPlugin, WeblogPlugin
+
+
+
+
public interface WikiPlugin
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

+Defines an interface for plugins. Any instance of a wiki plugin should implement this interface. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static StringCORE_PLUGINS_RESOURCEBUNDLE + +
+          Name of the default plugin resource bundle.
+  + + + + + + + + + + + +
+Method Summary
+ Stringexecute(WikiContext context, + Map<String,String> params) + +
+          This is the main entry point for any plugin.
+  +

+ + + + + + + + +
+Field Detail
+ +

+CORE_PLUGINS_RESOURCEBUNDLE

+
+static final String CORE_PLUGINS_RESOURCEBUNDLE
+
+
Name of the default plugin resource bundle. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+execute

+
+String execute(WikiContext context,
+               Map<String,String> params)
+               throws PluginException
+
+
This is the main entry point for any plugin. The parameters are parsed, + and a special parameter called "_body" signifies the name of the plugin + body, i.e. the part of the plugin that is not a parameter of + the form "key=value". This has been separated using an empty + line. +

+ Note that it is preferred that the plugin returns + XHTML-compliant HTML (i.e. close all tags, use <br /> + instead of <br>, etc. +

+

+
Parameters:
context - The current WikiContext.
params - A Map which contains key-value pairs. Any + parameter that the user has specified on the + wiki page will contain String-String + parameters, but it is possible that at some future date, + JSPWiki will give you other things that are not Strings. +
Returns:
HTML, ready to be included into the rendered page. +
Throws: +
PluginException - In case anything goes wrong.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/plugin/WikiPlugin.png ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/plugin/WikiPlugin.png b/apidocs/2.10.1/org/apache/wiki/api/plugin/WikiPlugin.png new file mode 100755 index 0000000..b43da6a Binary files /dev/null and b/apidocs/2.10.1/org/apache/wiki/api/plugin/WikiPlugin.png differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/InitializablePlugin.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/InitializablePlugin.html b/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/InitializablePlugin.html new file mode 100755 index 0000000..54ba561 --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/InitializablePlugin.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface org.apache.wiki.api.plugin.InitializablePlugin (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
org.apache.wiki.api.plugin.InitializablePlugin

+
+ + + + + + + + + +
+Packages that use InitializablePlugin
org.apache.wiki.pluginProvides plugins to the JSPWiki. 
+  +

+ + + + + +
+Uses of InitializablePlugin in org.apache.wiki.plugin
+  +

+ + + + + + + + + +
Classes in org.apache.wiki.plugin that implement InitializablePlugin
+ classPageViewPlugin + +
+          This plugin counts the number of times a page has been viewed.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/ParserStagePlugin.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/ParserStagePlugin.html b/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/ParserStagePlugin.html new file mode 100755 index 0000000..7eac27d --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/ParserStagePlugin.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface org.apache.wiki.api.plugin.ParserStagePlugin (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
org.apache.wiki.api.plugin.ParserStagePlugin

+
+ + + + + + + + + +
+Packages that use ParserStagePlugin
org.apache.wiki.pluginProvides plugins to the JSPWiki. 
+  +

+ + + + + +
+Uses of ParserStagePlugin in org.apache.wiki.plugin
+  +

+ + + + + + + + + +
Classes in org.apache.wiki.plugin that implement ParserStagePlugin
+ classWeblogPlugin + +
+          Builds a simple weblog.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/WikiPlugin.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/WikiPlugin.html b/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/WikiPlugin.html new file mode 100755 index 0000000..4273744 --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/api/plugin/class-use/WikiPlugin.html @@ -0,0 +1,525 @@ + + + + + + + +Uses of Interface org.apache.wiki.api.plugin.WikiPlugin (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
org.apache.wiki.api.plugin.WikiPlugin

+
+ + + + + + + + + + + + + + + + + +
+Packages that use WikiPlugin
org.apache.wiki.api.engineJSPWiki's WikiEngine Managers package. 
org.apache.wiki.formsContains classes for doing form handling within JSPWiki. 
org.apache.wiki.pluginProvides plugins to the JSPWiki. 
+  +

+ + + + + +
+Uses of WikiPlugin in org.apache.wiki.api.engine
+  +

+ + + + + + + + + +
Methods in org.apache.wiki.api.engine that return WikiPlugin
+ WikiPluginPluginManager.newWikiPlugin(String pluginName, + ResourceBundle rb) + +
+          Creates a WikiPlugin.
+  +

+ + + + + +
+Uses of WikiPlugin in org.apache.wiki.forms
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in org.apache.wiki.forms that implement WikiPlugin
+ classFormClose + +
+          Closes a WikiForm.
+ classFormElement + +
+           
+ classFormInput + +
+          Creates a simple input text field.
+ classFormOpen + +
+          Opens a WikiForm.
+ classFormOutput + +
+           
+ classFormSelect + +
+          Creates a Form select field.
+ classFormSet + +
+          FormSet is a companion WikiPlugin for Form.
+ classFormTextarea + +
+          Creates a Form text area element.
+  +

+ + + + + +
+Uses of WikiPlugin in org.apache.wiki.plugin
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in org.apache.wiki.plugin that implement WikiPlugin
+ classAbstractReferralPlugin + +
+          This is a base class for all plugins using referral things.
+ classBugReportHandler + +
+          Provides a handler for bug reports.
+ classCounter + +
+          Provides a page-specific counter, it is reset every time a page is rendered, so it is not usable as a hitcounter.
+ classCurrentTimePlugin + +
+          Just displays the current date and time.
+ classDenounce + +
+          Denounces a link by removing it from any search engine.
+ classGroups + +
+          Prints the groups managed by this wiki, separated by commas.
+ classIfPlugin + +
+          The IfPlugin allows parts of a WikiPage to be executed conditionally, and is intended as a flexible way + of customizing a page depending on certain conditions.
+ classImage + +
+          Provides an image plugin for better control than is possible with a simple image inclusion.
+ classIndexPlugin + +
+          A WikiPlugin that creates an index of pages according to a certain pattern.
+ classInsertPage + +
+          Inserts page contents.
+ classListLocksPlugin + +
+          This is a plugin for the administrator: It allows him to see in a single + glance who is editing what.
+ classNote + +
+          Outputs an image with the supplied text as the title which is shown as a tooltip by + most browsers.
+ classPageViewPlugin + +
+          This plugin counts the number of times a page has been viewed.
+ classRecentChangesPlugin + +
+          Returns the Recent Changes in the wiki being a date-sorted list of page names.
+ classReferredPagesPlugin + +
+          Displays the pages referring to the current page.
+ classReferringPagesPlugin + +
+          Displays the pages referring to the current page.
+ classReferringUndefinedPagesPlugin + +
+          Lists all pages containing links to Undefined Pages (pages containing dead links).
+ classRPCSamplePlugin + +
+          Simple plugin which shows how to add JSON calls to your plugin.
+ classSearch + +
+          The "Search" plugin allows you to access the JSPWiki search routines and show the displays in an array on your page.
+ classSessionsPlugin + +
+          Displays information about active wiki sessions.
+ classTableOfContents + +
+          Provides a table of contents.
+ classUndefinedPagesPlugin + +
+          Plugin that enumerates the pages in the wiki that have not yet been defined.
+ classUnusedPagesPlugin + +
+          Plugin for displaying pages that are not linked to in other pages.
+ classWeblogArchivePlugin + +
+          Creates a list of all weblog entries on a monthly basis.
+ classWeblogEntryPlugin + +
+          Builds a simple weblog.
+ classWeblogPlugin + +
+          Builds a simple weblog.
+  +

+ + + + + + + + + + + + + +
Methods in org.apache.wiki.plugin that return WikiPlugin
+ WikiPluginDefaultPluginManager.WikiPluginInfo.newPluginInstance(List<String> searchPath, + List<String> externalJars) + +
+          Creates a new plugin instance.
+ WikiPluginDefaultPluginManager.newWikiPlugin(String pluginName, + ResourceBundle rb) + +
+          Creates a WikiPlugin.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/plugin/package-frame.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/plugin/package-frame.html b/apidocs/2.10.1/org/apache/wiki/api/plugin/package-frame.html new file mode 100755 index 0000000..a81cc88 --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/api/plugin/package-frame.html @@ -0,0 +1,37 @@ + + + + + + + +org.apache.wiki.api.plugin (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + +org.apache.wiki.api.plugin + + + + +
+Interfaces  + +
+InitializablePlugin +
+ParserStagePlugin +
+WikiPlugin
+ + + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/plugin/package-summary.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/plugin/package-summary.html b/apidocs/2.10.1/org/apache/wiki/api/plugin/package-summary.html new file mode 100755 index 0000000..b0a61a9 --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/api/plugin/package-summary.html @@ -0,0 +1,218 @@ + + + + + + + +org.apache.wiki.api.plugin (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package org.apache.wiki.api.plugin +

+Plugin's API package of JSPWiki. +

+See: +
+          Description +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + +
+Interface Summary
InitializablePluginIf a plugin defines this interface, it is called exactly once + prior to the actual execute() routine.
ParserStagePluginImplements a Plugin interface for the parser stage.
WikiPluginDefines an interface for plugins.
+  + +

+

+Package org.apache.wiki.api.plugin Description +

+ +

+Plugin's API package of JSPWiki. + +This package holds JSPWiki's Plugin API. + +

Package Specification

+ +

Related Documentation

+

+ +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/plugin/package-summary.png ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/plugin/package-summary.png b/apidocs/2.10.1/org/apache/wiki/api/plugin/package-summary.png new file mode 100755 index 0000000..0a21a32 Binary files /dev/null and b/apidocs/2.10.1/org/apache/wiki/api/plugin/package-summary.png differ