ofbiz-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From er...@apache.org
Subject svn commit: r1075324 - in /ofbiz/trunk: applications/content/data/ExampleHelpData.xml framework/example/data/helpdata/HELP_EXAMPLE.xml framework/example/data/helpdata/HELP_EXAMPLE_FR.xml framework/example/data/helpdata/HELP_EXAMPLE_main.xml
Date Mon, 28 Feb 2011 13:45:02 GMT
Author: erwan
Date: Mon Feb 28 13:45:02 2011
New Revision: 1075324

URL: http://svn.apache.org/viewvc?rev=1075324&view=rev
Log:
More improvements on help, adding more descriptions and a French page

Added:
    ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_FR.xml   (with props)
Modified:
    ofbiz/trunk/applications/content/data/ExampleHelpData.xml
    ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE.xml
    ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_main.xml

Modified: ofbiz/trunk/applications/content/data/ExampleHelpData.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/data/ExampleHelpData.xml?rev=1075324&r1=1075323&r2=1075324&view=diff
==============================================================================
--- ofbiz/trunk/applications/content/data/ExampleHelpData.xml (original)
+++ ofbiz/trunk/applications/content/data/ExampleHelpData.xml Mon Feb 28 13:45:02 2011
@@ -25,10 +25,17 @@
         dataResourceId="HELP_EXAMPLE" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
     <ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_EXAMPLE" contentAssocTypeId="TREE_CHILD"
fromDate="2006-01-12 01:01:01" sequenceNum="000"/>
 
+    <DataResource dataResourceId="HELP_EXAMPLE_FR" localeString="fr" dataResourceTypeId="OFBIZ_FILE"
dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/xml" isPublic="Y" 
+        objectInfo="framework/example/data/helpdata/HELP_EXAMPLE_FR.xml" 
+        dataResourceName="Exemple pour le développement" />
+    <Content contentId="HELP_EXAMPLE_FR"  dataResourceId="HELP_EXAMPLE_FR" contentName="Exemple
pour le développement" localeString="fr" contentTypeId="DOCUMENT" templateDataResourceId="HELP_TEMPL"
statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
+    <ContentAssoc contentId="HELP_EXAMPLE" contentIdTo="HELP_EXAMPLE_FR" contentAssocTypeId="ALTERNATE_LOCALE"
fromDate="2006-01-12 01:01:01"/>
+
     <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="Example help main page" mimeTypeId="text/xml"
isPublic="Y" />
     <Content contentId="EXAMPLE_main" contentTypeId="DOCUMENT" contentName="Example main
menu." templateDataResourceId="HELP_TEMPL" dataResourceId="EXAMPLE_main" statusId="CTNT_IN_PROGRESS"
mimeTypeId="text/html"/>
-    <ContentAssoc contentId="HELP_EXAMPLE" contentIdTo="EXAMPLE_main" contentAssocTypeId="TREE_CHILD"
fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="EXAMPLE_main"/>
+    <ContentAssoc contentId="HELP_EXAMPLE" contentIdTo="EXAMPLE_main" mapKey="EXAMPLE_main"
fromDate="2006-01-12 01:01:01" contentAssocTypeId="TREE_CHILD" sequenceNum="000"/>
+    <ContentAssoc contentId="HELP_EXAMPLE" contentIdTo="EXAMPLE_main" mapKey="EXAMPLE_FindExample"
fromDate="2006-01-12 01:01:02" sequenceNum="000" contentAssocTypeId="INSTANCE"/>
 
     <DataResource dataResourceId="EXAMPLE_docbook" localeString="en" dataResourceTypeId="OFBIZ_FILE"

         objectInfo="framework/example/data/helpdata/HELP_EXAMPLE_docbook.xml" dataTemplateTypeId="NONE"
statusId="CTNT_IN_PROGRESS" dataResourceName="Example docBook usage" mimeTypeId="text/xml"
isPublic="Y" />

Modified: ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE.xml?rev=1075324&r1=1075323&r2=1075324&view=diff
==============================================================================
--- ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE.xml (original)
+++ ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE.xml Mon Feb 28 13:45:02 2011
@@ -17,8 +17,39 @@ License.
     version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
     xsi:schemaLocation="http://docbook.org/ns/docbook ../../../../applications/content/dtd/docbook.xsd"
     xmlns="http://docbook.org/ns/docbook">
-    <title>The Example Main Help page.</title>
-    <para>
-        The Example application will allow you to discover the possibilities to create an
application, with a lot of search boxes, lists and many more.
+  <title>The Example Main Help page.</title>
+  <para>
+    The Example application will allow you to discover the possibilities to create an application,
with a lot of search boxes, lists and many more.</para>
+  <para>This application could be used to have an example of the bests practices in
user interface development in Apache - OFBiz.</para>
+  <para>Look help for each example screen, help will explain which part of development
is used in this case.</para>
+  <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>Help file organization</title>
+    <para>Help is managed by using content component functionality.</para>
+    <para>Help can be for :
+      <itemizedlist>
+        <listitem><para>one component or sub-component, access is possible by
navigation in help index tree and select it, contentId is associated to
+          HELP_ROOT with contentAssocTypeId="TREE_CHILD" ;</para></listitem>
+        <listitem><para>one screen, access is done by help icon in screen (most
of time on top), contentId is search on ContentAssoc.mapKey with 
+          a value (helpTopic) build with component webSite and uri used to show this screen
;</para></listitem>
+        <listitem><para>one portlet, access is done by a link on the portalPages
(which contain this portlet) help, link is a showHelp (like 
+          for a screen) with helpTopic build with "HELP_" and portletId</para></listitem>
+       <listitem><para>one portal page, access is done by help icon if parameters.portalPageId
is not empty, contentId is read on PortalPage
+          (or originalPortalPage if exist) and is show on top of portlet list contain on
it.</para></listitem>
+      </itemizedlist>
     </para>
+  </section>
+
+  <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_docbook">What
it's possible to do in help file</link></para></listitem>
+      </itemizedlist>
+    </para>
+  </section>
 </section>

Added: ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_FR.xml?rev=1075324&view=auto
==============================================================================
--- ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_FR.xml (added)
+++ ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_FR.xml Mon Feb 28 13:45:02 2011
@@ -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 ../../../../applications/content/dtd/docbook.xsd"
+    xmlns="http://docbook.org/ns/docbook">
+    <title>Page principale de l'aide du composant Exemple</title>
+    <para>
+      L'application exemple vous permet de découvrir les possibilités pour créer
une application contenant, entre autres, des
+      boîtes de recherche, des listes et beaucoup d'autres choses.
+    </para>
+    <para>
+      Cette application peut être utilisée pour avoir un aperçu des bonnes pratiques
d'interface utilisateur pour OFBiz.</para>
+    <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><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/trunk/framework/example/data/helpdata/HELP_EXAMPLE_FR.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_FR.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_FR.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Modified: ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_main.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_main.xml?rev=1075324&r1=1075323&r2=1075324&view=diff
==============================================================================
--- ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_main.xml (original)
+++ ofbiz/trunk/framework/example/data/helpdata/HELP_EXAMPLE_main.xml Mon Feb 28 13:45:02
2011
@@ -18,7 +18,8 @@ License.
     xsi:schemaLocation="http://docbook.org/ns/docbook ../../../../applications/content/dtd/docbook.xsd"
     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>
         In this page, you can create or search an example
     </para>
-</section>
\ No newline at end of file
+</section>



Mime
View raw message