You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by jl...@apache.org on 2009/10/18 12:43:28 UTC

svn commit: r826406 - in /ofbiz/trunk/applications: content/data/helpdata/ humanres/data/ humanres/data/helpdata/ humanres/documents/

Author: jleroux
Date: Sun Oct 18 10:43:27 2009
New Revision: 826406

URL: http://svn.apache.org/viewvc?rev=826406&view=rev
Log:
Help data for Human resources. Work in progress : Introduction, Main page and Training
Training page done from Simranjeet Singh's "Trng Write Up.txt" file and comments in https://issues.apache.org/jira/browse/OFBIZ-2531
I used Oxygen DocBook editor and notably itemizedlist and orderedlist but it's not rendered in OFBiz help (all the contents under these tags are hidden).
Also when using help button in HR application it does not open the corresponding help pages. I'm obviously missing something here but I run out of time.

Added:
    ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_FR.xml
    ofbiz/trunk/applications/humanres/data/HumanResHelpData.xml
    ofbiz/trunk/applications/humanres/data/helpdata/
    ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES.xml
    ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES_main.xml
    ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES_training.xml
    ofbiz/trunk/applications/humanres/documents/
    ofbiz/trunk/applications/humanres/documents/Humanres.xml

Added: ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_FR.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_FR.xml?rev=826406&view=auto
==============================================================================
--- ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_FR.xml (added)
+++ ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_FR.xml Sun Oct 18 10:43:27 2009
@@ -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 ../../../content/dtd/docbook.xsd"
+    xmlns="http://docbook.org/ns/docbook">
+    <title>Bienvenue dans l'aide Apache OFBiz</title>
+    <section>
+        <para>Si vous êtes arrivés sur cette page sans sélectionner la page d'index,
+             c'est qu'il n'y a pas de page d'aide spécifique pour cette catégorie.
+        </para>
+    </section>
+    <section>
+        <para>
+            Cette fenêtre permet d'avoir une aide sur les différents composants de l'application Apache OFBiz.
+        </para>
+        <para>
+            L'aide est en cours de traduction. Toutes les contributions sont les bienvenues !
+        </para>
+    </section>
+</section>
+

Added: ofbiz/trunk/applications/humanres/data/HumanResHelpData.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/humanres/data/HumanResHelpData.xml?rev=826406&view=auto
==============================================================================
--- ofbiz/trunk/applications/humanres/data/HumanResHelpData.xml (added)
+++ ofbiz/trunk/applications/humanres/data/HumanResHelpData.xml Sun Oct 18 10:43:27 2009
@@ -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.
+-->
+<entity-engine-xml>
+    <DataResource dataResourceId="HELP_HUMANRES" localeString="en" dataResourceTypeId="OFBIZ_FILE" 
+        objectInfo="applications/humanres/data/helpdata/HELP_HUMANRES.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
+        dataResourceName="Human Resources Overview" mimeTypeId="text/xml" isPublic="Y" />
+    <Content contentId="HELP_HUMANRES" contentTypeId="DOCUMENT" contentName="Human Resources Overview" templateDataResourceId="HELP_TEMPL" 
+        dataResourceId="HELP_HUMANRES" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>/>
+    <ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_HUMANRES" contentAssocTypeId="TREE_CHILD" fromDate="2009-10-18 01:01:01" sequenceNum="000"/>
+
+    <DataResource dataResourceId="HUMANRES_main" localeString="en" dataResourceTypeId="OFBIZ_FILE" 
+        objectInfo="applications/humanres/data/helpdata/HELP_HUMANRES_main.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Human Resources Main Help" mimeTypeId="text/xml" isPublic="Y" />
+    <Content contentId="HUMANRES_main" contentTypeId="DOCUMENT" contentName="Human Resources Main." templateDataResourceId="HELP_TEMPL" dataResourceId="HUMANRES_main" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>/>
+    <ContentAssoc contentId="HELP_HUMANRES" contentIdTo="HUMANRES_main" contentAssocTypeId="TREE_CHILD" fromDate="2009-10-18 01:01:01" sequenceNum="000" mapKey="HUMANRES_main"/>
+    
+    <!-- training -->    
+    <DataResource dataResourceId="HUMANRES_training" localeString="en" dataResourceTypeId="OFBIZ_FILE" 
+      objectInfo="applications/humanres/data/helpdata/HELP_HUMANRES_training.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Human Resources Training Help" mimeTypeId="text/xml" isPublic="Y" />
+  <Content contentId="HUMANRES_training" contentTypeId="DOCUMENT" contentName="Training." templateDataResourceId="HELP_TEMPL" dataResourceId="HUMANRES_training" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>/>
+  <ContentAssoc contentId="HELP_HUMANRES" contentIdTo="HUMANRES_training" contentAssocTypeId="TREE_CHILD" fromDate="2009-10-18 01:01:01" sequenceNum="000" mapKey="HUMANRES_training"/>
+    
+</entity-engine-xml>

