Author: mmcallis Date: 2008-02-20 03:49:47 -0500 (Wed, 20 Feb 2008) New Revision: 10043 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.1. The JBoss Portlet DTD finished changing itemizedlist to variablelist 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-20 08:23:52 UTC (rev 10042) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-20 08:49:47 UTC (rev 10043) @@ -119,7 +119,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -Element <![CDATA[<!ELEMENT portlet-name (#PCDATA)>]]> +<![CDATA[<!ELEMENT portlet-name (#PCDATA)>]]> </screen></term> <listitem> <para> @@ -128,7 +128,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -Element <![CDATA[<!ELEMENT remotable (#PCDATA)>]]> +<![CDATA[<!ELEMENT remotable (#PCDATA)>]]> </screen></term> <listitem> <para> @@ -137,7 +137,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -Element <![CDATA[<!ELEMENT ajax (partial-refresh)>]]> +<![CDATA[<!ELEMENT ajax (partial-refresh)>]]> </screen></term> <listitem> <para> @@ -155,7 +155,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -Element <![CDATA[<!ELEMENT session-config (distributed)>]]> +<![CDATA[<!ELEMENT session-config (distributed)>]]> </screen></term> <listitem> <para> @@ -174,7 +174,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -Element <![CDATA[<!ELEMENT distributed (#PCDATA)>]]> +<![CDATA[<!ELEMENT distributed (#PCDATA)>]]> </screen></term> <listitem> <para> @@ -183,7 +183,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -Element <![CDATA[<!ELEMENT transaction (trans-attribute)>]]> +<![CDATA[<!ELEMENT transaction (trans-attribute)>]]> </screen></term> <listitem> <para> @@ -202,7 +202,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -Element <![CDATA[<!ELEMENT trans-attribute (#PCDATA)>]]> +<![CDATA[<!ELEMENT trans-attribute (#PCDATA)>]]> </screen></term> <listitem> <para> @@ -211,62 +211,102 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -Element <![CDATA[<!ELEMENT header-content (link | script | meta)*>]]> +<![CDATA[<!ELEMENT header-content (link | script | meta)*>]]> </screen></term> - -</para><para><programlisting><![CDATA[Specify content which should be included in the portal aggregated page when the portlet -is present on that page. This setting only applies when the portlet is used in the local mode.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT link EMPTY>]]> -</para><para><programlisting><![CDATA[ -No content is allowed inside an link element.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT script (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The script header element can contain inline script definitions.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT meta EMPTY>]]> -</para><para><programlisting><![CDATA[No content is allowed for meta element.]]></programlisting></para> -</listitem><listitem> -<para> +<listitem> + <para> + Specify content which should be included in the portal aggregated page when the portlet +is present on that page. This setting only applies when the portlet is used in the local mode. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<![CDATA[<!ELEMENT link EMPTY>]]> +</screen></term> +<listitem> + <para> + No content is allowed inside an link element. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<![CDATA[<!ELEMENT script (#PCDATA)>]]> +</screen></term> +<listitem> + <para> + The script header element can contain inline script definitions. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<![CDATA[<!ELEMENT meta EMPTY>]]> +</screen></term> +<listitem> + <para> + No content is allowed for meta element. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ Element <![CDATA[<!ELEMENT service (service-name,service-class,service-ref)>]]> -</para><para><programlisting><![CDATA[Declare a service that will be injected by the portlet container as an -attribute of the portlet context. - -Example: - +</screen></term> +<listitem> + <para> + Declare a service that will be injected by the portlet container as an attribute of the portlet context. + </para> + <para> + For example: + </para> + <para> +<screen><![CDATA[ <service> <service-name>UserModule</service-name> <service-class>org.jboss.portal.identity.UserModule</service-class> <service-ref>:service=Module,type=User</service-ref> -</service> - -In the portlet it is then possible to use it by doing a lookup on the service -name, for example in the init() lifecycle method : - +</service>]]> +</screen> + </para> + <para>In the portlet it is then possible to use it by doing a lookup on the service name, for example in the init() lifecycle method : + </para> + <para> +<screen><![CDATA[ public void init() { UserModule userModule = (UserModule)getPortletContext().getAttribute("UserModule"); -}]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT service-name (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The service name that will be used to bind the service as a portlet context attribute.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT service-class (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The full qualified name of the interface that the service implements.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT service-ref (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The reference to the service. In the JMX Microkernel environment it consist of the JMX -name of the service MBean. For an MBean reference if the domain is left out, then the -current domain of the portal will be used.]]></programlisting></para> -</listitem></itemizedlist> - - </para> +}]]> +</screen> + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<![CDATA[<!ELEMENT service-name (#PCDATA)>]]> +</screen></term> +<listitem> + <para> + The service name that will be used to bind the service as a portlet context attribute. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<![CDATA[<!ELEMENT service-class (#PCDATA)>]]> +</screen></term> +<listitem> + <para> + The full qualified name of the interface that the service implements. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<![CDATA[<!ELEMENT service-ref (#PCDATA)>]]> +</screen></term> +<listitem> + <para> + The reference to the service. In the JMX Microkernel environment it consist of the JMX name of the service MBean. For an MBean reference if the domain is left out, then the current domain of the portal will be used. + </para> +</listitem> +</varlistentry> +</variablelist> +</para> </sect2> <sect2> <title>Portlet Instance DTD</title>