[portal-commits] JBoss Portal SVN: r7626 - in docs/trunk/userGuide/en: modules and 1 other directory.

Author: chris.laprun(a)jboss.com Date: 2007-06-28 20:36:18 -0400 (Thu, 28 Jun 2007) New Revision: 7626 Added: docs/trunk/userGuide/en/images/management/default_page.png docs/trunk/userGuide/en/images/management/default_page_layout.png docs/trunk/userGuide/en/images/management/default_page_rename.png docs/trunk/userGuide/en/images/management/default_portal.png docs/trunk/userGuide/en/images/management/default_portal_properties.png docs/trunk/userGuide/en/images/management/default_portal_security.png docs/trunk/userGuide/en/images/management/default_portal_theme.png docs/trunk/userGuide/en/images/management/instances.png docs/trunk/userGuide/en/images/management/portals.png docs/trunk/userGuide/en/images/management/portals_properties.png docs/trunk/userGuide/en/images/management/portlets.png Removed: docs/trunk/userGuide/en/images/management/createinstance.gif docs/trunk/userGuide/en/images/management/createpage.gif docs/trunk/userGuide/en/images/management/createwindow.gif docs/trunk/userGuide/en/images/management/manage_page.gif docs/trunk/userGuide/en/images/management/management_1.gif docs/trunk/userGuide/en/images/management/manageportal.gif docs/trunk/userGuide/en/images/management/managewindow.gif docs/trunk/userGuide/en/images/management/portletpreferences.gif docs/trunk/userGuide/en/images/management/securepage.gif docs/trunk/userGuide/en/images/management/secureportal.gif docs/trunk/userGuide/en/images/management/secureportlet.gif docs/trunk/userGuide/en/images/management/themepage.gif docs/trunk/userGuide/en/images/management/themeportal.gif docs/trunk/userGuide/en/images/management/themewindow.gif docs/trunk/userGuide/en/images/management/tree.gif docs/trunk/userGuide/en/images/management/windowtheme.gif Modified: docs/trunk/userGuide/en/modules/dynamicity.xml Log: - Started rewriting of dynamicity chapter. Only frame so far and some screenshots. Deleted: docs/trunk/userGuide/en/images/management/createinstance.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/createpage.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/createwindow.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/management/default_page.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/default_page.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/default_page_layout.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/default_page_layout.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/default_page_rename.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/default_page_rename.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/default_portal.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/default_portal.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/default_portal_properties.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/default_portal_properties.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/default_portal_security.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/default_portal_security.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/default_portal_theme.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/default_portal_theme.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/instances.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/instances.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/management/manage_page.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/management_1.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/manageportal.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/managewindow.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/management/portals.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/portals.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/portals_properties.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/portals_properties.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/management/portletpreferences.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/management/portlets.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/portlets.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/management/securepage.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/secureportal.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/secureportlet.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/themepage.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/themeportal.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/themewindow.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/tree.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/management/windowtheme.gif =================================================================== (Binary files differ) Modified: docs/trunk/userGuide/en/modules/dynamicity.xml =================================================================== --- docs/trunk/userGuide/en/modules/dynamicity.xml 2007-06-29 00:24:09 UTC (rev 7625) +++ docs/trunk/userGuide/en/modules/dynamicity.xml 2007-06-29 00:36:18 UTC (rev 7626) @@ -2,9 +2,9 @@ <chapter id="dynamicity"> <chapterinfo> <author> - <firstname>Roy</firstname> - <surname>Russo</surname> - <email&gt;roy(a)jboss.org&lt;/email&gt; + <firstname>Chris</firstname> + <surname>Laprun</surname> + <email&gt;chris.laprun(a)jboss.com&lt;/email&gt; </author> </chapterinfo> <title>Administration - Portal Object Management (Dynamicity)</title> @@ -37,326 +37,149 @@ </note> </sect1> <sect1> - <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: + <title>Management Portlet</title> + <note>For the remainder of this chapter, the term <emphasis role="bold">object</emphasis> will be used to mean + Portal, Page, Portlet, or Window indifferently. + </note> + <para> + The management portlet provides a two-part interface: tabs, corresponding to the different sections that + can be managed, at the top and the main area under it, displaying the current information for the selected + tab. + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/adminportal.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + </para> + <para> + The tabs are: <itemizedlist> - <listitem> - <xref linkend="manageportal"/> - <itemizedlist> - <listitem> - <xref linkend="secureportal"/> - </listitem> - <listitem> - <xref linkend="themeportal"/> - </listitem> - </itemizedlist> + <listitem><emphasis>Portal Objects</emphasis> gathering operations pertaining to managing Portals and their + pages. This is the most complex part of the interface.</listitem> + <listitem><emphasis>Portlet Instances</emphasis> giving access to all the Portlet instances that have been + configured.</listitem> + <listitem><emphasis>Portlet Definitions</emphasis> giving access to the currently available portlet + providers as well as the Portlets that each provider publishes.</listitem> + <listitem><emphasis>Dashboards</emphasis> allowing administrators to configure how Dashboards should behave. </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> + We will look at each of these tabs and their functionality in the following sections. </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> - <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. + <sect2> + <title>Managing Portal Objects</title> + <para> + TODO + <sect3> + <title>Portals operations</title> + + <para> + <mediaobject> + <imageobject> + <imagedata fileref="images/management/portals.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + + <mediaobject> + <imageobject> + <imagedata fileref="images/management/portals_properties.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + </para> + </sect3> + + + <sect3> + <title>Looking at the default Portal</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + <mediaobject> <imageobject> - <imagedata fileref="images/management/manageportal.gif" format="gif" align="center" valign="middle"/> + <imagedata fileref="images/management/default_portal_security.png" format="png" align="center" + valign="middle"/> </imageobject> </mediaobject> - Expanding the tree structure will reveal all pages and portlet windows deployed in a particular portal - instance. + + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal_properties.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal_theme.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + </sect3> + + <sect3> + <title>Looking at the default Page of the default Portal</title> + + <para> + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_page.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_page_layout.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_page_rename.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + </para> + + </sect3> </para> - <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 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> - </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. An administrator is also able to choose a specific - layout for a portal, as well as a theme. - </para> - </sect3> </sect2> - <sect2 id="manageportletinstance"> - <title>Managing portlets and portlet instances</title> - <sect3 id="createportletinstance"> - <title>Creating portlet instances</title> - <para> - <mediaobject> - <imageobject> - <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> - </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> - tab and selecting a portlet - instance, displays a screen which allows an administrator to edit the portlet - instance preferences. - </para> - </sect3> - <sect3 id="securinginstances"> - <title>Securing portlets</title> - <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 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> + <title>Managing Portlet Instances</title> + <para> + TODO + <mediaobject> + <imageobject> + <imagedata fileref="images/management/instances.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + </para> </sect2> - <sect2 id="managepages"> - <title>Managing Portal Pages</title> + <sect2> + <title>Managing Portlet Definitions</title> <para> + TODO <mediaobject> <imageobject> - <imagedata fileref="images/management/manageportal.gif" format="gif" align="center" valign="middle"/> + <imagedata fileref="images/management/portlets.png" format="png" 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/themewindow.gif" format="gif" align="center" - valign="middle"/> - </imageobject> - </mediaobject> - </para> - <para>Selecting a portal window under the - <emphasis>Portal</emphasis> - tab, and selecting - the - <emphasis>Theme</emphasis> - option, allows an administrator to modify the - look-and-feel for the chosen portal page. - </para> - <note>From this screen, an administrator can elect to set all values to - <emphasis>emptyrenderer</emphasis> - so the portlet window is displayed with no - decorations and appears to be part of the layout. - </note> - </sect3> - <sect3 id="securepages"> - <title>Securing portal pages</title> - <para> - <mediaobject> - <imageobject> - <imagedata fileref="images/management/securepage.gif" format="gif" align="center" valign="middle"/> - </imageobject> - </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. 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> - </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> + <sect2> + <title>Managing Dashboards</title> + <para> + TODO + </para> + </sect2> + <sect2> + <title>Wizard mode</title> + <para> + TODO + </para> + </sect2> </sect1> </chapter>