Improve ReCollect docs

- add Simcoe County, ON, Canada
- consistent place naming
- sorting the table by country and name (ignoring prefixes such as "City
  of")
- fix formatting

Signed-off-by: Felix Kaechele <felix@kaechele.ca>
This commit is contained in:
Felix Kaechele
2023-06-08 08:21:05 -04:00
parent 91357ea699
commit 3e7f7e379d

View File

@@ -2,28 +2,32 @@
ReCollect is supported by the generic [ICS](/doc/source/ics.md) source. For all available configuration options, please refer to the source description.
## How to get the configuration arguments
- To get the URL, search your address in the recollect form of your home town.
- To get the URL, search your address in the recollect form of your home town.
- Click "Get a calendar", then "Add to Google Calendar".
- The URL shown is your ICS calendar link, for example.
```
https://recollect.a.ssl.fastly.net/api/places/BCCDF30E-578B-11E4-AD38-5839C200407A/services/208/events.en.ics?client_id=6FBD18FE-167B-11EC-992A-C843A7F05606
```
- The URL shown is your ICS calendar link, for example.
```plain
https://recollect.a.ssl.fastly.net/api/places/BCCDF30E-578B-11E4-AD38-5839C200407A/services/208/events.en.ics?client_id=6FBD18FE-167B-11EC-992A-C843A7F05606
```
- You can strip the client ID URL parameter to get the final URL: `https://recollect.a.ssl.fastly.net/api/places/BCCDF30E-578B-11E4-AD38-5839C200407A/services/208/events.en.ics`
known to work with:
|region|url|
|-|-|
|Ottawa, Canada|[ottawa.ca](https://ottawa.ca/en/garbage-and-recycling/recycling/garbage-and-recycling-collection-calendar)|
|City of Cambridge|[cambridgema.gov](https://www.cambridgema.gov/services/curbsidecollections)|
|City of Bloomington|[api.recollect.net/r/area/bloomingtonin](https://api.recollect.net/r/area/bloomingtonin)|
known to work with:
|Region|Country|URL|
|-|-|-|
|Ottawa, ON|Canada|[ottawa.ca](https://ottawa.ca/en/garbage-and-recycling/recycling/garbage-and-recycling-collection-calendar)|
|Simcoe County, ON|Canada|[simcoe.ca](https://www.simcoe.ca/dpt/swm/when)|
|City of Bloomington, IN|USA|[api.recollect.net/r/area/bloomingtonin](https://api.recollect.net/r/area/bloomingtonin)|
|City of Cambridge, MA|USA|[cambridgema.gov](https://www.cambridgema.gov/services/curbsidecollections)|
and probably a lot more.
## Examples
### Cambridge, MA
### Cambridge, MA, USA
```yaml
waste_collection_schedule:
@@ -33,7 +37,8 @@ waste_collection_schedule:
split_at: '\, (?:and )?|(?: and )'
url: https://recollect.a.ssl.fastly.net/api/places/F2BCBBF2-ACC9-11E8-B4BD-CFDD30C1D4D8/services/761/events.en-US.ics
```
### Ottawa, Ontario, Canada
### Ottawa, ON, Canada
```yaml
waste_collection_schedule: