Both sides previous revision
Previous revision
Next revision
|
Previous revision
|
dev:home [2009/12/03 08:55] jo |
— (current) |
====== Sahana Development WIKI ====== | |
| |
Welcome to the Sahana Development WIKI. The purpose of this repository is to host the development guidelines, standards and programming tips for Sahana. | |
| |
If you are a new contributor please first read the [[dev:orientation_new_developer| New Developer Orientation Guide ]] | |
| |
** Sahana Progress ** : see [[dev:release_roadmap | Sahana release roadmap]] | |
| |
| |
| |
===== Sahana Policy and Conventions ===== | |
| |
The following are policy and conventions that are a must for all Sahana developers | |
| |
* Sahana code will use an [[http://www.gnu.org/licenses/lgpl.html | LGPL]] license. | |
* Sahana [[dev:dependencies | dependencies and pre-requisites ]] for operation | |
* Sahana [[dev:cvs_convention| Code Commit and CVS Convention]] | |
* Sahana [[dev:module_acceptance_policy | Module acceptance policy]] | |
* Sahana [[dev:release_process | Release Process ]] | |
* Sahana [[dev:merge_process | Merge Process ]] | |
* Sahana [[Bug tracking process | Bug and Enhancement Tracking ]] Process | |
* Sahana [[dev:SWAT | Quality Standards / SWATS]] | |
* [[dev:gui_standards | GUI Standards ]] | |
* [[dev:mailing_list_policy | Mailing list policy ]] | |
* [[dev:monthly_reporting_policy | Monthly reporting policy]] - ([[dev:project_report_200810 | Oct-08 ]] ) | |
| |
==== Development Conventions ==== | |
| |
=== Languages === | |
| |
* [[dev:php_coding_convention| PHP coding convention]] | |
* [[dev:css_convention | CSS convention and identifiers]] | |
* [[dev:html_convention | HTML coding convention]] | |
* [[dev:js_convention | JavaScript convention]] | |
| |
=== Other === | |
| |
* [[dev:directory_convention | directory structure ]] - knowing where to place development files | |
* [[dev:sqlpolicies | Database schema convention ]] | |
* [[dev:phpdoc_convention | PHPDOC convention]] | |
* [[dev:3rd_party | Approved 3rd Party Libraries]] | |
| |
==== Proposed Conventions ==== | |
| |
* [[dev:coding_convention_changes | Changes to coding convention]] | |
* [[dev:usability_guidelines | Usability Guidelines ]] | |
| |
| |
| |
===== Design and Development Guides ===== | |
| |
Below is a list of conventions and guides we follow as a development team. | |
Some of these conventions have [[dev:automated_check | automated checks]]. Click [[dev:automated_check | here]] to find out how to use the automated checks as you write code. | |
| |
* [[dev:CVS| Getting Sahana from the CVS]] | |
* [[dev:sourceforge | Using sourceforge ]] | |
| |
==== Quality Assurance ==== | |
| |
* [[dev:qa_webpage | QA Checklist]] - A check list to test each web page that is produced by the system | |
* [[dev:qa_testcases | QA Test Case Guide]] - Guide to writing QA test cases | |
* [[dev:qa_testlink | QA Test Link Guide]] - Guide to do testing with TestLink | |
* [[dev:qa_webpage | QA test matrix]] (Deprecated for SWATs) | |
* [[dev:Selenium_process | Selenium Process]] - Scripts and guide lines for Selenium Process | |
* [[dev:Load Testing/Stress Testing | Load Testing/Stress Testing]] - Load and Stress testing process and results | |
* [[dev:GuidelinesandChecklistforTesting | Guidelines and Checklist for Testing]] - Guidelines and Checklist for Testing | |
| |
==== Performance ==== | |
| |
* [[dev:perf_profiling | Profiling Results]] - SAHANA Profiling results and Recommendations | |
| |
==== Design ==== | |
| |
* [[dev:architecture | Architecture and Framework]] | |
* [[dev:security | Data Security and Privacy]] | |
* [[dev:module_convention | module developers guide ]] | |
* [[dev:configuration | working with configuration settings ]] | |
* [[dev:release_naming_convention | CVS Release Naming Convention ]] & [[http://www.tldp.org/REF/CVS-BestPractices/html/index.html | CVS Best Practices ]] | |
| |
| |
=== Sahana API === | |
| |
* [[http://www.sahana.lk/phpdoc]] is where you find the latest Sahana API documentation. | |
| |
=== Database === | |
| |
* [[dev:SQLSchema |SQL Schema and Database Library]] | |
* [[dev:dbschema_convention | DB Schema with AXMLS]] | |
* [[http://cvs.sourceforge.net/viewcvs.py/sahana/sahana-phase2/inst/ | Main SQL Schemas]] | |
* [[dev:Database Transactions |Database Transactions]] | |
* [[postgreSQL]] | |
* [[dev:sahana_adodb | ADODB abstraction in Sahana]] | |
| |
=== PHP === | |
| |
* [[dev:sysconf | system configuration workings ]] | |
* [[dev:L10N | I18N and L10N]] design | |
* [[dev:Error | Error, Confirmation and Warning messages]] API | |
* [[dev:Session Management]] | |
* [[dev:logging | Logging / Event Auditing ]] design | |
* [[dev:exeptions | Logging / Exception Handling ]] design | |
* [[dev:Navigation handler]] design | |
* [[dev:Web Application Testing]] | |
* [[dev:Form_Handler | Form Handler]] | |
* [[dev:Form_Validation | Form Validation]] | |
* [[dev:TabForm | Form Interface (tabbed)]] | |
* [[dev:Location_Handler | Location Handler]] | |
* [[dev:ActionSequence | Action Sequence]] | |
* [[dev:AdminModule | Admin Module]] | |
* [[dev:UserPrefModule | User Preference Module]] | |
* [[dev:Stream | XML, PDF, Images, Web Services Output Handling]] | |
* [[dev:FrontController | Front Controller and Overriding the Front Controller ]] | |
* [[dev:ReportingLib | Reporting Library ]] | |
* [[dev:ChartLib | Chart Library ]] | |
* [[dev:WebSetup | Web Setup ]] | |
* [[dev:breadcrumbs | Breadcrumb trail ]] | |
* [[dev:stream_security | Stream Security ]] | |
* [[dev:secpolicyxml | Security Policy XML File ]] | |
* [[dev:browsercaps | Browser Capabilities Library ]] | |
* [[dev:onlinecam | Online Webcam ]] | |
* [[swat:RSS Library | RSS Library]] | |
* [[swat:Paging Library | Paging Library]] | |
* [[Web Services]] | |
* [[XST Functionality]] | |
* [[xajax support]] | |
* [[dev:sahana_xform| Sahana XForm]] | |
| |
| |
=== GIS === | |
* [[dev:gis:home | GIS Home ]] | |
* [[dev:GisApi | GIS API (Geographic Information Systems) ]] | |
* [[dev:gis_arch | GIS Architecture ]] | |
* [[dev:gis:gis_structure | GIS Database Structure ]] | |
* [[dev:gis_infra | GIS Infrastructure Roadmap ]] | |
* [[dev:gis_umn_mapserver | UMN/Mapserver Guide -- installation ]] | |
* [[http://sahanacentral.iosn.telehealth.ph/index.php?title=MapServer_for_Sahana|UMN/Mapserver Guide -- usage/configuration: courtesy of [[wp>IOSN]]]] | |
* [[dev:gis:gheat | [[wp>GHEAT]] ]] | |
| |
=== Messaging === | |
| |
* [[dev:msg_archi | Messaging Module & Architecture ]] | |
* [[dev:msg_arch_gsoc | Messaging - SMS Menus ]] | |
* [[dev:msg_kannel_comp | Kannel Compatibility ]] | |
* [[dev:msg_smstools_comp | SMSTools Compatibility ]] | |
* [[dev:msg_gnokii_comp | gnokii Compatibility ]] | |
* [[dev:binary_sms | Binary SMS format and SMS compression ]] | |
| |
=== Advanced Web Setup === | |
| |
* [[dev:saws | Sahana Advanced Web Setup ]] | |
| |
=== About Page === | |
| |
* [[dev:abt | About Sahana page, and module information pages ]] | |
| |
==== Sahana Mobile ==== | |
| |
* [[dev:sahana_mobile_Intro | Introduction to Sahana Mobile ]] | |
* [[dev:sahana_mobile_specs | Technologies & Specifications ]] | |
* [[dev:sahana_mobile_Diagrams | UML & Functional Diagrams ]] | |
* [[dev:sahana_mobile_Req_Specs | Requirement Specifications ]] | |
* [[dev:sahana_mobile_demos | Sahana Mobile Demos ]] | |
* [[http://ajuonline.net/academics/ | Sahana Mobile for Openmoko™ Smartphones [under development] ]] | |
| |
=== Packaging === | |
| |
* [[dev:sahana_packaging_rpm | Packaging Sahana RPM ]] | |
* [[dev:sahana_packaging_deb | Packaging Sahana deb ]] | |
| |
Shell script to create all packages : {{dev:packaging_script.sh.tar.gz|}} | |
| |
=== Framework Migration R&D === | |
| |
* [[dev:fk_requirements | Framework Requirements ]] | |
* [[dev:sahanazf | Experiment with Zend Framework ]] | |
| |
===== Sahana Module Guides ==== | |
| |
Below are links to page discussing development/ideas for existing and new modules included in Sahana. | |
| |
* [[dev:modules:Messaging_Alerting Module | Messaging/Alerting Module]] | |
* [[dev:modules:Situation_Awareness | Situation Awareness]] | |
* [[dev:modules:GPS_Interface | GPS Interface]] | |
* [[dev:modules:Missing_Person_Registry | Missing Person Registry]] | |
* [[dev:modules:Disaster_Victim_Registry | Disaster Victim Registry]] | |
* [[dev:modules:Housing_Registry | Housing Registry]] | |
* [[dev:modules:Image_Tagger | Image Tagger]] | |
* [[dev:modules:Organization_Registry | Organization Registry]] | |
* [[dev:modules:Request/Aid Management | Request/Aid Management]] | |
* [[dev:modules:Shelter_Registry | Shelter Registry]] | |
* [[dev:modules:Web_Services Web Services]] | |
* [[dev:modules:Inventory_Management | Inventory Management]] | |
* [[dev:modules:Streaming_Module | Streaming Module]] | |
* [[dev:modules:Volunteer_Coordination | Volunteer Coordination]] | |
* [[dev:modules:Volunteer_Management | Volunteer Management]] | |
* [[dev:modules:Aid_Catalog | Aid Catalog]] | |
* [[dev:modules:Reporting System | Reporting System]] | |
* [[dev:modules:Synchronization | Synchronization]] | |
* [[dev:modules:User_Preferences | User Preferences]] | |
* [[dev:modules:Administration | Administration]] | |
* [[dev:vita:home | Victim Identification, Tracking and Tracing (VITA)]] | |
| |
===== Sahana Contributors ===== | |
| |
* [[dev:team | Main Sahana II contributors and core team ]] | |
* [[dev:swat_teams | Action oriented SWAT teams]] | |
| |
| |
| |
| |
===== Sahana Google Summer of Code ===== | |
| |
* [[dev:sahana_gsoc_future_ideas | Ideas: Future GSOC]] (if it goes ahead and Sahana is selected) | |
* [[dev:sahana_gsoc09_ideas | Ideas: GSoC 2009]] | |
* [[dev:sahana_gsoc08_participants | Participants: GSoC 2008]] | |
* [[dev:sahana_gsoc08_ideas | Ideas: GSoC 2008]] | |
* [[dev:sahana_gsoc07_participants | Participants: GSoC 2007]] | |
* [[dev:sahana_gsoc07_ideas | Ideas: GSoC 2007]] | |
* [[dev:sahana_gsoc06_participants | Recipients: GSoC 2006]] | |
| |
| |
===== User Interface Refresh ===== | |
* [[dev:ui_refresh | User Interface Refresh ]] Proposal to change the user interface. | |
| |
===== Deprecated / Old Information ===== | |
* [[dev:qa_webpage | QA test matrix and ownership ]] | |
* [[dev:trackers | Old process Bug tracking process]] | |
| |
===== Sahana Graphic Design ===== | |
DEPRECATED - moving to: [[http://wiki.sahana.lk/doku.php?id=des:home]] | |
* [[dev:sahana_logo| Sahana Logo Contributions]] | |
* [[dev:sahana_slogan | Sahana Slogan Suggestions ]] | |
* [[dev:sahana_cd_cover | Sahana CD cover Contributions ]] | |
* [[dev:sahana_tee_design | Sahana T-Shirt Design ]] | |
* [[dev:sahana_theme | Sahana Application Themes ]] | |
| |
| |
===== Sahana Social Networking and Disease Surveillance Modules : R & D ===== | |
Here you can access the draft of the research proposal. Your views on the draft will be highly appreciated. | |
| |
Draft proposal : {{dev:sahandiseasesurveillencedraft1.4.pdf|}} | |