Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

We need to make map titles consistent #3083

Closed
easmetz opened this issue Jul 28, 2016 · 3 comments · Fixed by #3114
Closed

We need to make map titles consistent #3083

easmetz opened this issue Jul 28, 2016 · 3 comments · Fixed by #3114

Comments

@easmetz
Copy link
Contributor

easmetz commented Jul 28, 2016

Problem

Titles vary from map to map. We need consistency across maps.

Proposed Solution

Make all report titles consistent with the new standards found in https://github.com/inasafe/inasafe/blob/develop/docs/reporting-standards.md

cc

@Charlotte-Morgan

@easmetz easmetz added this to the Version 3.5 milestone Jul 28, 2016
timlinux added a commit that referenced this issue Aug 5, 2016
* Implementation for standardised map titles and layer names. See https://github.com/inasafe/inasafe/blob/develop/docs/reporting-standards.md. fix #3083

* For generic IF's, use simpler title format as per standards doc
timlinux added a commit that referenced this issue Aug 10, 2016
* Get rid off X in test name.

* Skip slow test only on travis.

* Small pep8.

* make the exposure/hazard visible when we add them from IFCW

* Fix test data.

* Show if we are running slow tests

* copy the dock behaviour to the wizard when the analysis is finished

* Fix #2969

* Fix failed test.

* Fix failed test.

* Fix tests

* Better handling in wizard for MetadataError from old xml keywords.

* use unicode if the layer name has some accents

* Fix #2913 for key error classified polygon population IF.

* Do not read impact layer's report when there is zero impact.

* add translations for countries

* Show proper message when there is invalid keyword.

* Add missing keyword data test.

* fix imports

* fix failed tests in qgis_testrunner.sh

* remove potential-idp, add grid jakarta and landcover to the test layers

* Call Report constructor in each IF

* use more POO in reports

* fix the question inheritance

* fix landcover imported twice

* display a nice error message if MemoryError

* fix #2858 not affected legend in classified raster building IF

* fix translated legend and attribute table

* Remove the building threshold fix #2932

* fix tests about threshold

* Remove print and add clearer comment.

* add missing translations in the road/building report

* add missing translations in notes

* Add message for missing keywords #2926.

* PEP8.

* Add header.

* Add more comment and add more catcher.

* reverse the impact summary for roads report #2950

* fix tests

* minimum needs : add a button to restore defaults

* Use suggestion style instead of info style

* Update string for message.

* Fix parsing date without timezones

* Add switch for Windows timezone mapping

* Move metadata definitions one level up.

* Fix docs

* Update keyword version.

* Add ash raster IF to loader.

* Add initial commit for Ash Raster Population IF.

* Initial commit for realtime ash report test

* Ash raster on population is running, but need to check the result.

* update dataset to 3.5

* It works but not good result.

* Cleaner approach.

