Author: mmcallis Date: 2008-02-11 20:08:04 -0500 (Mon, 11 Feb 2008) New Revision: 9937 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml Log: 5.2.1.4. Application Descriptors final revision, updating certain literal tags to computeroutput, as per content in screen tags... 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-11 21:47:47 UTC (rev 9936) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-12 01:08:04 UTC (rev 9937) @@ -316,9 +316,8 @@ </supports>]]></screen></term> <listitem> <para> - The <literal>&lt;supports&gt;</literal> element allows you to declare all the markup types your - portlet supports in the <literal>render</literal> method. This is accomplished via the - <literal>&lt;mime-type&gt;</literal> 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 <literal>&lt;mime-type&gt;</literal> to define which markup type your portlet supports, which in this example, is <literal>text/html</literal>. This section tells the portal that it will only output text and HTML, and that it only supports the VIEW mode. + The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all the markup types 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 <computeroutput>&lt;mime-type&gt;</computeroutput> 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> @@ -336,10 +335,10 @@ </para> <para> The <filename>HelloWorldPortlet/WEB-INF/portlet-instances.xml</filename> file is a JBoss Portal specific descriptor, that allows you to create instances of portlets. The - <literal>&lt;portlet-ref&gt;</literal> value must match the <literal>&lt;portlet-name&gt;</literal> value - given in the <filename>HelloWorldPortlet/WEB-INF/portlet.xml</filename> file. The <literal>&lt;instance-id&gt;</literal> - value can be named anything, but it must match the <literal>&lt;instance-ref&gt;</literal> value given - in the <literal>*-object.xml</literal> files, which in this example, would be the <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename> file. + <computeroutput>&lt;portlet-ref&gt;</computeroutput> value must match the <computeroutput>&lt;portlet-name&gt;</computeroutput> value + given in the <filename>HelloWorldPortlet/WEB-INF/portlet.xml</filename> file. The <computeroutput>&lt;instance-id&gt;</computeroutput> + value can be named anything, but it must match the <computeroutput>&lt;instance-ref&gt;</computeroutput> value given + in the <filename>*-object.xml</filename> files, which in this example, would be the <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename> file. </para> <para> The following is an example of the <filename>HelloWorldPortlet/WEB-INF/portlet-instances.xml</filename> file: @@ -361,8 +360,8 @@ </screen> </para> <para> - The <literal>*-object.xml</literal> files are JBoss Portal specific descriptors that allow users to - define the structure of their portal instances, as well as create and configure their windows and + The <filename>*-object.xml</filename> files are JBoss Portal specific descriptors that allow users to + define the structure of their portal instances, and create and configure their windows and pages. In the following example: </para> <para> @@ -374,12 +373,12 @@ </listitem> <listitem> <para> - specifies that the window will display the markup generated by the <literal>HelloWorldPortletInstance</literal> portlet instance. + specifies that the window will display the markup generated by the <computeroutput>HelloWorldPortletInstance</computeroutput> portlet instance. </para> </listitem> <listitem> <para> - the window is assigned to the <literal>default.default</literal> page. + the window is assigned to the <computeroutput>default.default</computeroutput> page. </para> </listitem> <listitem> @@ -419,7 +418,7 @@ </screen></term> <listitem> <para> - Tells the portal where this portlet should appear. In this case, <computeroutput>default.default</computeroutput> specifies that the portlet will appear in the portal instance named <literal>default</literal>, and on the page named <literal>default</literal>. + Tells the portal where this portlet should appear. In this case, <computeroutput>default.default</computeroutput> specifies that the portlet will appear in the portal instance named <computeroutput>default</computeroutput>, and on the page named <computeroutput>default</computeroutput>. </para> </listitem> </varlistentry> @@ -437,7 +436,7 @@ </screen></term> <listitem> <para> - Can be named anything. + This can be named anything. </para> </listitem> </varlistentry> @@ -446,8 +445,8 @@ </screen></term> <listitem> <para> - The value of <literal>&lt;instance-ref&gt;</literal> must match the value of one of the - <literal>&lt;instance-id&gt;</literal> elements found in the <filename>HelloWorldPortlet/WEB-INF/portlet-instances.xml</filename> file. + The value of <computeroutput>&lt;instance-ref&gt;</computeroutput> must match the value of one of the + <computeroutput>&lt;instance-id&gt;</computeroutput> elements found in the <filename>HelloWorldPortlet/WEB-INF/portlet-instances.xml</filename> file. </para> </listitem> </varlistentry> @@ -457,7 +456,7 @@ </screen></term> <listitem> <para> - Specifies the layout region, and the order this window will be found on the portal page. + Specifies the layout region and the order this window will be found on the portal page. </para> </listitem> </varlistentry> @@ -505,7 +504,7 @@ </para> <para> - This declaration is equivalent to the previous <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename> example. Use <computeroutput>&lt;content-type&gt;</computeroutput> to specify the content to display. In this example, the content being displayed by <computeroutput>HelloWorldPortletWindow</computeroutput> is a portlet. The <computeroutput>&lt;content-uri&gt;</computeroutput> element specifies which content to display, in this example, the <computeroutput>HelloWorldPortletInstance</computeroutput>: + This declaration is equivalent to the previous <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename> example. Use <computeroutput>&lt;content-type&gt;</computeroutput> to specify the content to display. In this example, the content being displayed by the <computeroutput>HelloWorldPortletWindow</computeroutput> is a <computeroutput>portlet</computeroutput>. The <computeroutput>&lt;content-uri&gt;</computeroutput> element specifies which content to display, which in this example, is the <computeroutput>HelloWorldPortletInstance</computeroutput>: </para> <para> <screen><![CDATA[ @@ -516,7 +515,7 @@ </screen> </para> <para> - To display certain content or a file, use the <computeroutput>cms</computeroutput> content-type, with the <computeroutput>&lt;content-uri&gt;</computeroutput> being the path to the file in the CMS. This behavior is pluggable, and it is possible to plug almost any kind of content. + To display certain content or a file, use the <computeroutput>cms</computeroutput> content-type, with the <computeroutput>&lt;content-uri&gt;</computeroutput> element being the path to the file in the CMS. This behavior is pluggable, and it is possible to plug in almost any kind of content. </para> </sect3> <sect3 id="first_portlet_build">