svn commit: r1307605 [4/9] - in /ofbiz/branches/20120329_portl
Locked
svn commit: r1307605 [4/9] - in /ofbiz/branches/20120329_portl
 
|
Modified: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_docbook.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_docbook.xml?rev=1307605&r1=1307604&r2=1307605&view=diff ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_docbook.xml (original) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_docbook.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_docbook_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_EXAMPLE_help.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help_FR.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help_FR.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_EXAMPLE_help_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_help_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile.xml Fri Mar 30 20:52:17 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/framework/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/framework/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 framework/example/data/helpdata/HELP_EXAMPLE_main.xml: + <programlisting> + &lt;DataResource dataResourceId="EXAMPLE_main" localeString="en" dataResourceTypeId="OFBIZ_FILE" + objectInfo="framework/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="framework/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/framework/example/data/helpdata/HELP_EXAMPLE_helpfile.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml Fri Mar 30 20:52:17 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/framework/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/framework/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 framework/example/data/helpdata/HELP_EXAMPLE_main.xml : + <programlisting> + &lt;DataResource dataResourceId="EXAMPLE_main" localeString="en" dataResourceTypeId="OFBIZ_FILE" + objectInfo="framework/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="framework/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/framework/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_helpfile_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Modified: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_main.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_main.xml?rev=1307605&r1=1307604&r2=1307605&view=diff ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_main.xml (original) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_main.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_EXAMPLE_main_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_main_FR.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_main_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_main_FR.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_EXAMPLE_main_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_main_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_main_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_EXAMPLE_pages.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_pages_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_EXAMPLE_portlets.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_EXAMPLE_portlets_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_Empty.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty_FR.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty_FR.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_Empty_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_Empty_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_PPAGE_MGMT.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_MGMT_FR.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_NEW.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_NEW.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_NEW.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_NEW.xml Fri Mar 30 20:52:17 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/framework/example/data/helpdata/HELP_PPAGE_NEW.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_NEW.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_NEW.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_NEW_FR.xml URL: http://svn.apache.org/viewvc/ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_NEW_FR.xml?rev=1307605&view=auto ============================================================================== --- ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_NEW_FR.xml (added) +++ ofbiz/branches/20120329_portletWidget/framework/example/data/helpdata/HELP_PPAGE_NEW_FR.xml Fri Mar 30 20:52:17 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> |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |