[portal-commits] JBoss Portal SVN: r12199 - docs/tags/JBoss_Portal_2_7_0/referenceGuide/en/modules.

Author: thomas.heute(a)jboss.com Date: 2008-10-28 10:06:09 -0400 (Tue, 28 Oct 2008) New Revision: 12199 Modified: docs/tags/JBoss_Portal_2_7_0/referenceGuide/en/modules/coordination.xml Log: - Wrapped images in figure or example elements. - Minor improvements. Modified: docs/tags/JBoss_Portal_2_7_0/referenceGuide/en/modules/coordination.xml =================================================================== --- docs/tags/JBoss_Portal_2_7_0/referenceGuide/en/modules/coordination.xml 2008-10-28 13:43:53 UTC (rev 12198) +++ docs/tags/JBoss_Portal_2_7_0/referenceGuide/en/modules/coordination.xml 2008-10-28 14:06:09 UTC (rev 12199) @@ -95,11 +95,15 @@ is available on page configuration screens: the ability to configure coordination using the <literal>Coordination</literal> action: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/coordination.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/coordination.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + </para> <para> Clicking on that link will bring you to the coordination configuration for that particular page. The @@ -118,11 +122,15 @@ </itemizedlist> We will look at the specific configuration and what each of these concepts mean later. Here is how the interface looks like for a page, with both the alias and parameter bindings section collapsed: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/coordination_event.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/coordination_event.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + </para> </sect2> </sect1> @@ -144,11 +152,15 @@ <literal>paramC</literal> to the "<literal>alias</literal>" name so that JBoss Portal's event bus can transmit that value to interested portlets on a given page when the requested page URL contains a value for the appropriate URL parameter: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/alias_example.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <example> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/alias_example.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </example> + </para> </sect2> <sect2> @@ -220,25 +232,37 @@ <title>Graphical configuration</title> <para> Creating a new alias binding is done by first selecting one or more public parameters that will be used for the binding: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_alias_1.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_alias_1.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + The interface will prompt you for a name for this new binding: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_alias_2.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_alias_2.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + Clicking on <literal>Create alias</literal> will create the new binding and it will appear in the existing binding lists: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_alias_3.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_alias_3.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + </para> </sect2> </sect1> @@ -265,13 +289,16 @@ to communicate even if both parameters were semantically equivalent. JBoss Portal's explicit coordination model allows users to explicit the semantic link between both parameter names such that, when <literal>Portlet A</literal> updates the value of <literal>{nsA}paramA</literal>, <literal>Portlet B</literal> - gets notified of the update via a change of value of <literal>{nsB}paramB</literal>: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/parameter_example.png" format="png" align="center" - valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + gets notified of the update via a change of value of <literal>{nsB}paramB</literal>: + <example> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/parameter_example.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </example> + </para> </sect2> @@ -354,25 +381,37 @@ <title>Graphical configuration</title> <para> Creating a new parameter binding is done by first selecting a public parameter / window from the list: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_parameter_1.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_parameter_1.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + The interface will prompt you for a name for this new binding: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_parameter_2.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_parameter_2.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + Clicking on <literal>Create binding</literal> will create the new binding and it will appear in the existing binding lists: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_parameter_3.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_parameter_3.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + </para> </sect2> </sect1> @@ -495,52 +534,76 @@ <para> Creating a new event wiring is fairly easy as the interface will guide you. First, it will present a list of available produced events on this page: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_event_1.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_event_1.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + Select an event. The interface will display the list of all windows producing this event for this page. Note also that your selection is summarized on the right side of the screen: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_event_2.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_event_2.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + Selecting one or more windows (here we selected two) will continue the process. The interface will now present you with the list of consumed events on this page, while your new event wiring is still be being built up on the right side of the screen: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_event_3.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_event_3.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + Select a destination event and be presented with the list of windows consuming that event: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_event_4.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_event_4.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + Select one or more destination windows to which the source event will be mapped via the destination event. You will now be ask to name your new event wiring after having the opportunity to review what will be created. We name our new event wiring <literal>foo</literal> here: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_event_5.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_event_5.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + Click on the <literal>Create wiring</literal> button. Your new event wiring has been created and will appear in the list of existing wirings: - <mediaobject> - <imageobject> - <imagedata fileref="images/coordination/create_event_6.png" format="png" align="center" valign="middle" scalefit="1"/> - </imageobject> - </mediaobject> + <figure> + <mediaobject> + <imageobject> + <imagedata fileref="images/coordination/create_event_6.png" format="png" align="center" + valign="middle" scalefit="1"/> + </imageobject> + </mediaobject> + </figure> + </para> </sect2> </sect1> @@ -555,19 +618,18 @@ </para> <programlisting role="XML"><![CDATA[<portal> - ... + ... + <coordination> + <bindings> + <implicit-mode>TRUE</implicit-mode> + </bindings> + <wirings> + <implicit-mode>FALSE</implicit-mode> + </wirings> + </coordination> + ... +</portal>]]></programlisting> - <coordination> - <bindings> - <implicit-mode>TRUE</implicit-mode> - </bindings> - <wirings> - <implicit-mode>FALSE</implicit-mode> - </wirings> - </coordination> - - </portal>]]></programlisting> - <para> Specifying this <literal>&lt;implicit-mode&gt;</literal> element at the portal level allows the user to specify which default behavior to apply to child pages. Quite reasonably, if <literal>&lt;implicit-mode&gt;</literal>