Added: ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES.xml?rev=826406&view=auto
==============================================================================
--- ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES.xml (added)
+++ ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES.xml Sun Oct 18 10:43:27 2009
@@ -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 ../../../content/dtd/docbook.xsd"
+  xmlns="http://docbook.org/ns/docbook">
+  <title>Human Resources Introduction</title>
+  <para>WIP, to be continued...</para>
+</section>

Added: ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES_main.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES_main.xml?rev=826406&view=auto
==============================================================================
--- ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES_main.xml (added)
+++ ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES_main.xml Sun Oct 18 10:43:27 2009
@@ -0,0 +1,27 @@
+<?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 ../../../content/dtd/docbook.xsd"
+  xmlns="http://docbook.org/ns/docbook">
+  <title>The Human Resources Main screen.</title>
+  <para> This is the default tab for the Human Resources Manager application. WIP, to be
+    continued...</para>
+</section>

Added: ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES_training.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES_training.xml?rev=826406&view=auto
==============================================================================
--- ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES_training.xml (added)
+++ ofbiz/trunk/applications/humanres/data/helpdata/HELP_HUMANRES_training.xml Sun Oct 18 10:43:27 2009
@@ -0,0 +1,128 @@
+<?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 ../../../content/dtd/docbook.xsd"
+  xmlns="http://docbook.org/ns/docbook">
+  <title>Simple Howto for the moment, work in progress...</title>
+  <para>Introduction: Trainings in HR module includes Training Calendar where we can create new
+    schedules from trainings available in an organization. Admin can assign trainings &amp;
+    employee can request for scheduled trainings. Employee can also check status of their training
+    requests &amp; assignments. </para>
+  <para/>
+  <para>Need of Trainings in HR: </para>
+  <para>
+    <itemizedlist>
+      <listitem>
+        <para>Training and development of professionals fills up the skill gaps and further improve
+          the levels of proficiency. </para>
+      </listitem>
+      <listitem>
+        <para>Training and development manages constantly changing business and industrial scenario
+          and therefore, matches with the requirements or demands of changes on the organizations.
+        </para>
+      </listitem>
+      <listitem>
+        <para>Creates a learning organization culture.</para>
+      </listitem>
+    </itemizedlist>
+  </para>
+  <para>Organizational development: </para>
+  <para>
+    <itemizedlist>
+      <listitem>
+        <para>Organization decides to use certain initiatives and wants to train and develop a good
+          number of people in the entire organization or the people in certain chosen departments or
+          projects on those initiatives. </para>
+      </listitem>
+      <listitem>
+        <para>Prepares the organization to meet the needs of legal/statutory requirements. Features
+          of Trainings: </para>
+      </listitem>
+      <listitem>
+        <para>New Trainings can be added/modified. </para>
+      </listitem>
+      <listitem>
+        <para>Trainings can be scheduled in the calendar. </para>
+      </listitem>
+      <listitem>
+        <para>Employees can apply to supervisor for available scheduled trainings but, cannot
+          request same training event again to same approver </para>
+      </listitem>
+      <listitem>
+        <para>Admin can assign trainings to Employees. </para>
+      </listitem>
+      <listitem>
+        <para>Admin can approve/reject the trainings requested to him but, once rejected cannot be
+          approved again. </para>
+      </listitem>
+      <listitem>
+        <para>Employees can check the status of their training requests and Trainings assigned to
+          them. </para>
+        <para/>
+      </listitem>
+    </itemizedlist>
+  </para>
+  <para>Road Ahead: Currently we have implemented Trainings under HR module. We are working on the
+    implementation of Training calendar in profile tab of Employee. We are also planning to
+    introduce trainer's information in training calendar.</para>
+  <para/>
+  <section>
+    <para>In "GlobalHRSetting" </para>
+    <orderedlist>
+      <listitem>
+        <para>Admin can create &amp; manage the trainings provided by the organization. </para>
+      </listitem>
+    </orderedlist>
+  </section>
+  <section>
+    <para>In "Training Calendar" </para>
+    <para>
+      <orderedlist>
+        <listitem>
+          <para>Admin can schedule a training through training calender. </para>
+        </listitem>
+        <listitem>
+          <para>Admin can assign training to an employee(right half of calendar screen). </para>
+        </listitem>
+        <listitem>
+          <para> Employee with his login can request for Training to admin from the calendar.
+          </para>
+        </listitem>
+        <listitem>
+          <para> Employee cannot request same training event again to same approver. </para>
+        </listitem>
+      </orderedlist>
+    </para>
+  </section>
+  <section>
+    <para>In "Training Approval" tab (in case of Employee login tab name would be "Training
+      Status")</para>
+    <para>
+      <orderedlist>
+        <listitem>
+          <para>Admin can approve/reject the training requested to him </para>
+        </listitem>
+        <listitem>
+          <para>Admin can not change the training status once it is rejected. </para>
+        </listitem>
+        <listitem>
+          <para>Employee can check status of requested and assigned trainings. </para>
+        </listitem>
+      </orderedlist>
+    </para>
+  </section>
+</section>

Added: ofbiz/trunk/applications/humanres/documents/Humanres.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/humanres/documents/Humanres.xml?rev=826406&view=auto
==============================================================================
--- ofbiz/trunk/applications/humanres/documents/Humanres.xml (added)
+++ ofbiz/trunk/applications/humanres/documents/Humanres.xml Sun Oct 18 10:43:27 2009
@@ -0,0 +1,50 @@
+<?xml version="1.0"?>
+<!--
+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.
+-->
+<chapter 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 ../../content/dtd/docbook.xsd"
+    xmlns="http://docbook.org/ns/docbook">
+    <title>The Human Resource Application.</title>
+  <para>
+    The human resource application is supporting you to ...WIP, to be completed...
+  </para>
+  
+  <section>
+    <title>Human resource in Apache OFBiz, an overview.</title>
+    <para>
+      WIP, to be completed...
+    </para>
+    
+  </section>
+   
+    <!--xi:include href="../data/helpdata/HELP_HUMANRES.xml" />
+    <xi:include href="../data/helpdata/HELP_HUMANRES_main.xml" />
+    <xi:include href="../data/helpdata/HELP_HUMANRES_employees.xml" />
+    <xi:include href="../data/helpdata/HELP_HUMANRES_employees_positions.xml" />
+    <xi:include href="../data/helpdata/HELP_HUMANRES_performance_review.xml" />
+    <xi:include href="../data/helpdata/HELP_HUMANRES_skills.xml" />
+    <xi:include href="../data/helpdata/HELP_HUMANRES_recruitment.xml" /-->
+    <xi:include href="../data/helpdata/HELP_HUMANRES_training.xml" />
+    <!--xi:include href="../data/helpdata/HELP_HUMANRES_employment_applications.xml" />
+    <xi:include href="../data/helpdata/HELP_HUMANRES_resumes.xml" />
+    <xi:include href="../data/helpdata/HELP_HUMANRES_leave.xml" />
+    <xi:include href="../data/helpdata/HELP_HUMANRES_global_HR_settings.xml" /-->
+</chapter>