Author: mmcallis Date: 2008-02-26 23:03:42 -0500 (Tue, 26 Feb 2008) New Revision: 10131 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: - revising 6.1.3. The JBoss Portal Object DTD - 5. Portlet Primer making modes consistent, eg s/VIEW/view Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-27 02:01:47 UTC (rev 10130) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-27 04:03:42 UTC (rev 10131) @@ -47,17 +47,17 @@ <itemizedlist> <listitem> <para> - VIEW - generates markup reflecting the current state of the portlet. + <computeroutput>view</computeroutput> - generates markup reflecting the current state of the portlet. </para> </listitem> <listitem> <para> - EDIT - allows a user to customize the behavior of the portlet. + <computeroutput>edit</computeroutput> - allows a user to customize the behavior of the portlet. </para> </listitem> <listitem> <para> - HELP - provides information to the user as to how to use the portlet. + <computeroutput>help</computeroutput> - provides information to the user as to how to use the portlet. </para> </listitem> </itemizedlist> @@ -73,17 +73,17 @@ <itemizedlist> <listitem> <para> - NORMAL - a portlet shares this page with other portlets. + <computeroutput>normal</computeroutput> - a portlet shares this page with other portlets. </para> </listitem> <listitem> <para> - MINIMIZED -a portlet may show very little information, or none at all. + <computeroutput>minimized</computeroutput> -a portlet may show very little information, or none at all. </para> </listitem> <listitem> <para> - MAXIMIZED - a portlet may be the only portlet displayed on this page. + <computeroutput>maximized</computeroutput> - a portlet may be the only portlet displayed on this page. </para> </listitem> </itemizedlist> @@ -215,7 +215,7 @@ throws PortletException, IOException, UnavailableException</screen></term> <listitem> <para> - As we extend from <literal>GenericPortlet</literal>, and are only interested in supporting the <literal>VIEW</literal> mode, only the <literal>doView</literal> method needs to be implemented, and the <literal>GenericPortlet</literal> <literal>render</literal> implemention calls our implementation when the <literal>VIEW</literal> mode is requested. + As we extend from <literal>GenericPortlet</literal>, and are only interested in supporting the <literal>view</literal> mode, only the <literal>doView</literal> method needs to be implemented, and the <literal>GenericPortlet</literal> <literal>render</literal> implemention calls our implementation when the <literal>view</literal> mode is requested. </para> </listitem> </varlistentry> @@ -282,7 +282,7 @@ <portlet-class>org.jboss.portlet.hello.HelloWorldPortlet</portlet-class> <supports> <mime-type>text/html</mime-type> - <portlet-mode>VIEW</portlet-mode> + <portlet-mode>view</portlet-mode> </supports> <portlet-info> <title>HelloWorld Portlet</title> @@ -312,12 +312,12 @@ <varlistentry><term><screen><![CDATA[ <supports> <mime-type>text/html</mime-type> - <portlet-mode>VIEW</portlet-mode> + <portlet-mode>view</portlet-mode> </supports>]]></screen></term> <listitem> <para> The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all of the markup types that your portlet supports in the <literal>render</literal> method. This is accomplished via the - <computeroutput>&lt;mime-type&gt;</computeroutput> element, which is required for every portlet. The declared MIME types must match the capability of the portlet. As well, it allows you to pair which modes and window states are supported for each markup type. All portlets must support the VIEW portlet mode, so this does not have to be declared. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it will only output text and HTML, and that it only supports the <computeroutput>VIEW</computeroutput> mode. + <computeroutput>&lt;mime-type&gt;</computeroutput> element, which is required for every portlet. The declared MIME types must match the capability of the portlet. As well, it allows you to pair which modes and window states are supported for each markup type. All portlets must support the <computeroutput>view</computeroutput> portlet mode, so this does not have to be declared. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it will only output text and HTML, and that it only supports the <computeroutput>view</computeroutput> mode. </para> </listitem> </varlistentry> @@ -475,7 +475,7 @@ </para> <para> - JBoss Portal 2.6 introduces the notion of <emphasis>content type</emphasis>, which is a generic mechanism to + JBoss Portal 2.6 introduces the notion of <emphasis>content-type</emphasis>, which is a generic mechanism to specify what content will be displayed by a given portlet window. The <computeroutput>window</computeroutput> section of the previous example, <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename>, can be re-written to take advantage of the new content framework. The following is an example deployment descriptor that uses the new content framework: </para> @@ -1052,7 +1052,7 @@ </init-param> <supports> <mime-type>text/html</mime-type> - <portlet-mode>VIEW</portlet-mode> + <portlet-mode>view</portlet-mode> </supports> <portlet-info> <title>HelloWorld JSF Portlet</title> @@ -1087,12 +1087,12 @@ <varlistentry><term><screen><![CDATA[ <supports> <mime-type>text/html</mime-type> - <portlet-mode>VIEW</portlet-mode> + <portlet-mode>view</portlet-mode> </supports>]]></screen></term> <listitem> <para> The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all of the markup types that your portlet supports in the <literal>render</literal> method. This is accomplished via the - <computeroutput>&lt;mime-type&gt;</computeroutput> element, which is required for every portlet. The declared MIME types must match the capability of the portlet. As well, it allows you to pair which modes and window states are supported for each markup type. All portlets must support the VIEW portlet mode, so this does not have to be declared. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it will only output text and HTML, and that it only supports the <computeroutput>VIEW</computeroutput> mode. + <computeroutput>&lt;mime-type&gt;</computeroutput> element, which is required for every portlet. The declared MIME types must match the capability of the portlet. As well, it allows you to pair which modes and window states are supported for each markup type. All portlets must support the <computeroutput>view</computeroutput> portlet mode, so this does not have to be declared. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it will only output text and HTML, and that it only supports the <computeroutput>view</computeroutput> mode. </para> </listitem> </varlistentry> @@ -1374,7 +1374,7 @@ </init-param> <supports> <mime-type>text/html</mime-type> - <portlet-mode>VIEW</portlet-mode> + <portlet-mode>view</portlet-mode> </supports> <portlet-info> <title>HelloWorld JSF Portlet</title> @@ -1409,12 +1409,12 @@ <varlistentry><term><screen><![CDATA[ <supports> <mime-type>text/html</mime-type> - <portlet-mode>VIEW</portlet-mode> + <portlet-mode>view</portlet-mode> </supports>]]></screen></term> <listitem> <para> The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all of the markup types that your portlet supports in the <literal>render</literal> method. This is accomplished via the - <computeroutput>&lt;mime-type&gt;</computeroutput> element, which is required for every portlet. The declared MIME types must match the capability of the portlet. As well, it allows you to pair which modes and window states are supported for each markup type. All portlets must support the VIEW portlet mode, so this does not have to be declared. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it will only output text and HTML, and that it only supports the <computeroutput>VIEW</computeroutput> mode. + <computeroutput>&lt;mime-type&gt;</computeroutput> element, which is required for every portlet. The declared MIME types must match the capability of the portlet. As well, it allows you to pair which modes and window states are supported for each markup type. All portlets must support the <computeroutput>view</computeroutput> portlet mode, so this does not have to be declared. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it will only output text and HTML, and that it only supports the <computeroutput>view</computeroutput> mode. </para> </listitem> </varlistentry> Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-27 02:01:47 UTC (rev 10130) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-27 04:03:42 UTC (rev 10131) @@ -528,7 +528,7 @@ </screen></term> <listitem> <para> - The <computeroutput>&lt;deployment&gt;</computeroutput> element is a generic container for portal object elements. The <computeroutput>&lt;parent-ref&gt;</computeroutput> child gives the name of the parent object that the current object will use as parent. The optional <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the behavior when a portal object which an identical name is already child of the parent element. The default behavior of the <computeroutput>&lt;if-exists&gt;</computeroutput> element is to keep the existing object and not create a new object. The last element is the portal object itself. + The <computeroutput>&lt;deployment&gt;</computeroutput> element is a generic container for portal object elements. The <computeroutput>&lt;parent-ref&gt;</computeroutput> child element gives the name of the parent object that the current object will use as parent. The optional <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the behavior when a portal object with an identical name is already a child of the parent element. The default behavior of the <computeroutput>&lt;if-exists&gt;</computeroutput> element is to keep the existing object, and not to create a new object. The last element is the portal object itself. </para> <para> The following is an example of the <computeroutput>&lt;deployment&gt;</computeroutput> and <computeroutput>&lt;parent-ref&gt;</computeroutput> elements: @@ -550,15 +550,17 @@ <itemizedlist> <listitem> <para> - a listener: specifies the id of a listener is the listener registry. A listener object is able to listen portal events which apply to the portal node hierarchy. + a listener: specifies the ID of a listener in the listener registry. A listener object is able to listen to portal events, which apply to the portal node hierarchy. </para> </listitem> <listitem> - <para> properties : a set of generic properties owned by the portal object. Some properties can drive the behavior of the object. + <para> + properties: a set of generic properties owned by the portal object. Certain properties drive the behavior of the object. </para> </listitem> <listitem> - <para> security-constraint : defines security configuration of the portal object. + <para> + security-constraint: defines the security configuration of the portal object. </para> </listitem> </itemizedlist> @@ -569,7 +571,7 @@ </screen> </para> <para> - Contains a reference to the parent object. The naming convention for naming object is to concatenate the names of the path to the object and separate the names by a dot. If the path is empty then the empty string must be used. The <computeroutput>&lt;parent-ref&gt;</computeroutput> element tells the portal where the portlet should appear. + Contains a reference to the parent object. The naming convention for naming object is to concatenate the names of the path to the object, and separate the names by a period. If the path is empty, then the empty string must be used. The <computeroutput>&lt;parent-ref&gt;</computeroutput> element tells the portal where the portlet should appear. </para> <para> The following is an example of the root having an empty path: @@ -580,7 +582,7 @@ </screen> </para> <para> - The following specifies that the portlet will appear on the <computeroutput>default</computeroutput> page: + The following specifies that the portlet will appear in the portal instance named <computeroutput>default</computeroutput>: </para> <para> <screen> @@ -611,7 +613,7 @@ </screen></term> <listitem> <para> - A portal object of type context. A context type represent a node in the tree which does not have a visual representation. It can exist only under the root. A context can only have children with the portal type. + The context type of a portal object. A context type represent a node in a tree, which does not have a visual representation. It only exists under root. A context can only have children with the portal type. </para> <para> <screen><![CDATA[ @@ -628,8 +630,8 @@ security-constraint?,page*, (display-name* | (resource-bundle, supported-locale+)))>]]> </screen></term> <listitem> - <para> - A portal object of type portal. A portal type represents a virtual portal and can have children of type page. In addition of the common portal object elements it support also the declaration of the modes and the window states it supports. If no declaration of modes or window states is done then the default value will be respectively (view,edit,help) and (normal,minimized,maximized). + <para> + A portal object with the type <emphasis>portal</emphasis>. A portal type represents a virtual portal, and can only have children that use the type <emphasis>page</emphasis>. In addition to the common portal object elements, it also supports the declaration of the modes and the window states that it supports. If there are no declarations of modes or window states, the default value will be <computeroutput>view</computeroutput>, <computeroutput>edit</computeroutput>, <computeroutput>help</computeroutput>, and <computeroutput>normal</computeroutput>, <computeroutput>minimized</computeroutput>, <computeroutput>maximized</computeroutput> respectively. </para> <para> <screen><![CDATA[ @@ -637,7 +639,7 @@ </screen> </para> <para> - The portal name value. + The portal name. </para> <para> <screen><![CDATA[ @@ -645,7 +647,7 @@ </screen> </para> <para> - The supported modes of a portal. + The supported modes of the portal. Accepted values are <computeroutput>view</computeroutput>, <computeroutput>edit</computeroutput>, and <computeroutput>help</computeroutput>. </para> <para> The following is an example of the <computeroutput>&lt;supported-mode&gt;</computeroutput> element: @@ -666,7 +668,7 @@ </screen></term> <listitem> <para> - A portlet mode value. + The portlet mode value. </para> </listitem> </varlistentry> @@ -675,7 +677,7 @@ </screen></term> <listitem> <para> - The supported window states of a portal. The following is an example of the <computeroutput>&lt;supported-window-states&gt;</computeroutput> element: + Use the <computeroutput>&lt;supported-window-states&gt;</computeroutput> element to define the supported window states for the portal. Accepted values are <computeroutput>normal</computeroutput>, <computeroutput>minimized</computeroutput>, and <computeroutput>maximized</computeroutput>. The following is an example of the <computeroutput>&lt;supported-window-states&gt;</computeroutput> element: </para> <para> <screen><![CDATA[ @@ -692,7 +694,7 @@ </screen> </para> <para> - A window state value. + Use the <computeroutput>&lt;window-state&gt;</computeroutput> element to define a window state. </para> </listitem> </varlistentry> @@ -702,7 +704,7 @@ </screen></term> <listitem> <para> - A portal object of type page. A page type represents a page which can have children of type page and window. The children windows are the windows of the page and the children pages are the subpages of this page. + A portal object with the type <emphasis>page</emphasis>. A page type represents a page, and can only have children that use the type <emphasis>page</emphasis> and <emphasis>window</emphasis>. The children windows are the windows of the page, and the children pages are the sub-pages of this page. </para> <para> <screen><![CDATA[ @@ -720,10 +722,10 @@ </screen></term> <listitem> <para> - A portal object of type window. A window type represents a window. Beside the common properties a window has a content and belong to a region on the page. + A portal object with the type <emphasis>window</emphasis>. A window type represents a window. Beside the common properties, a window has content and belongs to a region on the page. </para> <para> - The instance-ref or content tags are used to define the content of the window. The usage of the content tag is generic and can be used to describe any kind of content. The instance-ref is a shortcut to define a content type of portlet which points to a portlet instance. + The <computeroutput>&lt;instance-ref&gt;</computeroutput> and <computeroutput>&lt;content&gt;</computeroutput> elements are used to define the content of the window. The <computeroutput>&lt;content&gt;</computeroutput> element is generic, and is used to describe any kind of content. The <computeroutput>&lt;instance-ref&gt;</computeroutput> element is a shortcut to define the content-type of portlet which points to a portlet instance. </para> <para> The region and height defines how the window is placed in the page.