From portal-commits at lists.jboss.org Mon Mar 31 00:14:55 2008 Content-Type: multipart/mixed; boundary="===============6429671648783927803==" MIME-Version: 1.0 From: portal-commits at lists.jboss.org To: portal-commits at lists.jboss.org Subject: [portal-commits] JBoss Portal SVN: r10422 - docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules. Date: Mon, 31 Mar 2008 00:10:24 -0400 Message-ID: --===============6429671648783927803== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: mmcallis Date: 2008-03-31 00:10:24 -0400 (Mon, 31 Mar 2008) New Revision: 10422 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescr= iptors.xml Log: 6.2.2. The portlet-instances.xml Descriptor - periodic backup - revising text - adding text from previous sections Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/x= mldescriptors.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldesc= riptors.xml 2008-03-31 03:22:45 UTC (rev 10421) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldesc= riptors.xml 2008-03-31 04:10:24 UTC (rev 10422) @@ -376,7 +376,7 @@ - The reference to the portlet, which is the name of the portlet. The <portlet-ref> value must match the <portlet-name> give in the WEB-= INF/portlet.xml file. + The <portlet-ref> element defines= the portlet that an instance will represent. The <portl= et-ref> value must match the <portle= t-name> given in the WEB-INF/portlet.xml file. ...]]> + + The <deployments> element en= capsulates the entire document, and is a container for <= deployment> elements. Multiple deployments can be speci= fied within the <deployments> elemen= t. @@ -1081,7 +1083,7 @@ - Are <filename>*-object.xml</filename> descriptors necessary?</t= itle> + <title>Are <filename>*-object.xml</filename> descriptors required?</ti= tle> <para> Technically, they are not. The portal object hierarchy, such as creat= ing portals, pages, instances, and organizing them on the page, can be defi= ned using the management portlet, which is accessible to JBoss Portal admin= istrators. </para> @@ -1089,20 +1091,12 @@ </para> </sect2> <sect2 id=3D"desc_instancesxml"> - <title>portlet-instances.xml - This is a JBoss Portal specific descriptor that allows a de= veloper to instantiate one-or-many instances - of one-or-many portlets. The benefit of using this technique, = is to allow one portlet to be instantiated - several times with different preference parameters. - - Is this descriptor mandatory? - Technically, no, as you can define your portal object hiera= rchy (create portals, pages, instances and - organize them as you see fit) from the management portlet a= ccessible to Portal administrators. - - Our example, below, has us instantiating two separate instance= s of the - NewsPortlet - with different preference parameters, one instance will draw a= feed for RedHat announcements and the other - from McDonalds announcements. - The portlet-instances.xml Descriptor<= /title> + + The portlet-instances.xml Descriptor is JBoss Port= al specific, and allows developers to instantiate one-or-many instances of = one-or-many portlets. The benifit of this allows one portlet to be instanti= ated several times, with different prefence parameters. The following examp= le instiantiates two separate instances of the NewsPorlet, both using different parameters. One instance draws feeds = for Red Hat annoucnments, and the other draws McDonalds announcements: + + + -]]> +]]> + + - + + + ...]]> + + + The <deployments> element e= ncapsulates the entire document, and is a container for <= ;deployment> elements. Multiple deployments can be spec= ified within the <deployments> eleme= nt. + + + + + ...<= /instance>]]> + + + The <deployment>, and the emb= edded <instance> elements, specify a= portlet instance. The <deployment> = element specifies object deployments, such as portals, pages, windows, and = so on. + + + - ...]]> - The - deployments - tag, encapsulates the entire document. You may specif= y more than one portlet instance deployment, - within this tag. - - - - - ...]]> - The - deployment - , and embedded - instance - tags are used to specify one portlet instance. - - - - ...]]> - A - unique name - given to this instance of the portlet. It must corres= pond to the value of - instance-ref - , assigned to the window in your - *-object.xml - . + + + The <instance-id> elements def= ines a unique name given to an instance = of a portlet. The <instance-id> valu= e can be named anything, but it must match the value of one of the <instance-ref> elements in the WEB= -INF/*-object.xml file. ...]]> - The portlet that this instance will represent. It mus= t correspond to the value of - portlet-name - , assigned in your - portlet.xml - . - + + + The <portlet-ref> element defi= nes the portlet that an instance will represent. The <po= rtlet-ref> value must match the <por= tlet-name> given in the WEB-INF/portlet.xml file. + @@ -1270,6 +1257,12 @@ + + Is the <filename>portlet-instances.xml</filename> descriptor req= uired? + + Technically, they are not. The portal object hierarchy, such as creat= ing portals, pages, instances, and organizing them on the page, can be defi= ned using the management portlet, which is accessible to JBoss Portal admin= istrators. + + jboss-portlet.xml --===============6429671648783927803==--