[jboss-cvs] jboss-portal-docs/userGuide/en/modules ...
Roy Russo
russo at jboss.com
Mon Jul 17 13:58:58 EDT 2006
User: russo
Date: 06/07/17 13:58:58
Modified: userGuide/en/modules dynamicity.xml
Log:
JBPORTAL-873 - finished adminportlet
Revision Changes Path
1.10 +312 -151 jboss-portal-docs/userGuide/en/modules/dynamicity.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: dynamicity.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-portal-docs/userGuide/en/modules/dynamicity.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- dynamicity.xml 14 Jul 2006 14:32:13 -0000 1.9
+++ dynamicity.xml 17 Jul 2006 17:58:58 -0000 1.10
@@ -4,12 +4,15 @@
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
- <email>roy @ jboss dot org</email>
+ <email>roy at jboss.org</email>
</author>
</chapterinfo>
<title>Administration - Portal Object Management (Dynamicity)</title>
<sect1>
<title>Introduction</title>
+ <note>Viewing the Management Portlet is accomplished by logging in as an admin (admin/admin) and navigating to the
+ Admin page.
+ </note>
<para>
The concept of dynamicity is that all portal objects are able to dynamically be modified at runtime,
eliminating the need to struggle with large xml files, or restarting the application server for changes to take
@@ -28,98 +31,155 @@
portlet, allowing for dynamic customization of any of the above components.</listitem>
</itemizedlist>
</para>
- <para>
- Dynamicity and our new consolidated deployment descriptor work hand-in-hand. Portal objects are all considered
- branches to the root portal context, and within our new deployment descriptor all branches (and leaves) can be
- specified.
- </para>
- <para>
- <imageobject>
- <imagedata fileref="images/management/tree.gif" format="gif" align="center" valign="middle"/>
- </imageobject>
- </para>
</sect1>
<sect1>
- <title>Functionalities</title>
+ <title>Actions</title>
<para>Dynamicity allows an administrator to manage the entire portal deployment from within
a portlet. Some of the many tasks available to administrators are:
<itemizedlist>
- <listitem>Create/Destroy portal instances.</listitem>
- <listitem>Create/Destroy portlet instances.</listitem>
- <listitem>Create/Destroy portal pages and subpages.</listitem>
- <listitem>Assign pages to portal instances.</listitem>
- <listitem>Assign portlet instances to pages.</listitem>
- <listitem>Modify instance variables for portlets.</listitem>
- <listitem>Control the order and region in which portlets appear on a page.</listitem>
- <listitem>Modify the theme and/or layout for a portal instance or a specific page.</listitem>
- <listitem>Modify the security constraints for a portal instance or a specific
- page.</listitem>
+ <listitem>
+ <xref linkend="manageportal"/>
+ <itemizedlist>
+ <listitem>
+ <xref linkend="secureportal"/>
+ </listitem>
+ <listitem>
+ <xref linkend="themeportal"/>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <xref linkend="managepages"/>
+ <itemizedlist>
+ <listitem>
+ <xref linkend="createportletwindows"/>
+ </listitem>
+ <listitem>
+ <xref linkend="editportletwindow"/>
+ </listitem>
+ <listitem>
+ <xref linkend="themewindows"/>
+ </listitem>
+ <listitem>
+ <xref linkend="securepages"/>
+ </listitem>
+ <listitem>
+ <xref linkend="pagethemelayout"/>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <xref linkend="manageportletinstance"/>
+ <itemizedlist>
+ <listitem>
+ <xref linkend="createportletinstance"/>
+ </listitem>
+ <listitem>
+ <xref linkend="portletinstanceprefs"/>
+ </listitem>
+ <listitem>
+ <xref linkend="securinginstances"/>
+ </listitem>
+ </itemizedlist>
+ </listitem>
</itemizedlist>
</para>
<note>For the remainder of this chapter, the term
<emphasis role="bold">object</emphasis>
will be used to mean any Portal, Page, Portlet, or Window.
</note>
- </sect1>
- <sect1>
+ <sect2 id="manageportal">
<title>Managing portal instances</title>
<para>Administrators may manage the portal, pages, subpages, and windows at any time, by
clicking on the "Portal" tab at the top of the Management Portlet. The components
currently deployed in the portal container are displayed in a tree-structure for
- ease-of-navigation and modification.</para>
- <para>
+ ease-of-navigation and modification.
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/management/management_1.gif" format="gif" align="center" valign="middle"/>
+ <imagedata fileref="images/management/manageportal.gif" format="gif" align="center" valign="middle"/>
</imageobject>
+ </mediaobject>
+ Expanding the tree structure will reveal all pages and portlet windows deployed in a particular portal
+ instance.
</para>
- <sect2>
- <title>Creating portal pages</title>
- <para>By selecting a portal instance, and then selecting the
- <emphasis>Manage</emphasis>
- option, you can create a new page. Simply assign a name
- to a page and submit the form.
- </para>
- </sect2>
- <sect2>
- <title>Securing the portal instance</title>
- <para>Selecting the
+ <sect3 id="secureportal">
+ <title>Securing portal instances</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/management/secureportal.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Selecting the
<emphasis>Security</emphasis>
option, allows an administrator to
secure the portal instance. On this screen, you can select and unselect portal-wide
- security settings for a given role.
+ security settings for a given role. Security settings are defined as follows:
+ <itemizedlist>
+ <listitem>
+ <emphasis role="bold">view</emphasis>
+ Users can view the object.
+ </listitem>
+ <listitem>
+ <emphasis role="bold">viewrecursive</emphasis>
+ Users can view the object and child objects.
+ </listitem>
+ <listitem>
+ <emphasis role="bold">personalize</emphasis>
+ Users are able to view AND personalize the object.
+ </listitem>
+ <listitem>
+ <emphasis role="bold">personalizerecursive</emphasis>
+ Users are able to view AND personalize the object AND its child objects.
+ </listitem>
+ </itemizedlist>
</para>
- </sect2>
- <sect2>
- <title>Modifying the portal instance appearance</title>
- <para>Selecting the
+ </sect3>
+ <sect3 id="themeportal">
+ <title>Modifying the portal Theme/Layout</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/management/themeportal.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Selecting the
<emphasis>Theme</emphasis>
option, allows an administrator to modify
- the look-and-feel for the chosen portal instance.
+ the look-and-feel for the chosen portal instance. An administrator is also able to choose a specific
+ layout for a portal, as well as a theme.
</para>
+ </sect3>
</sect2>
- </sect1>
- <sect1>
+ <sect2 id="manageportletinstance">
<title>Managing portlets and portlet instances</title>
- <sect2>
+ <sect3 id="createportletinstance">
<title>Creating portlet instances</title>
<para>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/management/createinstance.gif" format="gif" align="center" valign="middle"/>
+ <imagedata fileref="images/management/createinstance.gif" format="gif" align="center"
+ valign="middle"/>
</imageobject>
+ </mediaobject>
</para>
<para>Clicking on the
<emphasis>Portlet</emphasis>
tab and then clicking on a specific
portlet allows you to create a new instance of this portlet.
</para>
- </sect2>
- <sect2>
+ </sect3>
+ <sect3 id="portletinstanceprefs">
<title>Modifying portlet instance preferences</title>
<para>
+ <mediaobject>
<imageobject>
<imagedata fileref="images/management/portletpreferences.gif" format="gif" align="center"
valign="middle"/>
</imageobject>
+ </mediaobject>
</para>
<para>Clicking on the
<emphasis>Instance</emphasis>
@@ -127,23 +187,110 @@
instance, displays a screen which allows an administrator to edit the portlet
instance preferences.
</para>
- </sect2>
- <sect2>
+ </sect3>
+ <sect3 id="securinginstances">
<title>Securing portlets</title>
- <para>Selecting the
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/management/secureportlet.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Selecting the
<emphasis>Security</emphasis>
option, allows an administrator to
- secure the portal page.
+ secure the portlet instance. Security settings are defined as follows:
+ <itemizedlist>
+ <listitem>
+ <emphasis role="bold">view</emphasis>
+ Users can view the object.
+ </listitem>
+ <listitem>
+ <emphasis role="bold">viewrecursive</emphasis>
+ Users can view the object and child objects.
+ </listitem>
+ <listitem>
+ <emphasis role="bold">personalize</emphasis>
+ Users are able to view AND personalize the object.
+ </listitem>
+ <listitem>
+ <emphasis role="bold">personalizerecursive</emphasis>
+ Users are able to view AND personalize the object AND its child objects.
+ </listitem>
+ </itemizedlist>
</para>
<note>Depending on whether you are securing a portlet or an instance, keep in mind that
instance security constraints take precedence over portlet security settings.</note>
+ </sect3>
</sect2>
- <sect2>
- <title>Modifying portlet window appearance</title>
+ <sect2 id="managepages">
+ <title>Managing Portal Pages</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/management/manageportal.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Expanding the tree structure will reveal all pages deployed in a particular portal
+ instance, that an administrator can then customize.
+ </para>
+ <sect3 id="createpage">
+ <title>Creating portal pages</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/management/createpage.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ By selecting a portal instance, and then selecting the
+ <emphasis>Manage</emphasis>
+ option, you can create a new page. Simply assign a name
+ to a page and submit the form.
+ </para>
+ </sect3>
+ <sect3 id="createportletwindows">
+ <title>Creating portlet windows</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/management/createwindow.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ <para>Selecting a portal page, allows you to
+ <emphasis>Manage</emphasis>
+ the order in
+ which windows appear and the layout column in which they will appear. Additionally,
+ you can name and assign portlet windows on the selected page, create subpages, or even delete the page.
+ </para>
+ </sect3>
+ <sect3 id="editportletwindow">
+ <title>Edit portlet windows</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/management/managewindow.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ <para>Selecting a portlet window, allows you to
+ <emphasis>Manage</emphasis>
+ which portlet instance is assigned to it, and even delete/remove the window from the page.
+ </para>
+ </sect3>
+ <sect3 id="themewindows">
+ <title>Modifying the Window Theme/Layout</title>
<para>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/management/windowtheme.gif" format="gif" align="center" valign="middle"/>
+ <imagedata fileref="images/management/themewindow.gif" format="gif" align="center"
+ valign="middle"/>
</imageobject>
+ </mediaobject>
</para>
<para>Selecting a portal window under the
<emphasis>Portal</emphasis>
@@ -158,40 +305,54 @@
so the portlet window is displayed with no
decorations and appears to be part of the layout.
</note>
- </sect2>
- </sect1>
- <sect1>
- <title>Managing portal pages</title>
- <sect2>
- <title>Creating portlet windows</title>
+ </sect3>
+ <sect3 id="securepages">
+ <title>Securing portal pages</title>
<para>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/management/manage_page.gif" format="gif" align="center" valign="middle"/>
+ <imagedata fileref="images/management/securepage.gif" format="gif" align="center" valign="middle"/>
</imageobject>
- </para>
- <para>Selecting a portal page, allows you to
- <emphasis>Manage</emphasis>
- the order in
- which windows appear and the layout column in which they will appear. Additionally,
- you can name and assign portlet instances on the selected page.
- </para>
- </sect2>
- <sect2>
- <title>Securing portal pages</title>
- <para>Selecting the
+ </mediaobject>
+ Selecting the
<emphasis>Security</emphasis>
option, allows an administrator to
secure the portal page. On this screen, you can select and unselect page security
- settings for a given role.
+ settings for a given role. Security settings are defined as follows:
+ <itemizedlist>
+ <listitem>
+ <emphasis role="bold">view</emphasis>
+ Users can view the object.
+ </listitem>
+ <listitem>
+ <emphasis role="bold">viewrecursive</emphasis>
+ Users can view the object and child objects.
+ </listitem>
+ <listitem>
+ <emphasis role="bold">personalize</emphasis>
+ Users are able to view AND personalize the object.
+ </listitem>
+ <listitem>
+ <emphasis role="bold">personalizerecursive</emphasis>
+ Users are able to view AND personalize the object AND its child objects.
+ </listitem>
+ </itemizedlist>
</para>
- </sect2>
- <sect2>
- <title>Modifying the portal page appearance</title>
- <para>Selecting the
+ </sect3>
+ <sect3 id="pagethemelayout">
+ <title>Modifying the Page Theme/Layout</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/management/themepage.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Selecting the
<emphasis>Theme</emphasis>
option, allows an administrator to modify
the look-and-feel for the chosen portal page.
</para>
+ </sect3>
</sect2>
</sect1>
</chapter>
More information about the jboss-cvs-commits
mailing list