Merge pull request #149 from johnspurlock/patch-1

Minor typos and cleanup.
pull/150/head
Dave Jones 2020-12-23 20:02:26 -06:00 zatwierdzone przez GitHub
commit bacb6c8ccf
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 25 dodań i 25 usunięć

Wyświetl plik

@ -16,20 +16,20 @@ The use-cases for this tag are multiple, in order of complexity:
4. To describe a specific place in a programmatic fashion to allow complex geo-aware searches.
It may allow very complex searches such as:
It may allow complex searches such as:
- Show me podcasts or episodes about places near me.
- Show me podcasts about train stations in Germany.
- Show me podcasts about mines in West Australia.
- Visa mig podcaster om platser i Kalifornien på svenska - "Show me podcasts about places in Californian, returning Swedish-language podcasts only" (using the <language> tag).
- Visa mig podcaster om platser i Kalifornien på svenska - "Show me podcasts about places in California, returning Swedish-language podcasts only" (using the `<language>` tag).
Unlike other elements in the "podcast" namespace, a "place" is not permanent. Places are built, and abandoned, all the time. Buildings are demolished, businesses close.
Unlike other elements in the `podcast` namespace, a "place" is not permanent. Places are built, and abandoned, all the time. Buildings are demolished, businesses close.
On the other hand, a point on the earth is permanent, but does not describe anything other than a point. This is not always great when wanting to describe a city, rather than an area within a city,
or a restaurant within a city. "Locations" are also, not always real places, especially in fiction podcasts.
This, therefore, means that the podcast:location tag is complex and has a number of attributes.
This, therefore, means that the `<podcast:location>` tag is complex and has a number of attributes.
<br>
@ -37,8 +37,8 @@ This, therefore, means that the podcast:location tag is complex and has a number
```
<podcast:location
name="[humanly readable place name]"
geo="[geoURI]"
name="[human-readable place name]"
geo="[geo URI]"
osmid="[OSM type][OSM id]"
>
```
@ -49,11 +49,11 @@ This tag can exist at either the `<channel>` level, or the `<item>` level, or bo
#### `name` **required**
This is meant for podcast apps to display the name of the location that the podcast is about. Examples might be "Houses of Parliament", "Gitmo Nation" or "Ernest Murrow Theater, Chicago"). This is not intended to be
programmatically parsed and is for display only. For a programmatic designation of the location, use the geoURI or OSM IDs, below.
This is meant for podcast apps to display the name of the location that the podcast is about. Examples might be "Houses of Parliament", "Gitmo Nation" or "Ernest Murrow Theater, Chicago". This is not intended to be
programmatically parsed and is for display only. For a programmatic designation of the location, use the geo URI or OSM IDs, below.
This field is a maximum of 128 characters. It may describe a real or fictional place. It should be in the same language as the podcast, as indicated in the <language> RSS tag: so a podcast in `en` should
read Eiffel Tower, Paris and not La Tour d'Eiffel.
read "Eiffel Tower, Paris" and not "La Tour d'Eiffel".
<br>
@ -63,20 +63,20 @@ read Eiffel Tower, Paris and not La Tour d'Eiffel.
Examples:
```- geo:37.786971,-122.399677 (a simple latlon description)```<br>
```- geo:37.786971,-122.399677,250 (a latlon including a height of 250 meters above ground level)```<br>
```- geo:37.786971,-122.399677;u=350 (a latlon with an accuracy ('uncertainty') of 350 meters).```<br>
- `geo:37.786971,-122.399677`, a simple latlon description.
- `geo:37.786971,-122.399677,250`, a latlon including a height of 250 meters above ground level.
- `geo:37.786971,-122.399677;u=350`, a latlon with an accuracy ('uncertainty') of 350 meters.
For information that may interest space travellers: the RFC does include an optional coordinate reference system for other planets, though these are not recommended to be used yet by the RFC.
For information that may interest space travelers: the RFC does include an optional coordinate reference system for other planets, though these are not recommended to be used yet by the RFC.
The `geo` attribute is recommended to be used alongside an OSMID. Since OSM IDs are not guaranteed to be permanent (perhaps it's the ID of a building which is later demolished), the geoURI serves as a permanent point.
Exceptions are podcasts from, or about, fictional places. Data within these attributes must relate to a real place.
The `geo` attribute is recommended to be used alongside an `osmid` attribute. Since OSM IDs are not guaranteed to be permanent (perhaps it's the ID of a building which is later demolished), the geo URI serves as a permanent point.
Exceptions are podcasts from or about fictional places. Data within these attributes must relate to a real place.
<br>
#### `osmid` **recommended**
From an OpenStreetMap query. If a value is given for `osmid` it must contain both 'type' and 'id'.
From an [OpenStreetMap](https://en.wikipedia.org/wiki/OpenStreetMap) query. If a value is given for `osmid` it must contain both 'type' and 'id'.
- osm type: A one-character description of the type of OSM point. Valid is "N" (node); "W" (way); "R" (relation).
- osm id: The ID of the OpenStreetMap feature that is described.
@ -89,13 +89,13 @@ that is the best programmatic representation of the place being described. The d
- The United States of America: [R148838](https://nominatim.openstreetmap.org/ui/details.html?osmtype=R&osmid=148838)
- The Eiffel Tower in Paris: [W5013364](https://nominatim.openstreetmap.org/ui/details.html?osmtype=W&osmid=5013364)
The `osmid` is recommended to be used alongside a `geo` attribute. Since OSM IDs are not guaranteed to be permanent (perhaps it's the ID of a building which is later demolished), the geoURI serves as a permanent
point. Exceptions are podcasts from, or about, fictional places. Data within these tags must relate to a real place.
The `osmid` is recommended to be used alongside a `geo` attribute. Since OSM IDs are not guaranteed to be permanent (perhaps it's the ID of a building which is later demolished), the geo URI serves as a permanent
point. Exceptions are podcasts from or about fictional places. Data within these tags must relate to a real place.
If a developer uses the `osmid` tag, the canonical latlon is the one returned by OSM. It is intended that the `geo` attribute is used for simple display within a podcast app without any API usage: but for more advanced
uses, like a geographic search, developers will ingest the full details from OpenStreetMap. The geoURI also offers a useful fallback should the `osmid` be removed.
uses, like a geographic search, developers will ingest the full details from OpenStreetMap. The geo URI also offers a useful fallback should the `osmid` be removed.
_Caution: our definition of `osmid` is what OpenStreetMap call "OSM type and OSM id". It must start with an alphabetical representation of the type, then the numerical ID. Do not use place_id, which is visible in
_Caution: our definition of `osmid` is what OpenStreetMap calls "OSM type and OSM id". It must start with an alphabetical representation of the type, then the numerical ID. Do not use place_id, which is visible in
API calls - these are unique to each mirror of the OSM data._
<br>
@ -113,7 +113,7 @@ Podcast hosts may also wish to remind podcast publishers to always be cautious a
### Examples
For a podcast that is talking about the Eiffel Tower, (but actually made in Birmingham AL), this is what the specification would suggest:
For a podcast that is talking about the Eiffel Tower, but actually made in Birmingham, Alabama, this is what the specification would suggest:
```
<podcast:location
@ -136,7 +136,7 @@ For a podcast that is set in Gitmo Nation, a nickname used by the show for the U
The `geo` point uses an optional 'uncertainty' value here of 3,900 km, indicating that the "location" described here is up to 3,900km away from the point given (which is the rough width of the USA). The OSMID
includes a more accurate bounding box and geoJSON.
For a podcast that is about Hogwarts (a fictional location) the `geo` and `osmid` must not be entered.
For a podcast that is about Hogwarts (a fictional location), the `geo` and `osmid` must not be entered:
```
<podcast:location
@ -144,7 +144,7 @@ For a podcast that is about Hogwarts (a fictional location) the `geo` and `osmid
>
```
For a podcast from Tesla upon landing on Mars
For a podcast from Tesla upon landing on Mars:
```
<podcast:location
@ -153,11 +153,11 @@ For a podcast from Tesla upon landing on Mars
>
```
(The co-ordinate reference system from Mars doesn't yet exist, but this shows the extensibility of this tag).
(The coordinate reference system for Mars doesn't yet exist, but this shows the extensibility of this tag.)
<br>
### What This Tag Isn't Built For
For privacy and user experience, this tag is not meant as a description of the physical location of podcast hosts and guests ("I'm doing this podcast in Denver, Colorado!"). The physical location of people
are available via the [podcast:person](https://github.com/Podcastindex-org/podcast-namespace#phase-2-open) tag's links to places like Twitter, Facebook, Wikipedia and Podchaser.
are available via the [podcast:person](https://github.com/Podcastindex-org/podcast-namespace#phase-2-open) tag's links to places like Twitter, Facebook, Wikipedia and Podchaser.