Commit Graph
49 Commits
Author SHA1 Message Date
holivier 1ddf7f5a41 Documented: User Manual : change the level of <Core Business Application> from 2 to 1 (OFBIZ-11036) 2020-11-18 17:25:36 +01:00
holivier fa11e7ddc7 Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting 2020-11-18 17:24:33 +01:00
holivier c2c1eae612 Documented: migrated Wiki Glossary to glossary asciidoc files (OFBIZ-12060)
- Accounting Glossary,
  - declare it as glossary
  - re-order existing items
  - add a comment at beginning about importance of order items
  - correction for some ID: change space to _
  - add some items coming from wiki glossary
- Facility
  - add glossary directly in facility.adoc
- Human Resource Glossary
  - re-order existing items
  - add a comment at beginning about importance of order items
  - move some items to Party Glossary or global Glossary
- HR appendix: add link to wiki OFBiz related book for Data Model Reference Book
- Add Party Glossary and included it in party.adoc
  - add some items coming from wiki glossary and HR glossary
- General Glossary
  - add a comment at beginning about importance of order items
  - add some items coming from wiki glossary and HR glossary
2020-11-18 17:19:39 +01:00
holivier 5e6f537708 Documented: HR Doc drive by process (OFBIZ-11026)
- Re-organize sub-chapter to have a process vision of HR component
- Add hr-data-model sub-chapter
- Add hr-appendix which list some bug or WIP development
2020-11-17 14:27:08 +01:00
holivier 98631771aa Documented: Synchronize wiki page End User Documentation (OFBIZ-12059)
- Add facility.adoc with only overview
- Correction for Content Management title
- in General glossary, add link to main components
- Complete Order management overview
- Add a short overview for Party
- Ordered applications in user-manual in alphabetic order
2020-11-16 17:00:48 +01:00
holivier e6dbed5fd6 fixed: spelling correction in a link to pluginsdoc document 2020-11-15 10:44:31 +01:00
holivier c21892609b Documented: Add a Global Glossary for user-documentation (OFBIZ-10303) 2020-11-14 17:12:14 +01:00
holivier ac6964e8eb Documented: OFBizDocumentationSystem migration to Asciidoc and Review (OFBIZ-11364)
Rewrite the document, add a part in documentation guidline.
Add a include for OFBizDocumentationSystem document in user manual and developer-manual.
2020-11-14 16:55:31 +01:00
holivier 19d5435c97 fixed: duplicate webtools include help from developer-manual to user-manual for help link work
when there will be a general glossary, duplication will not be necessary
2020-10-26 17:34:04 +01:00
holivier e934b2bd13 fixed: title-logo-image should be in header so without blank line
Now OFBiz-Logo is printed in pdf
2020-10-06 14:02:48 +02:00
holivier ee20e6c715 Improved: solve Error messages when generating HTML and PDF file from
AsciiDoc files (OFBIZ-11893)

Add the correct set when use icon, to avoid INFO message
2020-10-01 16:28:18 +02:00
holivier f2f43bc8d1 Improved: solve Error messages when generating HTML and PDF file from
AsciiDoc files (OFBIZ-11893)

* Add allow-uri-read when generated html and pdf to be able to allow
image from external uri, it's used for apache2.0 image;
Generalize usage of apache2.0 image for all main documents
* Put Trunk Version in gradle generation parameter and so remove in all
documents (to avoid Version unspecified)
2020-10-01 16:27:56 +02:00
holivier bc6deb281c Documented: include asciidoc user and developer manual from
ofbiz-plugins (OFBIZ-11587)

create file in ofbiz-plugins
* plugins-developer-manual, which will include all include:: plugins for
developer,
* plugins-user-manual, which will include all include:: plugins for user

The file plugins-user-manual is include in user-manual and
plugin-developer-manual is include in developer-manual
2020-07-20 12:58:28 +02:00
holivier b0f445b123 Documented: Framework, migration all docbook files to asciidoc
(OFBIZ-11587)

