svn commit: r1370454 [2/7] - in /ofbiz/branches/20120329_portl
Locked
svn commit: r1370454 [2/7] - in /ofbiz/branches/20120329_portl
 
|
Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel.xml Tue Aug 7 19:23:16 2012 @@ -0,0 +1,151 @@ +<?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>Practices of development</title> + + <para>The use of portal pages and of portlets to define the user interfaces is heavily recommended.</para> + + <para>A portal page contains generic or specific portlets, which configurations can completely be changed: title, page arrangement, menus, scripts, ...</para> + + <para>A group of templates has been defined in order to meet the most standard needs during the development of the interfaces.</para> + + <para>Thus, all you have to do, for most of cases, is to define a "Form" at the right place, in the right file. Then, the portlet is straight usable.</para> + + <para>This part aims to describe the tools and recommendations that you have in order to create standard interfaces which configurations can be changed as soon as possible.</para> + + <section> + <title>Creation of portal pages and portlets</title> + + <para>First, you have to identify the type of portlet.</para> + + <para>Go, in the index, to "Use of Portlets" - "Types of portlets", or straight to <link>Types of portlets</link></para> + + <para>Once you have chosen the template, you have to configure the portlet according to the needs of your screen. + <itemizedlist> + <listitem><para>configuration of the portlet's title</para> </listitem> + <listitem><para>configuration of the screen or of the "Form" that is used</para></listitem> + <listitem><para>use of a script before the loading of the portlet (recovery of a list, data test, various actions)</para> </listitem> + <listitem><para>use of a menu (at the top of the title bar of the screenlet)</para> </listitem> + <listitem><para>use of a test on a variable in order to, or not to, display the contents of the portlet</para></listitem> + <listitem><para>...</para></listitem> + </itemizedlist> + </para> + <para>&nbsp;</para> + <para>Most part of the elements which configurations can be changed, on a portlet, have default values that avoid having to define them during the creation of the portlets.</para> + + <para>Thus, when you look at the file ExamplePortletData.xml that defines the portlets, very few fields (mainly the ones regarding the portlet itself) are filled in. + <itemizedlist> + <listitem><para>configuration of the portlet's title</para> </listitem> + <listitem><para>configuration of the screen or of the "Form" that is used</para></listitem> + <listitem><para>use of a script before the loading of the portlet (recovery of a list, data test, various actions)</para> </listitem> + <listitem><para>use of a menu (at the top of the title bar of the screenlet)</para> </listitem> + <listitem><para>use of a test on a variable in order to, or not to, display the contents of the portlet</para></listitem> + <listitem><para>...</para></listitem> + </itemizedlist> + </para> + <para>And here are some extracts: + <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> + </section> + + <section> + <title>Naming rules</title> + <para>In order to make the comprehension of the names of the portal pages and of the portlets easier, naming conventions have been established: + <itemizedlist> + <listitem><para>Portal page: + <itemizedlist> + <listitem><para>xxxxSummary: it contains a group of portlets to display and/or to manage an object and its associated entities (pages like Actor Profile or Project Summary, for example). <link xl:href="showHelp?helpTopic=HELP_PPAGE_RECAP">For more details</link></para></listitem> + <listitem><para>xxxxMgmt: it enables to do a search, to get a list, and, after the selection of an element, to display/manage associated entities by associated entities</para></listitem> + <listitem><para>sub...: it is a page used as part of a screen</para></listitem> + </itemizedlist></para> + </listitem> + <listitem><para>Portlet: + <itemizedlist> + <listitem><para>Findxxxs: search form</para></listitem> + <listitem><para>Listxxxs: portlet that lists the record of the entity, often as result of the portlet xxxFind</para></listitem> + <listitem><para>xxxRecap: small or medium portlet, only on display, meant to be in a column (25% or 33%) in order to remind the object on which you are working</para></listitem> + <listitem><para>xxxDetailsMenu: same contents as in xxxSummary, with a menu enabling to display the details of associated entities somewhere else on the screen</para></listitem> + <listitem><para>xxxDetail: empty portlet that enables to define the slot (the container) where the details of associated entities will be displayed (see xxxMenuDetail)</para></listitem> + <listitem><para>xxxOverview: medium or big portlet, only on display, meant to be in the main column (50% and more) which presents a general view of the object, if needed from elements of associated entities (synthesis of a Project, Command)</para></listitem> + <listitem><para>xxxCreate: creation portlet. Can contain fields linked to associated entities in order to enable to create the object and the associated entities in only one operation. There can be a similarity of form with xxxOverview</para></listitem> + <listitem><para>xxxUpdate: update portlet. Only contains fields linked to the object. The update of the associated entities is done via the suitable portlets</para></listitem> + <listitem><para>xxxyyyys or xxxyyyysList: xxx is the name of the major entity (the object); yyyy is the name of the associated entity; the s shows that it is a list</para></listitem> + </itemizedlist></para> + </listitem> + </itemizedlist> + </para> + </section> + + <section> + <title>Migration of a standard screen</title> + <para>For the migration of an ofbiz standard screen in a portlet, the projective is to use at the maximum: + <orderedlist> + <listitem><para>the elements of the ofbiz standard</para></listitem> + <listitem><para>the available tools, thanks to the addon portletWidget.</para></listitem> + </orderedlist> + </para> + </section> + + <section> + <title>Rules to follow:</title> + <para> + + <orderedlist> + <listitem><para>If you have any doubt, watch how the portlets' parameters are defined in Example (/ofbiz/framework/data/ExamplePortletData/xml). This corresponds to good practices (a good practice that is not in Example is not a good practice)</para></listitem> + <listitem><para>except in very special situations, files' name and location (form, menu, script, screen) should use default values.</para></listitem> + <listitem><para>except in very special situations, a portlet should have a portletType (Screenlet, ScreenletList, Decorator or Empty)</para></listitem> + <listitem><para>field component, sub-component and webapp must be correclty filled in, webap can be empty</para></listitem> + <listitem><para>choose the correct component for the portlet. A portlet coming from a form in projectmgr but which uses workeffort items without projectmgr personalisation + should be defined in WorkEffort with component = "WorkEffort" (ex: WorkEffortNotes). It's possible to override a uiLabel in a component, so a specifics title is not a correct reason. + If a form drop-down is defined with constraints (parentType = xxx, xxxType= , ...), it's easly resolved by defining and using a portlet attribute.</para></listitem> + <listitem><para>except in very special situations, the screenlet title should use an existing label. You must search twice before creating a new one, and if you create it, you must put it in the right component</para></listitem> + <listitem><para>if possible, use only one form. If possible, extend the standard (which is used by screen) Form, and override only link fields (edit, remove) by show-portlets, and add an on-event-update-area if a submit button exists</para></listitem> + <listitem><para>update and create targets must have to use a return json, so as to have a display of error (or success) messages. </para></listitem> + <listitem><para>edition actions (in the editArea area) should be uri, and not portlets (except if EditXXX is used directly as a portlet in an other PortalPage); to be clearer, put screen and form in same place as the portlets that use them.</para></listitem> + <listitem><para>currently, for edit actions (or create in sub-list), a "cancel" button or a "refresh" button should exist.</para></listitem> + <listitem><para>the json uri (and the edit uri) should be put in portlet-controllers, with ofbiz best practice presentation (request without service call in only one line, ...)</para></listitem> + <listitem><para>if possible, use a portlet (mini-lang) script rather than a screen. If the script is a copy from an action screen section, add a comment; Use a script only if it is used in more than one portlet or screen or if the result is used in the menu or title of the screenlet. Otherwise it's better to put it in the action section of the Form.</para></listitem> + <listitem><para>any part of the spread code (form, screen, menu, script, java) must own a comment to indicate the origin of the copy and the justification of the copy (think about the one who will need to delete the copy)</para></listitem> + <listitem><para>every link to another page (in other components, for example) should be moved to a showPortalPage with portalPageId as a portlet attribute, most of the time it should be xxxxRecap; Of course the editForm should define correctly.</para></listitem> + <listitem><para>in every portlet editForm, field's names and tooltips should be very explicit; all attributes should have a default value (portlet should be usable without adding any attribute)</para></listitem> + <listitem><para>most of the time, you should add 2 portal pages (xxxMgmt and xxxRecap). Update it each time you add a new portlet</para></listitem> + <listitem><para>when it's possible, use icons, and not text for menu. To do that, you should : + <itemizedlist> + <listitem><para>search the correct icon in the "Icon list" Page, and therefore find the icon's logical name</para></listitem> + <listitem><para>give the image-location by using the iconsPurpose map</para></listitem> + <listitem><para>if the icon default tooltips (you can see it in the "Icon List" page) is clear in your case, use it via the IconsTooltips_ labels, otherwise use a specific image-title uiLabel.</para></listitem> + </itemizedlist></para></listitem> + </orderedlist> + </para> + </section> + + <section> + <title>more help</title> + <para> + For further information, (Portal page type, portlet type), click on the "index" button and go to Example / Development Tree. + </para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel_FR.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel_FR.xml Tue Aug 7 19:23:16 2012 @@ -0,0 +1,139 @@ +<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>Pratiques de développement</title> + <para>L'usage des pages portails et des portlets pour définir les interfaces utilisateurs est grandement recommandé.</para> + <para>Une page portail contient des portelts génériques ou spécifiques, et ces portlets sont entièrement configurables : + titre, disposition sur la page, menus, script,... + </para> + <para>Un ensemble de types de portlet a été défini pour répondre aux besoins les plus classiques lors du développement des interfaces.</para> + <para>Ainsi dans la plupart des cas, il suffit de définir un "Form" au bon endroit, dans le bon fichier, et la portlet est directement utilisable.</para> + <para> Cette partie a pour but de décrire les outils et les recommandations à disposition pour réaliser des interfaces standards et configurables dans les meilleurs délais.</para> + + <section> + <title>Création de page portail et portlets</title> + + <para>Il faut d'abord identifier le type de portlet.</para> + <para> Voir dans l'index Utilisation des portlets - Types de portlets ou directement + <link xl:href="showHelp?helpTopic=HELP_portlettypes">Types de portlets</link></para> + <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 ExamplePortletData.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>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> + </section> + + <section> + <title>Règle de nommage</title> + <para> + Afin de faciliter la compréhension des noms de page portail et noms de portlet, des conventions de nommage ont été établies : + <itemizedlist> + <listitem><para>Page portail : + <itemizedlist> + <listitem><para>xxxxRecap : elle contient un ensemble de portlets pour visualiser et/ou gérer un objet et ses entités associées + (les pages profil d'acteur ou Résumé Projet sont de ce type), plus de <link xl:href="showHelp?helpTopic=HELP_PPAGE_RECAP">détails</link></para></listitem> + <listitem><para>xxxxMgmt : elle permet de faire une recherche, d'obtenir une liste puis aprés sélection d'un élément de visualiser/gérer entités associées par entités associées</para></listitem> + <listitem><para>sub... : c'est une page qui est utilisée en tant que partie d'écran</para></listitem> + </itemizedlist></para> + </listitem> + <listitem><para>Portlet : + <itemizedlist> + <listitem><para>Findxxxs : formulaire de recherche</para></listitem> + <listitem><para>Listxxxs : portlet listant l'enregistrement de l'entité, souvent en tant que résultat de la portlet xxxFind</para></listitem> + <listitem><para>xxxSummary : portlet de petite ou moyenne taille uniquement en affichage, destinée à être dans une colonne (25% ou 33%) pour rappeler l'objet sur lequel on travaille</para></listitem> + <listitem><para>xxxDetailsMenu : contenu identique à xxxSummary avec un menu permettant d'afficher dans un autre emplacement de l'écran le détail d'entités associés</para></listitem> + <listitem><para>xxxDetail : portlet vide permettant de définir l'emplacement (le container) où s'affiche le détail d'entités associés (cf xxxMenuDetail)</para></listitem> + <listitem><para>xxxOverview : portlet de moyenne à grande taille, uniquement en affichage, destinée à être dans la colonne principale (50% et plus) qui présente une vue générale de l'objet, au besoin à partir d'éléments d'entités associées (synthèse Projet, Commande)</para></listitem> + <listitem><para>xxxCreate : portlet de création, peut contenir des champs liés à des entités associées afin de permettre de créer l'objet et les entités associées en une seule opération. Il peut y avoir similitude de formulaire HTML (form) avec xxxOverview</para></listitem> + <listitem><para>xxxUpdate : portlet de mise à jour, ne contient que des champs liés à l'objet, la mise à jour des entités associés se fait via les portlets adéquates</para></listitem> + <listitem><para>xxxyyyys ou xxxyyyysList : xxx c'est le nom de l'entité majeure (l'objet) yyyy le nom de l'entité associée, le s pour signaler que c'est une liste</para></listitem> + </itemizedlist></para> + </listitem> + </itemizedlist> + </para> + </section> + + <section> + <title>Migration d'écran standard</title> + <para> + Pour la migration d'écran standard ofbiz en portlet, l'objectif est d'utiliser au maximum : + <orderedlist> + <listitem><para>les éléments du standard ofbiz</para></listitem> + <listitem><para>Des portlet avec le minimum de champ définis donc avec l'usage du maximum de champ avec leur valeur par défaut.</para></listitem> + </orderedlist> + </para> + </section> + + <section> + <title>Règles à suivre :</title> + <para> + + <orderedlist> + <listitem><para>en cas de doute, regarder comment sont paramétrés les portlet dans l'exemple (/ofbiz/specialpurpose/example/data/ExamplePortletData.xml), + cela correspond aux bonnes pratiques (une bonne pratique qui n'est pas dans exemple n'est pas une bonne pratique)</para></listitem> + <listitem><para>sauf cas très particulier, le nom et la location des fichiers (form, menu, script, screen) doivent utiliser les valeurs par défaut</para></listitem> + <listitem><para>sauf cas très particulier, une portlet doit avoir un type (Screenlet, ScreenletList, Decorator ou Empty)</para></listitem> + <listitem><para>les champs composant, sous-composant et webapp doivent être correctement renseignés (webapp vide ou non)</para></listitem> + <listitem><para>mettre dans le bon composant la portlet, une portlet issue d'une form de projectmgr est un élément de WorkEffort s'il n'y a pas de spécificité project. + Les uiLabels sont surchargeables par composant donc un titre spécifique n'est pas une bonne raison; + un ou des drop-downs avec des contraintes (parentType = xxx, xxxType= , ...) peuvent facilement être rendus paramétrables.</para></listitem> + + <listitem><para>sauf cas très particulier, le titre de la screenlet doit utiliser un label existant, bien faire une recherche avant d'en créer un, et si création, le mettre dans le bon composant</para></listitem> + <listitem><para>dans la mesure du possible, utiliser uniquement une form. Si possible, celle-ci hérite du formulaire HTML (form) standard, les champs de type lien (edit, remove) étant surchargés pour être des show-portlets, et un on-event-update-area est ajouté s'il y a un bouton submit</para></listitem> + <listitem><para>les target pour l'update ou le create doivent utiliser un retour json, afin d'avoir un affichage des messages d'erreur ou de retour correct. </para></listitem> + <listitem><para>les actions d'édition (dans la zone d'editArea) sont la plupart de temp des uri, pas des portlets (sauf usage en tant que tel par ailleurs); par souci d'homogénéité, il faut mettre screen, form dans les mêmes locations que les portlet les utilisant. De même, si possible faire un héritage de la form standard.</para></listitem> + <listitem><para> pour l'instant, il n'y a pas consensus concernant le lieu du bouton "annuler" mais comme qui peut le plus, peut le moins, il faut mettre un bouton annuler dans les formulaires d'édition et un bouton dans le menu (en dernier à droite) qui fait un refresh de la portlet</para></listitem> + <listitem><para> les uri json (et les uri d'action d'édition) sont à mettre dans le portlet-controller en respectant les bonnes pratiques OFBiz (request sans appel de service sur une ligne ...)</para></listitem> + <listitem><para> dans la mesure du possible, utiliser un script (mini-lang) plutôt qu'un screen, si le script est une copie du pavé action du screen, mettre un commentaire ; le script n'a d'intérêt que s'il est utilisé plusieurs fois ou si le résultat est utilisé dans l'en-tête du screenlet (menu ou titre ), sinon autant le mettre dans le pavé action de la form.</para></listitem> + <listitem><para>toute partie de code dupliqué (form, screen, menu, script, java) doit posséder un commentaire pour signaler l'origine de la copie et la justification de la copie (pensez à celui qui voudra supprimer la duplication)</para></listitem> + <listitem><para>les addons nommé portlet-nomDunComposantStdOfbiz ont pour objectif d'être reversé à OFBiz, ils ne doivent donc contenir que des éléments standards</para></listitem> + <listitem><para>portletWidget a pour objectif d'être reversé à OFBiz, pas genericPortlet ; il faut donc dans les addons portlet-nomDunComposantStdOfbiz migrer les portlets qui n'utiliseraient pas portletWidget</para></listitem> + <listitem><para>pour tous les liens hyperlink vers d'autres pages (par exemple d'un autre composant), si possible migrer la target vers un showPortalPage et mettre en paramétrage de la nom de la portalPage, normalement ça doit être une page de type xxxxRecap. Bien entendu, paramétrer ou faire la form d'editAttribue.</para></listitem> + <listitem><para>pour toutes les form d'editAttribue de portlet, le nom du champ ou son titre doivent être explicites, et si possible avoir un tooltips ; tout paramètre de portlet doit avoir une valeur par défaut (la portlet doit être utilisable sans avoir besoin de saisir une valeur)</para></listitem> + <listitem><para>Il faut au minimum disposer des deux pages portails classiques ( xxxMgmt et xxxRecap), les mettre à jour à chaque ajout de portlet</para></listitem> + <listitem><para>Dans la mesure du possible, il faut mettre des icônes à la place de libellé. Pour cela, il faut : + <itemizedlist> + <listitem><para>chercher la bonne icône dans la page "Liste des icônes", et donc trouver son nom logique</para></listitem> + <listitem><para>exprimer l'image-location en utilisant la map iconsPurpose </para></listitem> + <listitem><para>si le Tooltips par défaut (celui visible dans la page Liste des portlet) est suffisamment clair pour votre usage, utilisez-le via les labels IconsTooltips_, sinon personnalisez correctement l'image-title en rédigeant un nouveau Tooltips mieux adapté</para></listitem> + </itemizedlist></para></listitem> + </orderedlist> + </para> + </section> + + <section> + <title>Suite de l'aide</title> + <para> + Pour avoir la suite (les types de page portail, les types de portlet), cliquez sur le bouton "Index" et regardez l'arborescence de la rubrique Exemple / Développement. + </para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_devel_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Modified: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook.xml?rev=1370454&r1=1370453&r2=1370454&view=diff ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook.xml (original) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook.xml Tue Aug 7 19:23:16 2012 @@ -24,31 +24,70 @@ under the License. xmlns="http://docbook.org/ns/docbook"> <title>Help on writing docBook documents</title> + <para>This file aims to contain an example of what is possible to put in a docBook file that is used as an ofbiz helping page.</para> + <para>It has to be opened as an xml file. To display the helping page, only a few docBook tags are interpreted. This file contains all the ones that are interpreted.</para> + <para>The interpretation of these tags is made by the ftl file HelpTemplate.ftl</para> + <para>It is advisable to only take a 2-character indentation, in order to limit the width of the file.</para> + <para>&nbsp;</para> + <para>The tag "para" enables to manage the paragraphs and, for the moment, it enables to manage the chosen carriage returns. The number of spaces or carriage returns in the docBook text is ignored. For instance, an empty line between two paragraphs in a docBook file does not generate any space between the paragraphs.</para> + <para>When forcing this action is necessary, in exceptional situations, it is possible to include html code, + to generate spaces or carriage returns for instance. But attention! During the creation of pdf files or according to the type of transformation in html,</para> + <para> <br \>these elements will appear and won't be interpreted. + <programlisting> + &lt;para>Short paragraph&lt;/para> + to insert an empty line between two paragraphs &lt;para>&amp;nbsp;&lt;/para> + &lt;para>Short paragraphe with a carriage&amp;lt;br \>in the middle&lt;/para> + </programlisting> + </para> + <section> + <title><anchor xml:id="WhatIsSection"/>What is a section? (H2)</title> + <para>When the user asks for the display of the helping page (clicks on the icon), the system looks for the associated file(s) and displays it (for more details about the organization of the helping page, read <link xl:href="showHelp?helpTopic=DOCUMENTATION_SYSTEM">Principles and organization of the Apache OfBoz Documentation</link>).</para> + <para>The tag "Title" of the file will be the title of the page (H1 in html), and it will be possible to have as many subsections (H2) as we want, and with as many levels (H3, H4, H5, ...) as we want. This is the aim of the tag. In the tag Title, it is possible to put a tag Anchor in order to link it (with an internal or external link) straight to this section.</para> + <section> + <title>Subsection (H3)</title> + <para>and we could go on...</para> + </section> + </section> <section> <title>Example of an ordered list</title> - <para>The orderedlist will put numbers in front of each item.</para> + <para>There will be a number in front of each item.</para> <orderedlist> <listitem><para>First item of my list</para></listitem> <listitem><para>Second item</para></listitem> <listitem><para>Third...</para></listitem> - <listitem><para>4th...</para></listitem> - <listitem><para>and this can go longer...</para></listitem> + <listitem><para>Forth...</para></listitem> + <listitem><para>and so on...</para></listitem> </orderedlist> </section> <section> <title>Example of an itemized list</title> - <para>The itemizedlist will put a bullet in front of each item.</para> + <para>There will only be a symbol (a point) at the beginning of each line.</para> <itemizedlist> <listitem><para>First item of my list</para></listitem> <listitem><para>Second item</para></listitem> <listitem><para>Third...</para></listitem> - <listitem><para>4th...</para></listitem> - <listitem><para>and this can go longer...</para></listitem> + <listitem><para>Forth...</para></listitem> + <listitem><para>and so on...</para></listitem> </itemizedlist> </section> <section> <title>Examples of text formatting</title> + <para>In formatting, there are 2 notions: + <itemizedlist> + <listitem><para>formatting the text <emphasis role="caution">in progress</emphasis></para></listitem> + <listitem><para>a paragraph with a specific formatting. In this case, you can put a title at that paragraph, but it is not compulsory. Currently, in any case, this title will be on level H3.</para></listitem> + </itemizedlist> + </para> + <para>Each formatting corresponds to a style. Currently, 4 have been created. + <itemizedlist> + <listitem><para>caution: caution (but softer than warning)</para></listitem> + <listitem><para>important: as its name implies</para></listitem> + <listitem><para>note: as its name implies</para></listitem> + <listitem><para>tip: trick</para></listitem> + <listitem><para>warning: warning (stronger than caution)</para></listitem> + </itemizedlist> + </para> <caution> <title>Caution title</title> <para>Here is a caution text</para> @@ -69,4 +108,35 @@ under the License. <para>Here is a warning</para> </warning> </section> + + <section> + <title>Possible inclusion</title> + <para>During the display of the helping page, according to the links between elements of contents, it is possible to display several elements of contents + <itemizedlist> + <listitem><para>another helping file</para></listitem> + <listitem><para>a picture</para></listitem> + <listitem><para>a form (or a screen) so as to be able to see the helping page of each field</para></listitem> + </itemizedlist> + </para> + <para>During the display of the helping page on the <link xl:href="showHelp?helpTopic=EXAMPLE_main">home page</link> of the component Example, 2 helping files are displayed.</para> + <para>Example of a display of a picture, <emphasis role="caution">only the field fileref is compulsory, but for a good page setting, the fields width and depth are recommended.</emphasis></para> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="/example/images/MgmtPage.png" width="638" depth="478"/> + </imageobject> + <textobject><phrase>A typical portal page</phrase></textobject> + <caption>Diagram of a typical portal page, about a search management and a main entity management</caption> + </mediaobject> + </para> + <para>&nbsp;</para> + <para>So as to enable the user to display the helping page of each field (which appears when the mouse is situated on the field's label), it is sometimes interesting to display a form in a helping page text. To do this, you have to create an associated element of contents (dataresource) which is associated to a screen.xml, with a dataTemplateTypeId="SCREEN_COMBINED". It is advisable to do a dedicated screen that does not include the general decorator.<br \> + Then, you have to associate the element of contents with the same parent as for the helping page with which the screen has to appear. Here are the data for the display of the following screen. + <programlisting> + &lt;DataResource dataResourceId="EXAMPLE_EditForm" objectInfo="component://example/widget/example/ExampleScreens.xml#ExampleEditForm" dataResourceTypeId="URL_RESOURCE" dataTemplateTypeId="SCREEN_COMBINED"/> + &lt;Content contentId="EXAMPLE_EditForm" contentTypeId="DOCUMENT" contentName="Example Fields" dataResourceId="EXAMPLE_EditForm"/> + &lt;ContentAssoc contentId="HELP_EXAMPLE_docbook" contentIdTo="EXAMPLE_EditForm" mapKey="EXAMPLE_docbook" fromDate="2006-01-12 01:01:01" sequenceNum="005" contentAssocTypeId="INSTANCE"/> + </programlisting> + </para> + </section> </section> Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml Tue Aug 7 19:23:16 2012 @@ -0,0 +1,157 @@ +<?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>Comment écrire un document avec docBook (fichier d'aide)</title> + <para>Ce fichier a pour objectif de contenir un exemple de ce qu'il est possible de mettre dans un fichier docbook utilisé en tant qu'aide d'ofbiz. + Au delà de sa lecture en tant qu'aide, il faut surtout l'ouvrir en tant que fichier xml. Pour l'affichage de l'aide, seules quelques balises + docbook sont interprétées, ce fichier contient l'ensemble de celles qui le sont.</para> + <para>L'interprétation de ces balises est réalisée par un fichier ftl HelpTemplate.ftl</para> + <para>Il est conseillé de prendre un indentation uniquement de 2 caractères, afin de limiter la largeur du fichier.</para> + <para>&nbsp;</para> + <para>La balise para permet de gérer les paragraphes et, pour l'instant, c'est ce qui permet de gérer les retours à la ligne choisis. + Le nombre d'espace ou les retours à la ligne dans le texte docbook sont ignorés, par exemple une ligne vide entre 2 para dans le fichier docbook + ne génère pas d'espace entre les paragraphes. Quand il est nécessaire de forçer ce comportement, de manière exceptionnelle, il est possible + d'inclure du code html. Par exemple pour générer des espaces ou des retours à la ligne, mais attention lors de la génération de pdf ou selon le + type de transformation en html, <br \>ces éléments apparaitront et ne seront pas interprétés. + <programlisting> + &lt;para>Petit paragraphe&lt;/para> + pour insérer une ligne blanche entre deux paragraphe &lt;para>&amp;nbsp;&lt;/para> + &lt;para>Petit paragraphe avec un retour &amp;lt;br \>à la ligne au milieu&lt;/para> + </programlisting> + </para> + <section> + <title><anchor xml:id="WhatIsSection"/> Qu'est ce qu'une section (H2)</title> + <para>Lorsque l'utilisateur demande l'affichage de l'aide (click sur l'icone) le système recherche le (ou les fichiers) associé(s) et l'affiche + (pour plus de détail sur l'organisation de l'aide lire <link xl:href="showHelp?helpTopic=DOCUMENTATION_SYSTEM">Principes et organisation de la + documentation Apache OFBiz</link>).</para> + <para>La balise title du fichier sera le titre de la page ( H1 en html), et il est possible d'avoir des sous-section (H2), autant qu'on en veut + et avec autant de niveau que voulu (H3, H4, H5, ...), la balise est là pour ça. Dans la balise title, il est possible de mettre une balise + anchor (ancre) pour pouvoir faire un lien (interne ou externe) directement vers cette section </para> + <section> + <title>Sous-section (H3)</title> + <para>et on pourrait continuer ....</para> + </section> + </section> + <section> + <title>Liste d'élément</title> + <section> + <title>Exemple d'une liste numérotée</title> + <para>Il y aura un chiffre en début de chaque ligne.</para> + <orderedlist> + <listitem><para>Premier élément de ma liste</para></listitem> + <listitem><para>Deuxiéme élément</para></listitem> + <listitem><para>Troisiéme ...</para></listitem> + <listitem><para>4 iém ...</para></listitem> + <listitem><para>et ainsi de suite...</para></listitem> + </orderedlist> + </section> + <section> + <title>Exemple de liste à point</title> + <para>Il y aura jutse un signe (un point)au début de chaque ligne.</para> + <itemizedlist> + <listitem><para>Premier élément de ma liste</para></listitem> + <listitem><para>Deuxiéme élément</para></listitem> + <listitem><para>Troisiéme ...</para></listitem> + <listitem><para>4 iém ...</para></listitem> + <listitem><para>et ainsi de suite...</para></listitem> + </itemizedlist> + </section> + </section> + <section> + <title>Exemples de formattage de texte spécifique</title> + <para>Pour le formattage il y a deux notions : + <itemizedlist> + <listitem><para>du formattage en <emphasis role="caution">cours</emphasis> de texte</para></listitem> + <listitem><para>un paragraphe avec un formatage particulier, dans ce cas, il est possible de mettre un titre pour ce paragraphe, mais + ce n'est pas obligatoire. Actuellement, dans tous les cas, ce titre sera de niveau H3</para></listitem> + </itemizedlist> + </para> + <para>Chaque formattage correspond à un style, actuellement 4 ont été défini + <itemizedlist> + <listitem><para>caution : prudence (ou attention mais plus faible que warning)</para></listitem> + <listitem><para>important : comme son nom l'indique</para></listitem> + <listitem><para>note : comme son nom l'indique</para></listitem> + <listitem><para>tip : astuce</para></listitem> + <listitem><para>warning : attention, mais plus fort que caution</para></listitem> + </itemizedlist> + </para> + <caution> + <title>Prudence</title> + <para>Avec le texte qui explique à quoi faire attention, le titre n'est pas obligatoire</para> + </caution> + <important> + <title>Important</title> + <para>Voici le texte qui est important</para> + </important> + <note> + <title>une Note</title> + <para>et voici le texte de la note, il peut inclure des section ou autre</para> + </note> + <tip> + <title>Astuce</title> + <para>Ne pas mettre le titre ou plutot inclure du formattage en cours de texte</para> + </tip> + <warning> + <para>Attention, en voila enfin un sans titre</para> + </warning> + </section> + <section> + <title>Inclusion Possible</title> + <para>Lors de l'affichage d'une aide, en fonction des liens entre éléments de contenu, il est possible d'afficher plusieurs éléments de contenu + <itemizedlist> + <listitem><para>un autre fichier d'aide</para></listitem> + <listitem><para>une image</para></listitem> + <listitem><para>un formulaire (ou un écran) afin de pouvoir voir l'aide de chaque champ</para></listitem> + </itemizedlist> + </para> + <para>Lors de l'affichage de l'aide sur la <link xl:href="showHelp?helpTopic=EXAMPLE_main">page d'accueil</link> du composant example, + 2 fichiers d'aide sont affichés.</para> + <para>Exemple d'affichage d'une image, <emphasis role="caution">Seul le champ fileref est obligoire, mais pour une bonne mise en page, les + champs width et depth sont conseillés</emphasis></para> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="/example/images/MgmtPage.png" width="638" depth="478"/> + </imageobject> + <textobject><phrase>Une page portail type</phrase></textobject> + <caption>Schema d'une page portail type de gestion de recherche et gestion objet métier majeur</caption> + </mediaobject> + </para> + <para>&nbsp;</para> + <para>Afin de permettre à l'utilisateur de pouvoir visualiser l'aide de chaque champ (qui apparait quand la souris est positionné sur le label + du champ), il est intéressant, quelque fois, de faire apparaitre une form dans un texte d'aide. Pour cela, il faut créer un élément de contenu + associé dataresource qui est associé à un screen.xml, avec un dataTemplateTypeId="SCREEN_COMBINED". Il est conseillé de faire un screen + dédié qui n'inclus pas le decorator general.<br \> + Il faut ensuite associer l'élément de contenu avec le même père que l'aide avec lequel le screen doit s'afficher, mais avec un numéro de séquence + supérieur. Voici les données pour l'affichage du screen ci-dessous. + <programlisting> + &lt;DataResource dataResourceId="EXAMPLE_EditForm" objectInfo="component://example/widget/example/ExampleScreens.xml#ExampleEditForm" dataResourceTypeId="URL_RESOURCE" dataTemplateTypeId="SCREEN_COMBINED"/> + &lt;Content contentId="EXAMPLE_EditForm" contentTypeId="DOCUMENT" contentName="Example Fields" dataResourceId="EXAMPLE_EditForm"/> + &lt;ContentAssoc contentId="HELP_EXAMPLE_docbook" contentIdTo="EXAMPLE_EditForm" mapKey="EXAMPLE_docbook" fromDate="2006-01-12 01:01:01" sequenceNum="005" contentAssocTypeId="INSTANCE"/> + </programlisting> + </para> + </section> +</section> + Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help.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" + xmlns="http://docbook.org/ns/docbook"> + <title>The Example Main Help page.</title> + <para>For example, if you want to see how you should do to add some help you can look to help files in data/helpdata directory in example + component and data/ExempleHelpData.xml in content component.</para> + + <section> + <title>Development help sub-subject</title> + <para>To have the complete list you should click on index button and look to example tree option, but here is a list of + main shortcut : + <itemizedlist> + <listitem><para>How is organize <link xl:href="showHelp?helpTopic=DOCUMENTATION_SYSTEM">The Apache OFBiz documentation system</link></para></listitem> + <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_devel">Portlet development Best Practice</link></para></listitem> + <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_docbook">What it's possible to do in help file</link></para></listitem> + </itemizedlist> + </para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help_FR.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help_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 ../../../../applications/content/dtd/docbook.xsd" + xmlns="http://docbook.org/ns/docbook"> + <title>Utilisation des fichiers d'aide du composant Exemple</title> + <para> + Par exemple, si vous voulez voir comment vous pouvez ajouter des textes d'aide, vous pouvez regarder les fichiers contenus dans le + répertoire data/heldata dans le composant Example et dans le fichier contenu dans data/ExempleHelpData.xml au niveau de l'application + content + </para> + + <section> + <title>Sous-menus dans l'aide</title> + <para> + Pour avoir la liste complète, cliquez sur le bouton "Index" et regardez l'arborescence de l'aide. Voici aussi une liste + de raccourcis : + <itemizedlist> + <listitem><para>Comment fonctionne <link xl:href="showHelp?helpTopic=DOCUMENTATION_SYSTEM">le système de documentation d'Apache OFBiz</link></para></listitem> + <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_devel">Les bonnes pratiques de développement avec les portlets</link></para></listitem> + <listitem><para><link xl:href="showHelp?helpTopic=EXAMPLE_docbook">Ce qu'il est possible de faire dans les fichiers d'aide</link></para></listitem> + </itemizedlist> + </para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_help_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile.xml Tue Aug 7 19:23:16 2012 @@ -0,0 +1,90 @@ +<?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 help files</title> + <section> + <title>Several spaces</title> + <para> + The help files are contained in the corresponding component (directory /data/helpdata/). Thus, for the component Example, you can find, for instance, the help file that you are reading right now (as well as every available subject in the help page of the component Example): + <programlisting> + /ofbiz/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile.xml + </programlisting> + </para> + <para> + The configuration of the use of these files in the various help menus is done in the component Content (directory /data/helpdata/) with one file per component. There, you can find the definition of the Contents and DataResource corresponding to the help files defined in the component, in the language configurations, in the browsing tree configurations of the help page, ... + <programlisting> + /ofbiz/applications/content/data/ExampleHelpData.xml + </programlisting> + </para> + </section> + + <section> + <title>The drafting of the help file</title> + <para> + See the help page about docBook and its syntax, as well as the various help files that exists in the component Example (/ofbiz/specialpurpose/example/data/helpdata). + </para> + </section> + + <section> + <title>The help page configuration</title> + <para> + In these configuration files, one content (Content) and one resource (DataResource) are defined for each help file. Here is an example of a definition for the help file specialpurpose/example/data/helpdata/HELP_EXAMPLE_main.xml: + <programlisting> + &lt;DataResource dataResourceId="EXAMPLE_main" localeString="en" dataResourceTypeId="OFBIZ_FILE" + objectInfo="specialpurpose/example/data/helpdata/HELP_EXAMPLE_main.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Main page" mimeTypeId="text/xml" isPublic="Y" /> + &lt;Content contentId="EXAMPLE_main" contentTypeId="DOCUMENT" contentName="Main menu." templateDataResourceId="HELP_TEMPL" dataResourceId="EXAMPLE_main" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> + </programlisting> + + </para> + <para> + The configuration of the tree is done by means of associations ContentAssoc of the kind TREE_CHILD and of the seequenceNum that enables to put the items in order: + <programlisting> + &lt;ContentAssoc contentId="HELP_EXAMPLE" contentIdTo="EXAMPLE_main" contentAssocTypeId="TREE_CHILD" sequenceNum="001"" mapKey="EXAMPLE_main"/> + &lt;ContentAssoc contentId="HELP_EXAMPLE" contentIdTo="EXAMPLE_help" contentAssocTypeId="TREE_CHILD" sequenceNum="002" mapKey="EXAMPLE_docbook"/> + &lt;ContentAssoc contentId="EXAMPLE_help" contentIdTo="EXAMPLE_docbook" contentAssocTypeId="TREE_CHILD" sequenceNum="001" mapKey="EXAMPLE_docbook"/> + &lt;ContentAssoc contentId="EXAMPLE_help" contentIdTo="EXAMPLE_helpfile" contentAssocTypeId="TREE_CHILD" sequenceNum="002" mapKey="EXAMPLE_helpfile"/> + &lt;ContentAssoc contentId="HELP_EXAMPLE" contentIdTo="EXAMPLE_devel" contentAssocTypeId="TREE_CHILD" sequenceNum="003" mapKey="EXAMPLE_docbook"/> + ... + </programlisting> + </para> + <para> + The pages for each language can be associated by using ContentAssoc of the kind ALTERNATE_LOCALE: + <programlisting> + &lt;DataResource dataResourceId="EXAMPLE_main_FR" localeString="fr" dataResourceTypeId="OFBIZ_FILE" + objectInfo="specialpurpose/example/data/helpdata/HELP_EXAMPLE_main_FR.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Accueil" mimeTypeId="text/xml" isPublic="Y" /> + &lt;Content contentId="EXAMPLE_main_FR" contentTypeId="DOCUMENT" contentName="Accueil" templateDataResourceId="HELP_TEMPL" localeString="fr" dataResourceId="EXAMPLE_main_FR" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> + &lt;ContentAssoc contentId="EXAMPLE_main" contentIdTo="EXAMPLE_main_FR" contentAssocTypeId="ALTERNATE_LOCALE" fromDate="2006-01-12 01:01:01"/> + </programlisting> + </para> + </section> + + <section> + <title>Organization of the help files</title> + <para>The Help page is managed by using the component Content's functionality.</para> + <para>The Help page is meant to: + <itemizedlist> + <listitem><para><emphasis role="warning">a component or a sub-component</emphasis>; the access is possible in the browsing tree; the content is associated to the help page root (contentId=HELP_ROOT) with the child type (contentAssocTypeId="TREE_CHILD");</para></listitem> + <listitem><para><emphasis role="warning">a screen</emphasis>; the access is possible thanks to the help icon (on the top right hand corner of most themes); contentId is searched on ContentAssoc.mapKey with + a "helpTopic" value built on the component webSite and the uri used to display this screen ;</para></listitem> + <listitem><para><emphasis role="warning">a portlet</emphasis>; the access is made possible by a link on the Help portalPage (which contains this portlet); the link is a showHelp (as well as for a screen) with the helpTopic value built with "HELP_" and portletId</para></listitem> + <listitem><para><emphasis role="warning">a portal page</emphasis>; the access is made possible thanks to the help icon if the portalPageId is not empty; the content is linked by the portal page and is displayed at the top of the list of the portlets that contain it.</para></listitem> + </itemizedlist> + </para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.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>Utilisation des fichiers d'aide</title> + + <section> + <title>Les différents emplacements</title> + <para> + Les fichiers d'aide sont contenus dans le composant correspondant (répertoire /data/helpdata/). + Ainsi pour le composant Example, on trouve par exemple le fichier d'aide que vous êtes en train de lire (ainsi que tous les sujets accessibles dans l'aide du composant Exemple) : + <programlisting> + /ofbiz/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile.xml + </programlisting> + </para> + <para> + La configuration de l'usage de ces fichiers dans les différents menus d'aide se fait dans le composant Content (répertoire /data/helpdata/) avec un fichier par composant. + On y trouve la défition des Content et DataResource correspondants aux fichiers d'aide définis dans le composant, les configurations de langues, la configuration de l'arbre de navigation de l'aide,... + <programlisting> + /ofbiz/applications/content/data/ExampleHelpData.xml + </programlisting> + </para> + </section> + + <section> + <title>La rédaction du fichier d'aide</title> + <para> + Voir l'aide au sujet de bocBook et sa synthaxe, ainsi que les différents fichiers d'aide existants dans le composant Example (/ofbiz/specialpurpose/example/data/helpdata). + </para> + </section> + + <section> + <title>La configuration de l'aide</title> + <para> + Dans ces fichiers de configuration, on définit pour chaque fichier d'aide, un contenu (Content) et une ressource (DataResource). + Voici un exemple de définition pour le fichier d'aide specialpurpose/example/data/helpdata/HELP_EXAMPLE_main.xml : + <programlisting> + &lt;DataResource dataResourceId="EXAMPLE_main" localeString="en" dataResourceTypeId="OFBIZ_FILE" + objectInfo="specialpurpose/example/data/helpdata/HELP_EXAMPLE_main.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Main page" mimeTypeId="text/xml" isPublic="Y" /> + &lt;Content contentId="EXAMPLE_main" contentTypeId="DOCUMENT" contentName="Main menu." templateDataResourceId="HELP_TEMPL" dataResourceId="EXAMPLE_main" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> + </programlisting> + <important> + <title>Bien renseigner les labels</title> + <para>Ils sont utilisés comme labels dans l'arbre de navigation de l'aide (principalement "contentName").</para> + </important> + </para> + <para> + On configure l'arborescence de l'aide au moyen d'associations ContentAssoc de type TREE_CHILD et du seequenceNum qui permet d'ordonner les items : + <programlisting> + &lt;ContentAssoc contentId="HELP_EXAMPLE" contentIdTo="EXAMPLE_main" contentAssocTypeId="TREE_CHILD" sequenceNum="001"" mapKey="EXAMPLE_main"/> + &lt;ContentAssoc contentId="HELP_EXAMPLE" contentIdTo="EXAMPLE_help" contentAssocTypeId="TREE_CHILD" sequenceNum="002" mapKey="EXAMPLE_docbook"/> + &lt;ContentAssoc contentId="EXAMPLE_help" contentIdTo="EXAMPLE_docbook" contentAssocTypeId="TREE_CHILD" sequenceNum="001" mapKey="EXAMPLE_docbook"/> + &lt;ContentAssoc contentId="EXAMPLE_help" contentIdTo="EXAMPLE_helpfile" contentAssocTypeId="TREE_CHILD" sequenceNum="002" mapKey="EXAMPLE_helpfile"/> + &lt;ContentAssoc contentId="HELP_EXAMPLE" contentIdTo="EXAMPLE_devel" contentAssocTypeId="TREE_CHILD" sequenceNum="003" mapKey="EXAMPLE_docbook"/> + ... + </programlisting> + </para> + <para> + On peut asssocier les pages pour chaque langue au moyen de ContentAssoc de type ALTERNATE_LOCALE : + <programlisting> + &lt;DataResource dataResourceId="EXAMPLE_main_FR" localeString="fr" dataResourceTypeId="OFBIZ_FILE" + objectInfo="specialpurpose/example/data/helpdata/HELP_EXAMPLE_main_FR.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Accueil" mimeTypeId="text/xml" isPublic="Y" /> + &lt;Content contentId="EXAMPLE_main_FR" contentTypeId="DOCUMENT" contentName="Accueil" templateDataResourceId="HELP_TEMPL" localeString="fr" dataResourceId="EXAMPLE_main_FR" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> + &lt;ContentAssoc contentId="EXAMPLE_main" contentIdTo="EXAMPLE_main_FR" contentAssocTypeId="ALTERNATE_LOCALE" fromDate="2006-01-12 01:01:01"/> + </programlisting> + </para> + </section> + + <section> + <title>Organisation des fichiers d'aides</title> + <para>L'aide utilise la gestion de contenu du composant Content.</para> + <para>A qui se destinent les fichiers d'aide : + <itemizedlist> + <listitem><para><emphasis role="warning">à un composant ou sous-composant</emphasis>, l'accès est possible dans l'arbre de navigation, le contenu est associé + à la racine de l'aide (contentId=HELP_ROOT) avec le type enfant (contentAssocTypeId="TREE_CHILD");</para></listitem> + <listitem><para><emphasis role="warning">à un écran</emphasis>, l'accès est possible grâce à l'icone d'aide (en haut à droite sur la plupart des thèmes), le contentId est recherché sur ContentAssoc.mapKey + avec une valeur "helpTopic" batie sur le webSite du composant et l'URI utilisée pour afficher le screen ;</para></listitem> + <listitem><para><emphasis role="warning">à une portlet</emphasis>, l'accés est possible par lien avec la page portail d'aide (qui contient cette portlet), le lien est un showHelp (comme + pour un screen) avec la valeur "helpTopic" batit avec "HELP_" et le portletId</para></listitem> + <listitem><para><emphasis role="warning">à une page portail</emphasis>, l'accès est possible grâce à l'icone d'aide si le portalPageId est renseigné, le contenu est lié par la page portail + et est affiché en haut de la liste des portlets la contenant.</para></listitem> + </itemizedlist> + </para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Modified: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main.xml?rev=1370454&r1=1370453&r2=1370454&view=diff ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main.xml (original) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main.xml Tue Aug 7 19:23:16 2012 @@ -15,11 +15,11 @@ 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" + xsi:schemaLocation="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"> <title>The Example Main page.</title> - <para><link xl:href="showHelp?helpTopic=EXAMPLE">About the Example application</link></para> - <para> + <para>What is the component example? how to use it? what it's goal?... for all these questions refer to the help index in the Sample In this page, you can create or search an example </para> + <para><link xl:href="showHelp?helpTopic=HELP_EXAMPLE">About the Example application</link></para> </section> Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main_FR.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main_FR.xml Tue Aug 7 19:23:16 2012 @@ -0,0 +1,26 @@ +<?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 d'accueil du composant Example</title> + <para>A quoi sert le composant exemple? comment l'utiliser ? quel est son objectif? ... pour toutes ces questions reportez vous à l'index de l'aide dans la rubrique Exemple</para> + <para><link xl:href="showHelp?helpTopic=HELP_EXAMPLE">A propos du composant Example</link></para> + <para> + + </para> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_main_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages.xml Tue Aug 7 19:23:16 2012 @@ -0,0 +1,60 @@ +<?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 PortalPage usage.</title> + <para>In this page, you can create or search an example</para> + <para>A portal page is composed of one or more portlets organized around columns and sequencing</para> + + <para>Below is a PortalPage configuration example : + <programlisting> + &lt;PortalPage portalPageId="ExampleMgmt" sequenceNum="200" parentPortalPageId="EXAMPLE" + portalPageName="Example management" description="Search, list, navigation menu, edit area" ownerUserLoginId="_NA_"/> + &lt;PortalPageColumn portalPageId="ExampleMgmt" columnSeqId="00001" columnWidthPercentage="25"/> + &lt;PortalPagePortlet portalPageId="ExampleMgmt" portalPortletId="FindExample" portletSeqId="00001" columnSeqId="00001" sequenceNum="1"/> + &lt;PortalPagePortlet portalPageId="ExampleMgmt" portalPortletId="ExampleDetailsMenu" portletSeqId="00001" columnSeqId="00001" sequenceNum="10"/> + &lt;PortalPageColumn portalPageId="ExampleMgmt" columnSeqId="00002"/> + &lt;PortalPagePortlet portalPageId="ExampleMgmt" portalPortletId="ListExample" portletSeqId="00001" columnSeqId="00002" sequenceNum="20"/> + &lt;PortalPagePortlet portalPageId="ExampleMgmt" portalPortletId="ExampleDetail" portletSeqId="00001" columnSeqId="00002" sequenceNum="30"/> + </programlisting> + </para> + + <para>To ensure the quality of this portal page, it is important to think about translations (CommonPortalEntityLabels.xml) : + <programlisting> + &lt;property key="PortalPage.portalPageName.ExampleMgmt"> + &lt;value xml:lang="en">Examples management &lt;/value> + &lt;value xml:lang="fr">Gestion des exemples &lt;/value> + &lt;/property> + </programlisting> + </para> + + <section> + <title>Portal Page Type</title> + <para>The notion of "portal page - type" exists only in terms of good practices. You can organize the content of your pages portals + as you wish, but three pages type are found in most components. During the creation of + portal page for a new component, it is advisable to start with these three types pages</para> + <para>To have the complete list you should click on index button and look to example tree option, but here is a list of + main shortcut : + <itemizedlist> + <listitem><para><link xl:href="showHelp?helpTopic=HELP_PPAGE_MGMT">Management pages</link></para></listitem> + <listitem><para><link xl:href="showHelp?helpTopic=HELP_PPAGE_RECAP">Recap (Summary) pages</link></para></listitem> + <listitem><para><link xl:href="showHelp?helpTopic=HELP_PPAGE_NEW">Creation pages</link></para></listitem> + </itemizedlist> + </para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml?rev=1370454&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml Tue Aug 7 19:23:16 2012 @@ -0,0 +1,61 @@ +<?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 pages portail</title> + <para> + Une page portail est composée d'une ou plusieurs portlets organisées autour de colonnes et d'un séquençage + </para> + + <para>Et voici un exemple de configuration de page portail : + <programlisting> + &lt;PortalPage portalPageId="ExampleMgmt" sequenceNum="200" parentPortalPageId="EXAMPLE" + portalPageName="Example management" description="Search, list, navigation menu, edit area" ownerUserLoginId="_NA_"/> + &lt;PortalPageColumn portalPageId="ExampleMgmt" columnSeqId="00001" columnWidthPercentage="25"/> + &lt;PortalPagePortlet portalPageId="ExampleMgmt" portalPortletId="FindExample" portletSeqId="00001" columnSeqId="00001" sequenceNum="1"/> + &lt;PortalPagePortlet portalPageId="ExampleMgmt" portalPortletId="ExampleDetailsMenu" portletSeqId="00001" columnSeqId="00001" sequenceNum="10"/> + &lt;PortalPageColumn portalPageId="ExampleMgmt" columnSeqId="00002"/> + &lt;PortalPagePortlet portalPageId="ExampleMgmt" portalPortletId="ListExample" portletSeqId="00001" columnSeqId="00002" sequenceNum="20"/> + &lt;PortalPagePortlet portalPageId="ExampleMgmt" portalPortletId="ExampleDetail" portletSeqId="00001" columnSeqId="00002" sequenceNum="30"/> + </programlisting> + </para> + + <para>Pour garantir la qualité de cette page portail, il est important de penser aux traductions (CommonPortalEntityLabels.xml) : + <programlisting> + &lt;property key="PortalPage.portalPageName.ExampleMgmt"> + &lt;value xml:lang="en">Examples management &lt;/value> + &lt;value xml:lang="fr">Gestion des exemples &lt;/value> + &lt;/property> + </programlisting> + </para> + + <section> + <title>Les Pages Portails Types</title> + <para> La notion de page portail type n'existe que au niveau des bonnes pratiques. Vous pouvez agencer le contenu de vos pages portails + comme vous le souhaitez, mais nous avons déterminé 3 pages type que l'on rencontre dans la plupart des composants. Lors de la création de + page portail pour un nouveau composant, il est conseillé de commencer par ces trois pages type + <itemizedlist> + <listitem><para><link xl:href="showHelp?helpTopic=HELP_PPAGE_MGMT">Les pages de gestion d'entité majeure</link> (Gestion des acteurs, gestion des commandes,...)</para></listitem> + <listitem><para><link xl:href="showHelp?helpTopic=HELP_PPAGE_RECAP">Les pages de résumé,</link> qui regroupent une sélection de portelts autour d'une entité majeure (rôles, groupes, coordonnées d'un acteur ; + lignes d'une commande, informations d'expédition de la commande,...)</para></listitem> + <listitem><para><link xl:href="showHelp?helpTopic=HELP_PPAGE_NEW">Les pages de création</link> d'entité majeure, avec enchainement d'actions mineures après création</para></listitem> + </itemizedlist> + </para> + <para>Pour avoir la liste complète, passer par l'index.</para> + </section> +</section> Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/specialpurpose/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |