Commit b23c1e78 authored by Philip Withnall's avatar Philip Withnall

geolocation-and-navigation: Monospace-format nav and place URIs

Add more monospace formatting to the nav and place URI sections, to
break up some of the big blocks and make the Markdown source code a bit
more readable.
Signed-off-by: default avatarPhilip Withnall <philip.withnall@collabora.co.uk>
Reviewed-by: default avatarFrédéric Dalleau <frederic.dalleau@collabora.com>
Differential Revision: https://phabricator.apertis.org/D4903
parent 1ecded36
......@@ -2302,7 +2302,7 @@ i.e. each parameter is separated by a semicolon, keys
and values are separated by an equals sign, and percent-encoding is used
to encode reserved characters.
The location string must be of the format 1\*paramchar, as defined in
The location string must be of the format `1\*paramchar`, as defined in
RFC 5870. All non-ASCII characters in the string must be
[percent-encoded][RFC5870-percent-escape],
and implementations must interpret the decoded
......@@ -2350,56 +2350,33 @@ parameter may appear zero or one times, unless otherwise specified.
This section is non-normative. Each example is given as a fully encoded
string, followed by it split up into its un-encoded components.
```
- place:Paris
- `place:Paris`
- Location string: Paris
- No parameters
- place:Paris;location=geo%3A48.8567%2C2.3508;country=FR;formatted-address=Paris%2C%20France
- `place:Paris;location=geo%3A48.8567%2C2.3508;country=FR;formatted-address=Paris%2C%20France`
- Location string: Paris
- Parameters:
- location: geo:48.8567,2.3508
- country: FR
- formatted-address: Paris, France
- place:K%C3%B6nigsstieg%20104%2C%2037081%20G%C3%B6ttingen;location=geo%3A51.540060%2C9.911850;country=DE;locality=G%C3%B6ttingen;postal-code=37081;street=K%C3%B6nigsstieg;building=104;formatted-address=K%C3%B6nigsstieg%20104%2C%2037081%20G%C3%B6ttingen%2C%20Germany
- `location`: `geo:48.8567,2.3508`
- `country`: FR
- `formatted-address`: Paris, France
- `place:K%C3%B6nigsstieg%20104%2C%2037081%20G%C3%B6ttingen;location=geo%3A51.540060%2C9.911850;country=DE;locality=G%C3%B6ttingen;postal-code=37081;street=K%C3%B6nigsstieg;building=104;formatted-address=K%C3%B6nigsstieg%20104%2C%2037081%20G%C3%B6ttingen%2C%20Germany`
- Location string: Königsstieg 104, 37081 Göttingen
- Parameters:
- location: geo:51.540060,9.911850
- country: DE
- locality: Göttingen
- postal-code: 37081
- street: Königsstieg
- building: 104
- formatted-address: Königsstieg 104, 37081 Göttingen, Germany
- place:CN
Tower;location=geo%3A43.6426%2C-79.3871;formatted-address=301%20Front%20St%20W%2C%20Toronto%2C%20ON%20M5V%202T6%2C%20Canada
- `location`: `geo:51.540060,9.911850`
- `country`: DE
- `locality`: Göttingen
- `postal-code`: 37081
- `street`: Königsstieg
- `building`: 104
- `formatted-address`: Königsstieg 104, 37081 Göttingen, Germany
- `place:CN Tower;location=geo%3A43.6426%2C-79.3871;formatted-address=301%20Front%20St%20W%2C%20Toronto%2C%20ON%20M5V%202T6%2C%20Canada`
- Location string: CN Tower
- Parameters:
- location: geo:43.6426,-79.3871
- formatted-address: 301 Front St W, Toronto, ON M5V 2T6, Canada
```
- `location`: `geo:43.6426,-79.3871`
- `formatted-address`: 301 Front St W, Toronto, ON M5V 2T6, Canada
## Appendix: nav URI scheme
......@@ -2417,8 +2394,8 @@ an equals sign, and percent-encoding is used to encode reserved
characters.
The destination place must be provided as [](#appendix-place-uri-scheme)
(*with* the place: URI prefix), or as a geo URI (*with* the geo: URI prefix); and
must be encoded in the format 1\*paramchar, as defined in RFC 5870; i.e.
(*with* the `place:` URI prefix), or as a geo URI (*with* the `geo:` URI prefix); and
must be encoded in the format `1\*paramchar`, as defined in RFC 5870; i.e.
all non-ASCII and reserved characters in the string must be
percent-encoded.
......@@ -2430,90 +2407,60 @@ semicolon and equals sign separators must not be percent-encoded. The
ordering of parameters does not matter, unless otherwise specified. Each
parameter may appear zero or one times, unless otherwise specified.
- description: a human-readable description of the route, intended to
- `description`: a human-readable description of the route, intended to
be displayed in the UI rather than machine-parsed
- way: a named intermediate destination, as a place URI (*with* the
place: scheme prefix) or as a geo URI (*with* the geo: scheme
- `way`: a named intermediate destination, as a place URI (*with* the
`place:` scheme prefix) or as a geo URI (*with* the `geo:` scheme
prefix); these parameters are order-dependent (see below)
- via: a non-named intermediate routing point, as a place URI (*with*
the place: scheme prefix) or as a geo URI (*with* the geo: scheme
- `via`: a non-named intermediate routing point, as a place URI (*with*
the `place:` scheme prefix) or as a geo URI (*with* the `geo:` scheme
prefix); these parameters are order-dependent (see below)
The way and via parameters are order-dependent: they will be added to
The `way` and `via` parameters are order-dependent: they will be added to
the route in the order they appear in the nav URI. Way-places and
via-places may be interleaved — they form a single route. The
destination place always forms the final point in this route. The way
and via parameters may each appear zero or more times.
destination place always forms the final point in this route. The `way`
and `via` parameters may each appear zero or more times.
### Examples
This section is non-normative. Each example is given as a fully encoded
string, followed by it split up into its un-encoded
components.
string, followed by it split up into its un-encoded components.
```
- nav:place%3AKings%2520Cross%2520station%252C%2520London%3Blocality%3DLondon%3Bpostal-code%3DN19AL
- `nav:place%3AKings%2520Cross%2520station%252C%2520London%3Blocality%3DLondon%3Bpostal-code%3DN19AL`
- Destination place:
- Location string: Kings Cross station, London
- Parameters:
- locality: London
- postal-code: N19AL
- `locality`: London
- `postal-code`: N19AL
- nav:geo%3A51.531621%2C-0.124372
- Destination place: geo:51.531621,-0.124372
- `nav:geo%3A51.531621%2C-0.124372`
- Destination place: `geo:51.531621,-0.124372`
- nav:place%3ABullpot%2520Farm%3Blocation%3Dgeo%253A54.227602%252C-2.517940;way=place%3ABirmingham%2520New%2520Street%2520station%3Blocation%3Dgeo%253A52.477620%252C-1.897904;via=place%3AHornby%3Blocation%3Dgeo%253A54.112245%252C-2.636527%253Bu%253D2000;way=place%3AInglesport%252C%2520Ingleton%3Bstreet%3DThe%2520Square%3Bbuilding%3D11%3Blocality%3DIngleton%3Bpostal-code%3DLA63EB%3Bcountry%3DGB
- `nav:place%3ABullpot%2520Farm%3Blocation%3Dgeo%253A54.227602%252C-2.517940;way=place%3ABirmingham%2520New%2520Street%2520station%3Blocation%3Dgeo%253A52.477620%252C-1.897904;via=place%3AHornby%3Blocation%3Dgeo%253A54.112245%252C-2.636527%253Bu%253D2000;way=place%3AInglesport%252C%2520Ingleton%3Bstreet%3DThe%2520Square%3Bbuilding%3D11%3Blocality%3DIngleton%3Bpostal-code%3DLA63EB%3Bcountry%3DGB`
- Destination place:
- Location string: Bullpot Farm
- Parameters:
- location: geo:54.227602,-2.517940
- `location`: `geo:54.227602,-2.517940`
- Parameters:
- way:
- `way`:
- Location string: Birmingham New Street station
- Parameters:
- location: geo:52.477620,-1.897904
- via:
- `location`: `geo:52.477620,-1.897904`
- `via`:
- Location string: Hornby
- Parameters:
- location: geo:54.112245,-2.636527;u=2000
- way:
- `location`: `geo:54.112245,-2.636527;u=2000`
- `way`:
- Location string: Inglesport, Ingleton
- Parameters:
- street: The Square
- building: 11
- locality: Ingleton
- postal-code: LA63EB
- country: GB
```
- `street`: The Square
- `building`: 11
- `locality`: Ingleton
- `postal-code`: LA63EB
- `country`: GB
[automotive domain]: https://wiki.apertis.org/mediawiki/index.php/Glossary#automotive-domain
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment