Page History

...

The OFBiz project follows the Sun coding standards for Java source code. For information regarding this standard please visit http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

For Groovy we suggest you read http://www.groovy-lang.org/style-guide.html but we don't expect people to follow all details there, still a good read..

HTML code should be XHTML compliant. Groovy and Javascript files should follow the same conventions as Java files.

...

1. Java -> Code Style -> Code Formatter -> Show... In dropdown pick -> Java Conventions built-in -> Indentation, select Tab policy as "Spaces Only". Enter a new name for this profile and click "OK".Java -> Editor -> Typing, and check "Insert spaces for tab".
2. General -> Editors -> Text Editors -> Insert spaces for tabs
3. Ant -> Editor -> Formatter, and uncheck "Use tab character instead of spaces".
4. If you installed Colorer, Colorer Library Editor -> Uses spaces instead of tabs.
5. If you installed XML Buddy, XMLBuddy -> Formatting -> Uses spaces instead of tabs.
6. If you installed Oxygen, Oxygen -> Editor -> Format -> uncheck Indent with tabs, indent size 2 (beware for existing files with 4 spaces, always a trouble :/)
7. XML -> XML Files -> Editors -> Text Editors -> Indent using spaces (4)
8. Unfortunately the main FreeMarker plugins has no Unfortunaltely neither of the 2 main FreeMarker plugins have similar functionnality yet. But there is somehow a (sometimes annoying) solution :
   • Install AnyEdit plugin (http://andrei.gmxhome.de/eclipse/) and set its parameters in General -> Editors -> AnyEdit Tools. When using AnyEdit plugin, you should set it to
     • Convert tab to space (it's by default in last versions)
     • Add filters (like *.js, *.css) for files you don't want to auto-convert)

In Eclipse, for Java, you may use Ctrl+I to be sure of correct indentation.For Javascript in Eclipse we suggest to use Aptana and to import /tools/ofbiz.aptana.js.format.xml (from Windows/Preferences/Aptana/Editors/Javascript/Formatting/Import in Eclipse).

Personaly (Jacques Le Roux), I use Eclipse and format my Java code with this attached file: ofbiz.xml

Entity Definitions

Entity Names

...

In most of case, the request name is the same than the view-map called. For the request-map name use java naming convention for Objects (ex : "FindParty"), and declare all in one line.

     <request-map uri="FindParty"><security https="true" auth="true"/><response name="success" type="view" value="FindParty"/></request-map>

...

For the request-map name use java naming convention for field or method (ex : "editParty"), and declare each xml element on separate line

   <request-map uri="createPerson">
        <security https="true" auth="true"/>
        <event type="service" invoke="createPerson"/>
        <response name="success" type="view" value="EditPerson"/>
        <response name="error" type="view" value="EditPerson"/>
    </request-map>

...

For the view-map name use java naming convention for Objects (ex : "FindParty"), and declare all in one line.

    <view-map name="FindParty" type="screen" page="component://mycomponent/widget/PartyScreens.xml#FindParty"/>

...