- common-sending-email: include in email
- datafile: move as a include at the end of entity-engine section
- entity-engine: list of link to OFBiz wiki about entity configuration
- service-engine: a link to OFBiz wiki Service Engine Guide
- webtools: help for main screen
- mini-lang: include a link to OFBiz wiki mini-lang-reference at the
beginning of minilang-to-groovy-manual
           move minilang-to-groovy-manual to Development environment
section
- unit-test: include as Junit test, and use README to list gradle
command available (so add a tag in REAME.adoc)
- base: add a link to OFBiz wiki Configuration Guide, in deployment
section
- SingleSignOn with LDAP: move to plugin LDAP and include in deployment
section

developer-manual is updated with some include lines or with directly a
sentence.
2020-07-14 16:56:05 +02:00
holivier 2c700e86af Documented: Framework/base migration to asciidoc
(OFBIZ-11587)

only one file about receiving email, so create email.adoc which included
receiving and later sending.
email.adoc is included in developer-manual.adoc in deployment section
2020-07-14 16:27:23 +02:00
holivier 1c09166948 Documented: Product (catalog) migration to asciidoc
(OFBIZ-11587)

product.adoc included (by include:: ) the other files by sub-component

user-manual is updated to include it in.
2020-07-14 15:38:31 +02:00
holivier 34291541a0 Documented: Party migration to asciidoc
(OFBIZ-11581)

For all of HELP_Party files content has been directly put in
party.adoc

user-manual is updated to include it in.
2020-07-02 12:18:57 +02:00
holivier 00176a26c2 Documented: Order migration to asciidoc
(OFBIZ-11580)

For all of HELP_Order files content has been directly put in
order.adoc except for order_report which has its own file

user-manual is updated to include it in.
2020-07-02 12:06:52 +02:00
holivier 49de6efaf2 Documented: SFA migration to asciidoc
(OFBIZ-11577)

For all of HELP_SFA files content has been directly put in
sfa.adoc
2020-07-02 11:33:18 +02:00
holivier 2f7aa04236 Documented: Marketing migration to asciidoc and new documentation
organization
(OFBIZ-11577)

Main files and ContactList
2020-07-02 11:14:10 +02:00
holivier 8652c3ca04 Documented: Manufacturing migration to asciidoc and new documentation
organization
(OFBIZ-11416)

Main files
2020-06-20 16:02:46 +02:00
holivier 192059e3da Improvement: Help link using asciidoc files via generated html
(OFBIZ-11693)

Change release for all asciidoc files, now there area 3 publish site,
one per release
* site/trunk
* site/next   currently for the 18.12
* site/stable currently for the 17.12
2020-06-04 17:56:54 +02:00
Aditya Sharmaandholivier a82c3032ad Documented: datamodel markdown migration to asciidoc (OFBIZ-11574)
* Documented: datamodel markdown migration to asciidoc
(OFBIZ-11574)

- DATAMODEL_CHANGE migration to asciidoc and add a included in
developer_manual
- Readme migration to asciidoc

* Documented: theme/README.md change theme/README.adoc but with very
simple content
(OFBIZ-11574)

README.md  has been migrated to asciidoc as doc/themes.adoc previously
but remove README.md has been forgot.
In this commit README.md is removed and a new README.adoc is created
with only a brief component definition and link to the theme
documentation (and developer-manual which included theme.adoc)

* Documented: datamodel markdown migration to asciidoc
(OFBIZ-11574)

Added new field parentGlXbrlClassId taking reference from DATAMODEL_CHANGES.md which was added with OFBIZ-10613 and missing in adoc file

Co-authored-by: holivier <holivier@apache.org>
2020-05-25 19:46:04 +05:30
holivier a88129294d Documented: Content overview doc file migration in asciidoc format
(OFBIZ-11384)

