[jboss-cvs] jboss-portal-docs/userGuide/en/modules ...
Roy Russo
russo at jboss.com
Mon Jul 17 11:00:12 EDT 2006
User: russo
Date: 06/07/17 11:00:12
Modified: userGuide/en/modules user_role.xml
Log:
JBPORTAL-873 - finished user/role
Revision Changes Path
1.8 +127 -130 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.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- user_role.xml 14 Jul 2006 21:15:28 -0000 1.7
+++ user_role.xml 17 Jul 2006 15:00:12 -0000 1.8
@@ -12,122 +12,77 @@
<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
- the user and administrative functions.</para>
- <para>
+ <para>This section covers the administrator functions made available by the UserPortlet. For end-user
+ operation, see:
+ <xref linkend="intro_user_portlet"/>
+ . Adminsitrative functions are available once you are logged in with the proper credentials (admin/admin)
+ <mediaobject>
<imageobject>
<imagedata fileref="images/role/user_ss.gif" format="gif" align="center" valign="middle"/>
</imageobject>
+ </mediaobject>
</para>
</sect2>
<sect2>
- <title>Functionalities</title>
- <orderedlist>
- <para>Managing users using the user module consists in:</para>
- <listitem>Allowing a user to register a new profile with a login and password</listitem>
- <listitem>Allowing a user to log in the sytem and be recognized as member of user
- groups</listitem>
- <listitem>Allowing a user to update a profile with more information like his real name,
- instant messenger informations...</listitem>
- <listitem>Allowing an administrator to see the list of users, from there he can assign
- roles to a user</listitem>
- <listitem>Allowing as administrator to assign roles to a user</listitem>
- <listitem>Allowing a user to logout</listitem>
- </orderedlist>
- </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>
- :
- </para>
- <programlisting><![CDATA[ <portlet>
- <portlet-name>UserPortlet</portlet-name>
- <portlet-class>org.jboss.portal.core.portlet.user.UserPortlet</portlet-class>
- <supported-locale>en</supported-locale>
- <supported-locale>fr</supported-locale>
- <resource-bundle>Resource</resource-bundle>
- <supports>
- <mime-type>text/html</mime-type>
- <portlet-mode>VIEW</portlet-mode>
- </supports>
- <portlet-info>
- <title>User portlet</title>
- </portlet-info>
- <init-param>
- <description>Whether we should use ssl on login and throughout the Portal. 1=yes;0=no</description>
- <name>useSSL</name>
- <value>0</value>
- </init-param>
- <init-param>
- <description>Subscription mode</description>
- <name>subscriptionMode</name>
- <!-- <value>emailVerification</value>-->
- <value>automatic</value>
- </init-param>
- <init-param>
- <description>Domain of your website for email verification.</description>
- <name>emailDomain</name>
- <value>JBoss.com</value>
- </init-param>
- <init-param>
- <description>Email displayed in the TO field</description>
- <name>emailFrom</name>
- <value>jbossportal at example.com</value>
- </init-param>
- <init-param>
- <description>Default role of registered users</description>
- <name>defaultRole</name>
- <value>Users</value>
- </init-param>
- </portlet>]]></programlisting>
- <orderedlist>
- <para>The following attributes can be modified in the xml descriptor:</para>
- <listitem>
- <literal>useSSL</literal>
- <para>Allows for user logins to be passed thru a SSL.</para>
- <orderedlist>
- <listitem>
- <literal>0</literal>
- <para>Set to zero to disable.</para>
- </listitem>
- <listitem>
- <literal>1</literal>
- <para>Set to 1 to enable. You must have SSL configured properly in tomcat for
- this to work.</para>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- <literal>subscriptionMode</literal>
+ <title>Actions</title>
+ <para>All administrative functions are available after clicking on the '
+ <emphasis>List of all users</emphasis>
+ ' link.
<orderedlist>
+ <para>Managing users using the UserPortlet consists of:</para>
<listitem>
- <literal>automatic</literal>
- <para>The user can register and is automatically enabled</para>
- </listitem>
- <listitem>
- <literal>emailVerification</literal>
- <para>The user is disabled until he clicks on a link sent to his email
- address.</para>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- <literal>emailDomain</literal>
- <para>Your domain name or the name of your website for the email verification form
- text.</para>
+ <para>
+ <xref linkend="searchingusers"/>
+ </para>
</listitem>
<listitem>
- <literal>emailFrom</literal>
- <para>Email address that will appear in the "From" header when the email verification
- is sent.</para>
+ <para>
+ <xref linkend="updatingusers"/>
+ </para>
</listitem>
<listitem>
- <literal>defaultRole</literal>
- <para>Default role assigned to new users</para>
+ <para>
+ <xref linkend="updatinguserroles"/>
+ </para>
</listitem>
</orderedlist>
+ </para>
+ <sect3 id="searchingusers">
+ <title>Searching for Users</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/role/searchusers.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Typing a partial username in the form text field, allows you to search for usernames matching that
+ criteria.
+ </para>
+ </sect3>
+ <sect3 id="updatingusers">
+ <title>Updating User Profiles</title>
+ <para>Clicking on the
+ <emphasis>Profile</emphasis>
+ link on the search page will allow you to edit a user's profile data, and even reset his password.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/role/editprofile.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </sect3>
+ <sect3 id="updatinguserroles">
+ <title>Updating User Roles</title>
+ <para>Clicking on the
+ <emphasis>Roles</emphasis>
+ link in the search page allows you to modify the roles the specific user belongs to.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/role/editroles.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </sect3>
</sect2>
</sect1>
<sect1 id="roleadmin">
@@ -135,36 +90,78 @@
<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
- example he can be an administrator of a category of forum but only a reader on another
- category)</para>
+ different permission level to different portlets, pages, or portal instances. A user can have several roles.
+ </para>
+ <para>The RolePortlet is accessible once logged in as an administrator (admin/admin) from the Admin Page
<imageobject>
- <imagedata fileref="images/role/normalstate.gif" format="GIF89a" align="center" valign="middle"/>
+ <imagedata fileref="images/role/normalstate.gif" format="gif" align="center" valign="middle"/>
<caption>Normal state</caption>
</imageobject>
+ </para>
</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
+ <title>Actions</title>
+ <para>
+ <orderedlist>
+ <para>Managing roles using the RolePortlet consists of:</para>
+ <listitem>
+ <para>
+ <xref linkend="createrole"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="editrole"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="editrolemembers"/>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <sect3 id="createrole">
+ <title>Creating Roles</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/role/createrole.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ To create a new role, you need to define a short name that will be used for
reference, and a display name for displaying to the user, for example
<literal>admin</literal>
would be a good name for the display name
<literal>Administrators</literal>
, changing the display name will not affect the
- security rules
+ security rules.
</para>
</sect3>
- <sect3>
+ <sect3 id="editrole">
<title>Edit a role</title>
- <para>While editing a role, you just need to pick an exising role then change the
- display name.</para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/role/editrolename.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ While editing a role, you just need to pick an exising role then change the
+ display name. Additionally, you can delete existing roles from this screen.
+ </para>
</sect3>
- <sect3>
+ <sect3 id="editrolemembers">
<title>Editing Role Members</title>
- <para>Allows for an administrator to search and modify the members' assigned
- roles.</para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/role/editrolemembers.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Allows for an administrator to search and modify the members' assigned
+ roles.
+ </para>
</sect3>
</sect2>
</sect1>
More information about the jboss-cvs-commits
mailing list