[jboss-cvs] jboss-portal-docs/userGuide/en/modules ...
Roy Russo
russo at jboss.com
Fri Jul 14 17:15:28 EDT 2006
User: russo
Date: 06/07/14 17:15:28
Modified: userGuide/en/modules admincmsPortlet.xml intro.xml
user_role.xml
Log:
JBPORTAL-873 - finished intro
Revision Changes Path
1.13 +1 -1 jboss-portal-docs/userGuide/en/modules/admincmsPortlet.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: admincmsPortlet.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-portal-docs/userGuide/en/modules/admincmsPortlet.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -b -r1.12 -r1.13
--- admincmsPortlet.xml 14 Jul 2006 14:32:13 -0000 1.12
+++ admincmsPortlet.xml 14 Jul 2006 21:15:28 -0000 1.13
@@ -8,7 +8,7 @@
</author>
</chapterinfo>
<title>Administration - Content Management System</title>
- <sect1>
+ <sect1 id="cmsadmin">
<title>Introduction</title>
<para>The CMSAdmin Portlet allows control over the content management system.</para>
<para>Viewing the CMSAdmin Portlet is accomplished by logging in as an admin (admin/admin) and
1.3 +336 -90 jboss-portal-docs/userGuide/en/modules/intro.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: intro.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-portal-docs/userGuide/en/modules/intro.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- intro.xml 14 Jul 2006 17:42:12 -0000 1.2
+++ intro.xml 14 Jul 2006 21:15:28 -0000 1.3
@@ -166,9 +166,9 @@
</para>
</sect2>
</sect1>
- <sect1>
- <title>The Portal Contents</title>
- <sect2 id="contents_pages">
+ <sect1 id="contents_pages">
+ <title>The Portal Pages</title>
+ <sect2>
<title>Navigating the Portal Pages</title>
<para>Navigating the portal pages is normally performed either by typing in a specific URL (
<xref linkend="intro_portal_pages"/>
@@ -178,10 +178,12 @@
<imagedata fileref="images/intro/tabs.gif" format="gif" align="center" valign="middle"/>
</imageobject>
</mediaobject>
- Each page, in the default installation of JBoss Portal is explained here, along with the portlets found
+ Each page, in the default installation of JBoss Portal is explained in the following sections, along with
+ the portlets found
within them.
</para>
- <sect3>
+ </sect2>
+ <sect2>
<title>Default Page</title>
<para>The default page contains the following portlets:
<itemizedlist>
@@ -201,7 +203,8 @@
<xref linkend="intro_nav_portlet"/>
</listitem>
</itemizedlist>
- <sect4 id="intro_greetings_portlet">
+ </para>
+ <sect3 id="intro_greetings_portlet">
<title>Greetings Portlet</title>
<para>
<mediaobject>
@@ -212,11 +215,15 @@
</mediaobject>
Displays hard-coded links to downloading JBoss Portal, downloading
portlets from PortletSwap.com, and the live online JBoss Portal demo. It also contains default
- information on using the UserPortlet to login.
+ authentication information on using the UserPortlet to login.
</para>
- </sect4>
- <sect4 id="intro_user_portlet">
+ </sect3>
+ <sect3 id="intro_user_portlet">
<title>User Portlet</title>
+ <note>Administrators should view,
+ <xref linkend="useradmin"/>
+ , for managing the portal Userbase. Only user operations are covered in this section...
+ </note>
<para>
<mediaobject>
<imageobject>
@@ -224,7 +231,14 @@
valign="middle"/>
</imageobject>
</mediaobject>
- Allows you to login using the credentials (by clicking the
+ The User Portlet allows a user to:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Login to the Portal</emphasis>
+ </para>
+ <para>
+ Login using the credentials (by clicking the
<emphasis>Standard Login</emphasis>
link):
<programlisting>
@@ -236,9 +250,52 @@
Username: admin
Password: admin
</programlisting>
+ Once successfully logged in, the user will have additional functionality at his disposal, that
+ is covered in the following sections.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/user_portlet_loggedin.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Create a new account</emphasis>
+ </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/user_portlet_create.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Create a new account by clicking on the
+ <emphasis>Create</emphasis>
+ link in the portlet. A User can then fill in the necessary information to create an account on
+ the system:
</para>
- </sect4>
- <sect4 id="intro_page_portlet">
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Edit personal information.</emphasis>
+ </para>
+ <para>A user has the ability to edit his personal information at any time by clicking on the
+ <emphasis>Edit Info</emphasis>
+ link.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/user_portlet_editinfo.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </sect3>
+ <sect3 id="intro_page_portlet">
<title>Page Portlet</title>
<para>
<mediaobject>
@@ -247,9 +304,11 @@
valign="middle"/>
</imageobject>
</mediaobject>
+ Allows a user to navigate to different Portal Pages, by clicking on the page names. Similar to the
+ Navigation Tabs at the top of the page.
</para>
- </sect4>
- <sect4 id="intro_cms_portlet">
+ </sect3>
+ <sect3 id="intro_cms_portlet">
<title>CMS Portlet</title>
<para>
<mediaobject>
@@ -258,9 +317,15 @@
valign="middle"/>
</imageobject>
</mediaobject>
+ Renders data from the Content Management System embedded with the Portal. Users are able to
+ navigate the content, view images, binary files, etc.. via this portlet.
</para>
- </sect4>
- <sect4 id="intro_nav_portlet">
+ <note>Administrators should view,
+ <xref linkend="admincmsPortlet"/>
+ , for managing the data in the CMS.
+ </note>
+ </sect3>
+ <sect3 id="intro_nav_portlet">
<title>Navigation Portlet</title>
<para>
<mediaobject>
@@ -269,18 +334,199 @@
</imageobject>
</mediaobject>
</para>
- </sect4>
- </para>
</sect3>
- <sect3>
+ </sect2>
+ <sect2>
<title>News Page</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/newspage.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ The News Page contains customizable weather and news displays from common internet feeds. An open internet
+ connection on the server-side is therefore required for them to operate. ;-)
+ </para>
+ <para>
+ This page contains the following portlets:
+ <itemizedlist>
+ <listitem>
+ <xref linkend="weatherportlet"/>
+ </listitem>
+ <listitem>
+ <xref linkend="newsportlet"/>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <sect3 id="weatherportlet">
+ <title>Weather Portlet</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/weatherportlet.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ The Weather Portlet retrieves an RSS weather feed, based on a key (commonly a US Postal Code), and
+ displays
+ it as HTML to the user.
+ </para>
+ <para>Additionally, a user is able to modify his preference in location by going in to the Portlet's Edit
+ Mode (click
+ <imageobject>
+ <imagedata fileref="images/intro/edit.gif" format="gif"/>
+ </imageobject>
+ ). Any valid US Postal Code can be inputted here. Once the form is submitted, this property will be saved
+ in the user's preference, so he will always see the same weather data for his location, when logged in.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/weatherportlet_edit.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ <para>
+ <emphasis role="bold">Not in the United States?</emphasis>
+ Follow these steps to configure the Weather portlet to display information for your area.
+ <orderedlist>
+ <listitem>
+ <para>Go to
+ <ulink url="http://weather.yahoo.com/">http://weather.yahoo.com/</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Enter your city name in the location field, found on the page:
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/weather_config1.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Find your location on the list under the form and click on it (In this case, its
+ <emphasis>Marseille, France</emphasis>
+ ):
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/weather_config2.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Copy the location digits from the address bar in your browser (In this case, its
+ <emphasis>FRXX0059</emphasis>
+ ):
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/weather_config3.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Paste these numbers in to the weather portlet edit form (In this case, its
+ <emphasis>FRXX0059</emphasis>
+ ):
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/weather_config4.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Hit
+ <emphasis>submit</emphasis>
+ ...
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/weather_config5.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
</sect3>
- <sect3>
- <title>Test Page</title>
+ <sect3 id="newsportlet">
+ <title>News Portlet</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/newsportlet.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ The News Portlet retrieves an RSS news feed, based on a url, and displays it as HTML to the user.
+ </para>
+ <para>Additionally, a user is able to modify his preference in RSS feed source by going in to the Portlet's
+ Edit
+ Mode (click
+ <imageobject>
+ <imagedata fileref="images/intro/edit.gif" format="gif"/>
+ </imageobject>
+ ). Once the form is submitted, this property will be saved
+ in the user's preference, so he will always see the same news source, when logged in.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/newsportlet_edit.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ <note>This portlet is capable of handling most RSS 1.0 and RSS 2.0 feeds.</note>
</sect3>
- <sect3>
+ </sect2>
+ <sect2>
+ <title>Test Page</title>
+ <para>
+ Items in this test page change frequently. They are used mainly by the JBoss Portal Development team to
+ debug and test new functionality. For that reason, these items are not covered in this document. It is
+ recommended that Portal Administrators remove this page for that reason.
+ </para>
+ </sect2>
+ <sect2>
<title>Admin Page</title>
- </sect3>
+ <para>
+ <note>You
+ <emphasis role="bold">must be</emphasis>
+ logged in as an administrator, or have proper priviledges to see this page.
+ </note>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/adminpage.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ The Admin Page's purpose is to allow an administrator to manage all aspects of the portal (Follow the links
+ for in-depth reviews of
+ these functions):
+ <itemizedlist>
+ <listitem>
+ <para>Users/Roles (See:
+ <xref linkend="useradmin"/>
+ ,
+ <xref linkend="roleadmin"/>
+ )
+ </para>
+ </listitem>
+ <listitem>
+ <para>Content Management System (See:
+ <xref linkend="admincmsPortlet"/>
+ )
+ </para>
+ </listitem>
+ <listitem>
+ <para>Portal Objects (themes, layouts, portal instances, pages, windows, security, and deployed
+ portlets) (See:
+ <xref linkend="dynamicity"/>
+ )
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ </para>
</sect2>
</sect1>
</chapter>
\ No newline at end of file
1.7 +22 -27 jboss-portal-docs/userGuide/en/modules/user_role.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: user_role.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-portal-docs/userGuide/en/modules/user_role.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- user_role.xml 14 Jul 2006 14:32:13 -0000 1.6
+++ user_role.xml 14 Jul 2006 21:15:28 -0000 1.7
@@ -2,20 +2,15 @@
<chapter id="userPortlet">
<chapterinfo>
<author>
- <firstname>Thomas</firstname>
- <surname>Heute</surname>
- <email>theute at jboss.org</email>
- </author>
- <author>
<firstname>Roy</firstname>
<surname>Russo</surname>
<email>roy at jboss.org</email>
</author>
</chapterinfo>
<title>Administration - Users and Roles</title>
- <section>
- <title>User Portlet</title>
- <sect1>
+ <sect1 id="useradmin">
+ <title>Managing Users</title>
+ <sect2>
<title>Introduction</title>
<para>The user portlet is dedicated to create and manage users and their profiles. This portlet is accessible
immediately on the default portal homepage. Also, once logged in, you will notice how it changes to allow
@@ -25,8 +20,8 @@
<imagedata fileref="images/role/user_ss.gif" format="gif" align="center" valign="middle"/>
</imageobject>
</para>
- </sect1>
- <sect1>
+ </sect2>
+ <sect2>
<title>Functionalities</title>
<orderedlist>
<para>Managing users using the user module consists in:</para>
@@ -40,8 +35,8 @@
<listitem>Allowing as administrator to assign roles to a user</listitem>
<listitem>Allowing a user to logout</listitem>
</orderedlist>
- </sect1>
- <sect1>
+ </sect2>
+ <sect2>
<title>Configuration</title>
<para>The following xml block is the standard configuration for the UserPortlet found in
<emphasis>portal-core.war/WEB-INF/portlet.xml</emphasis>
@@ -133,11 +128,11 @@
<para>Default role assigned to new users</para>
</listitem>
</orderedlist>
+ </sect2>
</sect1>
- </section>
- <section>
- <title>Role Portlet</title>
- <sect1>
+ <sect1 id="roleadmin">
+ <title>Managing Roles</title>
+ <sect2>
<title>Introduction</title>
<para>The role portlet is dedicated to create and edit roles. A role will be used to grant
different permission level to different portlets. A user can have several roles (for
@@ -147,10 +142,10 @@
<imagedata fileref="images/role/normalstate.gif" format="GIF89a" align="center" valign="middle"/>
<caption>Normal state</caption>
</imageobject>
- </sect1>
- <sect1>
- <title>Functionalities</title>
+ </sect2>
<sect2>
+ <title>Functionalities</title>
+ <sect3>
<title>Create a role</title>
<para>To create a new role, you just need to define a short name that will be used for
reference, and a display name for displaying to the user, for example
@@ -160,17 +155,17 @@
, changing the display name will not affect the
security rules
</para>
- </sect2>
- <sect2>
+ </sect3>
+ <sect3>
<title>Edit a role</title>
<para>While editing a role, you just need to pick an exising role then change the
display name.</para>
- </sect2>
- <sect2>
+ </sect3>
+ <sect3>
<title>Editing Role Members</title>
<para>Allows for an administrator to search and modify the members' assigned
roles.</para>
+ </sect3>
</sect2>
</sect1>
- </section>
</chapter>
More information about the jboss-cvs-commits
mailing list