* Refactor how notes are handled (#3023)

* Fix #2973 - explain about rounding used in presented reports. Fix issue introduced by #2845 which added invalid notes to generic landcover IF. Fixed issue in generic landcover IF which was not inheriting the mixin and thus failing to render the notes properly. Moved floods.shp test data to jk so it intersects with landcover.
* Updated all impact functions to include notes helper from impact function base and return a list of notes rather than a dict
* Added readme for JSON examples
* Move more actions into definitions.py and add hazard based actions to all IFs
* More DRY for actions - implement actions and notes and IF base class and use standard form for creating them unless an IF needs special behaviour.
* Added actions method to mixin base
* Fix failing tests resulting from notes and actions refactoring. Other cleanups to tests
* Refactor unit test for test_tsunami_landcover so that tests pass and are easily comparable with dock values
* Use almost equal for tsunami on landcover test so that it works on different platforms
* Fix for travis test with tsunami landcover

* refactoring report templates,merging child class buildings and roads (#3029)

* refactoring report templates,merging child class buildings and roads

* refactoring report templates

* docstrings

* remove useless import

* Make test.

* Replace people with population.

* Fix failed test on travis.

* PEP8.

* Another fix failing test.

* Code standarads.

* Impact data should be in raw format.

* Add pdf generation tests.
Fix tests.

* Update PyCharm logo

Fix #3037

* More appropriate URL

* Fix #2746, remove Entire area.

* Fix failing test.

* Removed the impact merge tool. fix #2909. (#3036)

* Update Ash template

* uncomment logo path calculations

* ash on places

* add airports dataset

* Add backend celery infrastructure for Ash Realtime

* Fix #2966 - support more formats than just png for custom map north arrow and organsiation logo (#3040)

* Fix #2966 - support more formats than just png for custom map north arrow and organsiation logo

* Fix some imports in template_composition

* fix #3034 - remove duplication of hazard and exposure concepts in def… (#3035)

* fix #3034 - remove duplication of hazard and exposure concepts in definitions.py. Also did some other refactoring and cleaups in definitions.py. See also #2704

* Update hazard and exposure terms to use Libby's terms from #3014

* add units in roads/places reports and refactoring

* More dirty hack.

* Fix #2746. Skip post processor for road and structure if entire area.

* Revert back changes.

* Small pep8.

* update exposure layers with new keywords

* Metadata definition cleanups from @easmetz (#3046)

* fix #2911 - PetaJakarta layer style not working (#3044)

* add headings for roads/places/buildingsin the impact summary

* add total line to the road impact table

* Add Realtime Ash functionality

* Add name and population fields to the wizard about place exposure (#3047)

* Add name and population fields to the wizard about place exposure

* Enable multi-selection in the drag and drop

* Let there be citations. Added forma citation structures to definitions and all impact function metadata. Not exposed in any reports yet. (#3049)

* Add nearby-table calculation

* disable inset layer

* fix zoom layer

* remove clear_further_steps in exposure places classify

* Move version compatibilities to definitions.py

* Only show unique volcano names.

* PEP8.

* Refactor report generation for Realtime Ash:
- Create templating system for population, nearby and landcover table
- Display overview map and collation
- Add environment variable for additional layer context
- Fix AshRasterPlaces and AshRasterLandCover so it calculates Unaffected exposure correctly

* Minor text tweaks (#3066)

* Reporting standards (#3027)

* Don't use 'quake' tmp dir for tests. Minor code cleanups.

* Create reporting-standards.md

* Show only title section

* Fix plugin load error (#3075)

* Fix for #3070 - raven import error on start up

* Update ash report styling

* Inserted definitions of displaced and evacuated into population in buildings/population notes (as they are the same). I am not completely sure if I have cited correctly as the link is too long for the space available. The definitions are slightly inconsistent in their wording as I have used the exact UNISDR definitions. I think it would be wise to edit them for consistency of wording (ie persons vs people, etc) but I'm open to comment.

* changes to correct how the citations are done - I did them incorrectly the first time

* removing rogue comma

* changing "persons" to "people"

* Added a make command so nightlies can be triggered locally (#3074)

* Don't use 'quake' tmp dir for tests. Minor code cleanups.

* Added make task for building nightlies

* Also sync the nightlies locally when running make-nightlies

* changed focus from exposure_people_in_buildings to exposure_population.

* inserted new concepts: displace, evacuated

* added definition for concept "affected"

* shortened description of ITB Bayesian EQ IF to fit into wizard window

* improved definitions of 'count' and 'density' to help users in wizard

* removed markdown "affected"

* removed statement "there are no InaSAFE Impact Functions that use this exposure data yet"

* removed statement about the "people_in_buildings" dataset being experimental

* changed "persons" to "people" according to feedback from Charlotte

* replace areas with zones
fix capitalisation
replace moderate with medium

* removed "the" before "people in buildings"

* fix #3071 (#3094)

* Reporting standards (#3078)

* Updated reporting-standards.md - map legend titles

* Updated reporting-standards.md - structure

* added other guidelines and terminology

* removed erroneous carriage return

* Update reporting-standards.md

* Update reporting-standards.md

* added detail on question syntax

* inserted more details

for notes and assumptions, analysis details and action lists

* Update reporting-standards.md

* tidying up to fit 80 character limits

* changes to make map titles more verbose and add general rules.

* changes to make map title section and legend title section more consistent

* added detail for notes and assumptions, analysis question
added definition for affected

* changes to the format (colour) of the reference tables, changes to how the sentences introducing the reference tables and syntax are worded

* added examples for questions and notes and assumptions

* fixed "examples" heading in "notes and assumptions"

* added specific mention of impact function in notes and assumptions

* changed according to Charlotte's feedback up to line 154.

* changed "which" to "what" in exposure measure.
changed exposure type and hazard type to exposure and hazard respectively.

* tweaked according to feedback from @charlottemorgan to the end - changed words about action checklist content

* removed or changed rogue "type"s

* tweaks to explicitly state the generic map title syntax in accordance with Charlotte's feedback
changed scenario to event to  be consistent with terminology

* changed "areas" to "places" in analysis question matrix

* inserted standard text about exclusion of rows and columns with 0 or 'no data' values

* added status table to beginning of document. minor tweaks to rest of document (formatting, capitalisation)

* added status of overall examples

* changed zombie mistake

* incorporated Tim's brain dump for roads, volcano, tsunami and places. (#3093)

* Minor fixes (#3096)

* Minor text tweaks
added single and multi event notes for volcano

* Fix volcano names in volcano point.

* Fix radii sorting in volcano point.

* Fix volcano names in volcano polygon IF.

* PEP8.

* fix volcano notes

* fix volcano notes

* Fix population thousand separator.

* update test text string

* fix #2804 - make checking the analysis environment more efficient by not reading the full raster each time you pan or zoom (#3102)

* fix #2804 - make checking the analysis environment more efficient by not reading the full raster each time you pan or zoom

* Fix failing test for #2804

* Add thousands separator per #3089.

* add notes for all hazards (#3104)

* Add more format for datetime per #3076

* Add zero impact exception if no wet in value mapping. Fix #3108

* More zero impact exception on the other IFs.

* By pass Unknown geometry type.

* Add custom bullet list.

* Use tick for action checklist. Fix #2430.

* Better setup for postprocessor and checker.

* Implementation for standardised map titles and layer names. (#3114)

* Implementation for standardised map titles and layer names. See https://github.com/inasafe/inasafe/blob/develop/docs/reporting-standards.md. fix #3083

* For generic IF's, use simpler title format as per standards doc

* Updates to SPHERE standards - see #3065 (#3081)

* Updates to SPHERE standards - see #3065

* Capitalise relief item names for SPHERE

* Tweaks to add soap, detergent and stoves to SPHERE needs

* Fix failed unit test.

* Tidy up code.

* PEP8.

* Do not show total if it is Age, Gender, or MinimumNeeds. Fix #3118

* Fix for #2998 - show correct attribution for each earthquake IF (#3116)

* Fix for #2998 - show correct attribution for each earthquake IF

* Fix for acknowledgement notes in Pager, ITB, ITB Bayesian IFs. See #2998

* fix #3117 - Add citations to concept definitions in definitions.py

* Support more granular definition of notes  (#3110)

* Support more granular definition of notes and remove duplication of content in definitions.py. fix #3109

* Fixed bug in #3109 implementation which caused hazard notes to always be none

* Updated population based actions as per #3057 (comment)

* Use correct reference to hazard category in metadata

* Fix formatting in eq IF

* Added support for layer_mode specific notes in exposure layers too. Also fix issue with mode keyword for hazards. See #3110

* Reverse inadvertent commit on buildings keywords

* Small typo and coding standards for translation.

* Typo.

* Add question mark for fixing #3122

* Add unit test to catch the bug.

* upgrade inasafe requirement

* Translation 3.5 (#3124)

* Update translation strings.
* Add new vietnamesse translation.
* Update translation
* Update strings.
* Add vi and es_ES to LOCALES.

* add citations for concepts

* add new concepts for affected_people, killed_people, injured_people

* Fix #2750 by storing the non conflicting attribute name.

* PEP8.

* Elaborate comment.

* Translation 3.5 (#3130)

- Update translation for 3.5

* Merge branch 'develop' of http://github.com/AIFDR/inasafe into realtime_ash

* Update earthquake template

* Add logo for place and image credit #3405.

* Better formating svg.

* Fix tests

* Handled weird timezones gracefully

* Translation 3.5 (#3134)

* Update translation strings.

* Update translation for transifex.

* Update strings.

* Update translation.

* Update string.

* Add vietnamesse to Makefile

* Add vi and es_ES to LOCALES.

* Add new vietnamesse translation.

* Update translation.

* Update strings.

* Update translation.

* Update strings.

* Update translation.

* Add Vietnamesse to compiled language.

* Compile translation.

* Update string.

* Delete unused nl_BE translation.

* Update translation.

* Compile translation.

* Update strings.

* Update translation.

* Update strings.

* Update translation.

* Compile translation.

* Add changelog for 3.5 (#3125)

* fix tests

* Release tweaks... (#3136)

* Updated CHANGELOG for 3.5.0

* Changed designation to final final 3.5.0

* Fix for file filters not working right in options dialog

* Disable classify tool for 3.5
@Charlotte-Morgan
Copy link
Member

Hi @timlinux - this PR does not quite fix all the map titles. I have reopened the ticket.

Problem

all map titles have changed but are not quite right

Map titles for raster hazard data seem to be fine.
Map titles for vector hazard data seem to be treated as generic data.

In the standard, the generic option refers to when the hazard keyword is generic, not when the IF is generic.

The result is in some cases a regression. Eg for an earthquake hazard map in Nagekeo, the map title used to say "Buildings affected by each hazard zone"
it now says "Buildings affected"
we would like it to say "Buildings affected by earthquake hazard"

Proposed action

please review and fix or hold for 3.5.1

@timlinux
Copy link
Contributor

Hi @Charlotte-Morgan

In the standard, the generic option refers to when the hazard keyword is generic, not when the IF is generic.

Oh ok understood, will fix.

timlinux added a commit to timlinux/inasafe that referenced this issue Aug 11, 2016
…d layer_name elements. Removed those items from IF metadata. Make sure all IF's use map_title() method to get the layer name and map title
@timlinux
Copy link
Contributor

Hi @Charlotte-Morgan

Ok I have implemented the fix for InaSAFE 3.5 (see PR at #3146)

Here is an example with generic IF and vector hazard + exposure (taken from your lovely training projects):

screen shot 2016-08-11 at 3 32 26 pm

Just two things to note:

  1. In the standards doc it refers to buildings as exposure type. Long ago there was a debate about this and it was decided to use the term 'Structures' rather than 'Buildings' because the exposure layer could also include other types of things like power substations, city infrastructure etc. I don't mind changing it back to buildings as it probably does cover the more general use case. So either we should change the definitions to Buildings, or the standards doc to Structures.
    2)I'm not sure if I mentioned in my original patch, I have changed the generated layer name for the impact layer to use the same text as the map_title. It seems more logical to me and the previous implementation was a hodgepodge of different naming styles - everything is consistent now. If you prefer another system, we can document it in the standards doc and I will implement it.

timlinux pushed a commit that referenced this issue Aug 11, 2016
* Implementation for standardised map titles and layer names. See https://github.com/inasafe/inasafe/blob/develop/docs/reporting-standards.md. fix #3083

* For generic IF's, use simpler title format as per standards doc

* Further fixes for #3083 - completely softcode the map_title and layer_name elements. Removed those items from IF metadata. Make sure all IF's use map_title() method to get the layer name and map title

* Update string translation.

* Update translation.

* Compile translation.
timlinux added a commit that referenced this issue Aug 11, 2016
* Fix non conflicting error.

* Improvements to generation of map_title as per standards doc (#3146)

* Implementation for standardised map titles and layer names. See https://github.com/inasafe/inasafe/blob/develop/docs/reporting-standards.md. fix #3083

* For generic IF's, use simpler title format as per standards doc

* Further fixes for #3083 - completely softcode the map_title and layer_name elements. Removed those items from IF metadata. Make sure all IF's use map_title() method to get the layer name and map title

* PEP8 fixes

* Extra translation 3.5 (#3147)

* Implementation for standardised map titles and layer names. See https://github.com/inasafe/inasafe/blob/develop/docs/reporting-standards.md. fix #3083

* For generic IF's, use simpler title format as per standards doc

* Further fixes for #3083 - completely softcode the map_title and layer_name elements. Removed those items from IF metadata. Make sure all IF's use map_title() method to get the layer name and map title

* Update string translation.

* Update translation.

* Compile translation.
lucernae pushed a commit to lucernae/inasafe that referenced this issue Feb 16, 2017
…#3146)

* Implementation for standardised map titles and layer names. See https://github.com/inasafe/inasafe/blob/develop/docs/reporting-standards.md. fix inasafe#3083

* For generic IF's, use simpler title format as per standards doc

* Further fixes for inasafe#3083 - completely softcode the map_title and layer_name elements. Removed those items from IF metadata. Make sure all IF's use map_title() method to get the layer name and map title

* PEP8 fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants