From f1ff87357ff003db6c898309368d8ca13dc98464 Mon Sep 17 00:00:00 2001
From: CaCO3 <caco@ruinelli.ch>
Date: Sun, 5 Feb 2023 16:23:52 +0100
Subject: [PATCH] Added TOC to parameter overview

---
 param-docs/concat-parameter-pages.py          | 31 +++++++++++++++++--
 .../parameter-pages/InfluxDB/Database.md      |  2 +-
 .../<NUMBER>.AllowNegativeRates.md            |  8 +++++
 .../parameter-pages/System/RSSIThreashold.md  |  2 +-
 param-docs/templates/overview.md              |  3 ++
 5 files changed, 41 insertions(+), 5 deletions(-)
 create mode 100644 param-docs/parameter-pages/PostProcessing/<NUMBER>.AllowNegativeRates.md

diff --git a/param-docs/concat-parameter-pages.py b/param-docs/concat-parameter-pages.py
index 441c961..6d5108e 100644
--- a/param-docs/concat-parameter-pages.py
+++ b/param-docs/concat-parameter-pages.py
@@ -27,19 +27,44 @@ def appendParameterFile(folder, file):
 # Create templated overview markdown file
 if os.path.exists(parameterOverviewFile):
     os.remove(parameterOverviewFile)
-shutil.copy(parameterOverviewTemplateFile, parameterOverviewFile)
+#shutil.copy(parameterOverviewTemplateFile, parameterOverviewFile)
+
+folders = sorted( filter( os.path.isdir, glob.glob(parameterDocsFolder + '/*') ) )
+
+"""
+Create Table of Content
+"""
+toc = ""
+for folder in folders:
+    folder = folder.split("/")[-1]
+
+    toc += "\n\n[%s](#%s)\n\n" % (folder, folder.lower())
+
+    files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*')))
+    for file in files:
+        parameter = ".".join(file.split("/")[-1].split(".")[:-1])
+        anchor = parameter.replace("<", "").replace(">", "").replace(".", "").lower()
+        toc += " - [`%s`](#parameter-%s)\n" % (parameter, anchor)
+
+    with open(parameterOverviewTemplateFile, 'r') as overviewFileHandle:
+        overviewFileContent = overviewFileHandle.read()
+
+    overviewFileContent = overviewFileContent.replace("$TOC", toc)
+
+    with open(parameterOverviewFile, 'w') as overviewFileHandle:
+        overviewFileHandle.write(overviewFileContent)
+
 
 """
 Append all parameter pages in a sorted manner
 """
-folders = sorted( filter( os.path.isdir, glob.glob(parameterDocsFolder + '/*') ) )
 for folder in folders:
     folder = folder.split("/")[-1]
 #    print(folder)
 
     # Add section
     with open(parameterOverviewFile, 'a') as overviewFileHandle:
-        overviewFileHandle.write("\n## [%s]\n\n" % folder)
+        overviewFileHandle.write("\n## Section `%s`\n\n" % folder)
 
     files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*')))
     for file in files:
diff --git a/param-docs/parameter-pages/InfluxDB/Database.md b/param-docs/parameter-pages/InfluxDB/Database.md
index 75cef16..0074b74 100644
--- a/param-docs/parameter-pages/InfluxDB/Database.md
+++ b/param-docs/parameter-pages/InfluxDB/Database.md
@@ -1,4 +1,4 @@
 # Parameter `Database`
-Default Value: ``
+Default Value: `''`
 
 Name of the Database into which to publish the values.
diff --git a/param-docs/parameter-pages/PostProcessing/<NUMBER>.AllowNegativeRates.md b/param-docs/parameter-pages/PostProcessing/<NUMBER>.AllowNegativeRates.md
new file mode 100644
index 0000000..fc16086
--- /dev/null
+++ b/param-docs/parameter-pages/PostProcessing/<NUMBER>.AllowNegativeRates.md
@@ -0,0 +1,8 @@
+# Parameter `<NUMBER>.AllowNegativeRates`
+Default Value: `false`
+
+
+
+
+
+Please fill me with an explanation and useful links.
diff --git a/param-docs/parameter-pages/System/RSSIThreashold.md b/param-docs/parameter-pages/System/RSSIThreashold.md
index 40116b2..f10f039 100644
--- a/param-docs/parameter-pages/System/RSSIThreashold.md
+++ b/param-docs/parameter-pages/System/RSSIThreashold.md
@@ -1,5 +1,5 @@
 # Parameter `RSSIThreashold`
-Default Value: ``
+Default Value: `''`
 
 WLAN Mesh Parameter: Threshold for the RSSI value to check for start switching access point in a mesh system.
 Possible values: `-100` .. `0`, `0` = disabled.
diff --git a/param-docs/templates/overview.md b/param-docs/templates/overview.md
index 21cddad..d3b4233 100644
--- a/param-docs/templates/overview.md
+++ b/param-docs/templates/overview.md
@@ -11,4 +11,7 @@ In such case the functionality gets disabled respectively the default values wil
     Due to a typo, one of the sections is called `MakeImage` instead of `TakeImage`!
     For backwards compatibility, this did not get changed.
 
+## List of all Parameters
+$TOC
+
 ---