From 9fbb6f6ababa11fe037f43e61f61dda804ccccf2 Mon Sep 17 00:00:00 2001 From: mampfes Date: Wed, 6 May 2020 09:51:38 +0200 Subject: [PATCH] harmonize documentation --- README.md | 4 ++-- doc/source/abfall_io.md | 4 ++-- doc/source/abfall_kreis_tuebingen_de.md | 4 ++-- doc/source/awbkoeln_de.md | 4 ++-- doc/source/bsr_de.md | 2 +- doc/source/ics.md | 2 ++ doc/source/jumomind_de.md | 2 +- doc/source/regioit_de.md | 4 ++-- doc/source/stadtreinigung_hamburg.md | 4 ++-- info.md | 4 ++-- 10 files changed, 18 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c2bb12a3..d3d09ec0 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,8 @@ Alternative details view showing the list of appointment types and their next ev Currently the following service providers are supported: - [Abfall_Kreis_Tuebingen.de](./doc/source/abfall_kreis_tuebingen_de.md) -- [AbfallNavi / RegioIT.de](./doc/source/regioit_de.md) -- [AbfallPlus.de / Abfall.IO](./doc/source/abfall_io.md) +- [RegioIT.de / AbfallNavi](./doc/source/regioit_de.md) +- [Abfall.IO / AbfallPlus.de](./doc/source/abfall_io.md) - [AWBKoeln.de](./doc/source/awbkoeln_de.md) - [BSR.de / Berliner Stadtreinigungsbetriebe](./doc/source/bsr_de.md) - [Generic ICS File](./doc/source/ics.md) diff --git a/doc/source/abfall_io.md b/doc/source/abfall_io.md index fb3eadde..09f06acc 100644 --- a/doc/source/abfall_io.md +++ b/doc/source/abfall_io.md @@ -1,6 +1,6 @@ -# AbfallPlus / Abfall.IO +# Abfall.IO / AbfallPlus.de -Add support for schedules which are available on [AbfallPlus.de](https://abfallplus.de). This service is provided under the URL `Abfall.IO`, therefore the source is named `abfall_io`. +Support for schedules provided by [Abfall.IO](https://abfall.io). The official homepage is using the URL [AbfallPlus.de](https://www.abfallplus.de/) instead. ## Configuration via configuration.yaml diff --git a/doc/source/abfall_kreis_tuebingen_de.md b/doc/source/abfall_kreis_tuebingen_de.md index 07b88583..60bc7bd7 100644 --- a/doc/source/abfall_kreis_tuebingen_de.md +++ b/doc/source/abfall_kreis_tuebingen_de.md @@ -1,6 +1,6 @@ -# Abfall Kreis Tuebingen +# Abfall Kreis Tübingen -Support for Abfall Kreis Tuebingen. +Support for schedules provided by [abfall-kreis-tuebingen.de](https://www.abfall-kreis-tuebingen.de). ![](https://www.abfall-kreis-tuebingen.de/wp-content/themes/twentysixteen_child/images/ABW_Logo_600_250.png) diff --git a/doc/source/awbkoeln_de.md b/doc/source/awbkoeln_de.md index d8d3057b..69f4eec9 100644 --- a/doc/source/awbkoeln_de.md +++ b/doc/source/awbkoeln_de.md @@ -1,6 +1,6 @@ -# AWBKoeln.de +# Abfallwirtschaftsbetriebe Köln -Add support for schedules provided by `AWBKoeln.de`. +Add support for schedules provided by [awbkoeln.de](https://www.awbkoeln.de/). ## Configuration via configuration.yaml diff --git a/doc/source/bsr_de.md b/doc/source/bsr_de.md index 0650b764..ba894485 100644 --- a/doc/source/bsr_de.md +++ b/doc/source/bsr_de.md @@ -1,6 +1,6 @@ # Berliner Stadtreinigungsbetriebe -Add support for schedules provided by `Berliner Stadtreinigungsbetriebe`. +Support for schedules provided by [bsr.de](https://www.bsr.de/). ## Configuration via configuration.yaml diff --git a/doc/source/ics.md b/doc/source/ics.md index 45336aa8..6355bc80 100644 --- a/doc/source/ics.md +++ b/doc/source/ics.md @@ -17,10 +17,12 @@ waste_collection_schedule: **url**
*(string) (required)* + If the original url contains the current year (4 digits including century), this can be replaced by the wildcard `{%Y}` (see example below). **offset**
*(int) (optional, default: `0`)* + Offset in days which will be added to every start time. Can be used if the start time of the events in the ICS file are ahead of the actual date. ## Example diff --git a/doc/source/jumomind_de.md b/doc/source/jumomind_de.md index 32e4acbf..7076b3bb 100644 --- a/doc/source/jumomind_de.md +++ b/doc/source/jumomind_de.md @@ -1,6 +1,6 @@ # Jumomind.de -Add support for schedules provided by `Jumomind.de`. +Support for schedules provided by [jumomind.de](https://jumomind.de/). Jumomind is a service from [junker.digital](https://junker.digital/). ## Configuration via configuration.yaml diff --git a/doc/source/regioit_de.md b/doc/source/regioit_de.md index 23903473..607448b9 100644 --- a/doc/source/regioit_de.md +++ b/doc/source/regioit_de.md @@ -1,6 +1,6 @@ -# AbfallNavi / RegioIT.de +# RegioIT.de / AbfallNavi -Add support for schedules which are available via `AbfallNavi`. This service is provided by `RegioIT.de`, therefore the source is named `regioit_de`. +Support for schedules provided by [RegioIT.de](https://www.regioit.de). The official service uses the name **AbfallNavi** instead. ## Configuration via configuration.yaml diff --git a/doc/source/stadtreinigung_hamburg.md b/doc/source/stadtreinigung_hamburg.md index 0c11d2ab..f4c117c6 100644 --- a/doc/source/stadtreinigung_hamburg.md +++ b/doc/source/stadtreinigung_hamburg.md @@ -1,6 +1,6 @@ -# Stadtreinigung.Hamburg +# Stadtreinigung Hamburg -Add support for schedules provided by `Stadtreinigung.Hamburg`. +Add support for schedules provided by [stadtreinigung.hamburg](https://www.stadtreinigung.hamburg/). ## Configuration via configuration.yaml diff --git a/info.md b/info.md index fe38a05c..ede4c223 100644 --- a/info.md +++ b/info.md @@ -29,8 +29,8 @@ Alternative details view showing the list of appointment types and their next ev Currently the following service providers are supported: - [Abfall_Kreis_Tuebingen.de](./doc/source/abfall_kreis_tuebingen_de.md) -- [AbfallNavi / RegioIT.de](./doc/source/regioit_de.md) -- [AbfallPlus.de / Abfall.IO](./doc/source/abfall_io.md) +- [RegioIT.de / AbfallNavi](./doc/source/regioit_de.md) +- [Abfall.IO / AbfallPlus.de](./doc/source/abfall_io.md) - [AWBKoeln.de](./doc/source/awbkoeln_de.md) - [BSR.de / Berliner Stadtreinigungsbetriebe](./doc/source/bsr_de.md) - [Generic ICS File](./doc/source/ics.md)