wiki:DeveloperGuidelines

Version 211 (modified by Fran Boon, 11 years ago) ( diff )

--

Developer Guidelines

Table of Contents

  1. Getting Started
  2. Development Process
  3. Development Enviroment
  4. Framework
    1. Python
    2. Web2Py
    3. Javascript
      1. Deployment
    4. Mobile
    5. XSLT
  5. FAQ
  6. Other Resources
  7. Uncategorized

Getting Started

Development Process

Development Enviroment

Framework

Python

Indentation matters (use 4 spaces instead of Tabs)

More details at: DeveloperGuidelines/CodeConventions

Web2Py

This is an ​MVC environment (like ​Rails & ​Django. ​Django polls tutorial conversion course).

Web2Py can work at several different levels of abstraction.
The Sahana Eden framework (S3) is built on Web2Py's Auth/Crud classes in tools.py (with some remnants of the older T2), however sometimes we need more control therefore need to drop down a level or two.

Recommend using the CLI to try out code snippets in the Web2Py environment (gluon, Model): 

python web2py.py -S eden -M

Can execute a controller to be able to access its functions using: 

execfile("applications/eden/controllers/mycontroller.py", globals())

Web2Py can be extended through ​Plugins & also has a ​recipes site.

Javascript

  • S3 includes a cross-browser debug utility (only shows up when ?debug=1): 
    s3_debug('message', value);

All global variables should be in the S3 namespace:

Private variables should be protected, e.g. using the Module Pattern:

Can test out the performance of different options to achieve a task using:

Can check quality using JSLint:

Deployment

Browsers default to only downloading 2 files from the same origin at a time, so many files is very slow on high latency links.

We therefore consolidate into fewer, larger files when running in Production mode.

Although, note that iPhone 3.x cannot cache files larger than 15kb and in iPhone 4 the limit is 25kb. And this is the size before gzipping.

Since GIS is a specialised app which requires many files, it's JS is loaded separately when required.

The build script is static/scripts/tools/build.sahana.py

It needs to be run as a web2py script: 

python web2py.py -S eden -M -R applications/eden/static/scripts/tools/build.sahana.py

There is also a convenience wrapper for Windows to run this: static/scripts/tools/build.cmd

You must have an internet connection to run the build script unless you have a local version of the Compiler.

Our build process is based on the one used by OpenLayers

This uses Google's Closure compiler to compress the JS. This is done using their web service, however for OpenLayers itself we need to download the jar file & place in the tools folder since this is over 1Mb:

ToDo: Investigate using other options instead:

ToDo: Download/execute scripts asynchronously:

Mobile

XSLT

  • XSLT - Stylesheets for XML & JSON Import/Export

FAQ

Other Resources

Uncategorized

These pages need to be sorted into their appropriate category on this page. (DeveloperGuidelines)

Note: See TracWiki for help on using the wiki.