Author: julien(a)jboss.com
Date: 2008-03-31 06:22:20 -0400 (Mon, 31 Mar 2008)
New Revision: 10429
Added:
modules/portlet/trunk/docs/user-guide/en/images/admin1.png
modules/portlet/trunk/docs/user-guide/en/images/admin2.png
Modified:
modules/portlet/trunk/docs/user-guide/en/modules/simpleportal.xml
Log:
documentation for the admin portlet
Added: modules/portlet/trunk/docs/user-guide/en/images/admin1.png
===================================================================
(Binary files differ)
Property changes on: modules/portlet/trunk/docs/user-guide/en/images/admin1.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: modules/portlet/trunk/docs/user-guide/en/images/admin2.png
===================================================================
(Binary files differ)
Property changes on: modules/portlet/trunk/docs/user-guide/en/images/admin2.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: modules/portlet/trunk/docs/user-guide/en/modules/simpleportal.xml
===================================================================
--- modules/portlet/trunk/docs/user-guide/en/modules/simpleportal.xml 2008-03-31 09:44:16
UTC (rev 10428)
+++ modules/portlet/trunk/docs/user-guide/en/modules/simpleportal.xml 2008-03-31 10:22:20
UTC (rev 10429)
@@ -550,10 +550,45 @@
</sect1>
<sect1>
<title>Administration</title>
- <para>todo</para>
<sect2>
<title>Admin portlet</title>
- <para>todo</para>
+ <para>The admin portlet shows the list of portlet applications deployed in
the simple portal. For each
+ portlet application it is possible to unfold the appliation to display the
portlet contained in the
+ unfolded application as well as the portlet filters.</para>
+ <sect3>
+ <title>Portlet application administration</title>
+ <para>By default the admin portlet displays the list of portlet
applications. It shows the status
+ of each application and provides the capability to stop or start an
application.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
fileref="images/admin1.png" format="PNG"
+ valign="middle"/>
+ </imageobject>
+ <caption>
+ <para>The admin portlet showing all the portlet
applications.</para>
+ </caption>
+ </mediaobject>
+ <para>On the example we can see that all the applications are in
started mode except the
+ <emphasis>samples-basic-portlet</emphasis> application. It is
possible to manage the
+ life cycle of each application by clicking on the
<emphasis>start</emphasis> link when it
+ is stopped or clicking on the <emphasis>stop</emphasis> link when
it is started.</para>
+ </sect3>
+ <sect3>
+ <title>Portlet container and filter administration</title>
+ <para>Selecting a particular portlet application unfolds it and shows
the list of portlet containers
+ that the application contains as well as the filters it
contains.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
fileref="images/admin2.png" format="PNG"
+ valign="middle"/>
+ </imageobject>
+ <caption>
+ <para>The admin portlet showing the portlets container and
filters contained in an application.</para>
+ </caption>
+ </mediaobject>
+ <para>Again here it displays the name of the container and filters, the
status of the life cycle and
+ a link to start or stop the corresponding item.</para>
+ </sect3>
</sect2>
<sect2>
<title>Logging configuration</title>
Show replies by date