the new file content.adoc is call (via include) from user-manual.adoc
content_IT is migrated too even if there is only 2 lines in it !
2020-02-25 22:31:14 +01:00
holivier 3ebb9f6bbc Documented: All setup help file in docbook format migration to asciidoc
format
(OFBIZ-11363)

ofbiz-setup.adoc included all setup files and user-documentation.adoc
include ofbiz-setup
2020-02-25 22:04:21 +01:00
Michael Brohl 241d49d903 Documented: Themes documentation migration from md to asciidoc
(OFBIZ-11311)

Thanks Olivier Heintz for reporting and providing the patch.
2020-02-22 19:37:37 +01:00
Jacques Le Roux e7ceacdce8 Improved: Convert Minilang to Groovy Guide into asciidoc
(OFBIZ-10300)

Convert Dennis Balkirs Minilang to Groovy Guide into AsciiDoc.

Thanks: Benjamin Jugl

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1848745 13f79535-47bb-0310-9956-ffa450edef68
2018-12-12 11:41:25 +00:00
Jacques Le Roux 159fb21f80 Documented: no functional change
Renames the security doc dir to docs as requested by documentation guidelines
Includes webapp.adoc in developer-manual.adoc



git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1847078 13f79535-47bb-0310-9956-ffa450edef68
2018-11-21 08:15:36 +00:00
Gil Portenseigne a61c98775f Implemented : Impersonation of userLogin feature
(OFBIZ-10515)

Introduce a new feature that allow the impersonation of a login by an authorized user.
Add the documentation with all the details in security-impersonation.adoc.
Big thanks to Leila, Nicolas and Jacques for your contribution to this implementation.
Big thanks to Mathieu, Jacques, Pierre and Taher for your remarks and reviews that
improved this contribution quality. 

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1842110 13f79535-47bb-0310-9956-ffa450edef68
2018-09-27 16:01:35 +00:00
Jacques Le Roux b09ef50ebd Improved: fixes a typo, I also wondered about the URL but indeed
fortawesome.github.io leads to fontawesome.com


git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1840889 13f79535-47bb-0310-9956-ffa450edef68
2018-09-14 07:22:24 +00:00
Jacques Le Roux b4cea27a59 Improved: adds a missing ASL2 header. It could be that we don't want one there but then
I let Michael decide and put a line in the RAT exclude file. I finally did 
because I thought that maybe this file will be enhanced

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1832091 13f79535-47bb-0310-9956-ffa450edef68
2018-05-23 09:54:19 +00:00
Sharan Foga 9baedc3437 Improved: Corrected some minor spelling mistakes and modified a few sentences (OFBIZ-10306)
git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1830987 13f79535-47bb-0310-9956-ffa450edef68
2018-05-05 15:11:05 +00:00
Michael Brohl fb6413eb84 Improved: added the first draft of the documentation guidelines.
git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1828857 13f79535-47bb-0310-9956-ffa450edef68
2018-04-10 21:24:31 +00:00
Michael Brohl 388387601e Improved: Added Apache License header.
git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1828135 13f79535-47bb-0310-9956-ffa450edef68
2018-04-01 09:21:28 +00:00
Taher A. Alkhateeb 291fdc43d7 Improved: moved some shared attributes in asciidoc sources to gradle
(OFBIZ-10285)

Given that both the developer and user manuals share many of the configurations
like table of contents and other formatting settings, this commit moves such
configurations from the source documents to the buildscript to sustain DRY.


git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1827961 13f79535-47bb-0310-9956-ffa450edef68
2018-03-29 08:20:42 +00:00
Michael Brohl a7a1f091cb Improved: Added additional configuration (experimental features and
removed chapter labels), added headlines/structure for the development 
environment.

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1827940 13f79535-47bb-0310-9956-ffa450edef68
2018-03-28 18:08:22 +00:00
Michael Brohl cb8ee3f334 Improved: Added additional configuration to the user manual
(remove chapter label, activate experimental features), included
the quick start section of README.adoc to the user manual.

The further reading link was moved to make it work.

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1827939 13f79535-47bb-0310-9956-ffa450edef68
2018-03-28 18:04:52 +00:00
Taher A. Alkhateeb d8b35738a0 Implemented: added initial skeleton and some content to developer manual
(OFBIZ-10285)

Provide the following to the developer manual

- an initial draft skeleton of the topics to be covered
- add an introduction
- add an example workflow with corresponding diagram

This is still very much a work in progress. Modifications, improvements and
comments are very welcomed.


git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1827911 13f79535-47bb-0310-9956-ffa450edef68
2018-03-28 10:49:06 +00:00
Michael Brohl f11b2ef14e Improved: Added configuration for icons and source code highlighting.
git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1827148 13f79535-47bb-0310-9956-ffa450edef68
2018-03-18 18:57:31 +00:00
Michael Brohl ce13cb0b78 Improved: Added title page image in vector format, some basic author
and version information and table of contents configuration.

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1827146 13f79535-47bb-0310-9956-ffa450edef68
2018-03-18 16:24:31 +00:00
Michael Brohl dbf4316fbb Improved: Added a general image directory and OFBiz logo to the main
.adoc files.

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1827143 13f79535-47bb-0310-9956-ffa450edef68
2018-03-18 15:55:53 +00:00
Michael Brohl 87586bbffb Improved: Append Apache license header on top of each .adoc file.
Thanks Pierre Smits for reporting.

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1827136 13f79535-47bb-0310-9956-ffa450edef68
2018-03-18 13:04:40 +00:00
Michael Brohl 93011f5b7a Improved: Fixed some typos.
git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1827070 13f79535-47bb-0310-9956-ffa450edef68
2018-03-17 10:53:19 +00:00
Michael Brohl 1545dfaebf Improved: Adjusted the level offsets for core application includes.
git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1827047 13f79535-47bb-0310-9956-ffa450edef68
2018-03-16 21:21:36 +00:00
Taher A. Alkhateeb 521cdfb526 Implemented: Add section numbering to the documentation user manual
(OFBIZ-10285)


git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1826950 13f79535-47bb-0310-9956-ffa450edef68
2018-03-16 10:06:11 +00:00
Taher A. Alkhateeb 1266157dd5 Implemented: added an introductory paragraph to the core apps section
(OFBIZ-10285)


git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1826948 13f79535-47bb-0310-9956-ffa450edef68
2018-03-16 09:52:17 +00:00
Taher A. Alkhateeb ee651182f7 Implemented: add the introduction section of the OFBiz user manual
(OFBIZ-10285)

This brief introduction explains high level concepts along with the welcome
message to give beginners and idea of what OFBiz is and the purpose behind its
design.

Thank you: Michael Brohl and Sharan Foga for review and feedback.


git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1826931 13f79535-47bb-0310-9956-ffa450edef68
2018-03-16 09:27:12 +00:00
Michael Brohl 48f9957831 Improved: Create Empty Document templates for Human Resources
Documentation.
(OFBIZ-10254)

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1826538 13f79535-47bb-0310-9956-ffa450edef68
2018-03-12 12:04:47 +00:00
Taher A. Alkhateeb c688af9d89 Implemented: PoC for a documentation system for OFBiz based on Asciidoc
(OFBIZ-9837)

This commit has reference to the community discussion thread [1] and [2] in
which it was agreed to commit a PoC for a documentation framework based on
AsciiDoc. The work in this commit includes:
- Applying the necessary requirements and tasks to build.gradle and facilitate
  the addition of two new tasks: generateOfbizDocumentation and
  generatePluginDocumentation.
- Create an initial skeleton for a "user manual" and "developer manual"
- Create a sample initial skeleton for the accounting component

Thanks: Michael Brohl, Sharan Foga, Olivier Heintz for testing and feedback.

[1] https://s.apache.org/4Lat
[2] https://s.apache.org/26kc


git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1826199 13f79535-47bb-0310-9956-ffa450edef68
2018-03-08 10:19:17 +00:00