[portal-commits] JBoss Portal SVN: r14027 - in docs/enterprise/trunk: PortletBridge/en-US and 3 other directories.

Author: jaredmorgs Date: 2012-01-11 20:47:10 -0500 (Wed, 11 Jan 2012) New Revision: 14027 Added: docs/enterprise/trunk/Reference_Guide/en-US/_Common_Content/ Removed: docs/enterprise/trunk/Reference_Guide/en-US/Common_Content/ Modified: docs/enterprise/trunk/Installation_Guide/en-US/Book_Info.xml docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide.xml docs/enterprise/trunk/Installation_Guide/en-US/Preface.xml docs/enterprise/trunk/PortletBridge/en-US/Book_Info.xml docs/enterprise/trunk/PortletBridge/en-US/Portlet_Bridge_Overview.xml docs/enterprise/trunk/PortletBridge/en-US/Preface.xml docs/enterprise/trunk/Reference_Guide/en-US/Book_Info.xml docs/enterprise/trunk/Reference_Guide/en-US/Preface.xml docs/enterprise/trunk/Reference_Guide/en-US/Reference_Guide.xml docs/enterprise/trunk/Tuning_Guide/en-US/Book_Info.xml docs/enterprise/trunk/Tuning_Guide/en-US/Preface.xml docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.xml docs/enterprise/trunk/User_Guide/en-US/Administration_CMS_Portlet.xml docs/enterprise/trunk/User_Guide/en-US/Book_Info.xml docs/enterprise/trunk/User_Guide/en-US/Dynamicity.xml docs/enterprise/trunk/User_Guide/en-US/JBoss_Portal_Basics.xml docs/enterprise/trunk/User_Guide/en-US/Preface.xml docs/enterprise/trunk/User_Guide/en-US/User_Guide.xml docs/enterprise/trunk/User_Guide/en-US/User_Role.xml Log: Initial changes for 4.3.7 release. Modified: docs/enterprise/trunk/Installation_Guide/en-US/Book_Info.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Book_Info.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/Installation_Guide/en-US/Book_Info.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -7,8 +7,8 @@ <subtitle>An Installation Guide for &PRODUCT;</subtitle> <productname>JBoss Enterprise Portal Platform</productname> <productnumber>4.3</productnumber> - <edition>1</edition> - <pubsnumber>1.4</pubsnumber> + <edition>4.3.7</edition> + <pubsnumber>1</pubsnumber> <abstract><para>This Installation Guide documents relevant information regarding the installation of JBoss Enterprise Portal Platform</para> Modified: docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,17 +1,18 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent"> +%BOOK_ENTITIES; ]> - <book> - <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Getting_Started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Post_Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Databases.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Test_Your_Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Uninstall_JBoss.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Introduction.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Getting_Started.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Installation.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Post_Installation.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Configuration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Databases.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Test_Your_Installation.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Uninstall_JBoss.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> </book> Modified: docs/enterprise/trunk/Installation_Guide/en-US/Preface.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Preface.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/Installation_Guide/en-US/Preface.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,13 +1,8 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> - <preface id="Portal_User_Guide-Preface"> - <title>Preface</title> - <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Middleware_Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> - </xi:include> -</preface> + <title>Preface</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Conventions.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Feedback.xml"/> + </preface> Modified: docs/enterprise/trunk/PortletBridge/en-US/Book_Info.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Book_Info.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/PortletBridge/en-US/Book_Info.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,38 +1,32 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> <bookinfo id="book-Overview-Overview"> - <title>Portlet Bridge Overview</title> - <subtitle>For use with JBoss Enterprise Portal Platform 4.3</subtitle> - <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>4.3</productnumber> - - <edition>1</edition> - <pubsnumber>2.1</pubsnumber> - <abstract> - <para> + <title>Portlet Bridge Overview</title> + <subtitle>For use with JBoss Enterprise Portal Platform 4.3</subtitle> + <productname>JBoss Enterprise Portal Platform</productname> + <productnumber>4.3</productnumber> + <edition>4.3.7</edition> + <pubsnumber>1</pubsnumber> + <abstract> + <para> The JBoss Portlet Bridge is an implementation of the JSR-301 specification to support JSF within a portlet and with added enhancements to support other web frameworks. Currently the bridge supports any combination of JSF, Seam, and RichFaces to run inside a portlet. </para> - </abstract> - <corpauthor> - <inlinemediaobject> - <imageobject> - <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" /> - </imageobject> - <textobject> - <phrase>Logo</phrase> - </textobject> - - </inlinemediaobject> - - </corpauthor> - <copyright> - <year>&YEAR;</year> - <holder>&HOLDER;</holder> - - </copyright> - <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - + </abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"/> + </imageobject> + <textobject> + <phrase>Logo</phrase> + </textobject> + </inlinemediaobject> + </corpauthor> + <copyright> + <year>&YEAR;</year> + <holder>&HOLDER;</holder> + </copyright> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Legal_Notice.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Author_Group.xml"/> </bookinfo> - Modified: docs/enterprise/trunk/PortletBridge/en-US/Portlet_Bridge_Overview.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Portlet_Bridge_Overview.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/PortletBridge/en-US/Portlet_Bridge_Overview.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,13 +1,15 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> +<!-- This document was created with Syntext Serna Free. --> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Portlet_Bridge_Overview.ent"> +%BOOK_ENTITIES; ]> <book> - <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="gettingstarted.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="portlet_development.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="overview.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gettingstarted.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portlet_development.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> </book> - Modified: docs/enterprise/trunk/PortletBridge/en-US/Preface.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Preface.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/PortletBridge/en-US/Preface.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -4,8 +4,6 @@ <preface id="pref-Overview-Preface"> <title>Preface</title> <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Middleware_Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> - </xi:include> + <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </preface> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Book_Info.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Book_Info.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/Reference_Guide/en-US/Book_Info.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,30 +1,27 @@ -<?xml version="1.0" encoding="UTF-8"?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]> - <bookinfo id="JBoss_Portal_Reference_Guide"> - <title>Reference Guide</title> - <subtitle>A Reference Guide for Enterprise Portal Platform 4.3</subtitle> - <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>4.3</productnumber> - <edition>1</edition> - <pubsnumber>1.10</pubsnumber> - - <abstract><para>This book is the Enterprise Portal Platform Reference Guide.</para> - </abstract> - <corpauthor> - <inlinemediaobject> - <imageobject> - <imagedata fileref="Common_Content/images/redhat-logo.svg" /> - </imageobject> - </inlinemediaobject> - </corpauthor> - - <copyright> - <year>&YEAR;</year> - <holder>&HOLDER;</holder> - </copyright> - <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <title>Reference Guide</title> + <subtitle>A Reference Guide for Enterprise Portal Platform 4.3</subtitle> + <productname>JBoss Enterprise Portal Platform</productname> + <productnumber>4.3</productnumber> + <edition>4.3.7</edition> + <pubsnumber>1</pubsnumber> + <abstract> + <para>This book is the Enterprise Portal Platform Reference Guide.</para> + </abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="Common_Content/images/redhat-logo.svg"/> + </imageobject> + </inlinemediaobject> + </corpauthor> + <copyright> + <year>&YEAR;</year> + <holder>&HOLDER;</holder> + </copyright> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Legal_Notice.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Author_Group.xml"/> </bookinfo> - Modified: docs/enterprise/trunk/Reference_Guide/en-US/Preface.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Preface.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/Reference_Guide/en-US/Preface.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -5,9 +5,5 @@ <preface id="Portal_User_Guide-Preface"> <title>Preface</title> <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Middleware_Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> - </xi:include> + <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </preface> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Reference_Guide.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Reference_Guide.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/Reference_Guide/en-US/Reference_Guide.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,67 +1,42 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.docbook.org/xml/4.5/docbookx.dtd"> +<?xml version='1.0' encoding='UTF-8'?> +<!-- This document was created with Syntext Serna Free. --> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> +%BOOK_ENTITIES; +]> <book id="jboss_portal_reference_guide"> -<!--<book lang="en"> - <bookinfo> - <title>JBoss Portal Reference Guide</title> - <subtitle>JBoss Portal Reference Guide</subtitle> - <edition>2.7.0</edition> - <pubsnumber>1</pubsnumber> - <productname>JBoss Portal</productname> - <productnumber>2.7</productnumber> - <pubdate>Nov, 2007</pubdate> - <isbn>N/A</isbn> - - - <abstract><para>This document is an outline of the information plan for JBoss AS 5 GA project's documentation.</para></abstract> - - - - - - - - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </bookinfo> - --> - <!--<toc/>--> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml" /> - <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Trademarks.xml" /> -<!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Overview.xml" />--> -<!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Featurelist.xml" />--> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Target.xml" /> -<!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Acknowledgements.xml" />--> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Supported.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Installation.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Configuration.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Migration.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Tutorials.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="XML_Descriptors.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="URLs.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Coordination.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Error_Handling.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Content_Integration.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Widget_Integration.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Portlet_Modes.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Portal_API.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Clustering.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="WSRP.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Security.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Identity.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Identity_Portlets.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Authentication.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Ldap.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="SSO.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="CMS_Portlet.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Workflow.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Nav_Tabs.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Theme_And_Layouts.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Ajax.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Troubleshooting.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Portal_Objects_DTD.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Portlet_Instances_DTD.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Jboss_Portlet_DTD.xml" /> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml" /> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Target.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Supported.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Installation.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Configuration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Migration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Tutorials.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="XML_Descriptors.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="URLs.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Coordination.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Error_Handling.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Content_Integration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Widget_Integration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Portlet_Modes.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Portal_API.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Clustering.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="WSRP.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Security.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Identity.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Identity_Portlets.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Authentication.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Ldap.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="SSO.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="CMS_Portlet.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Workflow.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Nav_Tabs.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Theme_And_Layouts.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Ajax.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Troubleshooting.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Portal_Objects_DTD.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Portlet_Instances_DTD.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Jboss_Portlet_DTD.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> </book> Modified: docs/enterprise/trunk/Tuning_Guide/en-US/Book_Info.xml =================================================================== --- docs/enterprise/trunk/Tuning_Guide/en-US/Book_Info.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/Tuning_Guide/en-US/Book_Info.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,36 +1,31 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent"> %BOOK_ENTITIES; ]> <bookinfo id="book-Tuning_Guide-Tuning_Guide"> - <title>Tuning Guide</title> - <subtitle>A guide to tuning the performance of JBoss Enterprise Portal Platform 4.3.</subtitle> - <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>4.3</productnumber> - <edition>1</edition> - <pubsnumber>1.5</pubsnumber> - <abstract> - <para> + <title>Tuning Guide</title> + <subtitle>A guide to tuning the performance of JBoss Enterprise Portal Platform 4.3.</subtitle> + <productname>JBoss Enterprise Portal Platform</productname> + <productnumber>4.3</productnumber> + <edition>4.3.7</edition> + <pubsnumber>1</pubsnumber> + <abstract> + <para> This Installation Guide documents tuning of JBoss Enterprise Portal Platform. </para> - - </abstract> - <corpauthor> - <inlinemediaobject> - <imageobject> - <imagedata fileref="Common_Content/images/redhat-logo.svg" format="SVG" /> - </imageobject> - - </inlinemediaobject> - - </corpauthor> - <copyright> - <year>&YEAR;</year> - <holder>&HOLDER;</holder> - - </copyright> - <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="Common_Content/images/redhat-logo.svg" format="SVG"/> + </imageobject> + </inlinemediaobject> + </corpauthor> + <copyright> + <year>&YEAR;</year> + <holder>&HOLDER;</holder> + </copyright> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Legal_Notice.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Author_Group.xml"/> </bookinfo> - Modified: docs/enterprise/trunk/Tuning_Guide/en-US/Preface.xml =================================================================== --- docs/enterprise/trunk/Tuning_Guide/en-US/Preface.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/Tuning_Guide/en-US/Preface.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -6,8 +6,6 @@ <preface id="pref-Tuning_Guide-Preface"> <title>Preface</title> <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Middleware_Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> - </xi:include> + <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </preface> Modified: docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.xml =================================================================== --- docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,17 +1,17 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> +<!-- This document was created with Syntext Serna Free. --> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent"> %BOOK_ENTITIES; ]> <book> - <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="jbossweb.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="hibernate.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="identity.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="clustering.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="jvm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="overview.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="jbossweb.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="hibernate.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="identity.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="clustering.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="jvm.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> </book> - Modified: docs/enterprise/trunk/User_Guide/en-US/Administration_CMS_Portlet.xml =================================================================== --- docs/enterprise/trunk/User_Guide/en-US/Administration_CMS_Portlet.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/User_Guide/en-US/Administration_CMS_Portlet.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,470 +1,390 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ - ]> - + ]> <chapter id="Portal_User_Guide-Test-Administration_CMS_Portlet"> - <title>Administration Content Management System (CMS) Portlet</title> - - - -<section id="Portal_User_Guide-Administration_-_Content_Management_System-Introduction"> - <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 admin (admin/admin) and navigating to the admin portal and then the CMS Page tab. - </para> - - <para> - You will then be presented with a page that is similar to this: - </para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/cms_adminpage.png" format="PNG"/> - </imageobject> - </mediaobject> -</section> - -<section id="Portal_User_Guide-Administration_-_Content_Management_System-Actions"> - <title>Actions</title> - - - <para> - This section describes common actions an administrator can perform from within the AdminCMS Portlet. All - actions are available using the flyout menu. Note that the Pending Items action is only available if the - workflow mechanism has been activated. - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/actions_menu.png" format="PNG"/> - </imageobject> - </mediaobject> - </para> - - - <section id="Portal_User_Guide-Actions-Viewing-Directories"> - - <title>Viewing Directories</title> - - <para> - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/ss_viewfile.png" format="PNG"/> - </imageobject> - </mediaobject> - - A user can list directory contents by either clicking on the folder name or selecting "view" from the Action - dropdown and clicking "go". - </para> - </section> - - <section id="Portal_User_Guide-Actions-Viewing_File_Properties"> - - <title>Viewing File Properties</title> - - <para> - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/ss_viewfile.png" format="PNG"/> - </imageobject> - </mediaobject> - Clicking on the "Name" of a file brings up the File Properties page. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/fileproperties.png" format="PNG"/> - </imageobject> - </mediaobject> - <para> - The File Properties window displays all the possible actions available to perform on a file. - </para> - - <para> - Version and Locale Information are also contained on this screen. Note that any version labeled with a - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/live.png" format="PNG"/> - </imageobject> - </mediaobject> - - is the current "live" version shown to users. - </para> - -</section> - - <section id="Portal_User_Guide-Actions-Copying_Files"> - - <title>Copying Files/Directories</title> - - <para> - Clicking on the "Copy" action, displays the copy file/directory dialog window. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/resourcecopy.png" format="PNG"/> - </imageobject> - </mediaobject> - - <para> - The copy resource window allows a user to copy files to any folder on the system, as well as copy whole directory trees to any directory on the system. A user can select which - destination directory to copy the resource to by using the directory browser. Clicking the - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/plus.png" format="PNG"/> - </imageobject> - </mediaobject> - - icon expands the directory tree. Clicking on the name of the directory within the tree sets it as the destination directory for the copied resource. - - </para> -</section> - - - <section id="Portal_User_Guide-Actions-Moving_Files"> - <title>Moving Files/Directories</title> - - - <para> - Clicking on the "Move" action, displays the move file/directory dialog window. - </para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/resourcemove.png" format="PNG"/> - </imageobject> - </mediaobject> - - <para> - The move resource window allows a user to move files to any folder on the system, as well as move whole directory trees to any directory on the system. A user can select which destination directory to move the resource to, by using the directory browser. Clicking the - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/plus.png" format="PNG"/> - </imageobject> - </mediaobject> - - icon expands the directory tree. Clicking on the name of the directory within the tree sets it as the destination directory for the moved resource. - - </para> - -</section> - - <section id="Portal_User_Guide-Actions-Deleting_Files"> - <title>Deleting Files/Directories</title> - - - <para> - Clicking on the "Delete" action, displays the delete file/directory confirmation window. - </para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/resourcedelete.png" format="PNG"/> - </imageobject> - </mediaobject> - - <para> - The delete resource confirmation window allows a user to delete a file or a directory on the system. Note that deleting a directory will delete the entire tree, so all directories under the deleted one will also be deleted. - - </para> - - <warning> - <para> - Currently, there is no way to retrieve deleted files/directories! Deleting a file or directory is permanent! - </para> - </warning> -</section> - - <section id="Portal_User_Guide-Actions-Creating_Directories"> - - <title>Creating Directories</title> - - <para> - Clicking on the "Create Folder" action, displays the create directory dialog window. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/createdirectory.png" format="PNG"/> - </imageobject> - </mediaobject> - - <para> - The create directory resource window allows a user to create a directory under chosen path. On this window, a user can specify a name for the new empty directory and assign it a description. - </para> -</section> - - <section id="Portal_User_Guide-Actions-Creating_Text"> - - <title>Creating Text/HTML Files</title> - - <para> - Clicking on the "Create File" action, displays the create file dialog window with the embedded WYSIWYG editor and directory browser. - </para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/createhtml.png" format="PNG"/> - </imageobject> - </mediaobject> - - <para> - The create file window allows a user to create a text or HTML file using the embedded WYSIWYG HTML editor. The editor is a fully-functional HTML editor with a myriad of HTML functions. It also includes a preview - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/editorpreview.png" format="PNG"/> - </imageobject> - </mediaobject> - - button and a source view - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/editorsource.png" format="PNG"/> - </imageobject> - </mediaobject> - - button. - </para> - - <para> - An in-depth walk-through of the editor is beyond the scope of this document. However, the editor does contain help pages within it, that can be accessed by clicking the - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/editorhelp.png" format="PNG"/> - </imageobject> - </mediaobject> - - icon. - </para> - <important> - <para> - It is important to note here that when creating links to images or other resources within the system, a user must use the relative file path to that resource. ie: images/hello.i.e.,. Keep in mind at all times that the document base is http://localhost/portal/ by default!</para> - </important> - - <para> - Additionally, a user can set a title for the file that will be used in the portlet title bar, and a language for the file, used in serving localized content. - </para> -</section> - - <section id="Portal_User_Guide-Actions-Uploading_Files"> - - <title>Uploading Files</title> - - <para> - Clicking on the "Upload File" action, displays the upload file dialog window. - </para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/resourceupload.png" format="PNG"/> - </imageobject> - </mediaobject> - - <para> - The upload file window allows a user to upload files to any directory on the system. The upload process will work on files up to 1GB and of all types. A user can select which destination directory to upload the resource to, by using the directory browser. Clicking the - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/plus.png" format="PNG"/> - </imageobject> - </mediaobject> - - icon expands the directory tree. Clicking on the name of the directory within the tree, sets it as the destination directory for the uploaded resource. Additionally, a user can set a title for the file that will be used in the portlet title bar, and a language for the file, used in serving localized content. - </para> -</section> - - <section id="Portal_User_Guide-Actions-Uploading-Archives"> - - <title>Uploading Archives</title> - - <para> - Clicking on the "Upload Archive" action, displays the upload archive dialog window. - </para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/resourceuploadarchive.png" format="PNG"/> - </imageobject> - </mediaobject> - - <para> - The upload archive window allows a user to upload archives to any directory on the system. The system will then explode the archive, create versions, and place all the files in the repository. A user can select which destination directory to upload the resource to, by using the directory browser. Clicking the - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/plus.png" format="PNG"/> - </imageobject> - </mediaobject> - - icon expands the directory tree. Clicking on the name of the directory within the tree, sets it as the destination directory for the uploaded resource. Additionally, a user can set a language for the archive files, used in serving localized content. - - </para> - -</section> - - <section id="Portal_User_Guide-Actions-Exporting_Folders"> - <title>Exporting Folders</title> - - - <para> - Clicking on the "Export Folder" action, displays the export archive dialog window. - </para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/ss_exportarchive.png" format="PNG"/> - </imageobject> - </mediaobject> - - <para> - The export folder window allows a user to export entire directory structures as zip files. The system will aggregate all contents of a specific directory, and present to the user to download it. - A user can select which source directory to export the resources from, by using the directory browser. Clicking the - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/plus.png" format="PNG"/> - </imageobject> - </mediaobject> - - icon expands the directory tree. Clicking on the name of the directory within the tree, sets it as the source directory for the export resource. Additionally, a user can set a language for the files to be exported. - </para> - - <important> - <para> - Version information is not exported. Only versions labeled "Live" are exported! - </para> - </important> - -</section> - - - <section id="Portal_User_Guide-Actions-Editing_Text"> - <title>Editing Text/HTML Files</title> - - <para> - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/fileproperties.png" format="PNG"/> - </imageobject> - </mediaobject> - - Clicking on the "text/html"link, displays the edit file dialog window with the embedded WYSIWYG editor and directory browser. - </para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/editfile.png" format="PNG"/> - </imageobject> - </mediaobject> - - <para> - The edit file window allows a user to edit a text or HTML file using the embedded WYSIWYG HTML editor. The editor is a fully-functional HTML editor with a myriad of HTML functions. It also includes a preview - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/editorpreview.png" format="PNG"/> - </imageobject> - </mediaobject> - - button and a source view - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/editorsource.png" format="PNG"/> - </imageobject> - </mediaobject> - - button. - - </para> - - <para> - A user may specify at this point if he would like to make the new edit "live", or available in production. Additionally, a user can set a title for the file that will be used as the portlet window title. - </para> -</section> - - <section id="Portal_User_Guide-Actions-Securing_Resources"> - - <title>Securing Resources</title> - - <para> - Administrators are able to apply permissions settings to any folder or file in the CMS. These permissions on a specific node, can be applied on a per-Role and/or per-User basis. - </para> - - <para> - The security dialogue is accessed by navigating to the node you want to secure and selecting <emphasis>Secure</emphasis> - . - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/secure_menu.png" format="PNG"/> - </imageobject> - </mediaobject> - </para> - <para> - You should then be presented with a screen that allows you to assign read, write, and manage privileges on the selected node for selected Roles or specific Users. - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/secure_node.png" format="PNG"/> - </imageobject> - </mediaobject> - - There are three main security settings for every node in the CMS. - <itemizedlist> - <listitem> - <para><emphasis role="bold">Read Permissions:</emphasis> - Assigned roles/users can view the resource.</para> - </listitem> - <listitem> - <para> - <emphasis role="bold">Write Permissions:</emphasis> Assigned roles/users are able to edit the resource, or create nodes within it (as is the case for folders)</para> - - </listitem> - <listitem> - <para> - <emphasis role="bold">Manage Permissions:</emphasis> These permissions include: copy, move, delete, and exporting.</para> - </listitem> - </itemizedlist> - - Administrating and assigning permissions on a selected node is as simple as selecting which Roles and/or Users you want to allow to have a specific permission. - - </para> -</section> - <section id="Portal_User_Guide-Actions-Workflow"> - - <title>Content Publish/Approval Workflow</title> - - <para> - When the Publish/Approval Workflow service is activated on the CMS, any requests for publishing new content or making updates to existing content requires an Approval process before going "Live". You can specify a list of Portal Roles that can act as Approvers who can authorize/deny the publishing of content in the CMS. - </para> - <para> - When a content is created in the CMS, the screen should show an Pending Queue of Approvals for that particular content as shown below in the screen. The content waiting in this queue is not accessible for "Live" usage. - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/workflow_file_view.png" format="PNG"/> - </imageobject> - </mediaobject> - </para> - <para> - The user's who are designated as Approvers can view the CMS pending queue by clicking the <emphasis role="bold">Pending Items</emphasis> link in the flyout menu. The Pending Queue screen is as follows: - - <mediaobject> - <imageobject> - <imagedata fileref="images/admincms/workflow_pending_items.png" format="PNG"/> - </imageobject> - </mediaobject> - </para> -</section> -</section> + <title>Administration Content Management System (CMS) Portlet</title> + <section id="Portal_User_Guide-Administration_-_Content_Management_System-Introduction"> + <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 admin (admin/admin) and navigating to the admin portal and then the CMS Page tab. + </para> + <para> + You will then be presented with a page that is similar to this: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/cms_adminpage.png" format="PNG"/> + </imageobject> + </mediaobject> + </section> + <section id="Portal_User_Guide-Administration_-_Content_Management_System-Actions"> + <title>Actions</title> + <para> + This section describes common actions an administrator can perform from within the AdminCMS Portlet. All + actions are available using the flyout menu. Note that the Pending Items action is only available if the + workflow mechanism has been activated. + + + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/actions_menu.png" format="PNG"/> + </imageobject> + </mediaobject> + <section id="Portal_User_Guide-Actions-Viewing-Directories"> + <title>Viewing Directories</title> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/ss_viewfile.png" format="PNG"/> + </imageobject> + </mediaobject> + + A user can list directory contents by either clicking on the folder name or selecting &quot;view&quot; from the Action + dropdown and clicking &quot;go&quot;. + </para> + </section> + <section id="Portal_User_Guide-Actions-Viewing_File_Properties"> + <title>Viewing File Properties</title> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/ss_viewfile.png" format="PNG"/> + </imageobject> + </mediaobject> + Clicking on the &quot;Name&quot; of a file brings up the File Properties page. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/fileproperties.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The File Properties window displays all the possible actions available to perform on a file. + </para> + <para> + Version and Locale Information are also contained on this screen. Note that any version labeled with a + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/live.png" format="PNG"/> + </imageobject> + </mediaobject> + + is the current &quot;live&quot; version shown to users. + </para> + </section> + <section id="Portal_User_Guide-Actions-Copying_Files"> + <title>Copying Files/Directories</title> + <para> + Clicking on the &quot;Copy&quot; action, displays the copy file/directory dialog window. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/resourcecopy.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The copy resource window allows a user to copy files to any folder on the system, as well as copy whole directory trees to any directory on the system. A user can select which + destination directory to copy the resource to by using the directory browser. Clicking the + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/plus.png" format="PNG"/> + </imageobject> + </mediaobject> + + icon expands the directory tree. Clicking on the name of the directory within the tree sets it as the destination directory for the copied resource. + + </para> + </section> + <section id="Portal_User_Guide-Actions-Moving_Files"> + <title>Moving Files/Directories</title> + <para> + Clicking on the &quot;Move&quot; action, displays the move file/directory dialog window. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/resourcemove.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The move resource window allows a user to move files to any folder on the system, as well as move whole directory trees to any directory on the system. A user can select which destination directory to move the resource to, by using the directory browser. Clicking the + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/plus.png" format="PNG"/> + </imageobject> + </mediaobject> + + icon expands the directory tree. Clicking on the name of the directory within the tree sets it as the destination directory for the moved resource. + + </para> + </section> + <section id="Portal_User_Guide-Actions-Deleting_Files"> + <title>Deleting Files/Directories</title> + <para> + Clicking on the &quot;Delete&quot; action, displays the delete file/directory confirmation window. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/resourcedelete.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The delete resource confirmation window allows a user to delete a file or a directory on the system. Note that deleting a directory will delete the entire tree, so all directories under the deleted one will also be deleted. + + </para> + <warning> + <para> + Currently, there is no way to retrieve deleted files/directories! Deleting a file or directory is permanent! + </para> + </warning> + </section> + <section id="Portal_User_Guide-Actions-Creating_Directories"> + <title>Creating Directories</title> + <para> + Clicking on the &quot;Create Folder&quot; action, displays the create directory dialog window. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/createdirectory.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The create directory resource window allows a user to create a directory under chosen path. On this window, a user can specify a name for the new empty directory and assign it a description. + </para> + </section> + <section id="Portal_User_Guide-Actions-Creating_Text"> + <title>Creating Text/HTML Files</title> + <para> + Clicking on the &quot;Create File&quot; action, displays the create file dialog window with the embedded WYSIWYG editor and directory browser. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/createhtml.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The create file window allows a user to create a text or HTML file using the embedded WYSIWYG HTML editor. The editor is a fully-functional HTML editor with a myriad of HTML functions. It also includes a preview + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/editorpreview.png" format="PNG"/> + </imageobject> + </mediaobject> + + button and a source view + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/editorsource.png" format="PNG"/> + </imageobject> + </mediaobject> + + button. + </para> + <para> + An in-depth walk-through of the editor is beyond the scope of this document. However, the editor does contain help pages within it, that can be accessed by clicking the + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/editorhelp.png" format="PNG"/> + </imageobject> + </mediaobject> + + icon. + </para> + <important> + <para> + It is important to note here that when creating links to images or other resources within the system, a user must use the relative file path to that resource. ie: images/hello.i.e.,. Keep in mind at all times that the document base is http://localhost/portal/ by default!</para> + </important> + <para> + Additionally, a user can set a title for the file that will be used in the portlet title bar, and a language for the file, used in serving localized content. + </para> + </section> + <section id="Portal_User_Guide-Actions-Uploading_Files"> + <title>Uploading Files</title> + <para> + Clicking on the &quot;Upload File&quot; action, displays the upload file dialog window. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/resourceupload.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The upload file window allows a user to upload files to any directory on the system. The upload process will work on files up to 1GB and of all types. A user can select which destination directory to upload the resource to, by using the directory browser. Clicking the + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/plus.png" format="PNG"/> + </imageobject> + </mediaobject> + + icon expands the directory tree. Clicking on the name of the directory within the tree, sets it as the destination directory for the uploaded resource. Additionally, a user can set a title for the file that will be used in the portlet title bar, and a language for the file, used in serving localized content. + </para> + </section> + <section id="Portal_User_Guide-Actions-Uploading-Archives"> + <title>Uploading Archives</title> + <para> + Clicking on the &quot;Upload Archive&quot; action, displays the upload archive dialog window. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/resourceuploadarchive.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The upload archive window allows a user to upload archives to any directory on the system. The system will then explode the archive, create versions, and place all the files in the repository. A user can select which destination directory to upload the resource to, by using the directory browser. Clicking the + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/plus.png" format="PNG"/> + </imageobject> + </mediaobject> + + icon expands the directory tree. Clicking on the name of the directory within the tree, sets it as the destination directory for the uploaded resource. Additionally, a user can set a language for the archive files, used in serving localized content. + + </para> + </section> + <section id="Portal_User_Guide-Actions-Exporting_Folders"> + <title>Exporting Folders</title> + <para> + Clicking on the &quot;Export Folder&quot; action, displays the export archive dialog window. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/ss_exportarchive.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The export folder window allows a user to export entire directory structures as zip files. The system will aggregate all contents of a specific directory, and present to the user to download it. + A user can select which source directory to export the resources from, by using the directory browser. Clicking the + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/plus.png" format="PNG"/> + </imageobject> + </mediaobject> + + icon expands the directory tree. Clicking on the name of the directory within the tree, sets it as the source directory for the export resource. Additionally, a user can set a language for the files to be exported. + </para> + <important> + <para> + Version information is not exported. Only versions labeled &quot;Live&quot; are exported! + </para> + </important> + </section> + <section id="Portal_User_Guide-Actions-Editing_Text"> + <title>Editing Text/HTML Files</title> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/fileproperties.png" format="PNG"/> + </imageobject> + </mediaobject> + + Clicking on the &quot;text/html&quot;link, displays the edit file dialog window with the embedded WYSIWYG editor and directory browser. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/editfile.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The edit file window allows a user to edit a text or HTML file using the embedded WYSIWYG HTML editor. The editor is a fully-functional HTML editor with a myriad of HTML functions. It also includes a preview + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/editorpreview.png" format="PNG"/> + </imageobject> + </mediaobject> + + button and a source view + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/editorsource.png" format="PNG"/> + </imageobject> + </mediaobject> + + button. + + </para> + <para> + A user may specify at this point if he would like to make the new edit &quot;live&quot;, or available in production. Additionally, a user can set a title for the file that will be used as the portlet window title. + </para> + </section> + <section id="Portal_User_Guide-Actions-Securing_Resources"> + <title>Securing Resources</title> + <para> + Administrators are able to apply permissions settings to any folder or file in the CMS. These permissions on a specific node, can be applied on a per-Role and/or per-User basis. + </para> + <para> + The security dialogue is accessed by navigating to the node you want to secure and selecting <emphasis>Secure</emphasis> + . + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/secure_menu.png" format="PNG"/> + </imageobject> + </mediaobject> + </para> + <para> + You should then be presented with a screen that allows you to assign read, write, and manage privileges on the selected node for selected Roles or specific Users. + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/secure_node.png" format="PNG"/> + </imageobject> + </mediaobject> + + There are three main security settings for every node in the CMS. + <itemizedlist> + <listitem> + <para><emphasis role="bold">Read Permissions:</emphasis> + Assigned roles/users can view the resource.</para> + </listitem> + <listitem> + <para> + <emphasis role="bold">Write Permissions:</emphasis> Assigned roles/users are able to edit the resource, or create nodes within it (as is the case for folders)</para> + </listitem> + <listitem> + <para> + <emphasis role="bold">Manage Permissions:</emphasis> These permissions include: copy, move, delete, and exporting.</para> + </listitem> + </itemizedlist> + + Administrating and assigning permissions on a selected node is as simple as selecting which Roles and/or Users you want to allow to have a specific permission. + + </para> + </section> + <section id="Portal_User_Guide-Actions-Workflow"> + <title>Content Publish/Approval Workflow</title> + <para> + When the Publish/Approval Workflow service is activated on the CMS, any requests for publishing new content or making updates to existing content requires an Approval process before going &quot;Live&quot;. You can specify a list of Portal Roles that can act as Approvers who can authorize/deny the publishing of content in the CMS. + </para> + <para> + When a content is created in the CMS, the screen should show an Pending Queue of Approvals for that particular content as shown below in the screen. The content waiting in this queue is not accessible for &quot;Live&quot; usage. + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/workflow_file_view.png" format="PNG"/> + </imageobject> + </mediaobject> + </para> + <para> + The user&apos;s who are designated as Approvers can view the CMS pending queue by clicking the <emphasis role="bold">Pending Items</emphasis> link in the flyout menu. The Pending Queue screen is as follows: + + <mediaobject> + <imageobject> + <imagedata fileref="images/admincms/workflow_pending_items.png" format="PNG"/> + </imageobject> + </mediaobject> + </para> + </section> + </section> </chapter> - Modified: docs/enterprise/trunk/User_Guide/en-US/Book_Info.xml =================================================================== --- docs/enterprise/trunk/User_Guide/en-US/Book_Info.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/User_Guide/en-US/Book_Info.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,35 +1,33 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> - <bookinfo id="Portal_User_Guide-Documentation"> - <title>User Guide</title> - <subtitle>A User Guide for Enterprise Portal Platform 4.3</subtitle> - <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>4.3</productnumber> - <edition>1</edition> - <pubsnumber>1.10</pubsnumber> - <abstract> - <para>This document is intended for those using JBoss Portal as End-Users. This is a "Where do I Click?" Guide.</para> - <para> + <title>User Guide</title> + <subtitle>A User Guide for Enterprise Portal Platform 4.3</subtitle> + <productname>JBoss Enterprise Portal Platform</productname> + <productnumber>4.3</productnumber> + <edition>4.3.7</edition> + <pubsnumber>1</pubsnumber> + <abstract> + <para>This document is intended for those using JBoss Portal as End-Users. This is a &quot;Where do I Click?&quot; Guide.</para> + <para> For Portlet developers, Portal administrators, and those wishing to extend and/or implement the JBoss Portal framework, there is a Reference Guide available from our <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... page</ulink>. </para> - </abstract> - <corpauthor> - <inlinemediaobject> - <imageobject> - <imagedata format='SVG' fileref="Common_Content/images/title_logo.svg" /> - </imageobject> - <textobject><phrase>Logo</phrase></textobject> - </inlinemediaobject> - </corpauthor> - <copyright> - <year>&YEAR;</year> - <holder>&HOLDER;</holder> - </copyright> - <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata format="SVG" fileref="Common_Content/images/title_logo.svg"/> + </imageobject> + <textobject> + <phrase>Logo</phrase> + </textobject> + </inlinemediaobject> + </corpauthor> + <copyright> + <year>&YEAR;</year> + <holder>&HOLDER;</holder> + </copyright> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Legal_Notice.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Author_Group.xml"/> </bookinfo> - - - Modified: docs/enterprise/trunk/User_Guide/en-US/Dynamicity.xml =================================================================== --- docs/enterprise/trunk/User_Guide/en-US/Dynamicity.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/User_Guide/en-US/Dynamicity.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,150 +1,134 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> - <chapter id="Portal_User_Guide-Dynamicity"> - <title>Administration - Portal Object Management (Dynamicity)</title> - - <section id="Portal_User_Guide-Dynamacity-Introduction"> - <title>Introduction</title> - - - - <para> + <title>Administration - Portal Object Management (Dynamicity)</title> + <section id="Portal_User_Guide-Dynamacity-Introduction"> + <title>Introduction</title> + <para> The concept of dynamicity refers to the fact all portal objects can be dynamically modified at runtime, eliminating the need to struggle with large xml files, or restarting the application server for changes to take effect. In the scope of dynamicity, portal objects are defined and can be altered as follows: <itemizedlist> - <listitem> - <para>Portal Instances: Multiple Portal instances can be launched at any time, secured, and skinned.</para></listitem> - <listitem><para>Pages: Multiple pages, composed of windows, can securely coexist inside a portal instance. Each - could have its own theme applied, if desired.</para></listitem> - <listitem><para>Portlets: Can be hot-deployed and will instantly register with the portal, appearing in the - management portlet.</para></listitem> - <listitem><para>Portlet Instances: Instances can be created/destroyed. Instance preference variables can be modified - at runtime, assigned to windows and secured.</para></listitem> - <listitem><para>Windows: Windows can be secured, created/destroyed, and assigned to specific pages.</para></listitem> - <listitem><para>Themes/Layouts: Can be hot-deployed and will register with the portal. They appear in the management + <listitem> + <para>Portal Instances: Multiple Portal instances can be launched at any time, secured, and skinned.</para> + </listitem> + <listitem> + <para>Pages: Multiple pages, composed of windows, can securely coexist inside a portal instance. Each + could have its own theme applied, if desired.</para> + </listitem> + <listitem> + <para>Portlets: Can be hot-deployed and will instantly register with the portal, appearing in the + management portlet.</para> + </listitem> + <listitem> + <para>Portlet Instances: Instances can be created/destroyed. Instance preference variables can be modified + at runtime, assigned to windows and secured.</para> + </listitem> + <listitem> + <para>Windows: Windows can be secured, created/destroyed, and assigned to specific pages.</para> + </listitem> + <listitem> + <para>Themes/Layouts: Can be hot-deployed and will register with the portal. They appear in the management portlet, allowing for dynamic customization of any of the above components.</para> - </listitem> - </itemizedlist> + </listitem> + </itemizedlist> </para> - <note> - <para> + <note> + <para> Viewing the Management Portlet is accomplished by logging in as an admin (admin/admin) and navigating to the Admin portal (see <xref linkend="Portal_User_Guide-JBoss_Portal_Basics-Admin_Portal"/>). </para> - </note> - - <!-- + </note> +<!-- <note> Many of the operations that can be done via the Management portlet are done in the context of the current user session. In order to see the changes on the affected pages, please log out and log back in. </note> - --> - - </section> - - <section id="Portal_User_Guide-Dynamicity-Management_Portlet"> - <title>Management Portlet</title> - - - - <para> + --> </section> + <section id="Portal_User_Guide-Dynamicity-Management_Portlet"> + <title>Management Portlet</title> + <para> The management portlet provides a two-part interface: tabs at the top which correspond to the different sections that can be managed; and the main area under it, which displays the current information for the selected tab. </para> - <note> - <para> + <note> + <para> For the remainder of this chapter, the term <emphasis role="bold">object</emphasis> will be used to mean Portal, Page, Portlet, or Window indifferently. </para> - </note> - <para> - <mediaobject> - <imageobject> - <imagedata fileref="images/intro/adminportal.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> - </para> - <para> + </note> + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/adminportal.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> + <para> The tabs are: <itemizedlist> - <listitem> - <para><emphasis role="bold">Portal Objects</emphasis> gather operations pertaining to managing portal objects + <listitem> + <para><emphasis role="bold">Portal Objects</emphasis> gather operations pertaining to managing portal objects (portal instances, pages, windows and their respective configuration information). This is the most complex part of the interface.</para> - </listitem> - <listitem><para><emphasis role="bold">Portlet Instances</emphasis> give access to all the Portlet instances that have been + </listitem> + <listitem> + <para><emphasis role="bold">Portlet Instances</emphasis> give access to all the Portlet instances that have been configured.</para> - </listitem> - <listitem><para><emphasis role="bold">Portlet Definitions</emphasis> give access to the currently available portlet + </listitem> + <listitem> + <para><emphasis role="bold">Portlet Definitions</emphasis> give access to the currently available portlet providers as well as the Portlets that each provider publishes.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Dashboards</emphasis> allow administrators to configure how Dashboards should behave.</para> - </listitem> - </itemizedlist> + </listitem> + <listitem> + <para><emphasis role="bold">Dashboards</emphasis> allow administrators to configure how Dashboards should behave.</para> + </listitem> + </itemizedlist> We will look at each of these tabs and their functionality in the following sections. </para> - - - - <section id="Portal_User_Guide-Management_Portlet-Managing_Portal_Objects"> - <title>Managing Portal Objects</title> - - - - - <section id="Portal_User_Guide-Managing_Portal_Objects-Portals_Operations"> - <title>Portals Operations</title> - - - <mediaobject> - <imageobject> - <imagedata fileref="images/management/portals.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> - - <para> + <section id="Portal_User_Guide-Management_Portlet-Managing_Portal_Objects"> + <title>Managing Portal Objects</title> + <section id="Portal_User_Guide-Managing_Portal_Objects-Portals_Operations"> + <title>Portals Operations</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/management/portals.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> + <para> <emphasis role="bold">Portal Objects</emphasis> brings the administrator to a page displaying a list of the available portal instances defined for this Portal server. Several points are of particular interest. First, a - navigation indicator or "breadcrumbs" is located right beneath the tabs. This provides context as to + navigation indicator or &quot;breadcrumbs&quot; is located right beneath the tabs. This provides context as to where in the hierarchy of portal objects the current screen is located. Some of the screens can be found at several levels of the hierarchy. If you are lost, refer to the breadcrumbs for context. When you first click on the <emphasis role="bold">Portal Objects</emphasis> tab, the context is the list of portals as shown in the picture above. </para> - - <para> + <para> A link to access server-wide portal properties is located right beneath the breadcrumbs. This allows the administrator to set server-wide property and configure how errors should be handled: <mediaobject> - <imageobject> - <imagedata fileref="images/management/portals_properties.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/portals_properties.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> Please refer to the - <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... - handling</ulink> chapter of the JBoss Portal Reference Guide for more information on this point. + <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... handling</ulink> chapter of the JBoss Portal Reference Guide for more information on this point. </para> - - <para> + <para> A form allowing administrator to create new portal instances is located beneath the <literal>Properties</literal> link. Enter the name of the new portal (which, of course, should be different from any of the already existing one) and click on <literal>Create portal</literal> and the portal instances list will be refreshed to display the newly created portal instance. </para> - - <para> + <para> The last element at this level is a table listing all the available portal instances along with possible actions on them. Clicking on the portal name will display a screen showing the information for this given portal instance, thus drilling down the @@ -158,33 +142,29 @@ refreshed and the selected portal status will be refreshed, its action now showing its <literal>Default</literal> status. </para> - - <para> + <para> In the next sections we will demonstrate the functionality of the management portlet by drilling progressively further down this hierarchy to look at the default portal, one of its pages, show how to configure content on a page and, finally, look at specific window information. </para> -</section> - - <section id="Portal_User_Guide-Managing_Portal_Objects-Portal_instance_configuration"> - <title>Looking at portal instance information</title> - - <para> + </section> + <section id="Portal_User_Guide-Managing_Portal_Objects-Portal_instance_configuration"> + <title>Looking at portal instance information</title> + <para> If you click on the <literal>default</literal> portal in the list of available portal instances on the top-level <literal>Portal Objects</literal> page, you will be taken to a page showing the information - for the portal instance named "default", as shown below: + for the portal instance named &quot;default&quot;, as shown below: <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_portal.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> Note the breadcrumbs at the top of the screen indicating where in the hierarchy you currently are. In this case, we are looking at the <literal>default</literal> portal. </para> - - <para> + <para> Links to more information and operations that affect this portal instance are located beneath the breadcrumbs. We will look at them in turn later, excluding the <literal>Destroy</literal> operation, which as its name implies, allows an @@ -192,14 +172,12 @@ available in the portal instances list on the top level page, <literal>Make Default/Default</literal> excepted. </para> - - <para> + <para> It is possible to create new pages using the page creation form located under the portal-wide operation links. Enter the new page name and click on <literal>Create page</literal> and the new page will appear in the pages list, ready to be configured. </para> - - <para> + <para> Finally, a table displaying the list of available pages for this portal instance is located at the bottom of this screen. The first column shows the page name, which you can click to drill down the hierarchy and display the information specific to that particular page. The second column, on the other @@ -210,131 +188,115 @@ in this list: this is where you specify which page should be the default one when users first access the portal instance. </para> - - <para> - Let's now look at the default portal's <literal>Security</literal> information screen. This can be + <para> + Let&apos;s now look at the default portal&apos;s <literal>Security</literal> information screen. This can be accessed by clicking the <literal>Security</literal> action link on the portal page. Here, an administrator can configure the default policy for security on objects for this portal instance: <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_portal_security.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal_security.png" format="PNG"/> + </imageobject> + </mediaobject> Please refer to the - <ulink - url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... - </ulink> + <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... </ulink> chapter of the JBoss Portal Reference Guide for more information about how to secure portal objects. </para> - - <para> + <para> The <literal>Properties</literal> action link displays the currently configured properties for this portal instance and allows you to modify them, as well as configure the error handling strategy: <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_portal_properties.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal_properties.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> </para> - - <para> + <para> The <literal>Theme</literal> action link displays a screen where the administrator can configure theme, layout and render set for this portal instance: <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_portal_theme.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal_theme.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> Please refer to the - <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... - and Themes</ulink> + <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... and Themes</ulink> chapter of the Reference Guide for more information about themes and layouts. </para> - - <para> + <para> The <literal>Display Name</literal> action link displays a screen where the administrator can configure different names for different languages: <mediaobject> - <imageobject> - <imagedata fileref="images/management/display_names.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/display_names.png" format="PNG"/> + </imageobject> + </mediaobject> The different names will be used as page display names for the preferred locale of the logged-in user. This is used by the default tab navigation of the default layouts. </para> - - <para> - Now that we have looked at portal level information, let's drill down the hierarchy again and look at + <para> + Now that we have looked at portal level information, let&apos;s drill down the hierarchy again and look at a page, more precisely the <literal>default</literal> page, by clicking its name in the pages list. </para> - </section> - -<section id="Portal_User_Guide-Managing_Portal_Objects-Page_configuration"> - <title>Looking at a page configuration</title> - - - - <para> + </section> + <section id="Portal_User_Guide-Managing_Portal_Objects-Page_configuration"> + <title>Looking at a page configuration</title> + <para> <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_page.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/default_page.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> The layout of this screen should start feeling familiar. The information for a page looks a lot like the information for a portal instance. Note the breadcrumbs indicating that you are indeed looking at a page. Again, we find the action links at the top of the page, mirroring the ones that were available - for each page in the pages list of the portal instance screen. Once again, you can configure the page's + for each page in the pages list of the portal instance screen. Once again, you can configure the page&apos;s security, theme and properties. You can also destroy it if so desired. </para> - - <para> + <para> Similarly to other screens in the portal objects hierarchy, a page configuration screen also provides a list of all windows for that page. This list contains two columns: the first one contains the name of the window, while the second one provides a list of action links for that specific window. Clicking on a window name will display information about that window. </para> - - <para> + <para> Just like a portal instance can contain several pages, a page can contain several subpages. As such a page defines means to create subpages and set which subpage to display when a user is first directed to the page. These operations work similarly to the same operations at the portal instance level. </para> - - <para> + <para> You can also rename the page if desired: <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_page_rename.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/default_page_rename.png" format="PNG"/> + </imageobject> + </mediaobject> </para> - - <para> + <para> Of specific interest, though, is the <literal>Page Layout</literal> link. This is where you need to go to configure which portlet instance will be displayed in which window on which region on the page. - Let's take a look at this screen and how it works: + Let&apos;s take a look at this screen and how it works: <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_page_layout.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/default_page_layout.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> This screen is structured in two parts, flowing from left to right, following the natural process involved in displaying content on a page. First, you need to identify which content you want to @@ -342,99 +304,95 @@ figure out where on the page should this content be displayed, hence the <literal>Page Layout</literal> section. </para> - - <para> - Let's add a window named <literal>test</literal> displaying the content of the portlet instance + <para> + Let&apos;s add a window named <literal>test</literal> displaying the content of the portlet instance named <literal>NewsPortletInstance</literal> to the center region, beneath the already existing <literal>CMSWindow</literal>. First, we need to enter our new window name in the <literal>Window name</literal> field and select the <literal>portlet</literal> content type from the drop down menu: <mediaobject> - <imageobject> - <imagedata fileref="images/management/layout_content.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_content.png" format="PNG"/> + </imageobject> + </mediaobject> Once this is done, we can select the portlet instance by clicking its name in the instances list: <mediaobject> - <imageobject> - <imagedata fileref="images/management/layout_instance.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_instance.png" format="PNG"/> + </imageobject> + </mediaobject> Note that this displays some information about the portlet instance. Finally, we can add our window to the center region of the page by clicking on the <literal>Add</literal> button located left to the windows list for the region: <mediaobject> - <imageobject> - <imagedata fileref="images/management/layout_region.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_region.png" format="PNG"/> + </imageobject> + </mediaobject> Note that we could move the window up or down in the region by selecting it in the list and using the button to the right of the list, or even destroy it if desired. </para> - - <para> - We can repeat this process to add content of different types. Let's add a window using a Google widget - game. First, give a name to your window (we'll use "google" here) + <para> + We can repeat this process to add content of different types. Let&apos;s add a window using a Google widget + game. First, give a name to your window (we&apos;ll use &quot;google&quot; here) and select <literal>widget/google</literal> from the content type drop-down menu: <mediaobject> - <imageobject> - <imagedata fileref="images/management/layout_google1.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_google1.png" format="PNG"/> + </imageobject> + </mediaobject> Note how the instances list is replaced by a list of Google widgets. The widget we want to use is located in the <literal>Fun &amp; Games</literal> category, so select it from the category drop-down menu: <mediaobject> - <imageobject> - <imagedata fileref="images/management/layout_google2.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_google2.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> Press <literal>Search Gadgets</literal> and the widget list will be refreshed. The widget we want is <literal>Bejeweled</literal>: <mediaobject> - <imageobject> - <imagedata fileref="images/management/layout_google3.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_google3.png" format="PNG"/> + </imageobject> + </mediaobject> You can now add the new window to the desired region. </para> - - <para> - Let's repeat this process again, this time with content from CMS. Enter a new window name (we'll - use "cms" here) and select <literal>cms</literal> from the content type drop-down menu: + <para> + Let&apos;s repeat this process again, this time with content from CMS. Enter a new window name (we&apos;ll + use &quot;cms&quot; here) and select <literal>cms</literal> from the content type drop-down menu: <mediaobject> - <imageobject> - <imagedata fileref="images/management/layout_cms1.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_cms1.png" format="PNG"/> + </imageobject> + </mediaobject> Once again, the instances list was replaced by a directory listing showing the available content roots. Click on <literal>default</literal> and select <literal>project.html</literal>: <mediaobject> - <imageobject> - <imagedata fileref="images/management/layout_cms2.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_cms2.png" format="PNG"/> + </imageobject> + </mediaobject> You can now add the window to the desired region. </para> - - <para> + <para> - We've added three new windows to the default page using different content types. We added a window + We&apos;ve added three new windows to the default page using different content types. We added a window displaying the content of a portlet (displaying the content of an RSS feed in this case). Another one displaying a Google widget and yet another one some CMS-issued content. We decided to remove the existing <literal>CMSWindow</literal>, add the <literal>cms</literal> window below the @@ -442,38 +400,31 @@ to the left region, below the existing content: <mediaobject> - <imageobject> - <imagedata fileref="images/management/layout_final.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_final.png" format="PNG"/> + </imageobject> + </mediaobject> If all went well, logging out of the Admin portal, you should see: <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_page_after.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/default_page_after.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> </para> - - <para> + <para> You can read more about - <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... - Integration - </ulink> + <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... Integration </ulink> in the Reference Guide. More details on how to setup content roots in CMS are available in <xref linkend="Portal_User_Guide-Administration_-_Content_Management_System-Introduction"/>. </para> - -</section> - - -<section id="Portal_User_Guide-Managing_Portal_Objects-Window_configuration"> - <title>Looking at windows of a given page</title> - - <para> + </section> + <section id="Portal_User_Guide-Managing_Portal_Objects-Window_configuration"> + <title>Looking at windows of a given page</title> + <para> Window operations are similar to the same operations at other level of the hierarchy of portal objects. The only information displayed when a window name is clicked in the windows list of a portal page information screen is information about the content, similar to the one that is displayed in the @@ -481,106 +432,92 @@ section: <mediaobject> - <imageobject> - <imagedata fileref="images/management/google_window.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/google_window.png" format="PNG"/> + </imageobject> + </mediaobject> </para> -</section> -</section> - + </section> + </section> <section id="Portal_User_Guide-Management_Portlet-Managing_Portlet_Instances"> - <title>Managing Portlet Instances</title> - - <para> + <title>Managing Portlet Instances</title> + <para> The <literal>Portlet Instances</literal> tab brings the administrator to the list of instances created in the running portal. On this page, the user can either modify the security constraints for the portlet (to grant access only to certain roles), destroy an instance or override the portlet definition preferences for a specific instance if there is any overridable preference. <mediaobject> - <imageobject> - <imagedata fileref="images/management/instances.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/instances.png" format="PNG"/> + </imageobject> + </mediaobject> </para> -</section> - - <section id="Portal_User_Guide-Management_Portlet-Managing_Portlet_Definitions"> - <title>Managing Portlet Definitions</title> - - <para> + </section> + <section id="Portal_User_Guide-Management_Portlet-Managing_Portlet_Definitions"> + <title>Managing Portlet Definitions</title> + <para> The <literal>Portlet Definitions</literal> tab brings the administrator to the list of portlet definitions, formatted as a table displaying name, description, whether the portlet is remote (i.e., accessed - via WSRP from a remote producer) or if it is remotable (i.e., if it is exposed to WSRP consumers by Portal's + via WSRP from a remote producer) or if it is remotable (i.e., if it is exposed to WSRP consumers by Portal&apos;s producer). </para> - - <para> + <para> Portlet definitions can be made available by different providers. You can select the provider you want to browse by selecting it in the drop-down menu and clicking <literal>View portlets</literal>. By default, two providers are available: <itemizedlist> - <listitem> - <para><emphasis role="bold">local</emphasis>: this is Portal's portlet container. Any successfully deployed portlet will + <listitem> + <para><emphasis role="bold">local</emphasis>: this is Portal&apos;s portlet container. Any successfully deployed portlet will appear in the list of available portlet definitions for this provider.</para> - </listitem> - <listitem> - <para><emphasis role="bold">self</emphasis>: this is Portal's default WSRP consumer configured to consume portlets - published by Portal's own WSRP producer. This doesn't have much practical interest apart from allowing + </listitem> + <listitem> + <para><emphasis role="bold">self</emphasis>: this is Portal&apos;s default WSRP consumer configured to consume portlets + published by Portal&apos;s own WSRP producer. This doesn&apos;t have much practical interest apart from allowing a quick test of the WSRP functionality of Portal.</para> - </listitem> - </itemizedlist> + </listitem> + </itemizedlist> More providers can be added to this list. In particular, any active, properly configured WSRP consumer will also appear in the drop-down menu. Please refer to the - <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... - remote WSRP portlets in JBoss Portal - </ulink> + <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... remote WSRP portlets in JBoss Portal </ulink> chapter of the Reference Guide for more information on this topic. <mediaobject> - <imageobject> - <imagedata fileref="images/management/portlets.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/portlets.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> </para> - - <para> + <para> Clicking on a portlet name in the list will display the portlet definition title, description, supported languages and keywords. <mediaobject> - <imageobject> - <imagedata fileref="images/management/portlet_details.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/portlet_details.png" format="PNG"/> + </imageobject> + </mediaobject> The <literal>Preferences</literal> action (when available) is used to edit preferences at the portlet definition level as explained in the JSR-168 specification. </para> - -</section> - -<section id="Portal_User_Guide-Management_Portlet-Managing_Dashboards"> - <title>Managing Dashboards</title> - - <para> + </section> + <section id="Portal_User_Guide-Management_Portlet-Managing_Dashboards"> + <title>Managing Dashboards</title> + <para> The <literal>Dashboards</literal> tab allows the administrator to configure parameters for all user dashboards. It also allows the user to configure the error pages and theme properties as for the other portal objects. </para> -</section> - -<section id="Portal_User_Guide-Management_Portlet-Wizard_mode"> - <title>Wizard mode</title> - - - <para> + </section> + <section id="Portal_User_Guide-Management_Portlet-Wizard_mode"> + <title>Wizard mode</title> + <para> The wizard mode is a fast and easy way to create a new window on a page backed by a portlet instance. The user just needs to define which portlet definition to use and where the instance should be located (portal / page / location on the page. The wizard will automatically create a new instance of @@ -588,19 +525,12 @@ defined by the user. <mediaobject> - <imageobject> - <imagedata fileref="images/management/wizard.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/wizard.png" format="PNG"/> + </imageobject> + </mediaobject> </para> - - - - </section> - - </section> - + </section> </chapter> - Modified: docs/enterprise/trunk/User_Guide/en-US/JBoss_Portal_Basics.xml =================================================================== --- docs/enterprise/trunk/User_Guide/en-US/JBoss_Portal_Basics.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/User_Guide/en-US/JBoss_Portal_Basics.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,35 +1,27 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> - <chapter id="Portal_User_Guide-JBoss_Portal_Basics"> - <title>JBoss Portal Basics</title> - - - <section id="Portal_User_Guide-JBoss_Portal_Basics-Portal_Concepts"> - <title>Portal Concepts - Illustrated</title> - - <para> + <title>JBoss Portal Basics</title> + <section id="Portal_User_Guide-JBoss_Portal_Basics-Portal_Concepts"> + <title>Portal Concepts - Illustrated</title> + <para> This section will introduce the reader to some basic portal terms and concepts used within JBoss Portal and throughout this document. </para> - - <section id="Portal_User_Guide-Portal_Concepts-Portal_Instances"> - <title>Portal Instances</title> - - <para> - JBoss Portal supports multiple portal instances running within one container. A portal instance can be viewed as a 'bucket', containing portal objects such as Portal Pages, Themes, Layouts, and Portlet Windows. It also manages the relationship between the user and the portal itself. The hierarchy of portal objects is depicted in the following diagram: + <title>Portal Instances</title> + <para> + JBoss Portal supports multiple portal instances running within one container. A portal instance can be viewed as a &apos;bucket&apos;, containing portal objects such as Portal Pages, Themes, Layouts, and Portlet Windows. It also manages the relationship between the user and the portal itself. The hierarchy of portal objects is depicted in the following diagram: <mediaobject> - <imageobject> - <imagedata fileref="images/management/tree.gif" format="GIF" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/management/tree.gif" format="GIF" scalefit="1"/> + </imageobject> + </mediaobject> </para> - - <para> + <para> A portal instance is reachable by the url format <emphasis>http://<replaceable>[domain]</replaceable>/<replaceable>[context]</replaceable>/portal/<replaceable>[portal_name]</replaceable></emphasis>. In a default/local install, the @@ -38,16 +30,13 @@ http://localhost:8080/portal/portal/default.Consult your portal administrator for information on the available portal instances - some of which may have restricted logins. . </para> - -</section> - + </section> <section id="Portal_User_Guide-Portal_Concepts-Portal_Pages"> - <title>Pages</title> - <para> + <title>Pages</title> + <para> A Portal Page is an aggregator of Portlet Windows. It is generated by the portal, during the response phase. During this phase, the portal aggregates all of the HTML markup created by the individual portlets, decorates them with window controls, and presents them to the user as a consolidated page. </para> - - <para> + <para> A portal page is reachable by the url format <emphasis>http://<replaceable>[domain]</replaceable>/<replaceable>[context]</replaceable>/portal/<replaceable>[portal_name]</replaceable>/<replaceable>[page_name]</replaceable></emphasis>. In a default/local install, the <emphasis>default</emphasis> @@ -60,44 +49,41 @@ http://localhost:8080/portal/portal/default/News </para> - - <para> + <para> More, on navigating the portal pages and what they contain can be found in, <xref linkend="Portal_User_Guide-JBoss_Portal_Basics-Contents_Pages"/> </para> </section> - -<section id="Portal_User_Guide-Portal_Concepts-Portlet_Windows"> - - <title>Portlet Windows</title> - <para> + <section id="Portal_User_Guide-Portal_Concepts-Portlet_Windows"> + <title>Portlet Windows</title> + <para> Portlet Windows are found on Portal Pages and contain the HTML markup for a specific portlet instance. <mediaobject> - <imageobject> - <imagedata fileref="images/intro/window.jpg" format="JPG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/window.jpg" format="JPG" scalefit="1"/> + </imageobject> + </mediaobject> The diagram above shows the default JBoss Portal page with certain window-related items highlighted (in red). Lets look at these items: </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> <emphasis role="bold">Window Title:</emphasis> Defines the content and purpose of the individual portlet window. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <emphasis role="bold">Window Fragment:</emphasis> Generated HTML markup produced by the portlet on the server-side. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <emphasis role="bold">Window Controls:</emphasis> Window controls are divided into two categories and control different aspects of how the user can impact the generated markup. Each window control can be clicked on to interact with the window in @@ -106,683 +92,598 @@ <emphasis role="bold">Portlet Mode</emphasis> icons, on the other hand, control the mode in which the portlet operates, thus impacting the type of generated markup. Note that not all portlets support all defined window states and/or portlet modes. The table below explains the different Window State icons and their meaning. - </para> - </listitem> - </itemizedlist> - <table id="Table_1"> - <title>Window state icons and their meaning</title> - <tgroup cols="3"> - <colspec colname="c1" colnum="1" colwidth="1*"/> - <colspec colname="c2" colnum="2" colwidth="4*"/> - <colspec colname="c3" colnum="3" colwidth="4*"/> - <thead> - <row> - <entry> - Window State - </entry> - <entry> - Icon - </entry> - <entry> - Meaning - </entry> - - </row> - </thead> - <tbody> - <row> - <entry> - Normal - </entry> - <entry> - <mediaobject> - <imageobject> - <imagedata fileref="images/intro/ico_16_normal.gif" format="GIF"/> - </imageobject> - </mediaobject> - </entry> - - - <entry> - Normal window state, is the most common state for portlets (portlets in the above image are in the normal window state). The portlet window will occupy only enough space to show the portlet content on the page. - </entry> - - - - </row> - <row> - <entry> - Minimized - </entry> - <entry> - <mediaobject> - <imageobject> - <imagedata fileref="images/intro/ico_16_minimize.gif" format="GIF"/> - </imageobject> - </mediaobject> - </entry> - - <entry> - The portlet is instructed to render minimal-to-no markup. - </entry> - </row> - <row> - <entry> - Maximized - </entry> - <entry> - <mediaobject> - <imageobject> - <imagedata fileref="images/intro/ico_16_maximize.gif" format="GIF"/> - </imageobject> - </mediaobject> - </entry> - - <entry> - The portlet window can occupy as much space of real estate on the page. - </entry> - </row> - </tbody> - </tgroup> - </table> - - - - <para> + </para> + </listitem> + </itemizedlist> + <table id="Table_1"> + <title>Window state icons and their meaning</title> + <tgroup cols="3"> + <colspec colname="c1" colnum="1" colwidth="1*"/> + <colspec colname="c2" colnum="2" colwidth="4*"/> + <colspec colname="c3" colnum="3" colwidth="4*"/> + <thead> + <row> + <entry> Window State </entry> + <entry> Icon </entry> + <entry> Meaning </entry> + </row> + </thead> + <tbody> + <row> + <entry> Normal </entry> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/ico_16_normal.gif" format="GIF"/> + </imageobject> + </mediaobject> + </entry> + <entry> Normal window state, is the most common state for portlets (portlets in the above image are in the normal window state). The portlet window will occupy only enough space to show the portlet content on the page. </entry> + </row> + <row> + <entry> Minimized </entry> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/ico_16_minimize.gif" format="GIF"/> + </imageobject> + </mediaobject> + </entry> + <entry> The portlet is instructed to render minimal-to-no markup. </entry> + </row> + <row> + <entry> Maximized </entry> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/ico_16_maximize.gif" format="GIF"/> + </imageobject> + </mediaobject> + </entry> + <entry> The portlet window can occupy as much space of real estate on the page. </entry> + </row> + </tbody> + </tgroup> + </table> + <para> <emphasis role="bold">Portlet Modes and their meaning:</emphasis> Portlet modes are not always available (it depends on the portlet support for a given mode). Moreover, the Edit mode is only available to logged-in users, as in this mode, the portlet - preferences can be modified to be individually suited to a particular user's needs. + preferences can be modified to be individually suited to a particular user&apos;s needs. </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> <mediaobject> - <imageobject> - <imagedata fileref="images/intro/ico_edit.gif" format="GIF"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/ico_edit.gif" format="GIF"/> + </imageobject> + </mediaobject> <emphasis role="bold">Edit</emphasis> : Only visible to logged-in users. Allows a logged-in user to customize the - portlet's preferences. + portlet&apos;s preferences. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <mediaobject> - <imageobject> - <imagedata fileref="images/intro/ico_cancel.gif" format="GIF"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/ico_cancel.gif" format="GIF"/> + </imageobject> + </mediaobject> <emphasis role="bold">Return to View mode</emphasis> - : The button labeled 'Cancel' is only visible when a user is logged in and the + : The button labeled &apos;Cancel&apos; is only visible when a user is logged in and the portlet associated to the current window is in the Edit mode. This replaces the Edit button so the user understands that by clicking it the user will leave the - "Edit mode" and revert back to "View mode". Portlets are by default in View + &quot;Edit mode&quot; and revert back to &quot;View mode&quot;. Portlets are by default in View mode. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <mediaobject> - <imageobject> - <imagedata fileref="images/intro/ico_16_help.gif" format="GIF"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/ico_16_help.gif" format="GIF"/> + </imageobject> + </mediaobject> <emphasis role="bold">Help</emphasis> : Allows a user to access useful information about the portlet. </para> - </listitem> - </itemizedlist> - - -</section> -</section> - -<section id="Portal_User_Guide-JBoss_Portal_Basics-Contents_Pages"> - <title>Default Portal installation</title> - - <para> + </listitem> + </itemizedlist> + </section> + </section> + <section id="Portal_User_Guide-JBoss_Portal_Basics-Contents_Pages"> + <title>Default Portal installation</title> + <para> This section covers the default Portal installation and the pages and portlets that come with it. </para> - -<section id="Portal_User_Guide-Contents_Pages-Default_Portal_Pages"> - <title>Default Portal Pages</title> - - <para> + <section id="Portal_User_Guide-Contents_Pages-Default_Portal_Pages"> + <title>Default Portal Pages</title> + <para> Three pages are available in the default Portal: Home, News and Weather. You can access pages either by entering the page URL in your browser location bar, as shown in <xref linkend="Portal_User_Guide-Portal_Concepts-Portal_Pages"/>, or by clicking the tab associated to the page in the Navigation Tabs at the top of the page. <mediaobject> - <imageobject> - <imagedata fileref="images/intro/tabs.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/tabs.png" format="PNG"/> + </imageobject> + </mediaobject> </para> - - - <para> + <para> Although there are no pages with sub-pages in the default Portal installation, you can configure the navigation tabs to support sub-page navigation. By hovering over a tab with child Pages, it will display a menu for those subpages: <mediaobject> - <imageobject> - <imagedata fileref="images/intro/nav_sub.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/nav_sub.png" format="PNG"/> + </imageobject> + </mediaobject> , .</para> - - <para> + <para> While you can use a Portal anonymously, it is much more interesting to do so while logged in, as you get the opportunity to customize the content you want to see or even create your own personal Dashboard, as explained in <xref linkend="Portal_User_Guide-JBoss_Portal_Basics-Dashboard"/> . </para> -</section> - -<section id="Portal_User_Guide-Contents_Pages-Logging_In"> - <title>Logging in to the Portal</title> - - <para> + </section> + <section id="Portal_User_Guide-Contents_Pages-Logging_In"> + <title>Logging in to the Portal</title> + <para> Logging in to the portal is accomplished by clicking the <emphasis>Login</emphasis> link at the top-right of the portal page. The portal will present you with a login screen where you can enter your credentials: <mediaobject> - <imageobject> - <imagedata fileref="images/intro/login_ss.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/login_ss.png" format="PNG"/> + </imageobject> + </mediaobject> The default Portal installation defines two users: a regular user with no special privileges (login: <literal>user</literal>, password: <literal>user</literal>) and an - administrator user who can alter Portal's content (login: <literal>admin</literal>, password: + administrator user who can alter Portal&apos;s content (login: <literal>admin</literal>, password: <literal>admin</literal>). </para> - <para> + <para> Once logged in, the top-right menu will change so you can then navigate to your personal dashboard or log out. If you have access to other portal instances, they will be shown here as well. <mediaobject> - <imageobject> - <imagedata fileref="images/intro/logged.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/logged.png" format="PNG"/> + </imageobject> + </mediaobject> </para> - <note> - <para> + <note> + <para> If you login as an administrator, you will also be presented with a link to the <emphasis role="bold">Admin</emphasis> portal. </para> - </note> - -</section> -</section> - - <section id="Portal_User_Guide-Contents_Pages-Home_Page"> - <title>Home Page</title> - - - + </note> + </section> + </section> + <section id="Portal_User_Guide-Contents_Pages-Home_Page"> + <title>Home Page</title> <section id="Portal_User_Guide-Home_Page-Intro_greetings_portlet"> - <title>Greetings Portlet</title> - - <para> + <title>Greetings Portlet</title> + <para> <mediaobject> - <imageobject> - <imagedata fileref="images/intro/greetings.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/greetings.png" format="PNG"/> + </imageobject> + </mediaobject> The Greetings Portlet displays default authentication information on logging in, as well as a link to the official documentation. It is using JSP to show right from the first page, three heteregenous components, a JSP portlet, a JSF portlet and a CMS content. </para> -</section> - + </section> <section id="Portal_User_Guide-Home_Page-Intro_user_portlet"> - <title>Identity User Portlet</title> - - <note> - <para> + <title>Identity User Portlet</title> + <note> + <para> Administrators should view <xref linkend="Portal_User_Guide-User_Role-Managing_Users"/> for managing the portal user base. Only user operations are covered in this section.</para> - </note> - <para> + </note> + <para> <mediaobject> - <imageobject> - <imagedata fileref="images/intro/user_portlet.png" format="PNG" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/user_portlet.png" format="PNG" align="center" valign="middle"/> + </imageobject> + </mediaobject> </para> - <para> + <para> Once successfully logged in to the Identity User Portlet, the user will have additional functionality at their disposal, that is covered in the following sections. <mediaobject> - <imageobject> - <imagedata fileref="images/intro/user_portlet_loggedin.png" format="PNG" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/user_portlet_loggedin.png" format="PNG" align="center" valign="middle"/> + </imageobject> + </mediaobject> The Identity User Portlet allows a user to: <itemizedlist> - <listitem> - <para> + <listitem> + <para> <emphasis role="bold">Create a new account</emphasis> </para> - <para> + <para> Create a new account by clicking on the <emphasis role="bold">Register</emphasis> link in the navigation of the portlet. A user can then fill in the necessary information to create an account on the system: <mediaobject> - <imageobject> - <imagedata fileref="images/intro/user_portlet_create.png" format="PNG" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/user_portlet_create.png" format="PNG" align="center" valign="middle"/> + </imageobject> + </mediaobject> </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <emphasis role="bold">Lost password</emphasis> </para> - <para> + <para> Already registered users can request a new password by clicking on the <emphasis role="bold">Lost password</emphasis> link in the navigation of the portlet. After entering your user name you will receive an e-mail with your new login credentials. </para> - <para> + <para> <mediaobject> - <imageobject> - <imagedata fileref="images/intro/user_portlet_lost.png" format="PNG" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/user_portlet_lost.png" format="PNG" align="center" valign="middle"/> + </imageobject> + </mediaobject> </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <emphasis role="bold">View profile</emphasis> </para> - <para> + <para> The default page after login is the view profile page. This page displays a summary of the most important properties of a user. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <emphasis role="bold">Edit personal information</emphasis> </para> - <para>A user has the ability to edit their personal information, change their password and e-mail address at any time by clicking on the + <para>A user has the ability to edit their personal information, change their password and e-mail address at any time by clicking on the <emphasis role="bold">Edit profile</emphasis> link, when logged in. </para> - </listitem> - </itemizedlist> + </listitem> + </itemizedlist> </para> - -</section> - -<section id="Portal_User_Guide-Home_Page-Intro_CMS_portlet"> - <title>CMS Portlet</title> - - <para> + </section> + <section id="Portal_User_Guide-Home_Page-Intro_CMS_portlet"> + <title>CMS Portlet</title> + <para> <mediaobject> - <imageobject> - <imagedata fileref="images/intro/cms_portlet.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/cms_portlet.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> Portal includes a basic Content Management System (CMS) portlet which allows users to navigate the CMS content (static html, images, binary files, etc.). </para> - <para> + <para> Content is displayed through the portal using a path mapper. For example, if you wanted to display a zip file, located in <emphasis>/default/foo/bar.zip</emphasis>, you would type in the URL <emphasis>http://localhost:8080/content/default/foo/bar.zip</emphasis>. - Notice how the path to the content, is prefixed with the <emphasis - role="bold">/content</emphasis> term. + Notice how the path to the content, is prefixed with the <emphasis role="bold">/content</emphasis> term. Although in this example we are describing binary content retrieval, the same can be said for text/html files. Keep in mind, however, that binary files are displayed outside of the portal pages, but text/html are displayed inside the CMSPortlet Window. </para> - <para> + <para> <emphasis role="bold">Serving Logic:</emphasis> - The CMS Portlet now serves content based on the user's locale setting. For example, if a user's locale is + The CMS Portlet now serves content based on the user&apos;s locale setting. For example, if a user&apos;s locale is set to Spanish in their browser, and they request URL: default/index.html, the CMSPortlet will first try and retrieve the Spanish version of that file. If a Spanish version is not found, it will then try and retrieve the default language version set for the CMSPortlet (set to English, by default). </para> - <note> - <para> + <note> + <para> Administrators should read <xref linkend="Portal_User_Guide-Test-Administration_CMS_Portlet"/> for managing the data in the CMS. </para> - </note> - </section> - </section> - -<section id="Portal_User_Guide-Contents_Pages-News_Page"> - <title>News Page</title> - - <para> + </note> + </section> + </section> + <section id="Portal_User_Guide-Contents_Pages-News_Page"> + <title>News Page</title> + <para> The News Page contains 2 portlets displaying news from common internet feeds. An open internet - connection on the server-side is therefore required for them to operate. <mediaobject> - - <imageobject> - <imagedata fileref="images/intro/newspage.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + connection on the server-side is therefore required for them to operate. </para> - -<section id="Portal_User_Guide-News_Page-News_Portlet"> - <title>News Portlet</title> - <para> + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/newspage.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> + <section id="Portal_User_Guide-News_Page-News_Portlet"> + <title>News Portlet</title> + <para> The News Portlet retrieves an RSS news feed from a URL and displays it as HTML to the user. <mediaobject> - <imageobject> - <imagedata fileref="images/intro/newsportlet.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/newsportlet.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> </para> - <para> + <para> Additionally, a logged-in user is able to modify their preference in RSS feed source by using the - Portlet's Edit Mode by clicking + Portlet&apos;s Edit Mode by clicking <mediaobject> - <imageobject> - <imagedata fileref="images/intro/ico_edit.gif" format="GIF"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/ico_edit.gif" format="GIF"/> + </imageobject> + </mediaobject> Once the form is submitted, this property will be saved - in the user's preference, so the user will always see the same news source when logged in. + in the user&apos;s preference, so the user will always see the same news source when logged in. <mediaobject> - <imageobject> - <imagedata fileref="images/intro/newsportlet_edit.png" format="PNG"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/newsportlet_edit.png" format="PNG"/> + </imageobject> + </mediaobject> </para> - <note> - <para> + <note> + <para> This portlet is capable of handling most RSS 1.0 and RSS 2.0 feeds. </para> - </note> - -</section> -</section> - -<section id="Portal_User_Guide-Contents_Pages-Weather_Page"> - <title>Weather Page</title> - - <para> + </note> + </section> + </section> + <section id="Portal_User_Guide-Contents_Pages-Weather_Page"> + <title>Weather Page</title> + <para> Within the samples you will find a basic weather portlet that can be deployed in the Enterprise Portal Platform. By copying the web archive into the <literal>deploy</literal> directory of your EPP configuration, it will automatically create a new page with the weather portlet on it. This page contains a portlet that displays the weather forecast for a specific location. </para> - -<section id="Portal_User_Guide-Weather_Page-Weather_Portlet"> - <title>Weather Portlet</title> - - <para> + <section id="Portal_User_Guide-Weather_Page-Weather_Portlet"> + <title>Weather Portlet</title> + <para> 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. <mediaobject> - <imageobject> - <imagedata fileref="images/intro/weatherportlet.gif" format="GIF"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/weatherportlet.gif" format="GIF"/> + </imageobject> + </mediaobject> </para> - <para> - Additionally, a logged-in user is able to modify their location preference by using the Portlet's <emphasis role="bold">Edit Mode</emphasis> by clicking + <para> + Additionally, a logged-in user is able to modify their location preference by using the Portlet&apos;s <emphasis role="bold">Edit Mode</emphasis> by clicking <mediaobject> - <imageobject> - <imagedata fileref="images/intro/ico_edit.gif" format="GIF"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/ico_edit.gif" format="GIF"/> + </imageobject> + </mediaobject> Any valid US Postal Code can be input here. Once the form is submitted, this property will be saved - in the user's preference, so the user will always see the same weather data for their location when logged in. + in the user&apos;s preference, so the user will always see the same weather data for their location when logged in. <mediaobject> - <imageobject> - <imagedata fileref="images/intro/weatherportlet_edit.gif" format="GIF" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/weatherportlet_edit.gif" format="GIF" align="center" valign="middle"/> + </imageobject> + </mediaobject> </para> - <para> + <para> If you are not located in the United States you will need to configure the Weather portlet to display the information for your area. <orderedlist> - <listitem> - <para>Go to + <listitem> + <para>Go to <ulink url="http://weather.yahoo.com/">http://weather.yahoo.com/<... </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> Enter your city name in the location field: <mediaobject> - <imageobject> - <imagedata fileref="images/intro/weather_config1.png" format="PNG" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/weather_config1.png" format="PNG" align="center" valign="middle"/> + </imageobject> + </mediaobject> </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> Find your location on the list under the <emphasis role="bold">Search Results</emphasis> and click on it (<emphasis>Marseille, France</emphasis>, in this case): <mediaobject> - <imageobject> - <imagedata fileref="images/intro/weather_config2.gif" format="GIF" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/weather_config2.gif" format="GIF" align="center" valign="middle"/> + </imageobject> + </mediaobject> </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> Copy the location digits from the address bar in your browser (<emphasis>FRXX0059</emphasis> in this case): <mediaobject> - <imageobject> - <imagedata fileref="images/intro/weather_config3.gif" format="GIF" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/weather_config3.gif" format="GIF" align="center" valign="middle"/> + </imageobject> + </mediaobject> </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> Paste these numbers into the weather portlet edit form (<emphasis>FRXX0059</emphasis> in this case): <mediaobject> - <imageobject> - <imagedata fileref="images/intro/weather_config4.png" format="PNG" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/weather_config4.png" format="PNG" align="center" valign="middle"/> + </imageobject> + </mediaobject> Click on <emphasis role="bold">submit</emphasis> <mediaobject> - <imageobject> - <imagedata fileref="images/intro/weather_config5.png" format="PNG" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/weather_config5.png" format="PNG" align="center" valign="middle"/> + </imageobject> + </mediaobject> </para> - </listitem> - </orderedlist> + </listitem> + </orderedlist> </para> - - </section> - </section> - -<section id="Portal_User_Guide-JBoss_Portal_Basics-Dashboard"> - <title>Personal Dashboard</title> - - <para> + </section> + </section> + <section id="Portal_User_Guide-JBoss_Portal_Basics-Dashboard"> + <title>Personal Dashboard</title> + <para> Once logged in, all users/administrators of the portal can access a personal dashboard by clicking the <emphasis role="bold">Dashboard</emphasis> link at the top-right of the portal page. Note how the links changed. - <mediaobject> - <imageobject> - <imagedata fileref="images/intro/dashboard.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + The personal dashboard allows users to customize their portal pages however they like. All changes will be persisted so the next time the user logs in to their dashboard, the user will see the previous changes they made. While navigating any of the dashboard pages, a user will be able to drag and drop portlet windows to any location, if the administrator allows this functionality. Changes made in this fashion will also be persisted. </para> - <para> + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/dashboard.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> + <para> It is also possible to copy the content of a shared page to your dashboard so you can customize it to your liking. Just click the <emphasis role="bold">Copy to my dashboard</emphasis> link at the top right of the page. This will clone the page and add it to your personal dashboard as a page with the same name. - <mediaobject> - <imageobject> - <imagedata fileref="images/intro/dashboard_copy_to.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + </para> - - -<section id="Portal_User_Guide-Dashboard-Dashboard_Configure"> - <title>Configuring your personal dashboard</title> - - <para> - You can configure your dashboard by using the top-right menu item labeled <emphasis role="bold">'Configure dashboard'</emphasis>: + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/dashboard_copy_to.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> + <section id="Portal_User_Guide-Dashboard-Dashboard_Configure"> + <title>Configuring your personal dashboard</title> + <para> + You can configure your dashboard by using the top-right menu item labeled <emphasis role="bold">&apos;Configure dashboard&apos;</emphasis>: <mediaobject> - <imageobject> - <imagedata fileref="images/intro/dashboard_configure.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> - </para> -</section> - -<section id="Portal_User_Guide-Dashboard_Configure-Dashboard_Operations"> - <title>Dashboard-wide operations</title> - - <para> + <imageobject> + <imagedata fileref="images/intro/dashboard_configure.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> + </para> + </section> + <section id="Portal_User_Guide-Dashboard_Configure-Dashboard_Operations"> + <title>Dashboard-wide operations</title> + <para> You can select a theme and layout for your dashboard by selecting from the available ones and then clicking on select in the <emphasis role="bold">Theme and Layout</emphasis> form. </para> - <para> + <para> You can also create new pages that will be added to your dashboard by simply entering the name of the new page in the <emphasis role="bold">Create New Page</emphasis> form at the top left of the screen. <note> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> Page names must be unique. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> Page names cannot be blank. </para> - </listitem> - </itemizedlist> - - </note> + </listitem> + </itemizedlist> + </note> Upon creating a new page, the screen will refresh and allow a user to customize the new page. </para> - <para> + <para> You may delete dashboard pages at any time, by first selecting the page you want to delete using the pop-up menu at the top of the screen and then clicking the <emphasis role="bold">Delete this page</emphasis> button at the bottom of the screen. Users are not able to delete the default dashboard page. <mediaobject> - <imageobject> - <imagedata fileref="images/intro/dashboard_deletepage.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/dashboard_deletepage.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> <warning> - <para> + <para> Deleted pages are NOT recoverable. This change is permanent! </para> - </warning> + </warning> </para> -</section> - - + </section> <section id="Portal_User_Guide-Dashboard_Configure-Dashboard_Assignportlets"> - <title>Managing Portlets on a page</title> - - <para> + <title>Managing Portlets on a page</title> + <para> You can add, remove and reorder portlets on a dashboard page to suit your specific requirements. Select the page you want to modify by using the page pop-up selector and then the portlet management form. We will not explain how to use it here as it is similar to the page layout functionality of the Admin portal, which we will look at in <xref linkend="Portal_User_Guide-Managing_Portal_Objects-Page_configuration"/> <mediaobject> - <imageobject> - <imagedata fileref="images/intro/dashboard_assignportlets.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + <imageobject> + <imagedata fileref="images/intro/dashboard_assignportlets.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> </para> - </section> -</section> - -<section id="Portal_User_Guide-JBoss_Portal_Basics-Admin_Portal"> - <title>Admin Portal</title> - - - <para> + </section> + </section> + <section id="Portal_User_Guide-JBoss_Portal_Basics-Admin_Portal"> + <title>Admin Portal</title> + <para> - The Admin Portal's purpose is to allow an administrator to manage all aspects of the portal. You <emphasis role="bold">must be</emphasis> logged in as an administrator, or have proper privileges + The Admin Portal&apos;s purpose is to allow an administrator to manage all aspects of the portal. You <emphasis role="bold">must be</emphasis> logged in as an administrator, or have proper privileges to see this portal. Follow the links for in-depth reviews of these functions: <itemizedlist> - <listitem> - <para> + <listitem> + <para> Users/Roles (See: <xref linkend="Portal_User_Guide-User_Role-Managing_Users"/> - <xref linkend="Portal_User_Guide-User_Role-Managing_Roles"/></para></listitem> - <listitem><para>Content Management System (See: <xref linkend="Portal_User_Guide-Test-Administration_CMS_Portlet"/> </para></listitem> - <listitem><para>Portal Objects (themes, layouts, portal instances, pages, windows, security, and deployed - portlets) (See: <xref linkend="Portal_User_Guide-Dynamicity"/> </para></listitem> - <listitem><para>WSRP (See the + <xref linkend="Portal_User_Guide-User_Role-Managing_Roles"/></para> + </listitem> + <listitem> + <para>Content Management System (See: <xref linkend="Portal_User_Guide-Test-Administration_CMS_Portlet"/> </para> + </listitem> + <listitem> + <para>Portal Objects (themes, layouts, portal instances, pages, windows, security, and deployed + portlets) (See: <xref linkend="Portal_User_Guide-Dynamicity"/> </para> + </listitem> + <listitem> + <para>WSRP (See the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... chapter</ulink> in the Reference Guide for more information)</para> - </listitem> - </itemizedlist> - <mediaobject> - <imageobject> - <imagedata fileref="images/intro/adminportal.png" format="PNG" scalefit="1"/> - </imageobject> - </mediaobject> + </listitem> + </itemizedlist> + </para> - - - - -</section> - - - - + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/adminportal.png" format="PNG" scalefit="1"/> + </imageobject> + </mediaobject> + </section> </chapter> - Modified: docs/enterprise/trunk/User_Guide/en-US/Preface.xml =================================================================== --- docs/enterprise/trunk/User_Guide/en-US/Preface.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/User_Guide/en-US/Preface.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -5,9 +5,5 @@ <preface id="Portal_User_Guide-Preface"> <title>Preface</title> <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Middleware_Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> - </xi:include> + <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </preface> Modified: docs/enterprise/trunk/User_Guide/en-US/User_Guide.xml =================================================================== --- docs/enterprise/trunk/User_Guide/en-US/User_Guide.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/User_Guide/en-US/User_Guide.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,15 +1,14 @@ -<?xml version='1.0'?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<?xml version='1.0' encoding='UTF-8'?> +<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "User_Guide.ent"> +%BOOK_ENTITIES; ]> - <book> - <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="JBoss_Portal_Basics.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Dynamicity.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Administration_CMS_Portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="User_Role.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JBoss_Portal_Basics.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Dynamicity.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Administration_CMS_Portlet.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="User_Role.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> </book> - Modified: docs/enterprise/trunk/User_Guide/en-US/User_Role.xml =================================================================== --- docs/enterprise/trunk/User_Guide/en-US/User_Role.xml 2012-01-09 10:06:11 UTC (rev 14026) +++ docs/enterprise/trunk/User_Guide/en-US/User_Role.xml 2012-01-12 01:47:10 UTC (rev 14027) @@ -1,305 +1,261 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> - <chapter id="Portal_User_Guide-User_Role"> - <title>Administration - Users and Roles</title> - <para> - - This chapter covers the administrator functions made available by the User management portlet. For end-user operation, see: - <xref linkend="Portal_User_Guide-Home_Page-Intro_user_portlet"/>. Administrative functions are available once you are logged in with the proper - credentials (admin/admin), then going to the <xref linkend="Portal_User_Guide-JBoss_Portal_Basics-Admin_Portal"/> and then the Members Page tab. You can change between - user and role management by clicking on the corresponding links in the top of the portlet. - </para> - - - - <section id="Portal_User_Guide-User_Role-Managing_Users"> - <title>Managing Users</title> - - <para> - This section covers the user management of the <classname>IdentityUserManagementPortlet</classname> which is displayed by default. - For role management please see <xref linkend="Portal_User_Guide-User_Role-Managing_Roles"/>. - - <mediaobject> - <imageobject> - <imagedata fileref="images/role/memberspage.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - The Members page in the <xref linkend="Portal_User_Guide-JBoss_Portal_Basics-Admin_Portal"/>. - </para> - </caption> - </mediaobject> - </para> - - <section id="Portal_User_Guide-Managing_Users-Actions"> - <title>Actions</title> - - <para> - The first page of the user management portlet displays some user related actions (e.g.. Search users, Create new user account) and some additional information (e.g. Registered users and Subscription mode). The registered users represent the count of all registered users and the subscription mode describes the required tasks for registering a user (i.e. first e-mail validation and then approval by the administrator). - The <emphasis>Subscription mode</emphasis> symbolizes the mode used in the User portlet. The <emphasis>Admin subscription mode</emphasis> represents - the mode used in the User management portlet. - - <mediaobject> - <imageobject> - <imagedata fileref="images/role/user_management.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - The User management portlet. - </para> - </caption> - </mediaobject> - - </para> -<section id="Portal_User_Guide-Actions-Searching_for_Users"> - <title>Searching for Users</title> - <para> - To search for a user click on the link <emphasis role="bold">Search users</emphasis> and then type a partial username in the form text field. This will search for usernames that match that - criteria. - - <mediaobject> - <imageobject> - <imagedata fileref="images/role/user_su.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - The search users page. - </para> - </caption> - </mediaobject> - </para> - - </section> - -<section id="Portal_User_Guide-Actions-Updating_User_Profiles"> - <title>Updating User Profiles</title> - <para> - Clicking on the - <emphasis role="bold">Edit user</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/edit_profile.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - Editing a users profile. - </para> - </caption> - </mediaobject> - </para> -</section> - - -<section id="Portal_User_Guide-Actions-Updating_User_Roles"> - <title>Updating User Roles</title> - - - <para> - Clicking on the - <emphasis role="bold">Roles</emphasis> - link in the search page allows you to modify the roles a specific user belongs to. - - <mediaobject> - <imageobject> - <imagedata fileref="images/role/assign_roles.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - Assign roles to a user. - </para> - </caption> - </mediaobject> - </para> - -</section> - -<section id="Portal_User_Guide-Actions-Creating_Users"> - <title>Creating Users</title> - <para> - Clicking on the - <emphasis role="bold">Create User Account</emphasis> - link on the main UserPortlet view, allows administrators to instantly create new users. - - <mediaobject> - <imageobject> - <imagedata fileref="images/role/create_user.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - Creating a user in the User management portlet. - </para> - </caption> - </mediaobject> - - </para> - - </section> - -<section id="Portal_User_Guide-Actions-Pending_Users"> - <title>Pending Users</title> - - - <para> - Click on the <emphasis role="bold">Show pending registrations</emphasis> link to show all registrations with validated e-mail addresses. - You can approve or reject each user by clicking on the corresponding action or click on <emphasis>select all</emphasis> - to approve or reject all selected users. - </para> - - <para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/role/user_pending.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - Approve or reject pending registrations. - </para> - </caption> - </mediaobject> - - </para> - <note> - <para> - By default the subscription modes are set to <emphasis>automatic</emphasis> and users will be created automatically. Furthermore the - link to <emphasis role="bold">Show pending registrations</emphasis> will only be displayed if a user needs to be approved by the administrator. - </para> - </note> -</section> -</section> -</section> - - - -<section id="Portal_User_Guide-User_Role-Managing_Roles"> - <title>Managing Roles</title> - - <para> - The User management portlet is also responsible to create and edit roles and it is accessible once logged in - as described in previously - when clicking on the <emphasis role="bold">role management</emphasis> - link in the User management portlet. - </para> - -<section id="Portal_User_Guide-Managing_Roles-Introduction"> - <title>Introduction</title> - - <para> - A role will be used to grant different permission levels to different portlets, pages, or portal instances. A user can have several roles. - </para> - <para> - <mediaobject> - <imageobject> - <imagedata fileref="images/role/role_management.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - Role management. - </para> - </caption> - </mediaobject> - </para> -</section> - -<section id="Portal_User_Guide-Managing_Roles-Actions"> - <title>Actions</title> - - <para> - The User management portlet also provides several actions related to role management, which are described in the following sections. - - </para> - - -<section id="Portal_User_Guide-Actions-Creating_Roles"> - <title>Creating Roles</title> - - <para> - Creating new roles, is accomplished by first clicking on the - <emphasis role="bold">Create new role</emphasis> - link in the portlet. - <mediaobject> - <imageobject> - <imagedata fileref="images/role/create_role.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - Create a new role. - </para> - </caption> - </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. - </para> -</section> - - -<section id="Portal_User_Guide-Actions-Edit_Role"> - <title>Edit a role</title> - - <para> - Editing roles is accomplished by clicking on <emphasis role="bold">Edit role</emphasis> in the row of the role you want to edit. - <mediaobject> - <imageobject> - <imagedata fileref="images/role/edit_role.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - Edit an existing role. - </para> - </caption> - </mediaobject> - While editing a role, you just need to pick an existing role then change the display name. + <title>Administration - Users and Roles</title> + <para> + + This chapter covers the administrator functions made available by the User management portlet. For end-user operation, see: + <xref linkend="Portal_User_Guide-Home_Page-Intro_user_portlet"/>. Administrative functions are available once you are logged in with the proper + credentials (admin/admin), then going to the <xref linkend="Portal_User_Guide-JBoss_Portal_Basics-Admin_Portal"/> and then the Members Page tab. You can change between + user and role management by clicking on the corresponding links in the top of the portlet. + </para> + <section id="Portal_User_Guide-User_Role-Managing_Users"> + <title>Managing Users</title> + <para> + This section covers the user management of the <classname>IdentityUserManagementPortlet</classname> which is displayed by default. + For role management please see <xref linkend="Portal_User_Guide-User_Role-Managing_Roles"/>. + + + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/role/memberspage.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + The Members page in the <xref linkend="Portal_User_Guide-JBoss_Portal_Basics-Admin_Portal"/>. + </para> + </textobject> + </mediaobject> + <section id="Portal_User_Guide-Managing_Users-Actions"> + <title>Actions</title> + <para> + The first page of the user management portlet displays some user related actions (e.g.. Search users, Create new user account) and some additional information (e.g. Registered users and Subscription mode). The registered users represent the count of all registered users and the subscription mode describes the required tasks for registering a user (i.e. first e-mail validation and then approval by the administrator). + The <emphasis>Subscription mode</emphasis> symbolizes the mode used in the User portlet. The <emphasis>Admin subscription mode</emphasis> represents + the mode used in the User management portlet. + + <mediaobject> + <imageobject> + <imagedata fileref="images/role/user_management.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + The User management portlet. + </para> + </textobject> + </mediaobject> + + </para> + <section id="Portal_User_Guide-Actions-Searching_for_Users"> + <title>Searching for Users</title> + <para> + To search for a user click on the link <emphasis role="bold">Search users</emphasis> and then type a partial username in the form text field. This will search for usernames that match that + criteria. + + + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/role/user_su.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + The search users page. + </para> + </textobject> + </mediaobject> + </section> + <section id="Portal_User_Guide-Actions-Updating_User_Profiles"> + <title>Updating User Profiles</title> + <para> + Clicking on the + <emphasis role="bold">Edit user</emphasis> + link on the search page will allow you to edit a user&apos;s profile data, and even reset his password. + + + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/role/edit_profile.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + Editing a users profile. + </para> + </textobject> + </mediaobject> + </section> + <section id="Portal_User_Guide-Actions-Updating_User_Roles"> + <title>Updating User Roles</title> + <para> + Clicking on the + <emphasis role="bold">Roles</emphasis> + link in the search page allows you to modify the roles a specific user belongs to. + + + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/role/assign_roles.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + Assign roles to a user. + </para> + </textobject> + </mediaobject> + </section> + <section id="Portal_User_Guide-Actions-Creating_Users"> + <title>Creating Users</title> + <para> + Clicking on the + <emphasis role="bold">Create User Account</emphasis> + link on the main UserPortlet view, allows administrators to instantly create new users. + + + + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/role/create_user.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + Creating a user in the User management portlet. + </para> + </textobject> + </mediaobject> + </section> + <section id="Portal_User_Guide-Actions-Pending_Users"> + <title>Pending Users</title> + <para> + Click on the <emphasis role="bold">Show pending registrations</emphasis> link to show all registrations with validated e-mail addresses. + You can approve or reject each user by clicking on the corresponding action or click on <emphasis>select all</emphasis> + to approve or reject all selected users. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/role/user_pending.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + Approve or reject pending registrations. + </para> + </textobject> + </mediaobject> + <note> + <para> + By default the subscription modes are set to <emphasis>automatic</emphasis> and users will be created automatically. Furthermore the + link to <emphasis role="bold">Show pending registrations</emphasis> will only be displayed if a user needs to be approved by the administrator. + </para> + </note> + </section> + </section> + </section> + <section id="Portal_User_Guide-User_Role-Managing_Roles"> + <title>Managing Roles</title> + <para> + The User management portlet is also responsible to create and edit roles and it is accessible once logged in - as described in previously - when clicking on the <emphasis role="bold">role management</emphasis> + link in the User management portlet. + </para> + <section id="Portal_User_Guide-Managing_Roles-Introduction"> + <title>Introduction</title> + <para> + A role will be used to grant different permission levels to different portlets, pages, or portal instances. A user can have several roles. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/role/role_management.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + Role management. + </para> + </textobject> + </mediaobject> + </section> + <section id="Portal_User_Guide-Managing_Roles-Actions"> + <title>Actions</title> + <para> + The User management portlet also provides several actions related to role management, which are described in the following sections. + + </para> + <section id="Portal_User_Guide-Actions-Creating_Roles"> + <title>Creating Roles</title> + <para> + Creating new roles, is accomplished by first clicking on the + <emphasis role="bold">Create new role</emphasis> + link in the portlet. + + + 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. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/role/create_role.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + Create a new role. + </para> + </textobject> + </mediaobject> + </section> + <section id="Portal_User_Guide-Actions-Edit_Role"> + <title>Edit a role</title> + <para> + Editing roles is accomplished by clicking on <emphasis role="bold">Edit role</emphasis> in the row of the role you want to edit. + + While editing a role, you just need to pick an existing role then change the display name. </para> -</section> - - -<section id="Portal_User_Guide-Actions-Editing_Role_Members"> - <title>Editing Role Members</title> - - <para> - Editing role members is accomplished by first clicking the - <emphasis role="bold">Members</emphasis> - link at the role management page for the role you would like to modify. - - <mediaobject> - <imageobject> - <imagedata fileref="images/role/role_members.png" format="PNG" scalefit="1"/> - </imageobject> - <caption> - <para> - Show the members of an existing role. - </para> - </caption> - </mediaobject> - - Allows for an administrator to search and modify the members' assigned roles. - </para> - -</section> - -<section id="Portal_User_Guide-Actions-Deleting_Roles"> - <title>Deleting Roles</title> - - <para> - Deleting roles is accomplished by clicking the - <emphasis role="bold">Delete</emphasis> - link for the role you would like to remove. - </para> - - - - -</section> -</section> -</section> - + <mediaobject> + <imageobject> + <imagedata fileref="images/role/edit_role.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + Edit an existing role. + </para> + </textobject> + </mediaobject> + </section> + <section id="Portal_User_Guide-Actions-Editing_Role_Members"> + <title>Editing Role Members</title> + <para> + Editing role members is accomplished by first clicking the + <emphasis role="bold">Members</emphasis> + link at the role management page for the role you would like to modify. + + + + Allows for an administrator to search and modify the members&apos; assigned roles. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/role/role_members.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <para> + Show the members of an existing role. + </para> + </textobject> + </mediaobject> + </section> + <section id="Portal_User_Guide-Actions-Deleting_Roles"> + <title>Deleting Roles</title> + <para> + Deleting roles is accomplished by clicking the + <emphasis role="bold">Delete</emphasis> + link for the role you would like to remove. + </para> + </section> + </section> + </section> </chapter> -