README.web

   1 Coding style
   2 ------------
   3
   4 Javascript
   5     http://javascript.crockford.com/code.html with the following amendements:
   6     - Line Length should be 160 (132?), dont split at 80, rationale in 2011 we all use 16/9 screens
   7
   8     http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml ?
   9
  10 Modules Conventions
  11 -------------------
  12
  13 addons/<modulename>/controllers/ python controller
  14 addons/<modulename>/controllers/main.py main python controller is there is only one (or should it be <modulename>.py ?)
  15 addons/<modulename>/static/ static directory (directly served by the web server)
  16 addons/<modulename>/static/<external_library>/ directory containing an external javascrip library respect the directory structure of upstream is this directory
  17 addons/<modulename>/static/openerp/ module specfic static files
  18 addons/<modulename>/static/openerp/js/ module specific javscript files
  19 addons/<modulename>/static/openerp/css/ module specific css files
  20 addons/<modulename>/static/openerp/img/ module specific images files
  21 addons/<modulename>/static/openerp/ other files
  22 addons/<modulename>/__openerp__.py module manifest referencing js and css files
  23
  24
  25 Dependecies
  26 -----------
  27 Depends on
  28
  29 install "CherryPy>=3.1.2" "-d cherrypy"
  30 install "simplejson>=2.0.9" "-d simplejson"
  31
  32 Maybe soon on
  33
  34 #install "Babel>=0.9.4" "-d babel"
  35 #install "pytz>=2009j" "-d pytz"
  36
  37 Probably not anymore on:
  38
  39 #install "Mako>=0.2.4" "-d mako"
  40 #install "formencode>=1.2.2" "-d formencode"
  41 #install "pyparsing>=1.5.2" "-f pyparsing.py"
  42 #install "xlwt>=0.7" "-d xlwt"