[gatein-commits] gatein SVN: r7446 - in epp/docs/branches/5.2/Reference_Guide: en-US and 2 other directories.

Author: smumford Date: 2011-09-15 19:26:42 -0400 (Thu, 15 Sep 2011) New Revision: 7446 Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml epp/docs/branches/5.2/Reference_Guide/publican.cfg Log: Add Global Portlet content, uncommented text in JCR intro, incremented. Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml 2011-09-15 23:23:53 UTC (rev 7445) +++ epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml 2011-09-15 23:26:42 UTC (rev 7446) @@ -9,7 +9,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5.2</productnumber> <edition>5.2.0</edition> - <pubsnumber>1</pubsnumber> + <pubsnumber>5</pubsnumber> <abstract> <para> This Reference Guide is a high-level usage document. It deals with more advanced topics than the Installation and User Guides, adding new content or taking concepts discussed in the earlier documents further. It aims to provide supporting documentation for advanced users of the JBoss Enterprise Portal Platform product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms. Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml 2011-09-15 23:23:53 UTC (rev 7445) +++ epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml 2011-09-15 23:26:42 UTC (rev 7446) @@ -7,6 +7,20 @@ <title>Revision History</title> <simpara> <revhistory> + <revision> + <revnumber>5.2.0-5</revnumber> + <date>Wed Sep 14 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>Added Global Portlet Data section.</member> + </simplelist> + </revdescription> + </revision> <revision> <revnumber>5.2.0-1</revnumber> <date>Mon Aug 29 2011</date> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml 2011-09-15 23:23:53 UTC (rev 7445) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml 2011-09-15 23:26:42 UTC (rev 7446) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <section id="sect-Reference_Guide-Introduction"> - <title>Introduction</title> + <title>Introduction</title> <warning> <title>eXo JCR usage</title> <para> @@ -14,99 +14,98 @@ The information below is intended to assist users to understand particular low level details on how the JBoss Enterprise Portal Platform works and how it can be fine-tuned. </para> </warning> - <para> - The term <emphasis role="bold">JCR</emphasis> refers to the Java Content Repository. The JCR is the data store of JBoss Enterprise Portal Platform. All content is stored and managed via the JCR. - </para> - <para> - The eXo JCR included with JBoss Enterprise Portal Platform 5.1 is a (<ulink type="http" url="http://www.jcp.org/en/jsr/detail?id=170">JSR-170</ulink>) compliant implementation of the JCR 1.0 specification. The JCR provides versioning, textual search, access control, content event monitoring, and is used to storing text and binary data for the portal internal usage. The back-end storage of the JCR is configurable and can be a file system or a database. - </para> - <section id="sect-Reference_Guide-Introduction-Concepts"> - <title>Concepts</title> - <variablelist> - <varlistentry> - <term>Repository</term> - <listitem> - <para> - A repository is a form of data storage device. A 'repository' differs from a 'database' in the nature of the information contained. While a database holds hard data in rigid tables, a repository may access the data on a database by using less rigid <emphasis>meta</emphasis>-data. In this sense a repository operates as an 'interpreter' between the database(s) and the user. - </para> - <note> - <para> - The data model for the interface (the repository) is rarely the same as the data model used by the repository's underlying storage subsystems (such as a database), however the repository is able to make persistent data changes in the storage subsystem. - </para> - </note> - </listitem> - </varlistentry> - <varlistentry> - <term>Workspace</term> - <listitem> - <para> - The eXo JCR uses 'workspaces' as the main data abstraction in its data model. The content is stored in a workspace as a hierarchy of <emphasis>items</emphasis> and each workspace has its own hierarchy of items. - </para> - <para> - Repositories access one or more workspaces. Persistent JCR workspaces consist of a directed acyclic graph of <emphasis>items</emphasis> where the edges represent the parent-child relation. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Items</term> - <listitem> - <para> - An <emphasis>item</emphasis> is either a <emphasis>node</emphasis> or a <emphasis>property</emphasis>. Properties contain the data (either simple values or binary data). The nodes of a workspace give it its structure while the properties hold the data itself. - </para> - <variablelist> - <varlistentry> - <term>Nodes</term> - <listitem> - <para> - Nodes are identified using accepted <emphasis>namespacing</emphasis> conventions. Changed nodes may be versioned through an associated version graph to preserve data integrity. - </para> - <para> - Nodes can have various properties or child nodes associated to them. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Properties</term> - <listitem> - <para> - Properties hold data as values of predefined types, such as: <emphasis role="bold">String</emphasis>, <emphasis role="bold">Binary</emphasis>, <emphasis role="bold">Long</emphasis>, <emphasis role="bold">Boolean</emphasis>, <emphasis role="bold">Double</emphasis>, <emphasis role="bold">Date</emphasis>, <emphasis role="bold">Reference</emphasis> and <emphasis role="bold">Path</emphasis>. - </para> - </listitem> - </varlistentry> - </variablelist> - </listitem> - </varlistentry> - <!-- Commented as possibly not required in this document. -<varlistentry> -<term>The Data Model</term> -<listitem> -<para> -The core of any Content Repository is the data model. The data model defines the 'data elements' (fields, columns, attributes, etc.) that are stored in the CR and the relationships between these elements. -</para> -<para> -Data elements can be singular pieces of information (the value 3.14, for example), or compound values ('<emphasis>pi</emphasis>' = 3.14). A data model uses concepts like 'nodes', 'arrays' and 'links' to define relationships between data elements. -</para> -<para> -The use and structure of these elements forms the content repository's 'data model'. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term>Data Abstraction</term> -<listitem> -<para> -Data abstraction describes the separation between <emphasis>abstract</emphasis> and <emphasis>concrete</emphasis> properties of data stored in a repository. The <emphasis>concrete</emphasis> properties of the data refer to its implementation details. -</para> -<para> -The <emphasis>concrete</emphasis> properties of the data implementation may be changed without affecting the <emphasis>abstract</emphasis> properties of the data itself, which are read by the data client. -</para> -<para> -Consider the presentation of data in a list, graph or table. While the information <emphasis>implementation</emphasis> may change, the data itself is unaffected, and readers to whom the data is presented can perform a mental abstraction to interpret it correctly, regardless of the implementation. -</para> -</listitem> -</varlistentry> --> - </variablelist> - <!-- Commented until image can be redrawn for RedHat. Reinstitue for 5.1.0 release + <para> + The term <emphasis role="bold">JCR</emphasis> refers to the Java Content Repository. The JCR is the data store of JBoss Enterprise Portal Platform. All content is stored and managed via the JCR. + </para> + <para> + The eXo JCR included with JBoss Enterprise Portal Platform &VY; is a (<ulink type="http" url="http://www.jcp.org/en/jsr/detail?id=170">JSR-170</ulink>) compliant implementation of the JCR 1.0 specification. The JCR provides versioning, textual search, access control, content event monitoring, and is used to storing text and binary data for the portal internal usage. The back-end storage of the JCR is configurable and can be a file system or a database. + </para> + <section id="sect-Reference_Guide-Introduction-Concepts"> + <title>Concepts</title> + <variablelist> + <varlistentry> + <term>Repository</term> + <listitem> + <para> + A repository is a form of data storage device. A 'repository' differs from a 'database' in the nature of the information contained. While a database holds hard data in rigid tables, a repository may access the data on a database by using less rigid <emphasis>meta</emphasis>-data. In this sense a repository operates as an 'interpreter' between the database(s) and the user. + </para> + <note> + <para> + The data model for the interface (the repository) is rarely the same as the data model used by the repository's underlying storage subsystems (such as a database), however the repository is able to make persistent data changes in the storage subsystem. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term>Workspace</term> + <listitem> + <para> + The eXo JCR uses 'workspaces' as the main data abstraction in its data model. The content is stored in a workspace as a hierarchy of <emphasis>items</emphasis> and each workspace has its own hierarchy of items. + </para> + <para> + Repositories access one or more workspaces. Persistent JCR workspaces consist of a directed acyclic graph of <emphasis>items</emphasis> where the edges represent the parent-child relation. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Items</term> + <listitem> + <para> + An <emphasis>item</emphasis> is either a <emphasis>node</emphasis> or a <emphasis>property</emphasis>. Properties contain the data (either simple values or binary data). The nodes of a workspace give it its structure while the properties hold the data itself. + </para> + <variablelist> + <varlistentry> + <term>Nodes</term> + <listitem> + <para> + Nodes are identified using accepted <emphasis>namespacing</emphasis> conventions. Changed nodes may be versioned through an associated version graph to preserve data integrity. + </para> + <para> + Nodes can have various properties or child nodes associated to them. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Properties</term> + <listitem> + <para> + Properties hold data as values of predefined types, such as: <emphasis role="bold">String</emphasis>, <emphasis role="bold">Binary</emphasis>, <emphasis role="bold">Long</emphasis>, <emphasis role="bold">Boolean</emphasis>, <emphasis role="bold">Double</emphasis>, <emphasis role="bold">Date</emphasis>, <emphasis role="bold">Reference</emphasis> and <emphasis role="bold">Path</emphasis>. + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>The Data Model</term> + <listitem> + <para> + The core of any Content Repository is the data model. The data model defines the 'data elements' (fields, columns, attributes, etc.) that are stored in the CR and the relationships between these elements. + </para> + <para> + Data elements can be singular pieces of information (the value 3.14, for example), or compound values ('<emphasis>pi</emphasis>' = 3.14). A data model uses concepts like 'nodes', 'arrays' and 'links' to define relationships between data elements. + </para> + <para> + The use and structure of these elements forms the content repository's 'data model'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Data Abstraction</term> + <listitem> + <para> + Data abstraction describes the separation between <emphasis>abstract</emphasis> and <emphasis>concrete</emphasis> properties of data stored in a repository. The <emphasis>concrete</emphasis> properties of the data refer to its implementation details. + </para> + <para> + The <emphasis>concrete</emphasis> properties of the data implementation may be changed without affecting the <emphasis>abstract</emphasis> properties of the data itself, which are read by the data client. + </para> + <para> + Consider the presentation of data in a list, graph or table. While the information <emphasis>implementation</emphasis> may change, the data itself is unaffected, and readers to whom the data is presented can perform a mental abstraction to interpret it correctly, regardless of the implementation. + </para> + </listitem> + </varlistentry> + </variablelist> + <!-- Commented until image can be redrawn for RedHat. <mediaobject> <imageobject role="html"> <imagedata fileref="images/Advanced/JCR/repository_diagram.png" format="PNG" align="center" scale="90" /> @@ -129,7 +128,7 @@ Source Author: Day Management AG Source Author email: Source License: http://www.day.com/specs/jcr/2.0/license.html] --> - </section> + </section> </section> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml 2011-09-15 23:23:53 UTC (rev 7445) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml 2011-09-15 23:26:42 UTC (rev 7446) @@ -3,8 +3,8 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<chapter id="chap-Reference_Guide-Global_Portlet_Data_Data"> - <title>Global Portlet Data</title> +<chapter id="chap-Reference_Guide-Global_Portlet_Data"> + <title><remark>Global Portlet Data</remark></title> <section id="sect-Reference_Guide-Global_Portlet_Data-The_Global_Data_File"> <title>The Global Data File</title> <para> @@ -67,7 +67,7 @@ </listitem> </orderedlist> - <section id="sect-Reference_Guide-Global_Metadata_Elements-Global_Portlet-Portlet_Filter"> + <section id="sect-Reference_Guide-Global_Portlet_Data-Global_Metadata_Elements-Portlet_Filter"> <title>Portlet Filter</title> <para> Portlet filter mappings declared in the global <filename>portlet.xml</filename> file are applied across portlet applications. Modified: epp/docs/branches/5.2/Reference_Guide/publican.cfg =================================================================== --- epp/docs/branches/5.2/Reference_Guide/publican.cfg 2011-09-15 23:23:53 UTC (rev 7445) +++ epp/docs/branches/5.2/Reference_Guide/publican.cfg 2011-09-15 23:26:42 UTC (rev 7446) @@ -5,7 +5,7 @@ type: Book brand: JBoss debug:1 -#show_remarks: 1 +show_remarks: 1 cvs_branch: DOCS-RHEL-6 cvs_root: :ext:cvs.devel.redhat.com:/cvs/dist cvs_pkg: JBoss_Enterprise_Portal_Platform-Reference_Guide-5.2-web-__LANG__ \ No newline at end of file