All notable changes to this project will be documented in this file. For change log formatting, see http://keepachangelog.com/
- This package now requires Node 16 and above. #312
- Added a Catalan localization. #312
- Updated translations in Brazilian Portuguese, Danish, Esperanto, French, Hungarian, Japanese, Polish, Russian, Simplified Chinese, Swedish, Ukrainian, and Yoruba. #312
- Update Japanese localization, add named intersections. #290
- Corrected various Portuguese translations. #283
- Added a Yoruba localization. #284
- Renamed “traffic circle” to “roundabout” in the English localization. #285
- Rewrote the Burmese localization. #282
- Fixed typographical errors in Italian. #281
- Fixed grammatical errors in Danish. #286
- Added a Hungarian localization and grammar. #274
- Added a Japanese localization. #277
- Added an Arabic localization. #267
- Added a Slovenian localization. #264
- Updated Russian arrive instructions. #278
- Updated French grammar with 'chaussée' status street name and better articles matching. #268#279
- Added a Norwegian Bokmål localization. #261
- Updated Russian grammar with 'glade' status street name. #259
- Updated Dutch translations. #262
- Updated French localization with articles and prepositions insertion using grammar rules. #252
- Added a Burmese localization. #247
- Added a Finnish localization. #239
- Added a Korean localization. #243
- Updated translations in Simplified Chinese. #233 #248
- Updated Russian grammar with 'chord' status street name. #245
- Added Russian church names abbreviations. #237
- Corrected Lithuanian streets abbreviations. #238
- Added a European Portuguese localization. #229
- The Spanish localization now uses the informal imperative form instead of the formal imperative form, for consistency with the Castillian Spanish localization. #230
- Added some abbreviations in German, Hebrew, Hungarian, Slovenian, and Ukrainian. #226
- Added support for named waypoints in arrival instructions. #235
- Added "exit with number" to phrases. #217
- Added a Hebrew localization. #210
- Added a Danish localization. #208
- Extended ordinals support for Russian street names in grammar rules. #192
- Added a new phrase for a short arrival and short upcoming arrival case. #207
- Changed the phrases for forks to just say "Keep left onto [wayname]" (unless we have no information, in which case we still say "Keep left at the fork"). #205
- Changed the phrases for roundabout turns to match turns at standard intersections. #203
- Fixed inconsistent destinations when a ramp leads to multiple routes towards multiple places. #197
- Removed left/right for off ramps unless it doesn't match driving side. #199
- Fixed issue preventing
formatToken
from being called on refs or names when the way has only a ref or a name. #193
- Updated translations in Esperanto, French, Portuguese, Russian, and Spanish. #189
- Corrected punctuation in the Russian localization. #176
- Added a
merge straight
instruction. #183 - Added new untranslated Swedish strings related to roundabouts and rotary. #186
- Add a phrase for an upcoming arrival step. #184
- Change the default exit roundabout instruction to be
exit the traffic circle
. #182
- Change the default exit rotary instruction to be
exit the traffic circle
. #181
- Simplify roundabout and rotary instructions for US usecase. Will need an GB version of en.json now. #179
- Clean up Russian roundabout and rotary instructions. #174
- Added a
formatToken
option tocompile
,getWayName
, andtokenize
that allows you to manipulate any token value after any grammar or capitalization rules are applied but before the value is inserted into the instruction. #170 - Removed the
options
parameter to this module, including thetokenizedInstruction
hook. Use theformatToken
option instead. #170 - Added
namedistance
option to the depart instructions and added tests fornamedistance
in depart and continue instructions. Some typo fixes. #177
- Added
getBestMatchingLanguage
for determining the closest available language. Pass a user locale into this method before passing the return value intocompile
. #168
- Added grammatical cases support for Russian way names. #102
- Adds
osrmti.getWayName
to the public API. You MUST NOT change the result before passing it intoosrmti.tokenize
. #167
- Added Castilian Spanish localization. #163
- Added Esperanto localization. #162
- Added Romanian localization. #105
- Added Turkish localization. #158
- Added a
language
argument tocapitalizeFirstLetter
, which capitalizes according to that language’s rules. #164
language
is now the first argument oftokenize
instead of the last. #149- Added roundabout exit and rotary exit instructions. #150
- Updates
continue
maneuvers in en to read as turns when the road you are staying on turns at the intersection. #145 - Updates language files from Transifex. #144. #154
- Adds
phrase
types to the English localiztion. #141 - Adds
distance
,name
andnamedistance
options to the continue and continue straight instructions. #141 - Adds
tokenize
to the top level API so that external users can fill in osrm-text-instructions template strings. #141 - Made the format of name-and-ref combinations localizable. #148
- Improves the wording of "continue" instructions. #142
- Adds Brazilian Portuguese, Italian, and Ukrainian localizations. #137
- Adds the word “right” to right-hand exit instructions. #125
- Improves the wording of “continue straight” instructions. #130
- Improves the wording of various instructions in Russian and Swedish. #138. #137
- The Spanish localization consistently uses usted form. #137
- In cases where the
ref
contains numbers and the road class is motorway, the ref is used for theway_name
. #129
- Fix exits being correctly separated (by semicolons in OSRM)
- Support
exit
property onoff ramp
type- Curently supported languages: english, vietnamese, german
- Polish: Add translation
- German: Ausfahrt/Abbfahrt instead of Rampe, Shorten Kreisverkehr messages
- Adds optional third argument to
compile
:compile(language, step, options)
. If provided,options
must be an object with two keys:legIndex
andlegCount
. This information is used for making more detailed instructions when using waypoints.
- Breaking API change: move language selection from module loading to
compile(language, step)
- Add Spanish translation (thanks @josek5494)
- Update Russian translation
- Manage translations via Transifex
- Add Russian translation (thanks @yuryleb @oxidase)
- Add Swedish translation
- Add Vietnamese translation (thanks @1ec5)
- English: Make continue straight instructions briefer
- English: Consistify bearings to prefer simple directions
- Development: Completely automated fixture generation
- Development: Fixture instructions in all languages
- Improve Chinese translation
- Standardize capitalizeFirstLetter meta key
- Change instructions object customization to options.hooks.tokenizedInstruction
- Fix name of chinese translation file
- Run tests per language via LANGUAGE=de npm test
- Shorter merge instructions (Merge slightly left -> Merge left)
- Numeric ordinals (1st, 2nd) instead of word ordinals (first, second)
- Use lane only has straight as modifier, so simplify instructions.json and tests
- Add French translation (thanks @guillaumerose)
- Add Dutch translation (thanks @milovanderlinden)
- Add Chinese translation (thanks @YunjieLi)
- Add German Translation
- Put under Simplified BSD License
- Fix Mapbox API inconsistency with ref/name
- Better u-turn instructions
- Do not use name/destination on use lane
- Fix rotary names instruction
exit onto
- Only mention end-of-road on uturn intructions
- Respect name and ref for way_name
- Handle ferry mode
- Allow for runtime customizations of instructions.json
- Big refactoring of instructions.json, making it more verbose for localizaion
- Make all strings localizable
- Big refactoring of index.js, making it simpler
- Add destinations
- Fix rotaries name
- Remove external dependency number-to-words from js code
- Refactor use lane code
- Initial release