Commit e3137195 authored by Matt Tucker's avatar Matt Tucker Committed by matt

Tweaks for plugins.


git-svn-id: http://svn.igniterealtime.org/svn/repos/messenger/trunk@510 b35dd754-fafc-0310-a699-88a17e54d16e
parent 039981eb
...@@ -23,13 +23,6 @@ The server contains a pluggable backend data storage and security system and ...@@ -23,13 +23,6 @@ The server contains a pluggable backend data storage and security system and
interfaces for customizing and extending the server. interfaces for customizing and extending the server.
</p> </p>
<p><b>Environment:</b></p>
<ul>
<li>Requires JDK 1.5</li>
<li>Database (optional -- includes an all-Java embedded database)</li>
</ul>
<p><b>Documentation:</b></p> <p><b>Documentation:</b></p>
<ul> <ul>
...@@ -54,16 +47,21 @@ interfaces for customizing and extending the server. ...@@ -54,16 +47,21 @@ interfaces for customizing and extending the server.
<a href="ldap-guide.html">LDAP Guide</a> - <a href="ldap-guide.html">LDAP Guide</a> -
A guide to setting up Jive Messenger to work with LDAP user stores. A guide to setting up Jive Messenger to work with LDAP user stores.
</li> </li>
<li>
<a href="plugin-dev-guide.html">Plugin Guide</a> -
A guide to writing and installing plugins for Jive Messenger.
</li>
<li> <li>
<a href="javadoc/index.html">JavaDocs</a> - <a href="javadoc/index.html">JavaDocs</a> -
Jive Messenger API documentation. Jive Messenger API documentation.
</li> </li>
</ul> </ul>
<p><b>Developer Documentation:</b></p>
<ul>
<li>
<a href="plugin-dev-guide.html">Plugin Guide</a> -
A guide to writing and installing plugins for Jive Messenger.
</li>
</ul>
<p> <p>
An active support community for Jive Messenger is available at An active support community for Jive Messenger is available at
<a href="http://www.jivesoftware.org/forums/">http://www.jivesoftware.org/forums/</a>. <a href="http://www.jivesoftware.org/forums/">http://www.jivesoftware.org/forums/</a>.
......
...@@ -17,7 +17,7 @@ visit the Jive Messenger website: <a href="http://www.jivesoftware.org/messenger ...@@ -17,7 +17,7 @@ visit the Jive Messenger website: <a href="http://www.jivesoftware.org/messenger
<p>In order to install Jive Messenger, you'll need a server environment <p>In order to install Jive Messenger, you'll need a server environment
that meets the following requirements: </p> that meets the following requirements: </p>
<ul> <ul>
<li>JDK 1.5 or later. You can check your java version by typing "java <li><b>JDK 1.5.0</b> (Java 5) or later. You can check your java version by typing "java
-version" at the command line. See <a href="http://java.sun.com">http://java.sun.com</a> -version" at the command line. See <a href="http://java.sun.com">http://java.sun.com</a>
for Java on your platform or download a Jive Messenger installer with for Java on your platform or download a Jive Messenger installer with
bundled JVM for your operating system.</li> bundled JVM for your operating system.</li>
......
...@@ -32,20 +32,15 @@ a directory. The files in a plugin directory are as follows: ...@@ -32,20 +32,15 @@ a directory. The files in a plugin directory are as follows:
<pre>myplugin/ <pre>myplugin/
|- plugin.xml &lt;- Plugin definition file |- plugin.xml &lt;- Plugin definition file
|- classes/ &lt;- Resources your plugin needs (i.e., a properties file) |- classes/ &lt;- Resources your plugin needs (i.e., a properties file)
|- lib/ &lt;- Libraries your plugin needs |- lib/ &lt;- Libraries (JAR files) your plugin needs
|- src/ |- web &lt;- Resources for Admin Console integration.
|- java &lt;- Java source code for your plugin |- web.xml
| |- com |- images/
| |- mycompany
| |- *.java
|- web
|- *.jsp &lt;- JSPs your plugin uses for the admin console
|- images/ &lt;- Any images your JSP pages need (optional)
</pre> </pre>
</fieldset> </fieldset>
<p>The <tt>src/web</tt> directory exists for plugins that need to add content <p>The <tt>web</tt> directory exists for plugins that need to add content
to the Jive Messenger admin console. Further details are below.</p> to the Jive Messenger Admin Console. Further details are below.</p>
<p> <p>
The <tt>plugin.xml</tt> file specifies the main Plugin class. A sample The <tt>plugin.xml</tt> file specifies the main Plugin class. A sample
...@@ -167,15 +162,37 @@ tabs, sections and entries in the Admin Console framework. A sample ...@@ -167,15 +162,37 @@ tabs, sections and entries in the Admin Console framework. A sample
<p> <p>
In this example, we've defined a new tab "Example", a sidebar section In this example, we've defined a new tab "Example", a sidebar section
"My Plugin" and a page "My Plugin Admin". We've registered <tt>my-plugin-admin.jsp</tt> "My Plugin" and a page "My Plugin Admin". We've registered <tt>my-plugin-admin.jsp</tt>
as the page. as the page. You can override existing tabs, sections, and items by using
the existing id attribute values in your own <tt>&lt;adminconsole&gt;</tt> defintion.
</p> </p>
<h2>Using the Jive Messenger Build Script</h2> <h2>Using the Jive Messenger Build Script</h2>
<p> <p>
The Jive Messenger build script is designed to help you build and develop plugins. The Jive Messenger build script will help you build and develop plugins. It
looks for plugin development directories in the following format:
</p> </p>
<fieldset>
<legend>Plugin Structure</legend>
<pre>myplugin/
|- plugin.xml &lt;- Plugin definition file
|- classes/ &lt;- Resources your plugin needs (i.e., a properties file)
|- lib/ &lt;- Libraries your plugin needs
|- src/
|- java &lt;- Java source code for your plugin
| |- com
| |- mycompany
| |- *.java
|- web
|- *.jsp &lt;- JSPs your plugin uses for the admin console
|- images/ &lt;- Any images your JSP pages need (optional)
</pre>
</fieldset>
<p>The build script will compile source files and JSPs and create a valid
plugin structure.</p>
<br><br> <br><br>
</body> </body>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment