New updated help system

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

New updated help system

hans_bakker
I just committed a change to upgrade the help system, to promote its use
and content a copy from the svn log:

The 'new' help system

A new help system is implemented which is compatible with the current
system which uses the docs.ofbiz.org site to store the data.

The new help system has a number of advantages over the old version:
1. complete multilanguage without config xml files, using the locale.
2. Having an automatic multilevel index of all help pages using the
ContentAssoc entity
3. Using the content manager for retrieval.
4. Template driven, aware of the different visual themes.
5. A first step towards the storage of OFBiz documentation within the
OFBiz system itself.
6. Easy update via normal svn in seed data.
7. Aware of portlets on (userdefined) Portal pages.
8. Create awareness of the capabilities of the content component

The reason of this development was the requirement to provide user
documents to the customers of Antwebsystems Co.Ltd

Some of the possible extensions could be:
1. a search function
2. print all or specific help files in PDF format
3. make the help screens work better with the business theme
4. Explain how help can be extended
5. In the help screen be able to send a message to the local support
team
6. But most of all, create more help content!

--
Antwebsystems.com: Quality OFBiz services for competitive rates

Reply | Threaded
Open this post in threaded view
|

Re: New updated help system

chris snow
Any effort to help newcomers understand the complexity of ofbiz is most welcome!

hansbak wrote
I just committed a change to upgrade the help system, to promote its use
and content a copy from the svn log:

The 'new' help system

A new help system is implemented which is compatible with the current
system which uses the docs.ofbiz.org site to store the data.

The new help system has a number of advantages over the old version:
1. complete multilanguage without config xml files, using the locale.
2. Having an automatic multilevel index of all help pages using the
ContentAssoc entity
3. Using the content manager for retrieval.
4. Template driven, aware of the different visual themes.
5. A first step towards the storage of OFBiz documentation within the
OFBiz system itself.
6. Easy update via normal svn in seed data.
7. Aware of portlets on (userdefined) Portal pages.
8. Create awareness of the capabilities of the content component

The reason of this development was the requirement to provide user
documents to the customers of Antwebsystems Co.Ltd

Some of the possible extensions could be:
1. a search function
2. print all or specific help files in PDF format
3. make the help screens work better with the business theme
4. Explain how help can be extended
5. In the help screen be able to send a message to the local support
team
6. But most of all, create more help content!

--
Antwebsystems.com: Quality OFBiz services for competitive rates