This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 8d80909c9022a7240c721398f4acb697c338dd86
Author: holivier <holiv...@apache.org>
AuthorDate: Mon Feb 24 18:51:02 2020 +0100
Documented : Migrate Help to asciidoc and include in hr-intro.adoc
(OFBIZ-10256)
remove all related Help file in docbook format
---
applications/humanres/data/helpdata/HELP_HR.xml | 65 -------------------
.../humanres/data/helpdata/HELP_HR_main.xml | 75 ----------------------
.../src/docs/asciidoc/_include/HELP-hr-main.adoc | 46 +++++++++++++
.../src/docs/asciidoc/_include/hr-intro.adoc | 68 ++++++++++----------
4 files changed, 81 insertions(+), 173 deletions(-)
diff --git a/applications/humanres/data/helpdata/HELP_HR.xml
b/applications/humanres/data/helpdata/HELP_HR.xml
deleted file mode 100644
index c280a1f..0000000
--- a/applications/humanres/data/helpdata/HELP_HR.xml
+++ /dev/null
@@ -1,65 +0,0 @@
-<?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>The people who work for your company, are its most important asset.
- They are human capital. Selecting a software platform that increases the
- value of your company's human capital and delivers benefits, services and
- opportunities to your workforce, is critical to your company's success
- .</para>
-
- <para>The platform must be able to accurately and reliability process
- worker transactions, collect decision support information, and communicate
- between management, workers and outside resources.</para>
-
- <para> The OFBiz Human Resource Application (HR App) can provide a backbone
for
- building that platform.</para>
-
- <para>In this section we introduce you to the organization of this
- guide and to the key business objects that are the core to Human
Resources.</para>
-
- <para>In the Human Resources Application you can:</para>
-
- <itemizedlist>
- <listitem>
- <para>Create positions</para>
- </listitem>
-
- <listitem>
- <para>Fulfill positions</para>
- </listitem>
-
- <listitem>
- <para>Define the responsibilities of a position</para>
- </listitem>
-
- <listitem>
- <para>Define a tree reporting structure between positions</para>
- </listitem>
-
- <listitem>
- <para>Track the positions fulfillments over time</para>
- </listitem>
- </itemizedlist>
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_main.xml
b/applications/humanres/data/helpdata/HELP_HR_main.xml
deleted file mode 100644
index 276abf3..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_main.xml
+++ /dev/null
@@ -1,75 +0,0 @@
-<?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>The Main window is the entry point into the Human Resources
Application and displays the
- Company tree view for navigating to the main menu items.</para>
-
- <para> This screen will display the organizational setup of your Company.
The top level Company is defined in a system setup file:
general.properties.</para>
- <para>
- The system will also list any divisions or departments that have been
setup with the role "Internal organization" as defined in the party
relationships
- as a "Group member". </para>
-
- <para>The number of organizational levels can be as many as required.</para>
-
- <section>
- <title> Nodes In the Company Tree</title>
-
- <para>There are three node types in the tree, each identified by a
- different icon. The top of the tree represents your Company, the highest
- level in the organization. The Company and departments under the
- Company can have sub departments or positions. Under positions are
- the people who fulfill the position.</para>
- </section>
-
- <section>
- <title>Usage</title>
-
- <itemizedlist>
- <listitem>
- <para>Navigate the organization to view departments, positions and
- people</para>
- </listitem>
-
- <listitem>
- <para>Add or remove a department</para>
- </listitem>
-
- <listitem>
- <para>Add a person</para>
- </listitem>
-
- <listitem>
- <para>Quickly open the profile of any item in the tree</para>
- </listitem>
-
- <listitem>
- <para>If the item is a position you can add a person to fulfill the
- position</para>
- </listitem>
- </itemizedlist>
- </section>
-
-</section>
diff --git a/applications/humanres/src/docs/asciidoc/_include/HELP-hr-main.adoc
b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-main.adoc
new file mode 100644
index 0000000..31db91f
--- /dev/null
+++ b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-main.adoc
@@ -0,0 +1,46 @@
+////
+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.
+////
+
+= The Human Resources Main screen.
+The Main window is the entry point into the Human Resources Application and
displays the Company tree view for navigating
+ to the main menu items.
+
+This screen will display the organizational setup of your Company. +
+The top level Company is defined in a system setup file: general.properties.
+
+The system will also list any divisions or departments that have been setup
with the role "Internal organization"
+ as defined in the party relationships as a "Group member".
+
+The number of organizational levels can be as many as required.
+
+== Nodes In the Company Tree
+There are three node types in the tree, each identified by a different icon.
+
+* The top of the tree represents your Company, the highest level in the
organization.
+* The Company and departments under the Company can have sub departments or
positions.
+* Under positions are the people who fulfill the position.
+
+== Usage
+Contextual menu is with right-clic
+
+* Navigate the organization to view departments, positions and people
+* Add or remove a department
+* Add a person
+* Quickly open the profile of any item in the tree
+* If the item is a position you can add a person to fulfill the position
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc
b/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc
index 11b4e15..ae1b39a 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc
@@ -18,45 +18,47 @@ under the License.
////
= About Human Resources
-The people who work for your company are human capital and are its most
important
-asset. Selecting a software platform that increases the value of your
companies human
-capital and delivers benefits, services and opportunities to your workforce,
is
-critical to your companies success.
-That platform must be able to accurately and reliability process worker
transactions,
-collect decision support information, and communicate between management,
workers
-and outside resources.
-
-The OFBiz Human Resource application (HR App) can provide a stable foundation
for
+The people who work for your company are human capital and are its most
important
+asset. Selecting a software platform that increases the value of your
companies human
+capital and delivers benefits, services and opportunities to your workforce, is
+critical to your companies success.
+That platform must be able to accurately and reliability process worker
transactions,
+collect decision support information, and communicate between management,
workers
+and outside resources.
+
+The OFBiz Human Resource application (HR App) can provide a stable foundation
for
building that platform.
+include::HELP-hr-main.adoc[leveloffset=+1]
+
= Human Resources Processes
-Human Resources Management can be divided into several distinct processes.
+Human Resources Management can be divided into several distinct processes.
* Job Planning and Definition
* Recruitment
-* Candidate Selection and Hiring
+* Candidate Selection and Hiring
* Employee Training and Development
* Employee Evaluation and Performance Management
-* Employee Salary and Benefits
+* Employee Salary and Benefits
-== Job Planning and Definition
+== Job Planning and Definition
Generally job positions are authorised by a budget and fulfilled by people. The
- person fulfilling the position may be a permanent employee, a temporary
employee
-or a contractor.
+ person fulfilling the position may be a permanent employee, a temporary
employee
+or a contractor.
-* Positions may be salary or hourly, fulltime or part time.
+* Positions may be salary or hourly, fulltime or part time.
* Positions have responsibilities.
* Positions are defined by a type of work.
-For example there may be 20 job positions in an organization for a
administrative
-clerk. Each position is has a job definition and is authorised by a budget
request
-from a department in the organization.
-A position can be unfulfilled. (i.e a it exists but no one is currently
employed
-to do it).
-In some cases a position could also be considered a full-time equivalent (FTE)
and
-can be assigned to more than one person (e.g. job sharing)
+For example there may be 20 job positions in an organization for a
administrative
+clerk. Each position is has a job definition and is authorised by a budget
request
+from a department in the organization.
+A position can be unfulfilled. (i.e a it exists but no one is currently
employed
+to do it).
+In some cases a position could also be considered a full-time equivalent (FTE)
and
+can be assigned to more than one person (e.g. job sharing)
In the OFBiz Human Resources application you can:
@@ -69,25 +71,25 @@ In the OFBiz Human Resources application you can:
== Recruitment, Candidate Selection and Hiring
Recruitment is about at attracting applicants that match the skills and
experience
- you are looking for in a particular job position. Candidates can apply and
after
-reviewing their details, those who are the best match in terms of
qualifications
+ you are looking for in a particular job position. Candidates can apply and
after
+reviewing their details, those who are the best match in terms of
qualifications
and experience are short listed for interview. The final step is deciding upon
the
- final candidate that you want to hire and the employment contract details
that
+ final candidate that you want to hire and the employment contract details that
are related to that.
-In the OFBiz Human Resouces application you can:
+In the OFBiz Human Resouces application you can:
* Create a Requisition for new job positions
* Create Internal Job Postings
-* Apply for job positions
+* Apply for job positions
* Review Resumes / CVs
* Arrange and Grade Interviews
== Employee Training and Development
Training and professional development is important for an organisation because
it
-ensures that your employees have the knowledge they need to perform their
work.
-It can also help to fill any gaps in skills and improve their proficiency.
+ensures that your employees have the knowledge they need to perform their work.
+It can also help to fill any gaps in skills and improve their proficiency.
In the OFBiz Human Resources application you can:
@@ -100,7 +102,7 @@ In the OFBiz Human Resources application you can:
Evaluating and managing the performance of employees is another main Human
Resources
function. Performance reviews can be created for an employee and used to
evaluate
-the work that they have done in a particular job position. Comments and
ratings
+the work that they have done in a particular job position. Comments and ratings
can also be added.
In the OFBiz Human Resources application you can:
@@ -114,8 +116,8 @@ to another job position, or can be given other benefits
such as a salary increas
== Employee Salary and Benefits Administration
-Being able to manage employee salaries and associated benefits is a key part
of
-any Human Resources system.
+Being able to manage employee salaries and associated benefits is a key part of
+any Human Resources system.
In the OFBiz Human Resources application you can:
