improve documenation and GUI param description/name

mampfes · Oct 29, 2024 · fa74f1c · fa74f1c
1 parent 50539b2
commit fa74f1c
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 15 deletions.
diff --git a/custom_components/waste_collection_schedule/translations/de.json b/custom_components/waste_collection_schedule/translations/de.json
@@ -1977,23 +1977,23 @@
       },
       "args_data_umweltprofis_at": {
         "title": "Quelle konfigurieren",
-        "description": "Konfiguriere deinen Service Provider. Mehr details: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md",
+        "description": "Konfiguriere deinen Service Provider. \n\nSie müssen zuerst Ihren persönlichen XML-Link generieren, bevor Sie diese Quelle verwenden können. Gehen Sie zu [https://data.umweltprofis.at/opendata/AppointmentService/index.aspx](https://data.umweltprofis.at/opendata/AppointmentService/index.aspx) und füllen Sie das Formular aus. Am Ende von Schritt 6 erhalten Sie einen Link zu einer XML-Datei. Kopieren Sie diesen Link und verwenden Sie ihn als xmlurl-Parameter.\n\nMehr details: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md",
         "data": {
           "calendar_title": "Kalender Titel",
-          "url": "URL",
-          "xmlurl": "Xmlurl"
+          "url": "URL (Veraltet nicht verwenden)",
+          "xmlurl": "XML URL"
         },
         "data_description": {
           "calendar_title": "Ein lesbarerer oder benutzerfreundlicherer Name für den Müllkalender. Wenn nichts angegeben wird, wird der Name der Quelle verwendet."
         }
       },
       "reconfigure_data_umweltprofis_at": {
         "title": "Quelle Neu Konfigurieren",
-        "description": "Konfiguriere deinen Service Provider. Mehr details: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md",
+        "description": "Konfiguriere deinen Service Provider. \n\nSie müssen zuerst Ihren persönlichen XML-Link generieren, bevor Sie diese Quelle verwenden können. Gehen Sie zu [https://data.umweltprofis.at/opendata/AppointmentService/index.aspx](https://data.umweltprofis.at/opendata/AppointmentService/index.aspx) und füllen Sie das Formular aus. Am Ende von Schritt 6 erhalten Sie einen Link zu einer XML-Datei. Kopieren Sie diesen Link und verwenden Sie ihn als xmlurl-Parameter.\n\nMehr details: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md",
         "data": {
           "calendar_title": "Kalender Titel",
-          "url": "URL",
-          "xmlurl": "Xmlurl"
+          "url": "URL (Veraltet nicht verwenden)",
+          "xmlurl": "XML URL"
         },
         "data_description": {}
       },

diff --git a/custom_components/waste_collection_schedule/translations/en.json b/custom_components/waste_collection_schedule/translations/en.json
@@ -1980,23 +1980,23 @@
       },
       "args_data_umweltprofis_at": {
         "title": "Configure Source",
-        "description": "Configure your service provider. More details: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md.",
+        "description": "Configure your service provider. \n\nYou need to generate your personal XML link before you can start using this source. Go to [https://data.umweltprofis.at/opendata/AppointmentService/index.aspx](https://data.umweltprofis.at/opendata/AppointmentService/index.aspx) and fill out the form. At the end at step 6 you get a link to a XML file. Copy this link use it as xmlurl parameter.\n\nMore details: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md.",
         "data": {
           "calendar_title": "Calendar Title",
-          "url": "Url",
-          "xmlurl": "Xmlurl"
+          "url": "URL (Deprecated do not use)",
+          "xmlurl": "XML URL"
         },
         "data_description": {
           "calendar_title": "A more readable, or user-friendly, name for the waste calendar. If nothing is provided, the name returned by the source will be used."
         }
       },
       "reconfigure_data_umweltprofis_at": {
         "title": "Reconfigure Source",
-        "description": "Configure your service provider. More details: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md.",
+        "description": "Configure your service provider. \n\nYou need to generate your personal XML link before you can start using this source. Go to [https://data.umweltprofis.at/opendata/AppointmentService/index.aspx](https://data.umweltprofis.at/opendata/AppointmentService/index.aspx) and fill out the form. At the end at step 6 you get a link to a XML file. Copy this link use it as xmlurl parameter.\n\nMore details: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md.",
         "data": {
           "calendar_title": "Calendar Title",
-          "url": "Url",
-          "xmlurl": "Xmlurl"
+          "url": "URL (Deprecated do not use)",
+          "xmlurl": "XML URL"
         },
         "data_description": {}
       },

diff --git a/custom_components/waste_collection_schedule/translations/it.json b/custom_components/waste_collection_schedule/translations/it.json
@@ -1977,7 +1977,7 @@
       },
       "args_data_umweltprofis_at": {
         "title": "Configurazione Sorgente",
-        "description": "Compila i campi per ottenere le informazioni sul tuo servizio di raccolta. Maggiori informazioni: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md.",
+        "description": "Compila i campi per ottenere le informazioni sul tuo servizio di raccolta. \n\nYou need to generate your personal XML link before you can start using this source. Go to [https://data.umweltprofis.at/opendata/AppointmentService/index.aspx](https://data.umweltprofis.at/opendata/AppointmentService/index.aspx) and fill out the form. At the end at step 6 you get a link to a XML file. Copy this link use it as xmlurl parameter.\n\nMaggiori informazioni: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md.",
         "data": {
           "calendar_title": "Nome Calendario",
           "url": "Url",
@@ -1989,7 +1989,7 @@
       },
       "reconfigure_data_umweltprofis_at": {
         "title": "Riconfigurazione Sorgente",
-        "description": "Compila i campi per ottenere le informazioni sul tuo servizio di raccolta. Per maggiori informazioni: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md.",
+        "description": "Compila i campi per ottenere le informazioni sul tuo servizio di raccolta. \n\nYou need to generate your personal XML link before you can start using this source. Go to [https://data.umweltprofis.at/opendata/AppointmentService/index.aspx](https://data.umweltprofis.at/opendata/AppointmentService/index.aspx) and fill out the form. At the end at step 6 you get a link to a XML file. Copy this link use it as xmlurl parameter.\n\nPer maggiori informazioni: https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/data_umweltprofis_at.md.",
         "data": {
           "calendar_title": "Nome Calendario",
           "url": "Url",

diff --git a/...onents/waste_collection_schedule/waste_collection_schedule/source/data_umweltprofis_at.py b/...onents/waste_collection_schedule/waste_collection_schedule/source/data_umweltprofis_at.py
@@ -18,6 +18,22 @@
     },
 }
 
+HOW_TO_GET_ARGUMENTS_DESCRIPTION = {
+    "en": "You need to generate your personal XML link before you can start using this source. Go to [https://data.umweltprofis.at/opendata/AppointmentService/index.aspx](https://data.umweltprofis.at/opendata/AppointmentService/index.aspx) and fill out the form. At the end at step 6 you get a link to a XML file. Copy this link use it as xmlurl parameter.",
+    "de": "Sie müssen zuerst Ihren persönlichen XML-Link generieren, bevor Sie diese Quelle verwenden können. Gehen Sie zu [https://data.umweltprofis.at/opendata/AppointmentService/index.aspx](https://data.umweltprofis.at/opendata/AppointmentService/index.aspx) und füllen Sie das Formular aus. Am Ende von Schritt 6 erhalten Sie einen Link zu einer XML-Datei. Kopieren Sie diesen Link und verwenden Sie ihn als xmlurl-Parameter.",
+}
+
+PARAM_TRANSLATIONS = {
+    "en": {
+        "url": "URL (Deprecated do not use)",
+        "xmlurl": "XML URL",
+    },
+    "de": {
+        "url": "URL (Veraltet nicht verwenden)",
+        "xmlurl": "XML URL",
+    },
+}
+
 _LOGGER = logging.getLogger(__name__)
 
 

diff --git a/doc/source/data_umweltprofis_at.md b/doc/source/data_umweltprofis_at.md
@@ -4,7 +4,7 @@ Support for schedules provided by [Umweltprofis.at](https://www.umweltprofis.at)
 
 ## Configuration via configuration.yaml
 
-You need to generate your personal XML link before you can start using this source. Go to [https://data.umweltprofis.at/opendata/AppointmentService/index.aspx](https://data.umweltprofis.at/opendata/AppointmentService/index.aspx) and fill out the form. At the end at step 6 you get a link to a XML file. Copy this link and paste it to configuration.yaml as seen below.
+You need to generate your personal XML link before you can start using this source. Go to [https://data.umweltprofis.at/opendata/AppointmentService/index.aspx](https://data.umweltprofis.at/opendata/AppointmentService/index.aspx) and fill out the form. At the end at step 6 you get a link to a XML file. Copy this link use it as xmlurl parameter.
 
 ```yaml
 waste_collection_schedule: