svn commit: r1847248 [2/3] - in /ofbiz/ofbiz-framework/branche
Locked
svn commit: r1847248 [2/3] - in /ofbiz/ofbiz-framework/branche
 
|
Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc Fri Nov 23 12:00:10 2018 @@ -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. +//// += Leave + +Generally each of your employees will be allowed to take a certain amount of +time off work on an annual basis. This time-off work can be called leave, +holiday or vacation. The amount and type of leave they can take may depend on +their job position or how long they have worked for you. + +You may also allow your employees special leave such as days off when they are +ill (sick leave), time off during pregnacy or birth of a child (maternity or +paternity leave) or time off to attend a funeral (bereavement leave). + +OFBiz allows you to setup a range of different leave types and categories to +cover many situations. + +In all cases the employee will need to request the date (or dates) they would +like to take as leave. Next the manager of the employee will need to approve the + leave request. Once approved the employee can then take the leave. + +In the OFBiz Human Resources application: + +* Employees can schedule or a leave request +* Managers can create leave requests on behalf of an employee +* Managers can approve, reject or delete employee leave requests + +NOTE: Users with Human Resource Approver permission can only approve a leave +request. To update or delete a leave request, you will need to have Human +Resources Administration permission. + Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-performance-review.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-performance-review.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-performance-review.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-performance-review.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,39 @@ +//// +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. +//// += Performance Review + +Performance review allows employees to post reviews that can be used by management +in evaluating the performance of the individual employee. + +The employee's position is also captured with the review which allows the creation +of reports that look at ratings for a review item by position. + +*Performance Review Item* + +Each review has a list of items that can be rated and commented on. + +NOTE: Performance review item can be created or deleted but can not be changed. + +In the OFBiz Human Resources application you can: + +* Create performance review +* Search performance review +* Update performance review +* Add performance review item +* Delete performance review item Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-performance-review.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-performance-review.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-performance-review.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,35 @@ +//// +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. +//// += Qualifications + +Qualifications are a feature of the recruitment process that allows you to record + the details of any qualifications held by job applicants or your existing +employees. + +During the job application process, you may want to ensure that applicants have +a minimum set of qualifications as a requirement for a position. The details of +the qualifications for each applicant will need to be captured and if necessary, +verified. + +For existing employees, details of qualifications during their employment with +your organisation can be added at any time. + +In the case where qualifications expire if not renewed, you can also add an +expiry or renewal date. + Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,49 @@ +//// +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. +//// += Recruitment + +Recruitment is an important function in any organisation. It is a set of processes +that allow you to specify, search for candidates to fulfill the roles that you +have available. + +When you have a job position that needs to be fulfilled, you can create a Job +Requisition. The job requisition identifies the skills, qualifications, experience +and also the number of resources needed for a position. + +NOTE: Currently the default assumption is that the Job Requisition is for an +Internal Job posting + +Once the requisition is created, you can then create Job Posting based on the +requisition. For example if the requisition was for three (3) roles then three +job postings can be created (each with different application deadlines) one to +fulfill each of the positions. + +People can then apply for the positions and send in their CVs or Resumes. You +can track the progress of the the application and also create details about +various types of job interviews needed (e.g. HR, Panel, Case Study + /Practical Test etc) and link it to the requisition. + +You can also track the status of people who have applied for a position. + +In the OFBiz Human Resource application you can + +* Approve or reject job applications +* Manage and book job interviews +* Record the result of job interviews + Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,33 @@ +//// +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. +//// += Resumes + +Resumes or Curriculum Vitae (CVs) are documents that job applicants use to apply + for job positions. These documents summarise the applicant's experience, +qualifications, contact information and details about why they are suitable for + a particular job position. + +In OFBiz you can enter a resume as a document and then link it to a person. +Each resume entry has a unique identifier (that currently needs to be manually +entered!). This identifier links a person to an instance of their resume. + +NOTE: The OFBiz Content Manager application is used for the linking of resumes +because it was designed for managing, storing and retrieving electronic data in +varying formats - such as text, images, MS Word, PDF or even web URL's. + Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,108 @@ +//// +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. +//// += Security + +OFBiz has a security model that controls access to all aspects of teh system at +a very detailed level. This means that it is possible to manage what each user +has access to and what actions they can perform. + +NOTE: Security can be so fine grained to the lowest level such as a view, or the +creation, update or deletion of a single item of information + +This section covers the security permissions that inlcuded as part of the Human +Resources application and how an administrator can assign permissions to users +using the Party Manager application. + +NOTE: A person may have one or more OFBiz login id's. Each login id can be +assigned to it's own set of Security Groups. This means that the id a user logs +in with determines what applications the person can work in and what work can be + done in the application. + +== Human Resource Permissions + +In OFBiz a Security Group is collection of permissions that allow a members of + the group to use the application and any resources. The Human Resources +application has three special security groups that can be assigned Human +Resources users. There are also other general administrative security groups +that let managers and administrators work in the application. + +You can use the Party Manager application to add users to one or more Security +Groups. + + +The three special HR App Security Groups are named by role: + +* Employee Role - This is mandatory to be able to logon into the Human Resources +application. This is true even if user has the the other Human Resources Approver + and Administration Roles. The employee role has the most restrictions on what a +user may view and the actions they can take. + +* Approver Role - The Approver role gives members of the group the ability to +approve, training and employee leave requests. The approver has all of the +permissions included in the Employee Role and can also view and update some +additional screens that are not available to the Employee role. + +* Administrator Role - The Human Resources Administrator Role has permission to +do most things in the Human Resources application. They are allowed full access +to view, create, update and delete throughout the Human Resources application. +Please see the note below for the additional permissions required to be able to +do everything in Human Resources. + +NOTE: A person with the Human Administrator Role must also belong to the +following Security Groups (Work Effort User, My Portal Employee, My Portal +Customer or Scrum Team) to be able to add Training classes in the Training +feature. + + +== General OFBiz Permissions + +Some OFBiz users (from the demo data) may not have any of the Human Resource +permissions but can still access the Human Resouces application to be able to + perform general operations. These include: + +* Business Admin has permission for all operations in the Human Resources +application +* Flexible Admin has permission to create, update, delete and view operations +in Human Resources +* Full Admin has permission for all operations in Human Resources +* Super has permission for all operations in the Human Resources +* Viewadmin has permission for viewing details in Human Resources + +== Security Administration In Party Manager + +A user must be granted permission to use the Human Resources application. This +section describes how to do this using OFBiz Party Manager. It assumes the user +has a user login and Party administration privileges. + +Please do the following to grant permissions + +1. Login to the Party application +2. User the search functionality to locate the user that you want to give Human +Resources permissions to +3. When the search results are displayed, click on the Party ID column +4. In the User Name(s) screenlet click the Security Groups button for the User +Login that will receive Human Resources permissions +5. In the Add User Login to Security Group screenlet select the HUMANRES_EMPLOYEE. +from the Group drop-down-list. +6. Click the Add button to use the current date for the From Date or enter dates +for From Date and Thru Date as needed then click Add +7. If the person is to be allowed to approve Training add the HUMANRES_APPROVER +permission. As in the previous step enter dates as required +8. If the person is to be allowed all access then add the HUMANRES_ADMIN +permission... As in the previous steps enter dates as required. Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,45 @@ +//// +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. +//// += Skills + +Skills are the basic foundation of any Human Resources function as it is a key +factor in identifying the suitability of someone to perform a specific task or +job. They can often be divided into two types; general and specific, and are +characterised by things such as years of experience, rating or level of +expertise. + +In OFBiz basic skills can be defined in Global HR Settings and then linked to +actual individuals via the Skills menu option. + +In the recruitment process, skills are specified as part of the job requisition +for an employee (or job) position. This helps ensure that the recruiter can focus +on finding applicants with the relevant skillset. + +Your employees can also gain new skills as part of their employment and so OFBiz + allows you to record and track their newly acquired skills. It may be that +rather than start a new recruitment process, you may be able to find someone +with the right skills from your existing employees. + + +In the OFBiz Human Resources application you can + +* Assign or link skills to job applicants (i.e. non employees) +* Assign or link skills to existing employees +* Search for existing employees that have the required skills for a job + Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,73 @@ +//// +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. +//// += Training + +[#Introduction] +Introduction:: +Training and professional development is important for an organisation because it +can help to fill any gaps in skills and improve the proficiency of the existing +workforce. +The training section of the HR module includes a Training Calendar where new +training classes or events can be scheduled for an organisation. +Users that have HR administration permissions can create, assign and approve +training classes. All other users can view the list of classes available, their +training status and any requests they have made to enroll for training. + +[#HR Trainiing Process Flow] +General Process Flow:: +* Training classes are created in the Global HR Training Class Type screen +* Training classes are scheduled and added to the training calendar +* Employees can create a request to attend a training +* The employee supervisor needs to approve or reject the employee training request +* Employees can check the status of the training requests + +Training Calendar:: +The main screen in the Training feature is the Training Calendar. This is where +you add classes and class participants. You can navigate the calendar by clicking +the navigation text for day, week and month views located in the calendar title bar. + +Add New Training Event:: +Training classes are created in the Training Calendar by clicking the Add New text +command located in each calendar day cell. This action opens a small window above +the calendar to enter the training class details. + +NOTE: If you try to create a class and do not have correct User permissions, you +will get an error. After a class is created a numeric class identifier and text +identifier description appear in the calendar for the day of the class. + +Request Training / Add a Training Participant :: +Participants can be added to a class by clicking on the class identifier. If you +are the creator of the class the Participants window above and to the right of the + calendar opens. You can add participants by entering their party id and clicking + the Add button. The list of participants is displayed and updated. +After a new participant is added to a training class or event, they are given the +default status âAssignedâ. + +Approve Training:: +To approve a request for training, tor training administrator navigates to the +Training Approvals screen and locates all requests with a status of "Assigned". +They look up the person listed as the approver party. After checking with the +approver they click update button to open the approval screen. In the approval +screen the administrator sets the Approver Status and adds a reason for the +decision. The user can see the status of their training schedule by clicking on +the Training Status menu. + +WARNING: Something isnât working correctly in 16.11. The there is no update +button to click to approve a participant for training. + Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/humanres.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/humanres.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/humanres.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/humanres.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,52 @@ +//// +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. +//// += Human Resources + +The OFBiz Human Resources system is one of the core application components and has +all of the functionality you need to manage your business employees as well as the +recruitment process. It is well integrated with other components especially +Accounting to manage Payroll and any specific employee agreements. + +include::_include/hr-intro.adoc[leveloffset=+1] + +include::_include/hr-employee-positions.adoc[leveloffset=+1] + +include::_include/hr-employees.adoc[leveloffset=+1] + +include::_include/hr-employments.adoc[leveloffset=+1] + +include::_include/hr-performance-review.adoc[leveloffset=+1] + +include::_include/hr-qualifications.adoc[leveloffset=+1] + +include::_include/hr-recruitment.adoc[leveloffset=+1] + +include::_include/hr-skills.adoc[leveloffset=+1] + +include::_include/hr-resumes.adoc[leveloffset=+1] + +include::_include/hr-training.adoc[leveloffset=+1] + +include::_include/hr-leave.adoc[leveloffset=+1] + +include::_include/hr-security.adoc[leveloffset=+1] + +include::_include/hr-global-settings.adoc[leveloffset=+1] + +include::_include/hr-glossary.adoc[leveloffset=+1] Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/humanres.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/humanres.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/humanres.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Modified: ofbiz/ofbiz-framework/branches/release17.12/build.gradle URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/build.gradle?rev=1847248&r1=1847247&r2=1847248&view=diff ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/build.gradle (original) +++ ofbiz/ofbiz-framework/branches/release17.12/build.gradle Fri Nov 23 12:00:10 2018 @@ -18,6 +18,7 @@ */ import at.bxm.gradleplugins.svntools.tasks.SvnCheckout import org.apache.tools.ant.filters.ReplaceTokens +import org.asciidoctor.gradle.AsciidoctorTask /* ======================================================== * Project setup @@ -27,13 +28,16 @@ buildscript { jcenter() } dependencies { - classpath "at.bxm.gradleplugins:gradle-svntools-plugin:latest.release" + classpath 'at.bxm.gradleplugins:gradle-svntools-plugin:latest.release' + classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.9.2' + classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.16' } } apply plugin: 'java' apply plugin: 'eclipse' apply plugin: 'maven-publish' apply plugin: "at.bxm.svntools" +apply plugin: 'org.asciidoctor.convert' apply from: 'common.gradle' @@ -142,7 +146,7 @@ dependencies { compile 'org.apache.xmlgraphics:fop:2.2' compile 'org.apache.xmlrpc:xmlrpc-client:3.1.3' compile 'org.apache.xmlrpc:xmlrpc-server:3.1.3' - compile 'org.codehaus.groovy:groovy-all:2.4.13' + compile 'org.codehaus.groovy:groovy-all:2.4.13' // Remember to change the version number in javadoc.options block compile 'org.freemarker:freemarker:2.3.28' // Remember to change the version number in FreeMarkerWorker class when upgrading compile 'org.hamcrest:hamcrest-all:1.3' compile 'org.owasp.esapi:esapi:2.1.0.1' @@ -317,6 +321,7 @@ if (project.hasProperty('enableOwasp')) // ========== Task group labels ========== def cleanupGroup = 'Cleaning' +def docsGroup = 'Documentation' def ofbizServer = 'OFBiz Server' def ofbizPlugin = 'OFBiz Plugin' def sysadminGroup = 'System Administration' @@ -488,6 +493,93 @@ task createTenant(group: ofbizServer, de } } +// ========== Documentation tasks ========== +tasks.withType(AsciidoctorTask) { task -> + // bug workaround - see OFBIZ-9873 + if (os.contains('windows')) { + backends 'html5' + } else { + backends 'html5', 'pdf' + } + attributes \ + 'doctype': 'book', + 'experimental': '', + 'icons': 'font', + 'sectnums': '', + 'chapter-label': '', + 'toc': '', + 'toclevels': '5' +} + +task deleteOfbizDocumentation { + doFirst { delete "${buildDir}/asciidoc/ofbiz" } +} + +task deletePluginDocumentation { + def activeComponents = [] + iterateOverActiveComponents { component -> + activeComponents.add(component.name) + } + doFirst { + if (!project.hasProperty('pluginId')) { + throw new GradleException('Missing property \"pluginId\"') + } + if(!activeComponents.contains(pluginId)) { + throw new GradleException("Could not find plugin with id ${pluginId}") + } + delete "${buildDir}/asciidoc/plugins/${pluginId}" + } +} + +task deleteAllPluginsDocumentation { + doFirst { delete "${buildDir}/asciidoc/plugins" } +} + + +task generateOfbizDocumentation(group: docsGroup, type: AsciidoctorTask) { + dependsOn deleteOfbizDocumentation + description 'Generate OFBiz documentation manuals' + sourceDir "${rootDir}/docs/asciidoc" + outputDir file("${buildDir}/asciidoc/ofbiz") +} + +task generatePluginDocumentation(group: docsGroup) { + dependsOn deletePluginDocumentation + description 'Generate plugin documentation. Expects pluginId flag' + iterateOverActiveComponents { component -> + if (project.hasProperty('pluginId') && component.name == pluginId) { + def pluginAsciidoc = task "${component.name}Documentation" (type: AsciidoctorTask) { + sourceDir file("${component}/src/docs/asciidoc") + outputDir file("${buildDir}/asciidoc/plugins/${component.name}") + mustRunAfter deletePluginDocumentation + } + dependsOn pluginAsciidoc + } + } +} + +task generateAllPluginsDocumentation(group: docsGroup, + description: 'Generate all plugins documentation.') { + + dependsOn deleteAllPluginsDocumentation + file("${pluginsDir}").eachDir { plugin -> + iterateOverActiveComponents { component -> + if (component.name == plugin.name) { + if (subprojectExists(":plugins:${plugin.name}")) { + def pluginAsciidoc = task "${component.name}-Documentation" (type: AsciidoctorTask) { + sourceDir file("${component}/src/docs/asciidoc") + outputDir file("${buildDir}/asciidoc/plugins/${component.name}") + doLast { println "Documentation generated for plugin ${component.name}" } + mustRunAfter deleteAllPluginsDocumentation + } + dependsOn pluginAsciidoc + } + } + } + } +} + + // ========== System Administration tasks ========== task createTestReports(group: sysadminGroup, description: 'Generate HTML reports from junit XML output') { doLast { Added: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/developer-manual.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/developer-manual.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/developer-manual.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/developer-manual.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,274 @@ +//// +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. +//// += Apache OFBiz Developer Manual +The Apache OFBiz Project +Release 17.12 +:imagesdir: ./images +ifdef::backend-pdf[] +:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] +:source-highlighter: rouge +endif::[] + +== Introduction + +Welcome to the Apache OFBiz developer manual. This manual provides information +to help with customizing and developing OFBiz. If you are new to OFBiz and +interested in learning how to use it, you may want to start with the "Apache +OFBiz User Manual". + +OFBiz is a large system composed of multiple subsystems. This manual attempts +to introduce the overall architecture and high level concepts, followed by a +detailed description of each subsystem. In addition, the manual will cover +topics necessary for developers including the development environment, APIs, +deployment, security, and so on. + +=== Main systems + +OFBiz at its core is a collection of systems: + +- A web server (Apache Tomcat) +- A web MVC framework for routing and handling requests. +- An entity engine to define, load and manipulate data. +- A service engine to define and control business logic. +- A widget system to draw and interact with a user interface. + +On top of the above mentioned core systems, OFBiz provides: + +- A data model shared across most businesses defining things like orders, + invoices, general ledgers, customers and so on. +- A library of services that operate on the above mentioned data model such as + "createBillingAccount" or "updateInvoice" and so on. +- A collection of applications that provide a user interface to allow users to + interact with the system. These applications usually operate on the existing + data model and service library. Examples include the "Accounting Manager" and + "Order Manager". +- A collection of optional applications called "plugins" that extend basic + functionality and is the main way to add custom logic to OFBiz. + +=== Components + +The basic unit in OFBiz is called "component". A component is at a minimum a +folder with a file inside of it called "ofbiz-component.xml" + +Every application in OFBiz is a component. For example, the order manager is a +component, the accounting manager is also a component, and so on. + +By convention, OFBiz components have the following main directory structure: + +[source] +-- +component-name-here/ +âââ config/ - Properties and translation labels (i18n) +âââ data/ - XML data to load into the database +âââ entitydef/ - Defined database entities +âââ groovyScripts/ - A collection of scripts written in Groovy +âââ minilang/ - A collection of scripts written in minilang (deprecated) +âââ ofbiz-component.xml - The OFBiz main component configuration file +âââ servicedef - Defined services. +âââ src/ + âââ docs/ - component documentation source + âââ main/java/ - java source code + âââ test/java/ - java unit-tests +âââ testdef - Defined integration-tests +âââ webapp - One or more Java webapps including the control servlet +âââ widget - Screens, forms, menus and other widgets +-- + +It is apparent from the above directory structure that each OFBiz component is +in fact a full application as it contains entities, data, services, user +interface, routing, tests, and business logic. + +Both core OFBiz applications as well as plugins are nothing more than components. +The only difference is that core applications reside in the "applications" folder +whereas plugins reside in the "plugins" folder; also OFBiz does not ship with +plugins by default. + +=== Example workflow + +Many basic concepts were explained so far. An example would help in putting +all of these concepts together to understand the bigger picture. Let us take +an example where a user opens a web browser and enters a certain URL and hits +the enter key. What happens? It turns out answering this question is not quite +simple because lots of things occur the moment the user hits "enter". + +To try to explain what happens, take a look at the below diagram. Do not worry +if it is not fully understandable, we will go through most of it in our example. + +image::ofbiz-architecture.png[] + +==== User enters URL + +In the first step in our example, the user enters the following URL: + +https://localhost:8443/accounting/control/findInvoices + +If we break down this URL, we identify the following parts: + +- localhost: Name of the server in which OFBiz is running +- 8443: Default https port for OFBiz +- accounting: web application name. A web application is something + which is defined _inside_ a component +- control: Tells OFBiz to transfer routing to the control servlet +- findInvoices: request name inside the control servlet + +==== Control servlet takes over + +The Java Servlet Container (tomcat) re-routes incoming requests through web.xml +to a special OFBiz servlet called the control servlet. The control servlet for +each OFBiz component is defined in controller.xml under the webapp folder. + +The main configuration for routing happens in controller.xml. The purpose of +this file is to map requests to responses. + +===== Request Map + +A request in the control servlet might contain the following information: + +- Define communication protocol (http or https) as well as whether + authentication is required. +- Fire up an event which could be either a piece of code (like a script) or a + service. +- Define a response to the request. A response could either be another request + or a view map. + +So in this example, the findInvoices request is mapped to a findInvoices view. + +===== View Map + +A view map maps a view name to a certain view-type and a certain location. + +View types can be one of: + +- screen: A screen widget which translates to normal HTML. +- screenfop: A PDF screen designed with Apache FOP based constructs. +- screencsv: A comma separated value output report. +- screenxml: An XML document. +- simple-content; A special MIME content type (like binary files). +- ftl: An HTML document generated directly from a FreeMarker template. +- screenxls: An Excel spreadsheet. + +In the findInvoices example, the view-map type is a normal screen which is +mapped to the screen: +component://accounting/widget/InvoiceScreens.xml#FindInvoices + +==== Widget rendered + +Once the screen location is identified and retrieved from the previous step, +the OFBiz widget system starts to translate the XML definition of the screen +to actual HTML output. + +A screen is a collection of many different things and can include: + +- Other screens +- Decorator screens +- Conditional logic for hiding / showing parts of the screen +- data preparation directives in the <action> tag +- Forms +- Menus +- Trees +- Platform specific code (like FreeMarker for HTML output) +- Others (portals, images labels etc ...) + +Continuing the example, the FindInvoices screen contains many details including +two forms. One form is for entering invoice search fields and the other form +displays search results. + +== Web Framework + +include::../../framework/webapp/src/docs/asciidoc/webapp.adoc[leveloffset=+1] + +=== Control Servlet + +==== Requests + +==== Views + +== Entity Engine + +=== Entities + +==== Standard Entities + +==== View Entities + +==== Extended Entities + +==== Dynamic View Entities + +=== XML Data + +=== Entity engine configuration + +=== Supported databases + +== Service Engine + +=== Declaration and Implementation + +=== Supported languages + +=== Transaction management + +=== Web services + +== Widget System + +=== Screen Widget + +==== Decoration Pattern + +=== Form Widget + +=== Menu Widget + +=== Tree Widget + +=== Portal Widget + +=== Platform Specific Code + +== Core APIs + +== Development environment + +=== Setup your environment + +==== Java SE + +==== IDE + +===== Eclipse + +===== Intellij Idea + +==== Database + +=== Web tools + +== Testing + +=== Unit Tests + +=== Integration Tests + +== Deployment + +include::../../framework/security/src/docs/asciidoc/security.adoc[leveloffset=+1] + +== Appendices Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/developer-manual.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/developer-manual.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/developer-manual.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/documentation_guidelines.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/documentation_guidelines.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/documentation_guidelines.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/documentation_guidelines.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,627 @@ +//// +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. +//// += Apache OFBiz Documentation Guidelines +The Apache OFBiz Project +Release 17.12 +:imagesdir: ./images +ifdef::backend-pdf[] +:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] +:source-highlighter: rouge +endif::[] + +== Intro + +These guidelines serve as a general style guide and collection of examples of how we are documenting the project. +This is intentionally not a complete user manual, but lists the subset of functionality and formatting options we +would like to use. + +For further reference and more examples see + +* Official Asciidoc User Guide +footnote:[http://asciidoc.org/userguide.html] +* Asciidoc Writers Guide +footnote:[https://asciidoctor.org/docs/asciidoc-writers-guide/]. +* Asciidoc Quick Reference +footnote:[https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/] +* Asciidoc Recommended Practices +footnote:[https://asciidoctor.org/docs/asciidoc-recommended-practices/] + +If you would like to help out with the documentation of the project, please see the following wiki page +footnote:[https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Documentation+Team] for further information and +how we are organised. + +== General rules + +=== Document configuration + +Documents that will be published as standalone guides (e.g. developer manual, user manual) should contain common configuration +so that the output will be generated in exactly the same way for all documents. + +[NOTE] +This is not necessary for documents that will only be included as part of parent documents. In this case the documents will inherit the +configuration from the parent. + +Please see below for details of the proposed configuration: + +---- +The Apache OFBiz Project // <1> +Release 17.12 // <2> +:imagesdir: ./images // <3> +ifdef::backend-pdf[] // <4> +:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] // <5> +:source-highlighter: rouge // <6> +endif::[] // <7> +---- +<1> author +<2> target release, indicates the release for which this documentation is valid +<3> global definition of the image directory +<4> begin block of configurations only for pdf rendering +<5> define the title logo image +<6> use the Rouge source code highlighter +<7> end block of configurations only for PDF rendering + +The following configuration options are set globally in the Gradle build file. +They are not configured in the document itself and are listed for reference only: + +.build.gradle +---- +'doctype': 'book', // <1> +'experimental': '', // <2> +'icons': 'font', // <3> +'sectnums': '', // <4> +'chapter-label': '', // <5> +'toc': '', // <6> +'toclevels': '5' // <7> +---- +<1> doctype book +<2> allow experimental features like keyboard shortcuts +<3> make font awesome icons available +<4> number chapters and sections automatically +<5> do not prefix the chapters +<6> insert a table of contents +<7> max levels to show in the table of contents + +=== Apache License Header + +Each .adoc file must contain the Apache license header (put between "//// license... ////"). You can just copy the +following block: +---- +//// +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. +//// +---- + +=== File name conventions + +We will be implementing a consistent naming convention for the documentation content files. +Filenames should be in lower case with the extension `.adoc`. + +Each guide will be named after the component / module name (e.g. humanres.adoc, accounting.adoc, manufacturing.adoc, +party.adoc etc). +Lower level files that are in the include directory will include a prefix/shortname indicating the component name, +separated by dashes (e.g `hr-intro.adoc`, `hr-glossary.adoc`, etc.) +Similar pages will have consistent naming. We will have several intro, glossary, FAQ, settings, security pages, +so the naming format will be ([shortname]-intro, [shortname]-glossary, [shortname]-faq, [shortname]-settings, +[shortname]-security etc.) + +.For Human Resources this will be as follows: +[example] +==== + humanres.adoc + |- hr-intro.adoc + |- hr-employee-evaluations.adoc + |- hr-glossary.adoc + |- hr-employee-positions.adoc + |- hr-employees.adoc + |- hr-employments.adoc + |- hr-performance-review.adoc + |- hr-positions.adoc + |- hr-qualifications.adoc + |- hr-recruitment.adoc + |- hr-skills.adoc + |- hr-resumes.adoc + |- hr-training.adoc + |- hr-leave.adoc + |- hr-security.adoc + |- hr-global-settings.adoc +==== + + +=== General formatting + +* It is recommended to write one sentence per line and/or manually break the line after approximately 80 to 120 characters. +* Section titles will use asymmetric atx style + + (e.g. `== This is an example of an Asymmetric Section Title`) +* When including another file using the `include` directive, please ensure that there is a blank line between each + include line. + + +== Text formatting + +=== Quoted Text + +Words and phrases can be formatted by enclosing inline text with quote characters: + +.Emphasized text + +Word phrases enclosed in 'single quote characters' (acute accents) or _underline characters_ are emphasized. + +.Strong text +Word phrases *enclosed in asterisk characters* are rendered in a strong font (usually bold). + +.Monospaced text +Word phrases +enclosed in plus characters+ are rendered in a monospaced font. +Word phrases `enclosed in backtick characters` (grave accents) are also rendered in a monospaced font but in this case +the enclosed text is rendered literally and is not subject to further expansion (see inline literal passthrough). + +.âSingle quoted textâ +Phrases enclosed with a `single grave accent to the left and a single acute accent to the right' are rendered in single +quotation marks. + +.âDouble quoted textâ +Phrases enclosed with ``two grave accents to the left and two acute accents to the right'' are rendered in quotation marks. + +.Unquoted text +Placing #hashes around text# does nothing, it is a mechanism to allow inline attributes to be applied to otherwise unformatted text. + + +=== Paragraphs + +You can indicate special information with an eye catching symbol. Please don't overuse this (less is more). + +---- +[TIP] +This is a tip or idea. +---- + +[TIP] +This is a tip or idea. + +You can also have multiple lines and empty lines inside the paragraph using a whitespace and a plus sign: + +---- +[TIP] +This is a tip or idea. + +This is another idea. + + + +More ideas... +---- + +[TIP] +This is a tip or idea. + +This is another idea. + + + +More ideas... + +---- +[NOTE] +This is an information note. +---- + +[NOTE] +This is an information note. + +---- +[IMPORTANT] +This indicates important information. +---- + +[IMPORTANT] +This indicates important information. + +---- +[WARNING] +This is a warning or something to pay attention to. +---- + +[WARNING] +This is a warning or something to pay attention to. + +---- +[CAUTION] +This is something you should treat with caution. +---- + +[CAUTION] +This is something you should treat with caution. + +---- +[normal] +This is a Normal paragraph. +---- + +[normal] +This is a Normal paragraph. + +---- +[literal] +This is a Literal paragraph. +---- + +[literal] +This is a Literal paragraph. + +---- +[quote] +This is a Quote paragraph. +---- + +[quote] +This is a Quote paragraph. + +---- +[listing] +This is a Listing paragraph. +---- + +[listing] +This is a Listing paragraph. + +---- +[abstract] +This is an Abstract paragraph. +---- + +[abstract] +This is an Abstract paragraph. + +---- +[comment] +This is a Comment paragraph. It does not show up in the rendered text ;-) +---- + +[comment] +This is a Comment paragraph. It does not show up in the rendered text ;-) + +---- +[example] +This is a Example paragraph. +---- + +[example] +This is a Example paragraph. + +---- +[sidebar] +This is a Sidebar paragraph. +---- +[sidebar] +This is a Sidebar paragraph. + +---- +[source] +This is a Source paragraph. See Code formatting for further examples. +---- + +[source] +This is a Source paragraph. See Code formatting for further examples. + +.This indicates a simple description headline +This is the text for the simple description headline + +.This indicates an example inside a block +==== +Just a simple block example. +==== + + +== Code formatting + +Asciidoc and the used highlighter provide support for code syntax highlighting of several programming languages +and formats. The following are examples for code which is widely used within OFBiz. + +.Java source code formatting + [source,java] + ---- + public class Foo { + public String bar; + public String bar() { + return bar; + } + } + ---- + +Renders to + +[source,java] +---- +public class Foo { + public String bar; + + public String bar() { + return bar; + } +} +---- + +.Java source code formatting (numbered) +[source,java,numbered] +---- +public class Foo { + public String bar; + + public String bar() { + return bar; + } +} +---- + +.Java source code formatting (with explanation callouts) +[source,java] +---- +public class Foo { + public String bar; # <1> + + public String bar() { + return bar; # <2> + } +} +---- +<1> Declares the `bar` field +<2> Returns the `bar` value + + +.Groovy +[source,groovy] +---- +selected = UtilHttp.parseMultiFormData(parameters) +selected.each { row -> + payment = from("Payment").where("paymentId", row.paymentId).queryOne() + if (payment) { + payments.add(payment) + } +} +context.payments = payments +---- + + +.XML document +[source,xml] +---- +<author id="1"> + <personname> + <firstname>Lazarus</firstname> + <surname>het Draeke</surname> + </personname> +</author> +---- + +.Cascading Stylesheet (CSS) +[source,css] +---- +body { + background: transparent url(/images/ofbiz_logo.png) no-repeat scroll left top; + color: #000; + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: .75em; + line-height: 1.5em; + padding: 50px 0 0; + bgcolor: #ffffcc; +} +---- + +.Javascript +[source,javascript] +---- +function msg(){ + alert("Hello OFBiz"); +} +---- + +.JSON +[source,json] +---- +{ + "id": 1, + "name": "A green door", + "price": 12.50, + "tags": ["home", "green"] +} +---- + +.Properties files +[source,properties] +---- +foo = bar +---- + +.SQL +[source,sql] +---- +SELECT * FROM FOO; +---- + +.HTML +[source,html] +---- +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + </head> + <body style="background-color: rgb(255, 255, 255);"> + <h1>Headline</h1> + </body> +</html> +---- + + +== Importing files or file includes + +You can import files via the include macro. +This also works for source code includes. +To use ---- in your listing use the [listing] style before that. +The following example imports a file formatted as Java source code. + +[source,java] +---- +include::resource/source.java[] +---- + +=== Using leveloffset + +Via the `leveloffset` attribute you can change the section offset, for example a `=` section will become `==` if you +add the following statement `:leveloffset: 1`. +Use `:leveloffset: 0` to reset the offset. + +=== Importing files partially + +It is also possible to include partial files. +For this, please mark the part of the file to be included with a tag similar to the following: + +.article.adoc +---- +# tag::tagname[] +This should be included! +# end::tagname[] +This text will not be included! +---- + +and include the file with the tagname in the brackets like this: + + include::resource/article.adoc[tags=tagname] + +The result would be + +---- +include::resource/article.adoc[tags=tagname] +---- + +=== Importing images + +You can import images with +---- +image:: +---- + +For the HTML output you can add the alt text within the brackets []. +If the image is located in the images folder then the import would look like this: + + image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=3.0in, align=left] + +Result: + +image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=3.0in, align=left] + +Please notice that the images folder is specified in the document header configuration +and is therefore not provided here again. + +The import of an image with `image::` will add the image in a new line. +If you want to add an image to be inline then use the macro `image:` + + This is just a text image:OFBiz-Logo.svg[Apache OFBiz Logo, width=40%] to show inline images. + +Result: + +This is just a text image:OFBiz-Logo.svg[Apache OFBiz Logo, width=40%] to show inline images. + +=== Keyboard shortcuts + +You can also define keyboard shortcuts with the `kbd` macro. + + kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE + +The result is the following: + +kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE + +The result will be different depending on the rendering (PDF, HTML). + +=== Using inline icons + +You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons +from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro. +---- +icon:comment[] This is a comment icon +icon:file[] And a file icon +icon:battery-full[] And a battery icon +---- + +.The output looks like the following +[example] +icon:comment[] This is a comment icon + +icon:file[] And a file icon + +icon:battery-full[] And a battery icon + +== How to write a... + +=== FAQ or Glossary + +FAQ's and glossaries should be written as a labeled list. +For hyperlinking, they should also have an ID which can be linked within a list. + +For example +---- +<<faq_entry_1,FAQ entry 1>> +<<faq_entry_2,FAQ entry 2>> + +[#faq_entry_1] +FAQ entry 1:: +This is entry #1 in our example FAQ. + +[#faq_entry_2] +FAQ entry 2:: +This is entry #2 in our example FAQ. +---- + +Renders to + +<<faq_entry_1,FAQ entry 1>> + +<<faq_entry_2,FAQ entry 2>> + +[#faq_entry_1] +FAQ entry 1:: +This is entry #1 in our example FAQ. + +[#faq_entry_2] +FAQ entry 2:: +This is entry #2 in our example FAQ. + + +== Asciidoc FAQ + +=== How to reset Heading Counter in Asciidoc + +You can deactivate the counter for a section: +---- +:sectnums!: + +== Preface + +:sectnums: + +== First Chapter +---- + + Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/documentation_guidelines.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/documentation_guidelines.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/documentation_guidelines.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/OFBiz-Logo-250w.png URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/OFBiz-Logo-250w.png?rev=1847248&view=auto ============================================================================== Binary file - no diff available. Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/OFBiz-Logo-250w.png ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/OFBiz-Logo-250w.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/OFBiz-Logo.svg URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/OFBiz-Logo.svg?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/OFBiz-Logo.svg (added) +++ ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/OFBiz-Logo.svg Fri Nov 23 12:00:10 2018 @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- +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. +--> +<svg width="1600px" height="750px" viewBox="0 0 1600 750" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> + <!-- Generator: Sketch 39.1 (31720) - http://www.bohemiancoding.com/sketch --> + <title>OFBiz-Logo</title> + <desc>Created with Sketch.</desc> + <defs> + <linearGradient x1="43.0920252%" y1="100%" x2="51.9198469%" y2="0%" id="linearGradient-1"> + <stop stop-color="#282662" offset="0%"></stop> + <stop stop-color="#792B81" offset="25%"></stop> + <stop stop-color="#CB2039" offset="50%"></stop> + <stop stop-color="#DB4F32" offset="75%"></stop> + <stop stop-color="#F69A25" offset="100%"></stop> + </linearGradient> + </defs> + <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"> + <g id="OFBiz-Logo"> + <path d="M1254,366.596541 C1254,356.513539 1257.06832,348.893454 1263.20506,343.736057 C1269.3418,338.57866 1278.03,336 1289.26992,336 C1298.70112,336 1305.8713,337.79637 1310.78069,341.389163 C1315.69008,344.981957 1318.14474,350.139277 1318.14474,356.861278 C1318.14474,366.133003 1315.30251,373.637193 1309.61795,379.374073 C1303.93339,385.110953 1295.1483,387.97935 1283.26241,387.97935 C1263.75404,387.97935 1254,380.851818 1254,366.596541 L1254,366.596541 L1254,366.596541 Z M1261.92919,586.89927 C1259.38969,597.645793 1248.37649,606.357571 1237.3384,606.357571 L1199,606.357571 L1240.33024,431.458302 C1242.86974,420.711778 1253.88295,412 1264.92103,412 L1303.25943,412 L1261.92919,586.89927 L1261.92919,586.89927 Z M802.67211,443.092658 C802.67211,475.891386 796.277078,505.241752 783.486824,531.144634 C770.69657,557.047517 753.190979,576.604769 730.969527,589.816978 C708.748075,603.029187 683.16795,609.635192 654.228385,609.635192 C621.154596,609.635192 595.348384,601.087 948 576.808975,583.993205 C558.269566,566.898461 549,543.168995 549,512.804094 C549,482.091504 555.395031,453.84214 568.185286,428.055153 C580.97554,402.268167 598.610323,382.479125 621.090164,368.687434 C643.570005,354.895742 669.537708,348 698.994051,348 C731.938646,348 757.454174,356.344428 775.541403,373.033533 C793.628631,389.722639 802.67211,413.075447 802.67211,443.092658 L802.67211,443.092658 L802.67211,443.092658 Z M694.149282,392.851747 C678.516749,392.851747 664.176376,398.153936 651.127732,408.758471 C638.079089,419.363007 627.84058,433.936782 620.411896,452.480233 C612.983213,471.023684 609.268928,491.131436 609.268928,512.804094 C609.268928,529.84089 613.56458,542.705216 622.156013,551.397458 C630.747447,560.089701 642.859248,564.435757 658.491782,564.435757 C674.124315,564.435757 688.367793,559.394332 701.222645,549.31133 C714.077497,539.228329 724.122217,524.973265 731.357109,506.545711 C738.592,488.118157 742.209391,467.43093 742.209391,444.48341 C742.209391,428.026 097 738.010634,415.30664 729.612992,406.324656 C721.21535,397.342672 709.394232,392.851747 694.149282,392.851747 L694.149282,392.851747 L694.149282,392.851747 Z M858.803488,586.68017 C856.293096,597.437651 845.31317,606.158312 834.267971,606.158312 L795.151838,606.158312 L850.446191,371.46741 C852.979517,360.714979 863.99484,351.998412 875.031785,351.998412 L1012.77887,351.998412 L1006.92698,376.690762 C1004.37939,387.440444 993.360505,396.154783 982.318072,396.154783 L903.868457,396.154783 L888.558986,461.693964 L980.222018,461.693964 L974.161294,486.257086 C971.514989,496.982127 960.413802,505.676491 949.367162,505.676491 L877.706704,505.676491 L858.803488,586.68017 L858.803488,586.68017 Z M1120.43621,352 C1150.02175,352 1172.37206,356.722714 1187.48782,366.168284 C1202.60357,375.613855 1210.16133,389.72405 1210.16133,408.499294 C1210.16133,425.883779 1204.79984,440.225764 1194.0767,451.525679 C1183.35356,462.825595 1168.10884,470.329785 1148.34208,474.038475 L1148.34208,475.08153 9 C1161.26153,478.09485 1171.56464,483.686775 1179.25171,491.857483 C1186.93878,500.028191 1190.78226,510.487699 1190.78226,523.236322 C1190.78226,549.776636 1180.89903,570.232073 1161.13227,584.603247 C1141.36552,598.974421 1114.04129,606.159901 1079.15878,606.159901 L978,606.159901 L1033.29435,371.468998 C1035.82768,360.716567 1046.83392,352 1057.87874,352 L1120.43621,352 L1120.43621,352 Z M1073,452.499294 L1101.87482,452.499294 C1117.50736,452.499294 1129.23158,449.688844 1137.04785,444.067861 C1144.86411,438.446877 1148.77219,430.363213 1148.77219,419.816625 C1148.77219,403.938796 1137.79082,396 1115.82776,396 L1086.37156,396 L1073,452.499294 L1073,452.499294 Z M1047,561.234557 L1081.88234,561.234557 C1096.99809,561.234557 1108.85151,557.873607 1117.44294,551.151606 C1126.03438,544.429605 1130.33003,535.100071 1130.33003,523.162725 C1130.33003,504.387481 1118.50891,495 1094.86632,495 L1062.89084,495 L1047,561.234557 L1047,561.234557 Z M1441.63074,586.875929 C1439.10841,597.63534 3 1428.11462,606.357571 1417.06075,606.357571 L1283,606.357571 L1289.78268,575.065655 L1401.21237,452.505648 L1324.27743,452.505648 L1329.42173,431.422349 C1332.03903,420.695682 1343.11561,412 1354.16039,412 L1479.50383,412 L1471.17083,446.768796 L1361.48526,565.851924 L1446.5594,565.851924 L1441.63074,586.875929 L1441.63074,586.875929 Z" id="OFBiz" fill="#E05D30"></path> + <path d="M497.643967,164.64682 C650.145968,122.220991 772.408371,153.533209 780.378034,242.933073 C782.714022,269.174369 774.96919,297.784584 759.071547,326.874947 L834.599576,326.870159 C852.802343,295.102316 863.89684,258.359488 861.527095,229.422426 C852.813704,123.34646 694.945422,90.6127419 498.320856,147.915732 L498.854439,134.726798 C499.367546,121.057066 478.324364,116.837941 451.798072,125.241481 C425.311324,133.70287 403.357666,151.602332 402.792477,165.250853 L402.119194,182.139637 C201.372455,266.531777 51.4738766,412.981291 60.3767536,521.298877 C69.9078162,637.015309 256.945999,665.501149 478.170432,584.880775 C493.670466,579.234905 508.92668,573.202885 523.893942,566.827195 L523.889654,521.158149 C509.604745,527.781023 494.628751,533.952243 479.339391,539.602318 C304.263742,604.411581 155.169451,576.648854 146.345357,477.602592 C138.297652,387.444238 249.309274,269.246192 401.410676,199.912235 L399.586521,245.669719 C399.052196,259.344272 420.084768,263.57 4966 446.607202,255.163713 C473.09395,246.743783 495.052431,228.808647 495.602188,215.114811 L497.643967,164.64682 L497.643967,164.64682 Z M541.142188,320.379172 C542.947708,349.315271 499.253544,392.598899 443.553443,417.013129 C387.823442,441.458212 341.228101,437.797331 339.401362,408.870874 C337.609345,379.943454 381.330515,336.660789 437.040261,312.225348 C492.742291,287.765803 539.376212,291.432469 541.142188,320.379172 L541.142188,320.379172 Z" id="Bug" fill="url(#linearGradient-1)"></path> + <path d="M1520.01325,412 C1523.3709,412 1526.64898,412.861489 1529.84758,414.584493 C1533.04618,416.307497 1535.53787,418.772681 1537.32273,421.980119 C1539.10759,425.187557 1540,428.531902 1540,432.013254 C1540,435.459262 1539.12084,438.772681 1537.36249,441.953612 C1535.60414,445.134542 1533.13896,447.604144 1529.96687,449.362492 C1526.79477,451.120839 1523.47693,452 1520.01325,452 C1516.54957,452 1513.23174,451.120839 1510.05964,449.362492 C1506.88755,447.604144 1504.41795,445.134542 1502.65076,441.953612 C1500.88358,438.772681 1500,435.459262 1500,432.013254 C1500,428.531902 1500.89683,425.187557 1502.69052,421.980119 C1504.48421,418.772681 1506.98032,416.307497 1510.17893,414.584493 C1513.37753,412.861489 1516.65561,412 1520.01325,412 L1520.01325,412 L1520.01325,412 Z M1520.01325,415.313453 C1517.20343,415.313453 1514.46876,416.033569 1511.80915,417.473824 C1509.14953,418.914078 1507.06871,420.972816 1505.5666,423.650099 C1504.06449,426.327383 1503.31345,429.115073 1503.31345,432.013254 C1503.31345,434.893763 1504.05124,437.654946 1505.52684,440.296885 C1507.00244,442.938825 1509.06559,444.997563 1511.71637,446.473161 C1514.36714,447.948759 1517.13274,448.686547 1520.01325,448.686547 C1522.89376,448.686547 1525.65936,447.948759 1528.31014,446.473161 C1530.96091,444.997563 1533.01965,442.938825 1534.48641,440.296885 C1535.95318,437.654946 1536.68655,434.893763 1536.68655,432.013254 C1536.68655,429.115073 1535.93992,426.327383 1534.44665,423.650099 C1532.95338,420.972816 1530.87256,418.914078 1528.20411,417.473824 C1525.53566,416.033569 1522.8054,415.313453 1520.01325,415.313453 L1520.01325,415.313453 L1520.01325,415.313453 Z M1511.23923,443.066932 L1511.23923,421.542744 L1518.63486,421.542744 C1521.16193,421.542744 1522.99094,421.741549 1524.12194,422.139165 C1525.25293,422.536781 1526.15418,423.23039 1526.82571,424.220013 C1527.49724,425.209636 1527.833,426.261094 1527.833,427.37442 C1527.833,428.947214 1527.27193,430.31676 1526.14977,431.4831 01 C1525.02761,432.649443 1523.53878,433.303291 1521.68323,433.444665 C1522.44312,433.762758 1523.05279,434.142697 1523.51226,434.584493 C1524.37818,435.432741 1525.43847,436.855303 1526.69317,438.85222 L1529.31743,443.066932 L1525.07621,443.066932 L1523.16766,439.673956 C1521.66555,437.005509 1520.45505,435.335546 1519.53612,434.664016 C1518.89993,434.169205 1517.97217,433.921803 1516.75282,433.921803 L1514.71173,433.921803 L1514.71173,443.066932 L1511.23923,443.066932 L1511.23923,443.066932 Z M1514.71173,430.952949 L1518.92644,430.952949 C1520.94103,430.952949 1522.315,430.652532 1523.04838,430.05169 C1523.78176,429.450847 1524.14844,428.655627 1524.14844,427.666004 C1524.14844,427.029818 1523.97173,426.45991 1523.61829,425.956262 C1523.26485,425.452615 1522.77447,425.077094 1522.14712,424.829689 C1521.51977,424.582283 1520.35786,424.458582 1518.66137,424.458582 L1514.71173,424.458582 L1514.71173,430.952949 L1514.71173,430.952949 Z" id="®" fill="#E05D30"></path> + <path d="M887.325646,300.366454 L875.672642,326.731376 L863,326.731376 L909.830511,222.291325 L922.211828,222.291325 L968.896676,326.731376 L955.932709,326.731376 L944.279705,300.366454 L887.325646,300.366454 Z M915.657013,235.910774 L892.423836,288.859112 L939.254347,288.859112 L915.657013,235.910774 Z M1054.58267,231.468066 C1061.6959,237.585924 1065.25246,246.228482 1065.25246,257.396 C1065.25246,268.951954 1061.6959,277.897973 1054.58267,284.234326 C1047.46945,290.570679 1037.45525,293.738807 1024.53977,293.738807 L997.228043,293.738807 L997.228043,326.731376 L985.283713,326.731376 L985.283713,222.291325 L1024.53977,222.291325 C1037.45525,222.291325 1047.46945,225.350208 1054.58267,231.468066 L1054.58267,231.468066 Z M997.228043,282.304297 L1024.10278,282.304297 C1033.66801,282.304297 1040.99961,280.216488 1046.09783,276.040807 C1051.19604,271.865126 1053.74511,265.74736 1053.74511,257.687326 C1053.74511,249.821508 1051.18391,243.87368 1046.06141,239.843663 C1040.938 92,235.813645 1033.61945,233.798667 1024.10278,233.798667 L997.228043,233.798667 L997.228043,282.304297 Z M1088.33997,300.366454 L1076.68697,326.731376 L1064.01432,326.731376 L1110.84483,222.291325 L1123.22615,222.291325 L1169.911,326.731376 L1156.94703,326.731376 L1145.29403,300.366454 L1088.33997,300.366454 Z M1116.67134,235.910774 L1093.43816,288.859112 L1140.26867,288.859112 L1116.67134,235.910774 Z M1248.93293,226.042136 C1255.58489,228.736907 1261.45989,232.463403 1266.5581,237.221737 L1259.34781,246.325646 C1255.26924,242.247074 1250.52311,239.04253 1245.10929,236.711918 C1239.69547,234.381305 1234.14821,233.216017 1228.46735,233.216017 C1220.69864,233.216017 1213.56124,235.048919 1207.05495,238.714778 C1200.54866,242.380637 1195.4141,247.357391 1191.65114,253.64519 C1187.88817,259.932988 1186.00671,266.839752 1186.00671,274.365688 C1186.00671,281.84307 1187.88817,288.737695 1191.65114,295.04977 C1195.4141,301.361846 1200.5608,306.350739 1207.09137,310.016598 C1213.62194,313. 682457 1220.74719,315.515359 1228.46735,315.515359 C1234.14821,315.515359 1239.6712,314.422901 1245.03646,312.237952 C1250.40173,310.053002 1255.17213,306.969843 1259.34781,302.98838 L1266.70377,311.218314 C1261.41133,316.170865 1255.39067,320.091577 1248.64161,322.980565 C1241.89254,325.869553 1234.97364,327.314026 1227.8847,327.314026 C1218.02815,327.314026 1208.98502,324.959172 1200.75505,320.249392 C1192.52507,315.539613 1185.9946,309.130524 1181.16343,301.021935 C1176.33227,292.913346 1173.91672,284.028019 1173.91672,274.365688 C1173.91672,264.800466 1176.35654,256.024385 1181.23626,248.037181 C1186.11598,240.049978 1192.70715,233.71372 1201.00995,229.028218 C1209.31276,224.342716 1218.41658,222 1228.32168,222 C1235.41063,222 1242.28098,223.347365 1248.93293,226.042136 L1248.93293,226.042136 Z M1362.98671,326.731376 L1362.98671,280.77484 L1300.06049,280.77484 L1300.06049,326.731376 L1288.11616,326.731376 L1288.11616,222.291325 L1300.06049,222.291325 L1300.06049,269.485992 L1362 .98671,269.485992 L1362.98671,222.291325 L1374.93104,222.291325 L1374.93104,326.731376 L1362.98671,326.731376 Z M1418.48415,233.798667 L1418.48415,268.102198 L1471.14116,268.102198 L1471.14116,279.60954 L1418.48415,279.60954 L1418.48415,315.369697 L1479.37109,315.369697 L1479.37109,326.731376 L1406.53982,326.731376 L1406.53982,222.291325 L1477.40465,222.291325 L1477.40465,233.798667 L1418.48415,233.798667 Z" id="APACHE" fill="#282662"></path> + </g> + </g> +</svg> \ No newline at end of file Added: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/ofbiz-architecture.png URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/ofbiz-architecture.png?rev=1847248&view=auto ============================================================================== Binary file - no diff available. Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/ofbiz-architecture.png ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/ofbiz-architecture.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/article.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/article.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/article.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/article.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,4 @@ +# tag::tagname[] +This should be included! +# end::tagname[] +This text will not be included! \ No newline at end of file Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/article.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/article.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/article.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/source.java URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/source.java?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/source.java (added) +++ ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/source.java Fri Nov 23 12:00:10 2018 @@ -0,0 +1,20 @@ +/******************************************************************************* + * 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. + *******************************************************************************/ + +System.out.println("Hello"); \ No newline at end of file Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/source.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/source.java ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/source.java ------------------------------------------------------------------------------ svn:mime-type = text/plain |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |