AVHProgrammingRequirements

Prioritized programming tasks for SAPAC
Total time: 18 days (average of 16-20 days)


 * 1) Provide hyperlinks from each input field to a help page.
 * 2) * Estimated Time: 3 hours
 * 3) Make changes to page content from HISCOM specifications, including
 * 4) Consistency of field names in prompts and outputs. Don't use ABCD concept names like unitID, but clear descriptors. Alison to provide.
 * 5) Name of states and Canberra to Herbarium names; change prompt to State/Territory Herbarium.
 * 6) * Estimated Time: 1-2 days - will need to review and provide a complete list of changes to be done and a more accurate estimate of time required
 * 7) Input field validation - and provide appropriate error message
 * 8) Restrict to minimal, high-priority/high-usage fields in the first instance
 * 9) type checking for all input fields that are not just general string - lat/long, dates, numbers, etc
 * 10) queries must have genus as well as species
 * 11) query on record ID needs instituion ID and accession number
 * 12) * Estimated Time: 1-2 days - will need to review and provide a complete list of checks to be done and a more accurate estimate of time required
 * 13) Add support for auto wildcarding of left parts of dates and geocodes not specified, including date range queries.
 * 14) * Estimated Time: Bug fix
 * 15) Fix HTML-output: There are no borders around some of the output boxes in the HTML table, eg. "Other collecters" boxes (Rex suggests add  )
 * 16) * Estimated Time: Bug fix
 * 17) Geocodes outputs should be accurate in restricted area. But should limit to 5 decimal places (this allows for accuracies to 1 m)
 * 18) * Estimated Time: < 0.5 hour
 * 19) Clear button in Simple Query page
 * 20) * Estimated Time: 0.5 hour
 * 21) Create a pull down menu listing standard HISPID5 Infraspecific rank options for ease of use, for public and extended queries.  Changing the interface is easy. However most herbaria are not providing standard HISPID values - e.g. ssp ssp. subsp subsp. - so need some work to edit and standardize them.
 * 22) * Estimated Time: 3 hours
 * 23) Allow query on NULL to find records with NULL value for that field ?
 * 24) * Estimated Time: If we can just specify in the user guide that users can use isNull then no work is required, if we want to accept a string like NULL it will require more effort.
 * 25) Add: toggle button to either select all Herbaria or clear.
 * 26) * Estimated Time: 0.5 hour
 * 27) Deliver records collected from one or more States (location of collection), drop down list of States (SA, NSW, WA etc.), and All. Like in extended query, but ability to choose more than one state (this should also be changed in extended query)
 * 28) * Estimated Time: 3 hours
 * 29) Data download just in CSV for public simple query? HISCOM to decide as part of user interface review.
 * 30) * Estimated Time: 0.5 hour
 * 31) Wider box size that can handle full genus or species name - 12 characters?
 * 32) * Estimated Time: 0.2 hours
 * 33) Make names of fields in outputs consistent with names of query fields, and for extended fields modify which fields to output and default order of output.  Specification to be provided by HISCOM/Alison.
 * 34) * Estimated Time: 3 hours
 * 35) For CSV and HTML outputs of all queries, add separate fields for genus, species, infra rank, infra name and qualifier, before full scientific name.
 * 36) * Estimated Time: 1 hour
 * 37) For extended query, input a list of species names (genus species subspecies) for bulk searching
 * 38) * Estimated Time: 1 day
 * 39) How to deliver large outputs - provide option of a URL for a data file, which is removed after a couple of days. This requires modifying AVH code to directly generate CSV rather than XML, which will take some time.
 * 40) * Estimated Time: 2-3 days
 * 41) Data consistency - modify some fields to HISPID5 standards on data load and during database load and dynamic indexing from BioCASE providers.
 * 42) countries
 * 43) nearest named place - null values replaced with "not available"
 * 44) Standardize collectors field number so that null values are replaced with "s.n."
 * 45) null date fields replaced with "s.dat." if it is a text fields
 * 46) remove family name from Darwin full sci name
 * 47) states - there are currently 110 values in the AVH database, many of them are actually regions rather than states (need to investigate and work with herbaria to fix this problem), some are islands (Norfolk, Lord Howe). However consistency for most fields is easy - just consistency with South Australian vs SOUTH AUSTRALIA vs SA. Use HISCOM/HISPID5 standard.
 * 48) * Estimated Time: 1.5 day for dealing with simple conversions to HISPID5 standard.
 * 49) For public output, decimal lat/long changed to 0.00, 0.17, 0.33 etc rather than 0.2, 0.4, etc and for the public mapper, points on the map should be on a 10min grid and 10 mins in size
 * 50) * Estimated Time: 3 hours
 * 51) Problems with querying on different countries in login simple query.
 * 52) * Estimated Time: Bug fix
 * 53) No family column in extended query output
 * 54) * Estimated Time: Bug fix
 * 55) Addition to existing wildcard searches.  For queries on strings (e.g. names, localities, etc), if user puts in a word but not a wildcard, e.g. Barker, Adelaide, etc then return all records that include this word in the string.  To be done for:
 * 56) full scientific name
 * 57) determined by
 * 58) determination/determiner
 * 59) collector
 * 60) other collectors
 * 61) nearest named place
 * 62) locality text
 * 63) * Estimated Time: 1 day
 * 64) Query for gecode precision less than X returns values with precsion greater than X.
 * 65) * Estimated Time: Bug fix
 * 66) Add drop-down menu to allow selection of <=, >= or =, with default being <=
 * 67) * Estimated Time: 0.5 hour
 * 68) Wrap text for long output strings in HTML to keep fixed box width, e.g. Notes
 * 69) * Estimated Time: Bug fix
 * 70) Drop down selection menu for a small number of countries in the Australasian region, as well as text input. HISCOM to specify countries required.
 * 71) * Estimated Time: 2 hours
 * 72) Split into two URLs for public and restricted.  Restricted page should have specification for no web indexing from Google etc.  HISCOM to provide HTML for each screen.
 * 73) * Estimated Time: 1/2 day
 * 74) New Proposed Task.  Simple query for restricted login should return same outputs as extended query by default.  HISCOM needs to specify what default fields should be returned in resticted login. Suggest MoU plus a few other useful fields.  Extended query allows users the option to request more fields.
 * 75) * Estimated Time: 1 day
 * 76) New Task.  Cron script to check that all AVH instances are working and email sysadmin if not.  Requires modifying admin web interface to specify AVH URLs and emails for sysadmins This could be run at multiple sites (which would mean multiple emails to sysadmins).
 * 77) * Estimated Time: 4 hours
 * 78) New Task. Synchronize user accounts between multiple AVH instances.
 * 79) * Estimated Time: 1-2 days
 * 80) New Task.  Provide data for how many queries are processed, how many records returned in total and from each herbarium.  Information required should be specified by HISCOM.
 * 81) * Estimated Time: will depend on what info is required, but at least 2 days
 * 82) When state or states are selected in extended query, automatically provide drop down list of herbarium regions for those states.  HISCOM would need to provide the lists.  This is currently listed as Medium priority - to be done only if there is time in initial 3 weeks of work.
 * 83) * Estimated Time: approx 1 day

Mapping and priority contingencies
Time: up to 2 days


 * 1) High-priority contingencies arising during the work
 * 2) Changes to map output as specified by HISCOM

Proposed changes to mapper include:

LIKELY END OF FIRST TWO DAYS WORK - HIGHEST PRIORITY TASKS FOR PUBLICLY RELEASABLE SEP 2008
 * 1) Minor changes to map results page:
 * 2) Overlay text on the map should say "Generated on day/month/year, copyright Australia's Virtual Herbarium"
 * 3) Under list of records for each herbarium, don't need to say e.g. BRI 54 records, just BRI 54
 * 4) Ibra should be IBRA
 * 5) Better explanation about clicking on dots to query point
 * 6) * Estimated time: 0.5 hour
 * 7) Change default so that it uses different icons for different species, not different herbaria.
 * 8) * Estimated time: 0.5 hour
 * 9) Legend should be downloadable as well as the map. Move the location of the legend to be level with the top of the map. Currently you have to scroll up and down between the map and the legend.
 * 10) * Estimated time: 3 hours
 * 11) Clarify presentation and explanation of the actions of checkboxes and buttons.
 * 12) * Estimated time: 0.5 hour
 * 13) Add a "Redraw map" button on the right hand side after "Display options" and before "Click between dots" so you don't have to move the mouse from side to side. The text about "Click on dot ..." can go after "Click between dots" or even under the map, to save vertical realestate.
 * 14) * Estimated time: 0.5 hour
 * 15) Default icon (e.g. for query on 1 species) should be red circle with white border. Bill suggests the first icon be a red circle (or square) outlined in white. Solid red (no outline) makes it difficult to distinguish many overlapping points.
 * 16) * Estimated time: 1 hour
 * 17) Investigate performance of mapper for large numbers of specimens and modify specification of warning limits and hard limits. SHould be able to handle more than 10K specimen records.
 * 18) * Estimated time: 1 hour
 * 19) Change the icons used - no one seems to like the ones we inherited from AVH1. Could change to instead use circle, triangle, upside-down triangle, with different colours.
 * 20) * Estimated time: 2-3 hours
 * 21) Make it clear that only one of terrain, temperature and rainfall can be selected. Could use radio buttons but then you can't turn it off once if is clicked by mistake. Probably use Javascript plus text to explain
 * 22) * Estimated time: 1 hour
 * 23) Help needs to be writen to document the actions of the many checkboxes and buttons. Eg. what does "Show by precision" and "Do not separate" mean?
 * 24) * Estimated time: 4 hours


 * 1) Change default layers to not include terrain. However if we were to do that, we would first need a new version of the default coastline layer - otherwise land and sea are all white. Has anyone got a shapefile like that from their AVH1? NSW?
 * 2) * Estimated time: 3 hours if we get the shape file
 * 3) If New Zealand or New Guinea are selected for country query, move the default map view to show them rather than Australia
 * 4) * Estimated time: 2-3 hours
 * 5) Layers for major roads, rivers and elevation contours. These are apparently available in some implementations of AVH1 - maybe NSW? If we can get the shape files we can easily add them to AVH2.
 * 6) * Estimated time: 1/2 day if we have the shape files
 * 7) Improve the performance of the mapper and increase the number of specimens that the mapper can handle with reasonable response time.
 * 8) * Estimated time: 1-2 days
 * 9) Make the size of the dot be related to the geocode precision
 * 10) * Estimated time: this would require a fair amount of work, maybe a couple of days, since current code uses images for the dots.
 * 11) The latitude and longitude needs to expand to a finer granularity as you zoom in. Labels of the latitude and longitude values need to be added.
 * 12) Clicking on a point or specimen should not resize the whole browser window under Firefox (1.5).
 * 13) Add a "Monochrome map" button for grey scale printing.
 * 14) Do we need a "Collapse subspecies" button so that only one symbol is used for all infraspecific names, rather than the current situation of a different symbol for each infraspecific name. We could also have options to "Collapse species" to the genus level, and "Collapse all" for one symbol for all specimens.
 * 15) Might need to set a limit on the extent to which you can zoom in or out, so that the map redraws properly.