svn commit: r1370454 [3/7] - in /ofbiz/branches/20120329_portl
Locked
svn commit: r1370454 [3/7] - in /ofbiz/branches/20120329_portl
 
|
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets.xml Tue Aug 7 19:23:16 2012 @@ -0,0 +1,66 @@ +<?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 PortalPortlets usage.</title> + + <section> + <title></title> + <para> + After Portlet type selection, We can proceed to its configuration depending on our screen needs + <itemizedlist> + <listitem><para>Configure portlet title</para> </listitem> + <listitem><para>Configure the widget to be used (screen or form)</para></listitem> + <listitem><para>Configure whether it should call a script, before rendering process start. For example : get some data, check passed parameters or any action that may be needed to get portlet working</para> </listitem> + <listitem><para>Configure wheter it shoud should incllud a menu on its screenlet title bar</para> </listitem> + <listitem><para>Is there a variable to must be checked do decide if the portlet should be rendered or not(For example : a workEffort resume portlet may chek that it gets a workEffortId otherwise it does show anything to avoid a form with field labels only rendered)</para></listitem> + <listitem><para>...</para></listitem> + </itemizedlist> + </para> + <para>&nbsp;</para> + <para>Most of portlet cofigurable elements has default values deduced by renderers to facilitate portlet creation process.</para> + <para>So looking at a portlet définition file like ExempleExamplePortletData.xml, we can see that very litlle of theme are set, + mainly portlet own field. + </para> + <para>&nbsp;</para> + <para>here are some excerpts: + <programlisting> + &lt;PortalPortlet portalPortletId="FindExample" + portletName="Find Example (with portletType and showPortlet)" description="portlet to define search criteria for Example list" + portletTypeId="Screenlet" component="example" subComponent="Example" helpName="HELP_Screenlet"/> + &lt;PortalPortlet portalPortletId="ListExample" + portletName="List Examples (with portletType and showPortlet)" description="portlet to list example depending on search criteria, this portlet is call by FindExample" + portletTypeId="ScreenletList" component="example" subComponent="Example" helpName="HELP_ScreenletList"/> + </programlisting> + </para> + <para>&nbsp;</para> + <para>To ensure this portal page quality, its important to take care of translation files (CommonPortalEntityLabels.xml) : + <programlisting> + &lt;property key="PortalPortlet.portletName.FindExample"> + &lt;value xml:lang="en">Find Example &lt;/value> + &lt;value xml:lang="fr">Rechercher un exemple &lt;/value> + &lt;/property> + &lt;property key="PortalPortlet.description.FindExample"> + &lt;value xml:lang="en">portlet to define search criteria for Example list &lt;/value> + &lt;value xml:lang="fr">portlet (type Screenlet) de critères de recherche pour la liste des exemples &lt;/value> + &lt;/property> + </programlisting> + </para> + </section> + +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml Tue Aug 7 19:23:16 2012 @@ -0,0 +1,73 @@ +<?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>Utilisation des portlets</title> + + <section> + <title></title> + <para> + Une fois son type sélectionné, il va falloir configurer la portlet en fonction des besoins de votre écran : + <itemizedlist> + <listitem><para>configuration du titre de la portlet</para> </listitem> + <listitem><para>configuration du screen ou du form utilisé</para></listitem> + <listitem><para>utilisation d'un script avant le chargement de la portlet (récupération d)une liste, test de données, actions diverses)</para> </listitem> + <listitem><para>utilisation d'un menu (en haut dans la barre de titre du screenlet)</para> </listitem> + <listitem><para>utilisation d'un test sur une variable pour afficher ou non le contenu de la portlet</para></listitem> + <listitem><para>...</para></listitem> + </itemizedlist> + </para> + <para>&nbsp;</para> + <para>La majorité des éléments configurables sur une portlet ont des valeurs par défaut qui évitent d'avoir à les définir lors de la création des portlets.</para> + <para>Ainsi, lorsqu'on regarde le fichier de définition des portlets ExempleExamplePortletData.xml, très peu de champs sont renseignés, principalement ceux concernant la portlet elle-même. + <itemizedlist> + <listitem><para>configuration du titre de la portlet</para> </listitem> + <listitem><para>configuration du screen ou du form utilisé</para></listitem> + <listitem><para>utilisation d'un script avant le chargement de la portlet (récupération d)une liste, test de données, actions diverses)</para> </listitem> + <listitem><para>utilisation d'un menu (en haut dans la barre de titre du screenlet)</para> </listitem> + <listitem><para>utilisation d'un test sur une variable pour afficher ou non le contenu de la portlet</para></listitem> + <listitem><para>...</para></listitem> + </itemizedlist> + </para> + <para>&nbsp;</para> + <para>Et voici des extraits : + <programlisting> + &lt;PortalPortlet portalPortletId="FindExample" + portletName="Find Example (with portletType and showPortlet)" description="portlet to define search criteria for Example list" + portletTypeId="Screenlet" component="example" subComponent="Example" helpName="HELP_Screenlet"/> + &lt;PortalPortlet portalPortletId="ListExample" + portletName="List Examples (with portletType and showPortlet)" description="portlet to list example depending on search criteria, this portlet is call by FindExample" + portletTypeId="ScreenletList" component="example" subComponent="Example" helpName="HELP_ScreenletList"/> + </programlisting> + </para> + <para>&nbsp;</para> + <para>Pour garantir la qualité de cette page portail, il est important de penser aux traductions (CommonPortalEntityLabels.xml) : + <programlisting> + &lt;property key="PortalPortlet.portletName.FindExample"> + &lt;value xml:lang="en">Find Example &lt;/value> + &lt;value xml:lang="fr">Rechercher un exemple &lt;/value> + &lt;/property> + &lt;property key="PortalPortlet.description.FindExample"> + &lt;value xml:lang="en">portlet to define search criteria for Example list &lt;/value> + &lt;value xml:lang="fr">portlet (type Screenlet) de critères de recherche pour la liste des exemples &lt;/value> + &lt;/property> + </programlisting> + </para> + </section> + +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty.xml Tue Aug 7 19:23:16 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>Use of the template "Empty"</title> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="/example/images/Empty.png"/> + </imageobject> + <textobject><phrase>Empty portlet template</phrase></textobject> + </mediaobject> + </para> + <para>This designer enables to define a portlet as containing other portlets.</para> + <para>Thus, by means of a browsing menu, a portlet can be loaded in this area of contents. Go to the portlet "ExampleDetail" and the portlet containing the menu that manages it.</para> + + <para>Standard use: the template "Empty" is used to delimit an area "loading of portlets", controlled by another portlet that contains a menu.</para> + <section> + <title>Supplementary links</title> + <para><link xl:href="showHelp?helpTopic=HELP_portlettypes">Back to the menu "Portlet types"</link></para> + <para>Display <link xl:href="showHelp?helpTopic=AllPortletType">every portlet type and the fields</link></para> + <para>Display <link xl:href="showHelp?helpTopic=portletfields">the full list of the fields of a portlet</link></para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty_FR.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty_FR.xml Tue Aug 7 19:23:16 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>Portlet de type Empty</title> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="/example/images/Empty.png"/> + </imageobject> + <textobject><phrase>type de portlet Empty</phrase></textobject> + </mediaobject> + </para> + <para> + Ce décorateur permet de définir une portlet comme un conteneur d'autres portlets. + Ainsi, au moyen d'une navigation par menu, on peut charger une portlet dans cette zone de contenu. + Voir la portlet ExampleDetail et la portlet de menu qui la gère. + </para> + <para>Usage classique : sert à définir une zone chargement de portlets commandée par une autre portlet contenant un menu.</para> + <section> + <title>Liens complémentaires</title> + <para><link xl:href="showHelp?helpTopic=HELP_portlettypes">retour au menu "Types de portlet"</link></para> + <para>Voir <link xl:href="showHelp?helpTopic=AllPortletType">tous les Types de portlet et les champs</link></para> + <para>Voir <link xl:href="showHelp?helpTopic=portletfields">la liste complète des champs d'une portlet</link></para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_Empty_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT.xml Tue Aug 7 19:23:16 2012 @@ -0,0 +1,45 @@ +<?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>Portal Page to search and manage a main business entity.</title> + <para>This page type allows to search on a "business entity", and from the results list to view each + associated entities. From the results list, there is also a link to a page synthesis of the entity, ie view + all related entities, for an entity instance. + </para> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="/example/images/MgmtPage.png" width="800" depth="600"/> + </imageobject> + <textobject><phrase>Management PortalPage - Type</phrase></textobject> + <caption>Schema of a portal page type of management of a major business object: research, list and management</caption> + </mediaobject> + </para> + + + <section> + <title>Other Portal Page Type</title> + <para> + <itemizedlist> + <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_showPortalPage&portalPageId=ExampleRecap">Recap Page</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_MGMT.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml Tue Aug 7 19:23:16 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>Page portail de recherche et gestion d'une entité métier majeur</title> + <para>Ce type de page permet de faire des recherches sur une entité métier, et à partir de la liste des résultats de visualiser chacune des + entités associées. A partir de la liste des résultats, il y a aussi un lien vers une page de synthése de l'entité, c'est à dire visualiser + l'ensemble des entités associées, pour une instance de l'entité. + </para> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="/example/images/MgmtPage_FR.png" width="800" depth="600"/> + </imageobject> + <textobject><phrase>Page portail type : Gestion</phrase></textobject> + <caption>Schema d'une page portail type de gestion d'un objet métier majeur : recherche, liste et gestion</caption> + </mediaobject> + </para> + <section> + <title>Les autres Page Type</title> + <para> + <itemizedlist> + <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_showPortalPage&portalPageId=ExampleRecap">Page Recapitulative</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_MGMT_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW.xml Tue Aug 7 19:23:16 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>Portal page to create a record for a major business entity</title> + <para>This type of page is to create a record of a business entity and then complete it by adding one to a set of association + related entities.</para> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="/example/images/NewPage.png" width="800" depth="600"/> + </imageobject> + <textobject><phrase>Page Portail Type : Creation</phrase></textobject> + <caption>Schema des portlets inclus dans une page Création</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=ExampleRecap">Recap Page</link></para></listitem> + </itemizedlist> + </para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_PPAGE_NEW.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml 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=1370454&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 Aug 7 19:23:16 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=1370454&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 Aug 7 19:23:16 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=1370454&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 Aug 7 19:23:16 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=1370454&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 Aug 7 19:23:16 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=1370454&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 Aug 7 19:23:16 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=1370454&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 Aug 7 19:23:16 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=1370454&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 Aug 7 19:23:16 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=1370454&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 Aug 7 19:23:16 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=1370454&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 Aug 7 19:23:16 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=1370454&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 Aug 7 19:23:16 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=1370454&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 Aug 7 19:23:16 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>Attributs d'une portlet</title> + + <para>Les portlet utilisent des attributs pour permettre de rendre configurable cette portlet.</para> + <para>En effet, plus une porlet est configurable, plus il sera aisée de l'utiliser dans un autre contexte, sur une autre page.</para> + <para>&nbsp;</para> + + <section> + <title>Gestion des attributs</title> + <para>Un exemple d'attributs standard fixé lors de la configuration : l'attribut "initiallyCollapsed" est un attribut générique utilisé par les types de portlets Screenlet et ScreenletList + pour déterminer si la screenlet sera initialement fermée ou ouverte. Ici, on configure sa valeur pour une page portail et une portlet données. + <programlisting> + &lt;PortletAttribute portalPageId="ExampleNew" portalPortletId="FindExample2" attrName="initiallyCollapsed" attrValue="true" portletSeqId="00001"/> + </programlisting> + </para> + <para>Ensuite, on peut créer son propre attribut qui sera utilisé par le script (par exemple) pour rechercher une liste (par exemple une liste d'acteurs avec un rôle défini). + Ainsi, on pourra utiliser la portlet pour différentes valeurs de cet attributs (par exemple, une portlet acteur permet de filtrer sur des propects, des employés,...). + <programlisting> + &lt;PortletAttribute portalPageId="ExampleMgmt" portalPortletId="ListExample2" 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_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=1370454&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 Aug 7 19:23:16 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 |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |