////
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.
////
= Example Plugin

The Example application will allow you to discover the possibilities to create an application, with a lot of search boxes,
lists and many more.

This application could be used to have an example of the bests practices in user interface development in Apache - OFBiz.

Look help for each example screen, help will explain which part of development is used in this case.

For example, if you want to see how you should do to add some help you can look to help files in src/docs/asciisoc/_include/
directory and src/docs/asciisoc/example.adoc both in example component.

== Help file organization
Help is managed by using content component functionality.

Help can be for :

* one component or sub-component, access is possible by navigation in help index tree and select it, contentId is associated to
  HELP_ROOT with contentAssocTypeId="TREE_CHILD" ;
* one screen, access is done by help icon in screen (most of time on top), contentId is search on ContentAssoc.mapKey with
  a value (helpTopic) build with component webSite and uri used to show this screen ;
* one portlet, access is done by a link on the portalPages (which contain this portlet) help, link is a showHelp (like
  for a screen) with helpTopic build with "HELP_" and portletId
* one portal page, access is done by help icon if parameters.portalPageId is not empty, contentId is read on PortalPage
  (or originalPortalPage if exist) and is show on top of portlet list contain on it.

== Development help sub-subject
To have the complete list you should click on index button and look to example tree option, but here is a list of
main shortcut :

* How is organize The Apache OFBiz documentation system documentation is coming soon.
* link:documentation_guidelines.html[Documentation / asciidoc guidelines]

== UI help for Example

include::plugins/example/src/docs/asciidoc/_include/example_main.adoc[leveloffset=+2]
