Changes between Version 130 and Version 131 of Contribute/Code

11/02/13 11:16:42 (11 years ago)
Fran Boon



  • Contribute/Code

    v130 v131  
    55* [wiki:Develop]
     7There are tasks suitable for coders of various levels. Sahana Eden using Python, !JavaScript and HTML.
    79Tasks that you can engage with:
    810* Pick one of our [ Easy Bugs] to fix
    911* Review CI Server Results
    11 There are tasks suitable for coders of various levels. Sahana Eden using Python, !JavaScript and HTML.
    13 == Projects ==
    14 If you want to get more involved with Sahana Eden, make a longer term commitment and make some really valuable contributions, have a look at a BluePrint or [wiki:Projects/Advanced Code Projects List] for some ideas of what you can work on. These would be suitable for GSoC projects.
    16 == Review CI Server Results ==
    17 You can subscribe to the results of the [SysAdmin/ContinuousIntegration CI Server] on the [ Sahana Eden CI Server Mailing List]. Any errors found can either be [BugReportingGuidelines reported] or fixed. Make sure that you replicate the errors locally to ensure that it isn't an error with the test.
    19 == Easy Tasks ==
    20 ''Tasks for beginning coders, or if new to Python or web services''
    22 === Fix a Ticket ===
    23 Pick a ticket (which could be a bug or an enhancement) from First ensure that you can repeat this in your local instance - if not: MODIFY TICKET > resolve as > worksforme. If the bug is still present, assign the ticket to yourself. Then fix the bug or implement the feature. Submit your code as a patch to the ticket on Trac, then notify the Sahana-Eden mailing list about your patch for verification. Please submit as a patch file, not zipped. That makes it easier to review without downloading and unzipping. Alternatively (preferred method) push your code in a single commit to your Github repository and make a pull request.
    25 Easy tickets to get started on are listed here:
    27 === Common Operational Datasets [GCI] ===
    28 ''Added to GCI spreadsheet.''[[br]]
    29  * Purpose and schemas for common datasets (schemas are at end):
    30  * Add model definitions for these schemas. This work was started but is not included in the current version of Eden. An example from an old version is here: [ models/]
    31  * Think about how we could make use of them.
    32   * Display on the Map?
    33   * Have Reports which compare the baseline & situational assessments?
    35 === GIS/Mapping [GCI, multiple tasks] ===
    36 ''Added to GCI spreadsheet''[[BR]]
    37 These are various GIS/Mapping Tasks:
    38  * [=#AddOnHoverDelay]'''Add a delay to the onHover tooltip''' (highlightControl)
    39   * Something like [ hoverIntent]
    40  * [=#PotlatchIntegration]'''Continue Integration of [ Potlatch]'''
    41   * for editing the main OSM database
    42   * for editing a local OSM database
    43  * [=#FeaturePopupWindow]'''Make the display_feature() & display_features() popup a Window''' instead of opening in a DIV
    44   * This was working in FF before:
    45  * [=#GeoExtMeasure]'''Replace the Measure !Length/Area tools with [ GeoExt.ux]'''
    46  * ~~[=#FullScreenMap]Option to go Full screen & back~~
    47   * ~~Full screen view (No Ext window) will be required for use on a small-screen, such as a Mobile device~~ (completed by aviraldg)
    48  * [=#LayerTree]'''[ Layer Tree]'''
    49  * [=#LookupPresence]'''Create a pr/person/presence record upon login''' if HTML5 !GeoLocation available & has changed since last time
    50   * login_next
    51  * [=#MapPreview]'''Map Preview when !Lat/Lon set in pr/person/presence''' (auto or not)
    53 [wiki:DeveloperGuidelinesGIS Use the Mapping API to:]
    54  * [=#ColorCodedMaps]'''Color coded maps according to Geo-data''' (threats, needs, etc)
    55  * [=#VariableSizedMarkers]'''Place variable sized markers on the map in proportion to data''' (number of people in camp, number of families needing food)
    57 === !Lat/Lon converter [GCI] ===
    58 ''Added to GCI spreadsheet''[[BR]]
    59 Portuguese Volunteer Firefighters ([Deployments/Portugal/Bombeiros Bombeiros]) use Eden.
    61 They get given !Lat/Lon coordinates in degrees minutes seconds, but Eden stores internally as decimal degrees.
    63 Tasks:
    64 * Create a represent function to output the data as degrees minutes seconds, e.g. 57°55'56.6"E.
    65  * [[|Examples of lat lon formats]]
    66 * Create a validator (& possibly widget) to allow entry of this format (allowing for variations in input format like spaces and absence of the degree symbol, which most keyboards don't have) & have it converted to decimal degrees for storage
    68 === Scale Uploaded Images [GCI] ===
    69 ''Added to GCI spreadsheet''[[BR]]
    70 When images are uploaded we can limit the size, however larger pictures should be scaled instead. Example: personal profile picture.
    72  * [This part is done, see #1016] This should be implemented as a Validator {{{modules/s3/}}}).  The size limitation should be configurable in the model for that specific field, with a sensible default.
    74  * [GCI task, #1017] UI to to allow user to crop image (this would be a widget: {{{modules/s3/}}})
    75   * Ideally the image would be resized client-side to make it faster to upload...this might be hard with pure JS, so would need to be Flash?
    76   * Maybe: (e.g. from )
    78 === Suggestion Box [GCI] ===
    79 ~~''Added to GCI spreadsheet''[[BR]]
    80 (Original suggestion from:
    82 Here are some potential features for a "suggestion box", roughly in order of priority:[[BR]]
    83 ''For GCI, the first four bullets are the task.''~~
    84  * ~~Text data entry form -- just use standard Eden database fields like "timestamp", "authorstamp", and "comments", maybe with a subject field.~~
    85  * ~~Allow defining topics or keywords. Let user choose a topic for their suggestion. Add all module names as an initial list of topics. (Perhaps add a suggestion_topic table for this, and allow a suggestion to have multiple topics.)~~
    86  * ~~Simple search in the body of posts -- match words.~~
    87  * ~~Allow commenting on (replying to) suggestions -- show comment thread with original post. (Note threading now works with a normal comment field, so should not need to do much for this but see how it's handled for other comments.)~~ (completed by aviraldg)
    88  * Regexp search.
    89  * Some form of importance rating (e.g. voting up or down).
    91 === Map elements between EDXL-SITREP and EDXL-RM ===
    92 ''Not added to GCI spreadsheet -- time required says a week.''[[BR]]
    93 Proposed by: [ | Nuwan][[BR]]
    94 '''Specific    : ''' There are several elements within the [ | EDXL-SITREP] data standard that are identical to that of [ | EDXL-RM]. The objective is to create a descriptive table of those elements that a programmer can use to develop a set of procedures to strip the RM data from SITREP to manage records in the relational database [[BR]]
    95 '''Measurable  : ''' Requires diligently investigating each and every data element then comparing them with the two data standards SITREP and RM. Requires knowledge of data types and XML. If not, this exercise will help the student learn about XML and data standards [[BR]]
    96 '''Attainable  : ''' [[BR]]
    97 Step 1 :: Go through EDXL-RM and EDXL-SITREP documentations [[BR]]
    98 Step 2 :: create example files to get an understanding of the data and structure [[BR]]
    99 Step 3 :: develop the table with RM and SITREP elements with a description [[BR]]
    100 Step 4 :: develop a simple XSL file to strip the RM data from SITREP [[BR]]
    101 '''Relevant    : ''' Applies to Sahana interoperability policy. Given that Eden does support resource and incident management, it is important to derive the response resources and resource requirements from situational reports. This function would help automate some of those data extraction functions. That requires integrating the SITREP and RM components with underlying Eden schema [[BR]]
    102 '''Time-bound  : ''' The exercise of understanding the data standards and mapping the elements should not take more than one week. developing a XSL to test the mapping may take another week, depending on the level of expertise with XML. (NB this is far too large a task for GCI. -- Pat)[[BR]]
    103 '''Evaluate    : ''' The mapping table is the determining output. However, the example RM and SITREP files are also required. [[BR]]
    104 '''Reevaluate  : ''' If the XSL transformation is developed, then the mapping can be tested with the sample RM and SITREP files [[BR]]
    106 == Intermediate  Tasks ==
    108 === Feature Enhancements ===
    109  * Fix UI issues, add features, provide user-requested enhancements.
    110   * You can pick from these [/report/21 feature requests].
    112 === OSM Importer UI [GCI] ===
    113 ''Added to GCI spreadsheet.''[[BR]]
    115 ==== Current Status ====
    116 * There is an import stylesheet for .osm files: static/xslt/import/osm.xsl
    117 * This currently has hard-coded mappings between OSM admin levels & Sahana admin levels
    118  *
    119 * There is an S3ImportPOI method to allow features to be extracted from either an uploaded .osm file or an OSM mirror:
    120  *
    121  * this is accessed from the 'Import from OpenStreetMap menu option in /eden/gis
    123 ==== Enhancements Needed ====
    124 5 separate GCI Tasks here:
    125 1. We need to add the Sahana UUID to these features in the OSM database.
    126  * This is needed so that we can do deduplication on subsequent imports (the OSM ID is insufficient for this as it can change over time)
    127  * This means we need to read the OSM credentials (currently a deployment_setting in & do a REST API call to the main OSM database with the modified feature(s)
    128 2. Move the OSM credentials from a global deployment_setting to a per-user setting (component resource of db.auth_user)
    129 2. We would like to be able to control which features are imported from this UI (currently this is a deployment_setting in [000_] - that should become the list of avaialble options rather than the absolute list)
    130 3. We would like to be able to download features for a Location from main OSM database
    131  * We want to use the Polygon (falling-back to BBOX (min_lat, max_lon, etc)) to trigger a download of a suitably-filtered .osm file via the [ Overpass API]
    132 4. We would like to be able to download features for a Polygon
    133  * Provide a map window with a Polygon selector tool which then triggers a download of a suitably-filtered .osm file via the [ Overpass API]
    134 === Fix a Hard Ticket ===
    136 Pick a bug report from, try to reproduce the issue in a local instance, fix the problem and submit a patch to the ticket on Trac, then notify the Sahana-Eden mailing list about your patch for verification.
    138 === Build library(ies) to integrate Emergency Data Exchange Language Distribution Element ===
    139 ''Not added to GCI spreadsheet -- outside time bounds. Can it be split or cut down?''[[BR]]
    140 Difficulty : '''HARD''' proposed by: [ | Nuwan] [[BR]]
    141 '''Specific  : '''[ | EDXL-DE] is the final wrapper (envelope) of all [ | EDXL] data package. We may be delivering a EDXL Resource Management (RM) information and Situational Reporting (SITREP) information to the managers of several emergency organizations. The DE will contain who, when, and where those RM and SITREP data parcels would be delivered. Every EDXL message (data package) must carry this information. Otherwise, it cannot use available distribution methods and would need to rely on its own protocol; that's not very user friendly. [[BR]]
    142 '''Measurable: ''' It is purely a coding task that involves playing with XML and developing a class, possibly within or using the '''??? 3R**** ???''' framework It is basically a set of procedures for packing and unpacking EDXL-DE wrapped data. [[BR]]
    143 '''Attainable: ''' run through the steps [[BR]]
    144 Step 1 :: select one of the existing EDXL-based applications in Eden, I recommend the EDXL-RM [[BR]]
    145 Step 2 :: discuss each of the attributes/elements; then determine how EDXL-DE would be added to EDXL-RM as a pop-up GUI. [[BR]]
    146 Step 3 :: create some example XML files to get a feel for the inputs and outputs [[BR]]
    147 Step 4 :: write code to add to take the inputs EDXL-RM and EDXL-DE to package the data for delivery [[BR]]
    148 Step 5 :: test the code, fix bugs, and generalize the functions [[BR]]
    149 Step 6 :: Apply to EDXL-HAVE and EDXL-SITREP to generalize the library [[BR]]
    150 '''Relevant  : ''' Applies to Sahana Interoperability policy. Present developments to investigate are: HAVE, RM, and SITREP [[BR]]
    151 '''Time-bound: ''' If steps 1 - 4 are completed that can be a full accomplishment; additional work is a bonus [[BR]]
    152 '''Evaluate  : ''' Produce XML files with the EDXL-DE element appended to the EDXL-RM, SITREP, or HAVE[[BR]]
    153 '''Reevaluate: ''' Use an API to add and strip the EDXL-DE to any EDXL data standard. Use the same set of XML files to run through this process [[BR]]
    155 == Advanced Tasks ==
    156 These are smaller tasks that could be completed over a few days:
    157 * Better handling of image and file uploading and representations
    158  * Multiple-File Upload with Previews:
    159  * Represent function for full image or thumbnail
    160  * Lightbox viewer for full sized image
    161   * e.g. Make use of the one within Vulnerability module
    162 * Switch between an update and read page using JS
    163 * UI
    164  * Review CSS & for different themes to avoid duplication
    165  * Ensure that elements have consistent design & class/id tags and can easily be customized
    166   * Buttons
    167   * Tables
    168   * Popups
    169   * Fonts
    170   * Throbbers
    171  * Use class/id tags which is consistent with [ Bootstrap] / JQueryUI to support easy re-theming (Can copy bootstrap) from
    172  * Implement a new default theme
    173   * Re-implement some of the existing themes using the new default theme as a base
    174  * Implement an inline login form that appear inline the top right of the menu and doesn't require loading a new page (like for eg.
     12 * You can subscribe to the results of the [SysAdmin/ContinuousIntegration CI Server] on the [ Sahana Eden CI Server Mailing List]. Any errors found can either be [BugReportingGuidelines reported] or fixed. Make sure that you replicate the errors locally to ensure that it isn't an error with the test.
     13* [wiki:Projects/Quick Tasks]
     14 * Smaller Tasks, e.g. suitable for GCI or Hackathons
     15* [wiki:Projects/Advanced Projects]
     16 * Longer-term projects, e.g. suitable for GSoC
     17* [wiki:BluePrint BluePrints]