You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by er...@apache.org on 2012/06/05 12:17:18 UTC
svn commit: r1346330 [3/7] - in /ofbiz/branches/20120329_portletWidget:
framework/common/widget/ framework/images/webapp/images/
framework/minilang/src/org/ofbiz/minilang/method/
framework/webtools/webapp/webtools/WEB-INF/actions/portlet/ framework/wid...
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW_FR.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW_FR.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW_FR.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Page portail permettant de créer pour un enregistrement d'une entité métier majeur</title>
+ <para>Ce type de page permet de créer un enregistrement d'une entité métier et puis de le compléter via l'ajout d'association à un ensemble
+ d'entités associées. </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="/example/images/NewPage_FR.png" width="800" depth="600"/>
+ </imageobject>
+ <textobject><phrase>Page Portail Type : Création</phrase></textobject>
+ <caption>Schema des portlets inclus dans une page Création</caption>
+ </mediaobject>
+ </para>
+ <section>
+ <title>Les autres Page Type</title>
+ <para>
+ <itemizedlist>
+ <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_showPortalPage&portalPageId=ExampleMgmt">Page Recherche et gestion</link></para></listitem>
+ <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_showPortalPage&portalPageId=ExampleRecap">Page Recapitulative</link></para></listitem>
+ </itemizedlist>
+ </para>
+ </section>
+</section>
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW_FR.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW_FR.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW_FR.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Summary Portal Page for one record of a main business entity</title>
+ <para>This type of page should show, for a Business entity, a set (or all) of associated entities portlet (like PartyProfile, ViewProject, ...). </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="/example/images/RecapPage.png" width="800" depth="600"/>
+ </imageobject>
+ <textobject><phrase>Recap (or Summary) PortalPage - Type</phrase></textobject>
+ <caption>Schema of a portal page type of "Summary of a major business object": Show most of the existing portlet associated with the Business Entity</caption>
+ </mediaobject>
+ </para>
+
+ <section>
+ <title>Other Portal Page Type</title>
+ <para>
+ <itemizedlist>
+ <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_showPortalPage&portalPageId=ExampleMgmt">Management Page (search, list)</link></para></listitem>
+ <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_showPortalPage&portalPageId=ExampleNew">Creation Page</link></para></listitem>
+ </itemizedlist>
+ </para>
+ </section>
+</section>
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP_FR.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP_FR.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP_FR.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Page portail récapitulative pour un enregistrement d'une entité métier majeur</title>
+ <para>Ce type de page permet de gérer une entité métier et un ensemble (ou toutes) d'entités associées. </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="/example/images/RecapPage_FR.png" width="800" depth="600"/>
+ </imageobject>
+ <textobject><phrase>Page Portail Type : Recapitulative</phrase></textobject>
+ <caption>Schema des portlets inclus dans une page de type récapitulative</caption>
+ </mediaobject>
+ </para>
+ <section>
+ <title>Les autres Page Type</title>
+ <para>
+ <itemizedlist>
+ <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_showPortalPage&portalPageId=ExampleMgmt">Page Recherche et gestion</link></para></listitem>
+ <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_showPortalPage&portalPageId=ExampleNew">Page Création</link></para></listitem>
+ </itemizedlist>
+ </para>
+ </section>
+</section>
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP_FR.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP_FR.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_RECAP_FR.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title> Portlet Type : screenlet </title>
+
+ <para> <emphasis role="warning"> This is the most common type of portlet. </emphasis> It can manage with screens or forms and menu editing area (injection or substitution). </para>
+ <para> can also executed a script before loading the portlet to retrieve entity, lists, ... </para>
+
+ <para> When creating a new portlet, you must define a number of fields to ensure its operation and its reuse. </para>
+ <para> It's important to consider which component relates this portlet and its features. Once the component and subcomponent identified,
+ you should describe the function of the portlet as well as possible. </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="/example/images/Screenlet.png"/>
+ </imageobject>
+ <textobject><phrase>Screenlet</phrase></textobject>
+ </mediaobject>
+ </para>
+
+ <section>
+ <title>Main entity Field in PortalPortlet </title>
+ <itemizedlist>
+ <listitem> <para> portalPortletId: identifier of the portlet, max. 20 characters. </para> </listitem>
+ <listitem> <para> portletLongId: identifying complementary, max. 60 char. </para> </listitem>
+ <listitem> <para> portletTypeId: chosen type here screenlet </para> </listitem>
+ <listitem> <para> portletName: short description, don't forget labels in CommonPortalEntityLabels.xml for translations in other language</para> </listitem>
+ <listitem> <para> description: long description, don't forget labels in CommonPortalEntityLabels.xml translations in other language</para> </listitem>
+ <listitem> <para> component: component name, very important to generate the default values of other fields ââused by this type of portlet </para> </listitem>
+ <listitem> <para> subComponent: name of the subcomponent, very important to generate the default values of other fields ââused by this type of portlet </para> </listitem>
+ <listitem> <para> webapp: to filled in when sub-directory under the component must be used</para> </listitem>
+ <listitem> <para> screenshot: png image of the portlet </para> </listitem>
+ </itemizedlist>
+ <para>complementary or optional fields could be used. </para>
+ <tip>
+ <para>With component and subcomponent fields filled in, there will be default values ââfor many other fields. </para>
+ </tip>
+ </section>
+
+ <section>
+ <title> Field of the entity type used PortalPortlet screenlet (to be completed only if specific value) </title>
+ <itemizedlist>
+ <listitem> <para> titleLabel: title to be displayed </para> </listitem>
+ <listitem> <para> formName: optional, depends on the field useScreen, used if useScreen is empty or N </para> </listitem>
+ <listitem> <para> formLocation: see above </para> </listitem>
+ <listitem> <para> useScreen </para> </listitem>
+ <listitem> <para> screenName: optional, is used if there is useScreen </para> </listitem>
+ <listitem> <para> screenLocation: see above </para> </listitem>
+ <listitem> <para> useMenu </para> </listitem>
+ <listitem> <para> MenuName: Adding a menu at the top right of the screenlet, used if useMenu is Y</para> </listitem>
+ <listitem> <para> menuLocation: see above </para> </listitem>
+ <listitem> <para> editAreaDivId: edit box at the top of the screen or form used, available to inject content (via the menu, for example) </para> </listitem>
+ <listitem> <para> subAreaDivId: the area containing the form or screen used, available to replace the content of this field (via the menu, for example) </para> </listitem>
+ <listitem> <para> useScript </para> </listitem>
+ <listitem> <para> scriptName, used if useScript is Y </para> </listitem>
+ <listitem> <para> pkIdname </para> </listitem>
+ </itemizedlist>
+ <para> By default this type of portlet is reducible with save-collapsed = "true" </para>
+ <tip>
+ <para> For more information see Help Detailed <link xl:href="showHelp?helpTopic=portletfields"> fields of a portlet </link> </para>
+ <para> When making a portlet, when in doubt, it is possible to display the default values ââgenerated through page
+ <link xl:href="/webtools/control/ShowPortalPortlet"> ShowPortalPortlet </link> in Adm. Sys </para>
+ </tip>
+ </section>
+
+ <section>
+ <title>Possible generic attributed </title>
+ <itemizedlist>
+ <listitem> <para> collapsible: true if it is empty <emphasis role="warning"> not operational: currently always true</emphasis> </para> </listitem>
+ <listitem> <para> saveCollapsed: empty if this is true <emphasis role="warning"> not operational: currently always true</emphasis> </para> </listitem>
+ <listitem> <para> initiallyCollapsed: false if empty</para> </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title> Additional Links </title>
+ <itemizedlist>
+ <listitem><para>See <link xl:href="showHelp?helpTopic=AllPortletType"> all portlet types and fields </link> </para></listitem>
+ <listitem><para>See <link xl:href="showHelp?helpTopic=portletfields"> complete list of portalPortlet fields and their descriptions </link> </para></listitem>
+ </itemizedlist>
+ </section>
+
+</section>
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,100 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title> Portlet Type : screenletList </title>
+
+ <para> <emphasis role="warning"> This is the second most common type of portlet. </emphasis> It's use to manage list or subList with menu editing area (injection or substitution). </para>
+ <para>This portlet type is used when one needs a list. Indeed, the lists in screenlet required, due to the paging system,
+ use a form as content. So you simply create the Form respecting the rules of naming.</para>
+ <para> can also executed a script before loading the portlet to retrieve entity, lists, ... </para>
+
+ <para> When creating a new portlet, you must define a number of fields to ensure its operation and its reuse. </para>
+ <para> It's important to consider which component relates this portlet and its features. Once the component and subcomponent identified,
+ you should describe the function of the portlet as well as possible. </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="/example/images/ScreenletList.png"/>
+ </imageobject>
+ <textobject><phrase>ScreenletList</phrase></textobject>
+ </mediaobject>
+ </para>
+
+ <section>
+ <title>Main entity Field in PortalPortlet </title>
+ <itemizedlist>
+ <listitem> <para> portalPortletId: identifier of the portlet, max. 20 characters. </para> </listitem>
+ <listitem> <para> portletLongId: identifying complementary, max. 60 char. </para> </listitem>
+ <listitem> <para> portletTypeId: chosen type here screenlet </para> </listitem>
+ <listitem> <para> portletName: short description, don't forget labels in CommonPortalEntityLabels.xml for translations in other language</para> </listitem>
+ <listitem> <para> description: long description, don't forget labels in CommonPortalEntityLabels.xml translations in other language</para> </listitem>
+ <listitem> <para> component: component name, very important to generate the default values of other fields ââused by this type of portlet </para> </listitem>
+ <listitem> <para> subComponent: name of the subcomponent, very important to generate the default values of other fields ââused by this type of portlet </para> </listitem>
+ <listitem> <para> webapp: to filled in when sub-directory under the component must be used</para> </listitem>
+ <listitem> <para> screenshot: png image of the portlet </para> </listitem>
+ </itemizedlist>
+ <para>complementary or optional fields could be used. </para>
+ <tip>
+ <para>With component and subcomponent fields filled in, there will be default values ââfor many other fields. </para>
+ </tip>
+ </section>
+
+ <section>
+ <title> Field of the entity type used PortalPortlet screenlet (to be completed only if specific value) </title>
+ <itemizedlist>
+ <listitem> <para> titleLabel: title to be displayed </para> </listitem>
+ <listitem> <para> formName: optional, depends on the field useScreen, alway used </para> </listitem>
+ <listitem> <para> formLocation: see above </para> </listitem>
+ <listitem> <para> useScreen </para> </listitem>
+ <listitem> <para> screenName: optional, if present, used after showing form </para> </listitem>
+ <listitem> <para> screenLocation: see above </para> </listitem>
+ <listitem> <para> useMenu </para> </listitem>
+ <listitem> <para> MenuName: Adding a menu at the top right of the screenlet, used if useMenu is Y</para> </listitem>
+ <listitem> <para> menuLocation: see above </para> </listitem>
+ <listitem> <para> editAreaDivId: edit box at the top of the screen or form used, available to inject content (via the menu, for example) </para> </listitem>
+ <listitem> <para> subAreaDivId: the area containing the form or screen used, available to replace the content of this field (via the menu, for example) </para> </listitem>
+ <listitem> <para> useScript </para> </listitem>
+ <listitem> <para> scriptName, used if useScript is Y </para> </listitem>
+ <listitem> <para> pkIdname </para> </listitem>
+ </itemizedlist>
+ <para> By default this type of portlet is reducible with save-collapsed = "true" </para>
+ <tip>
+ <para> For more information see Help Detailed <link xl:href="showHelp?helpTopic=portletfields"> fields of a portlet </link> </para>
+ <para> When making a portlet, when in doubt, it is possible to display the default values ââgenerated through page
+ <link xl:href="/webtools/control/ShowPortalPortlet"> ShowPortalPortlet </link> in Adm. Sys </para>
+ </tip>
+ </section>
+
+ <section>
+ <title>Possible generic attributed </title>
+ <itemizedlist>
+ <listitem> <para> collapsible: true if it is empty <emphasis role="warning"> not operational: currently always true</emphasis> </para> </listitem>
+ <listitem> <para> saveCollapsed: empty if this is true <emphasis role="warning"> not operational: currently always true</emphasis> </para> </listitem>
+ <listitem> <para> initiallyCollapsed: false if empty</para> </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title> Additional Links </title>
+ <itemizedlist>
+ <listitem><para>See <link xl:href="showHelp?helpTopic=AllPortletType"> all portlet types and fields </link> </para></listitem>
+ <listitem><para>See <link xl:href="showHelp?helpTopic=portletfields"> complete list of portalPortlet fields and their descriptions </link> </para></listitem>
+ </itemizedlist>
+ </section>
+</section>
\ No newline at end of file
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList_FR.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList_FR.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList_FR.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Portlet de type ScreenletList</title>
+
+ <para>Ce type de portlet est utilisé lorsque l'on a besoin d'une liste. En effet, les listes imposent, du fait du système de pagination,
+ d'utiliser un form comme contenu. Ainsi il faut simplement créer le Form en respectant les règles de nommages.
+ </para>
+ <para>Usage classique : gérer une liste d'enregistrement avec possibilité de les éditer.</para>
+
+ <para>Lorsqu'on crée une nouvelle porlet, il faut définir un certain nombre de champs pour garantir son fonctionnement et sa réutilisation.</para>
+ <para>Il faut réfléchir à quel composant se rattache cette portlet et ses fonctionnalités. Une fois le composant et sous-composant identifiés,
+ il faut decrire la fonction de la portlet du mieux possible.</para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="/example/images/ScreenletList.png"/>
+ </imageobject>
+ <textobject><phrase>ScreenletList</phrase></textobject>
+ </mediaobject>
+ </para>
+
+ <section>
+ <title>Champ génériques de l'entité PortalPortlet</title>
+ <itemizedlist>
+ <listitem><para>portalPortletId : identifiant de la portlet, max. 20 carac.</para></listitem>
+ <listitem><para>portletLongId : identifiant complémentaire, max. 60 carac.</para></listitem>
+ <listitem><para>portletTypeId : renseigner avec le type choisi, ici, ScreenletList</para></listitem>
+ <listitem><para>portletName : descrition courte, penser aux labels de traductions dans CommonPortalEntityLabels.xml</para></listitem>
+ <listitem><para>descrition : descrition longue, penser aux labels de traductions dans CommonPortalEntityLabels.xml</para></listitem>
+ <listitem><para>component : nom du composant, à renseigner pour générer les valeurs par défaut utilisées par le type de portlet</para></listitem>
+ <listitem><para>subComponent : nom du sous-composant, à renseigner pour générer les valeurs par défaut utilisées par le type de portlet</para></listitem>
+ <listitem><para>webapp : à renseigner lorsqu'on utilise des sous-répertoire dans le sous composant</para></listitem>
+ <listitem><para>screenshot : image png de la portlet</para></listitem>
+ </itemizedlist>
+ <para>Ensuite, on peut utilisés les champs complémentaires ou optionnels.</para>
+ <tip>
+ <para>Avec les champs component et subcomponent renseignés, il y aura des valeurs par défaut pour beaucoup des autres champs.</para>
+ </tip>
+ </section>
+
+ <section>
+ <title>Champ de l'entité PortalPortlet utilisés par type Screenlet (à renseigner uniquement si valeur spécifique)</title>
+ <itemizedlist>
+ <listitem><para>titleLabel : titre à afficher</para></listitem>
+ <listitem><para>formName : optionnel, dépend du champ useScreen, il est toujours utilisé</para></listitem>
+ <listitem><para>formLocation : voir ci-dessus</para></listitem>
+ <listitem><para>useScreen</para></listitem>
+ <listitem><para>screenName : optionnel, s'il est présent, il sera utilisé en plus de la form</para></listitem>
+ <listitem><para>screenLocation : voir ci-dessus</para></listitem>
+ <listitem><para>useMenu</para></listitem>
+ <listitem><para>menuName : ajout d'un menu en haut à droite de la screenlet, il est utilisé si useMenu est Y</para></listitem>
+ <listitem><para>menuLocation : voir ci-dessus</para></listitem>
+ <listitem><para>editAreaDivId : zone d'édition en haut du screen ou du form utilisé, premet d'injecter du contenu (via le menu, par exemple)</para></listitem>
+ <listitem><para>subAreaDivId : zone contenant le screen ou le form utilisé, permet de remplacer le contenu de cette zone (via le menu, par exemple)</para></listitem>
+ <listitem><para>useScript</para></listitem>
+ <listitem><para>scriptName, il est utilisé si useScript est Y </para></listitem>
+ <listitem><para>pkIdname</para></listitem>
+ </itemizedlist>
+ <para>Par défaut ce type de portlet est réductible avec save-collapsed="true"</para>
+ <tip>
+ <para>Pour plus d'information voir l'aide détaillé des <link xl:href="showHelp?helpTopic=portletfields">champs d'une portlet</link></para>
+ <para>Lors de la réalisation d'une portlet, en cas de doute, il est possible de visualiser les valeurs par défaut généré, via la page
+ <link xl:href="/webtools/control/ShowPortalPortlet">ShowPortalPortlet</link> dans Adm. Sys</para>
+ </tip>
+ </section>
+
+ <section>
+ <title>Les attribues génériques possible</title>
+ <itemizedlist>
+ <listitem><para>collapsible : si vide c'est true <emphasis role="warning">non opérationnel : true pour le moment</emphasis></para></listitem>
+ <listitem><para>saveCollapsed : si vide c'est true <emphasis role="warning">non opérationnel : true pour le moment</emphasis></para></listitem>
+ <listitem><para>initiallyCollapsed : si vide c'est false</para></listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>Liens complémentaires</title>
+ <itemizedlist>
+ <listitem><para>Voir <link xl:href="showHelp?helpTopic=AllPortletType">tous les Types de portlet et les champs</link></para></listitem>
+ <listitem><para>Voir <link xl:href="showHelp?helpTopic=portletfields">la liste complète des champs et leur description</link></para></listitem>
+ </itemizedlist>
+ </section>
+
+</section>
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList_FR.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList_FR.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_ScreenletList_FR.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet_FR.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet_FR.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet_FR.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Portlet de type Screenlet</title>
+
+ <para><emphasis role="warning">C'est le type le plus courant de portlet.</emphasis>Il permet de gérer des screens ou des forms avec menu et zone d'édition (injection ou substitution).</para>
+ <para>On peut également éxécuté un script avant le chargement de la portlet pour récupérer entité, listes,...</para>
+
+ <para>Lorsqu'on crée une nouvelle porlet, il faut définir un certain nombre de champs pour garantir son fonctionnement et sa réutilisation.</para>
+ <para>Il faut réfléchir à quel composant se rattache cette portlet et ses fonctionnalités. Une fois le composant et sous-composant identifiés,
+ il faut decrire la fonction de la portlet du mieux possible.</para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="/example/images/Screenlet.png"/>
+ </imageobject>
+ <textobject><phrase>Screenlet</phrase></textobject>
+ </mediaobject>
+ </para>
+
+ <section>
+ <title>Champ important de l'entité PortalPortlet</title>
+ <itemizedlist>
+ <listitem><para>portalPortletId : identifiant de la portlet, max. 20 carac.</para></listitem>
+ <listitem><para>portletLongId : identifiant complémentaire, max. 60 carac.</para></listitem>
+ <listitem><para>portletTypeId : renseigner avec le type choisi, ici, Screenlet</para></listitem>
+ <listitem><para>portletName : description courte, penser aux labels de traductions dans CommonPortalEntityLabels.xml</para></listitem>
+ <listitem><para>description : description longue, penser aux labels de traductions dans CommonPortalEntityLabels.xml</para></listitem>
+ <listitem><para>component : nom du composant, trés important pour générer les valeurs par défaut des autres champs utilisées par ce type de portlet</para></listitem>
+ <listitem><para>subComponent : nom du sous-composant, trés important pour générer les valeurs par défaut des autres champs utilisées par ce type de portlet</para></listitem>
+ <listitem><para>webapp : à renseigner lorsqu'on utilise des sous-répertoire dans le sous composant</para></listitem>
+ <listitem><para>screenshot : image png de la portlet</para></listitem>
+ </itemizedlist>
+ <para>Ensuite, on peut utilisés les champs complémentaires ou optionnels.</para>
+ <tip>
+ <para>Avec les champs component et subcomponent renseignés, il y aura des valeurs par défaut pour beaucoup des autres champs.</para>
+ </tip>
+ </section>
+
+ <section>
+ <title>Champ de l'entité PortalPortlet utilisés par type Screenlet (à renseigner uniquement si valeur spécifique)</title>
+ <itemizedlist>
+ <listitem><para>titleLabel : titre à afficher</para></listitem>
+ <listitem><para>formName : optionnel, dépend du champ useScreen, il est utilisé si useScreen est vide ou N</para></listitem>
+ <listitem><para>formLocation : voir ci-dessus</para></listitem>
+ <listitem><para>useScreen</para></listitem>
+ <listitem><para>screenName : optionnel, il est utilisé si useScreen est Y</para></listitem>
+ <listitem><para>screenLocation : voir ci-dessus</para></listitem>
+ <listitem><para>useMenu</para></listitem>
+ <listitem><para>menuName : ajout d'un menu en haut à droite de la screenlet, il est utilisé si useMenu est Y</para></listitem>
+ <listitem><para>menuLocation : voir ci-dessus</para></listitem>
+ <listitem><para>editAreaDivId : zone d'édition en haut du screen ou du form utilisé, premet d'injecter du contenu (via le menu, par exemple)</para></listitem>
+ <listitem><para>subAreaDivId : zone contenant le screen ou le form utilisé, permet de remplacer le contenu de cette zone (via le menu, par exemple)</para></listitem>
+ <listitem><para>useScript</para></listitem>
+ <listitem><para>scriptName, il est utilisé si useScript est Y </para></listitem>
+ <listitem><para>pkIdname</para></listitem>
+ </itemizedlist>
+ <para>Par défaut ce type de portlet est réductible avec save-collapsed="true"</para>
+ <tip>
+ <para>Pour plus d'information voir l'aide détaillé des <link xl:href="showHelp?helpTopic=portletfields">champs d'une portlet</link></para>
+ <para>Lors de la réalisation d'une portlet, en cas de doute, il est possible de visualiser les valeurs par défaut généré, via la page
+ <link xl:href="/webtools/control/ShowPortalPortlet">ShowPortalPortlet</link> dans Adm. Sys</para>
+ </tip>
+ </section>
+
+ <section>
+ <title>Les attribues génériques possible</title>
+ <itemizedlist>
+ <listitem><para>collapsible : si vide c'est true <emphasis role="warning">non opérationnel : true pour le moment</emphasis></para></listitem>
+ <listitem><para>saveCollapsed : si vide c'est true <emphasis role="warning">non opérationnel : true pour le moment</emphasis></para></listitem>
+ <listitem><para>initiallyCollapsed : si vide c'est false</para></listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>Liens complémentaires</title>
+ <itemizedlist>
+ <listitem><para>Voir <link xl:href="showHelp?helpTopic=AllPortletType">tous les Types de portlet et les champs</link></para></listitem>
+ <listitem><para>Voir <link xl:href="showHelp?helpTopic=portletfields">la liste complète des champs et leur description</link></para></listitem>
+ </itemizedlist>
+ </section>
+
+</section>
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet_FR.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet_FR.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Screenlet_FR.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Icons List available in OFBiz.</title>
+
+ <para> Icons are useful to make the user interface nicer. </para>
+ <para> To ensure consistency in the application, a logical name was given to each icon and it is advisable to use only one. </para>
+ <para> To be able to change icon sets based on themes, it is advisable not access online the image file but to go through the appropriate properties files.</para>
+
+ <section>
+ <title> HowTo use of icons in a link (link or show-portlet) </title>
+ <para> An example of use of icon Details
+ <programlisting>
+ &lt;show-portlet portlet-id="ShowExample" image-location="${iconsPurpose.Details}"
+ image-title="${uiLabelMap.IconsTooltips_Details}">
+ </programlisting>
+ </para>
+ <para> In this page, the first column is: the logical name of the icon (in the example above Details). </para>
+ <para> second column is indicated which will be displayed as an "image-title" So when the mouse is over the icon, or in some case which good practice should be use to "image-title". </para>
+ <para> If you leave the mouse on the image of the icon you have the "image-title" default. </ para>
+
+ </section>
+</section>
\ No newline at end of file
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList_FR.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList_FR.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList_FR.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Liste des icônes utilisable dans OFBiz</title>
+
+ <para>Les icônes sont utiles pour rendre l'interface utilisateur plus agréable.</para>
+ <para>Afin de garantir l'homogénéité dans l'application, un nom logique a été donné à chacune des icônes et il est conseillé de n'utiliser que celle-ci.</para>
+ <para>Afin de pourvoir changer de jeux d'icône en fonction du thèmes, il est conseillé de ne jamais accéder en direct au fichier image mais de passer par les fichiers properties adéquate.</para>
+ <para>&nbsp;</para>
+
+ <section>
+ <title>Usage des icônes dans un lien (link ou show-portlet)</title>
+ <para>Voici un exemple d'usage de icône Details
+ <programlisting>
+ &lt;show-portlet portlet-id="ShowExample" image-location="${iconsPurpose.Details}"
+ image-title="${uiLabelMap.IconsTooltips_Details}">
+ </programlisting>
+ </para>
+ <para>Dans cette page il est indiqué en première colonne : le nom logique de l'icône (dans l'exemple ci-dessus Details).</para>
+ <para>En seconde colonne il est indiqué soit ce qui sera affiché en tant qu' "image-title" donc lorsque la souris sera sur l'icône, soit la bonne pratique à utilisé.</para>
+ <para>Si vos laissez la souris sur l'image de l'icône vous aurez l' "image-title" par défaut. </para>
+ </section>
+</section>
\ No newline at end of file
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList_FR.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList_FR.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_iconsList_FR.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>The Portlet Attribute page.</title>
+
+ <para>PortalPortlet use PortalAttribute to be able to configure a portlet for different usage.</para>
+ <para>There are several types of attributes, like standard ones, and user ones, like an type id.</para>
+ <para>&nbsp;</para>
+
+ <section>
+ <title>Attribute management</title>
+ <para>See a standard attribute used by Screenlet and ScreenletList portlet types for reducing or not screenlet :
+ <programlisting>
+ &lt;PortletAttribute portalPageId="ExampleNew" portalPortletId="FindExample" attrName="initiallyCollapsed" attrValue="true" portletSeqId="00001"/>
+ </programlisting>
+ </para>
+ <para>Here, a personal use to configure portlet with a parameted list (role type configuration) :
+ <programlisting>
+ &lt;PortletAttribute portalPageId="ExampleMgmt" portalPortletId="ListExample" attrName="roleTypeId" attrValue="VENDOR" portletSeqId="00001"/>
+ </programlisting>
+ </para>
+ </section>
+</section>
\ No newline at end of file
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs_FR.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs_FR.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs_FR.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Icons list available in OFBIz</title>
+
+ <para> Icons are useful to make the user interface nicer. </para>
+ <para> To ensure consistency in the application, a logical name was given to each icon and it is advisable to use it. </para>
+ <para> To be able to change icon sets based on themes, it is advisable not access online the image file but to go through the appropriate properties files. </para>
+ <para>&nbsp;</para>
+
+ <section>
+ <title>How to used icon in a link or show-portlet</title>
+ <para>Below is a "Details" icon usage example
+ <programlisting>
+ &lt;show-portlet portlet-id="ShowExample" image-location="${iconsPurpose.Details}"
+ image-title="${uiLabelMap.IconsTooltips_Details}">
+ </programlisting>
+ </para>
+ <para> In this page it is stated in the first column: the logical name of the icon (in the example above Details). </para>
+ <para> Second column is indicated, which will be displayed as an "image-title" So when the mouse is over the icon, or in some case what is good practice to use. </para>
+ <para> If you leave the mouse on the image of the icon you have the default "image-title". </para>
+ </section>
+</section>
\ No newline at end of file
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs_FR.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs_FR.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletattrs_FR.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook ../../../../applications/content/dtd/docbook.xsd"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>The Portlet Category page.</title>
+
+ <para>PortalPortlet use PortalCategory to be able to classify portlets according to their component.</para>
+ <para>You can define specific category or more detailled category.</para>
+ <para>You can also build a category tree using parent category.</para>
+ <para>&nbsp;</para>
+
+ <section>
+ <title>Category management</title>
+ <para>Here, a personal use to associate portlet with a category :
+ <programlisting>
+ &lt;PortletPortletCategory portalPortletId="FindExample2" portletCategoryId="EXAMPLE"/>
+ </programlisting>
+ </para>
+ </section>
+</section>
\ No newline at end of file
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats_FR.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats_FR.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats_FR.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook ../../../../applications/content/dtd/docbook.xsd"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Catégorie d'une portlet</title>
+
+ <para>Les portlet utilisent des catégories pour permettre de rechercher plus facilement dans les portlets.</para>
+ <para>On peut créer des catégories scpécifiques avec plus d'éléments.</para>
+ <para>On peut également complexifier l'arbre en utilisant des catégorie parente.'</para>
+ <para>&nbsp;</para>
+
+ <section>
+ <title>Gestion des catégories</title>
+ <para>Association d'une catégorie à une portlet existante :
+ <programlisting>
+ &lt;PortletPortletCategory portalPortletId="FindExample2" portletCategoryId="EXAMPLE"/>
+ </programlisting>
+ </para>
+ </section>
+</section>
\ No newline at end of file
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats_FR.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats_FR.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletcats_FR.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>The Portlet Fields description.</title>
+
+ <para>All fields used to define a portlet are listed below.</para>
+ <para>Some field have default value (scriptName, menuName, screenName or formName), other must be filled (portletId, type, component and sub-component,...). </para>
+ <para>Default values should be used, when it's possible</para>
+ <tip><para>Find above the list of fields and a long description of the field role when you go hover it, long description and its default value.</para></tip>
+
+ <para>If the form is not shown below, then <link xl:href="showHelp?helpTopic=portletfields">click here</link></para>
+</section>
\ No newline at end of file
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields_FR.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields_FR.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields_FR.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Description des champs d'une portlet</title>
+
+ <para>
+ Les différents champs paramétrables sont listés ci-dessous.
+ </para>
+ <para>
+ Certains attributs ont des valeurs par défaut (scriptName, menuName, screenName or formName), d'autres doivent être obligatoirement renseignés (l'identifiant, le type, le composant et sous-composant,...). </para>
+ <para>
+ Il est conseillé d'utiliser les valeurs par défaut quand c'est possible</para>
+ <tip><para>En passant la souris sur le nom des champs, une description du champs apparait ainsi que la valeur par défaut pour utiliser ce champs</para></tip>
+
+ <para>Si le formulaire n'est pas affiché ci-dessous, alors<link xl:href="showHelp?helpTopic=portletfields">clicker ici</link></para>
+</section>
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields_FR.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields_FR.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portletfields_FR.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>The Portlet Types usage.</title>
+ <para>To facilitate portlet creation process, there is several portlet types for classical portal page use-cases </para>
+ <para>For each type a given amount of parameter is required to perform type associted actions in order to render portlet and control its behavior.</para>
+
+ <section>
+ <title>Avaialable types</title>
+
+ <para>Here is a list of currently available types :
+ <itemizedlist>
+ <listitem><para>Screenlet : generic type. portlet widget get injected into a screenlet</para></listitem>
+ <listitem><para>ScreenletList : genric type for list portlet. widget get injected into a screent and preceeded by an empty container for further use</para></listitem>
+ <listitem><para>Empty : Define an empty container to for futur content injection using ajax mainly</para> </listitem>
+ <listitem><para>Decorator : Type allow loading portlet using URI</para></listitem>
+ </itemizedlist>
+ </para>
+ <para>To choose appropriate type see detail for each type.</para>
+ </section>
+
+ <section>
+ <title>For more information </title>
+ <para>See <link xl:href="showHelp?helpTopic=AllPortletType">All portlet types and field</link></para>
+ </section>
+</section>
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes_FR.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes_FR.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes_FR.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0 Unless required by
+applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for
+the specific language governing permissions and limitations under the
+License.
+-->
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+ xsi:schemaLocation="http://docbook.org/ns/docbook"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>Types de portlets</title>
+
+ <para>Pour faciliter la création de portlets, il existe plusieurs types de portlets correspondant à des usages classsiques dans des pages portail.</para>
+ <para>Pour cela, ces types reprennent une quantité d'objetcs et d'actions qui pourront être mis en oeuvre lors de la configuration de la portlet.</para>
+
+ <section>
+ <title>Gestion des types</title>
+
+ <para>Voici les différents types accessibles pour le moment :
+ <itemizedlist>
+ <listitem><para>Screenlet : type générique</para></listitem>
+ <listitem><para>ScreenletList : type générique pour une liste</para></listitem>
+ <listitem><para>Empty : contener vide pour permettre l'injection de portlet'</para> </listitem>
+ <listitem><para>Decorator : type permettant de charger kla portlet par URI</para></listitem>
+ </itemizedlist>
+ </para>
+ <para>Pour choisir un type, voir les détails sur chacun d'eux.</para>
+ </section>
+
+ <section>
+ <title>Liens complémentaires</title>
+ <para>Voir <link xl:href="showHelp?helpTopic=AllPortletType">tous les Types de portlet et les champs</link></para>
+ </section>
+</section>
\ No newline at end of file
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes_FR.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes_FR.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_portlettypes_FR.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/ExampleWactions.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/ExampleWactions.xml?rev=1346330&view=auto
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/ExampleWactions.xml (added)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/ExampleWactions.xml Tue Jun 5 10:17:15 2012
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<simple-methods xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/simple-methods.xsd">
+ <simple-method method-name="EditExample" short-description="action for EditExample screen">
+ <set field="widget.exampleId" from-field="parameters.exampleId"/>
+ <entity-one value-field="widget.example" entity-name="Example" use-cache="true">
+ <field-map field-name="exampleId" from-field="parameters.exampleId"/>
+ </entity-one>
+ <if-not-empty field="widget.exampleId">
+ <set field="parameters.idDescription" value="${parameters.exampleId} : ${widget.example.exampleName}"/>
+<!-- <set field="parameters.idDescription" value="${groovy: org.ofbiz.base.util.UtilURL.removeBadCharForUrl(idDescription)}"/> not necessary automatically done in add as parameters for idDescription-->
+ <set field="widget.idDescription" from-field="parameters.idDescription"/>
+ </if-not-empty>
+ </simple-method>
+ <simple-method method-name="ListExample" short-description="action for ListExample portlet">
+ <if-compare field="parameters.comingFromDelete" operator="equals" value="Y">
+ <clear-field field="parameters.exampleId"/>
+ </if-compare>
+ </simple-method>
+</simple-methods>
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/ExampleWactions.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/ExampleWactions.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/ExampleWactions.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Modified: ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/example/ExampleServices.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/example/ExampleServices.xml?rev=1346330&r1=1346329&r2=1346330&view=diff
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/example/ExampleServices.xml (original)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/script/org/ofbiz/example/example/ExampleServices.xml Tue Jun 5 10:17:15 2012
@@ -20,6 +20,74 @@ under the License.
<simple-methods xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/simple-methods-v2.xsd">
+ <!--#Bam# portletExample -->
+ <!--#Bam# Example methods to test all return Message-->
+ <simple-method method-name="createExample" short-description="create a Example and return message">
+
+ <!-- Example of Message management -->
+ <if-compare operator="equals" value="EXST_COMPLETE" field="parameters.statusId">
+ <!-- prepare a message for success or error message List -->
+ <entity-one value-field="statusItem" entity-name="StatusItem" use-cache="true">
+ <field-map field-name="statusId" from-field="parameters.statusId"/>
+ </entity-one>
+ <set field="argListName[]" from-field="statusItem.description"/>
+ <property-to-field resource="ExampleUiLabels" property="ExampleMessageExampleStatusIs" field="messageList" arg-list-name="argListName" />
+ </if-compare>
+
+ <!-- Now test if Error message -->
+ <if-empty field="parameters.exampleTypeId">
+ <!-- Error message -->
+ <property-to-field resource="ExampleUiLabels" property="ExampleMessageExampleTypeCannotBeEmpty" field="errorMessage"/>
+ <if-empty field="messageList">
+ <field-to-result field="errorMessage"/>
+ <else>
+ <!-- <set field="errorMessageList[]" from-field="errorMessage"/> it's not necessary to put it because errorMessage will be print too -->
+ <set field="errorMessageList[]" from-field="messageList"/>
+ <field-to-result field="errorMessageList"/>
+ </else>
+ </if-empty>
+
+ <if-empty field="parameters.description">
+ <!-- if there is a success message or messageList put fail, not success. It's should be used if you want to store some entity (so no rollback)
+ but you want to give a fail(or Warning) message to user -->
+ <!-- Currently not specifics look for fail, only error or success -->
+ <set field="responseMessage" value="fail"/>
+ <field-to-result field="responseMessage"/>
+ <log level="info" message="fail message"/>
+ <set field="parameters.exampleTypeId" value="INSPIRED"/>
+ <else>
+ <return response-code="error"/>
+ </else>
+ </if-empty>
+ </if-empty>
+
+ <!-- Start of Success Message example -->
+ <if-compare operator="equals" value="EXST_APPROVED" field="parameters.statusId">
+ <!-- return a success message -->
+ <property-to-field resource="ExampleUiLabels" property="ExampleMessageCreateExampleIsSuccess" field="successMessage"/>
+ <field-to-result field="successMessage"/>
+ <else>
+ <if-not-empty field="messageList">
+ <property-to-field resource="ExampleUiLabels" property="ExampleMessageCreateExampleIsSuccess" field="successMessageList[]"/>
+ <set field="successMessageList[]" from-field="messageList"/>
+ <field-to-result field="successMessageList"/>
+ </if-not-empty>
+ </else>
+ </if-compare>
+
+ <!-- Now create value -->
+ <make-value entity-name="Example" value-field="newEntity"/>
+ <sequenced-id sequence-name="Example" field="exampleId"/>
+ <log level="info" message="newEntity=${newEntity}"/>
+ <set field="newEntity.exampleId" from-field="exampleId"/>
+ <set-nonpk-fields map="parameters" value-field="newEntity"/>
+ <create-value value-field="newEntity"/>
+
+
+ <field-to-result field="exampleId"/>
+ </simple-method>
+ <!--#Eam# portletExample -->
+
<!-- ExampleStatus methods -->
<simple-method method-name="createExampleStatus" short-description="create a ExampleItem">
<now-timestamp field="nowTimestamp"/>
Modified: ofbiz/branches/20120329_portletWidget/specialpurpose/example/servicedef/services.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/servicedef/services.xml?rev=1346330&r1=1346329&r2=1346330&view=diff
==============================================================================
--- ofbiz/branches/20120329_portletWidget/specialpurpose/example/servicedef/services.xml (original)
+++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/servicedef/services.xml Tue Jun 5 10:17:15 2012
@@ -25,13 +25,15 @@ under the License.
<version>1.0</version>
<!-- Example & Related Services -->
- <service name="createExample" default-entity-name="Example" engine="entity-auto" invoke="create" auth="true">
+ <!--#Bam# portletExample change from engine entity-auto to simple to be able to generate some success or error message -->
+ <service name="createExample" default-entity-name="Example" engine="simple" invoke="createExample" auth="true"
+ location="component://example/script/org/ofbiz/example/example/ExampleServices.xml">
<description>Create a Example</description>
<permission-service service-name="exampleGenericPermission" main-action="CREATE"/>
<auto-attributes include="pk" mode="OUT" optional="false"/>
<auto-attributes include="nonpk" mode="IN" optional="true"/>
- <override name="exampleTypeId" optional="false"/>
- <override name="statusId" optional="false"/>
+ <override name="exampleTypeId" optional="true"/><!--#Bam# portletExample it's mandatory but Test if present will be done in service -->
+ <override name="statusId" optional="true"/><!--#Bam# portletExample it's mandatory but Test will be done in service -->
<override name="exampleName" optional="false"/>
</service>
<service name="updateExample" default-entity-name="Example" engine="entity-auto" invoke="update" auth="true">