TODO.md

   1 # TODO list
   2
   3
   4
   5 ## Essential
   6
   7 * test in MSIE https://github.com/WebReflection/url-search-params
   8 * Nominatim backend API
   9    * need /status to support &format=json
  10    * need /details to support &format=json
  11 * reverse: zoom not set
  12 http://localhost:8000/reverse.html?format=html&lat=52.3755991766591&lon=7.646484374999999&zoom=
  13 * move this TODO.txt to github issues
  14 * write install instructions
  15 * check output of /dist into repository
  16
  17 ## Might never work
  18
  19 * pagination. API returns an array whichout indication if more results exist
  20 * API returns category, type, but without admin_level we can't derive e.g. state,country
  21 * seeting acceptlanguage whichout a server component https://github.com/dansingerman/jQuery-Browser-Language
  22 * nice 404 detail page. The API returns HTTP 400 error instead of an empty data set.
  23
  24 ## Unknown
  25
  26 * config vs config.local.js
  27 * should it be possible to add comments to config?
  28 * snake_case vs camelCase
  29 * support nearlat,nearlon parameters
  30 * need a `<link href="nominatim.xml" rel="search" title="Nominatim Search" type="application/opensearchdescription+xml">` file
  31 * do we an /src/assets directory?
  32 * in which repository should the images/mapicons/ live?
  33
  34
  35 ## Nice-to-have
  36
  37 * add permalink (like https://github.com/openstreetmap/Nominatim/pull/1003)
  38 * different content for official OSM, e.g. github urls
  39 * set HTML title
  40 * cache `update_data_date` result
  41 * a new search causes a new pageview
  42 * webpack or grunt build framework
  43 * don't copy jquery/leaflet in /src, use dependency manager instead, e.g. https://bower.io/
  44 * add tests with fixtures
  45 * concatenate/minify JS and CSS
  46 * detailpage: make linkedplaces, childplaces optional (rarely used? second click to enable?)
  47 * set better alt tag for icons
  48
  49 ## Code cleanup
  50
  51 * remove Perl dependency from build
  52 * show map bounds section => move to handlebar template, map to partial
  53 * make sure we use https URL to external sites where possible
  54 * aResults vs aPlace vs aFeature variable naming
  55 * use CSS preprocessor and linter
  56 * use eslint
  57