From f73852e5c607334d4caf7eaf3b546a5116b33ce4 Mon Sep 17 00:00:00 2001 From: neri Date: Fri, 23 Sep 2022 12:14:22 +0200 Subject: [PATCH] add features, limitations and execution section to readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 76ccc45..5105312 100644 --- a/README.md +++ b/README.md @@ -45,3 +45,20 @@ Liste der 10 zuletzt bearbeiteten Seiten: - Mehrere Tags im `tags`-Parameter müssen ebenfalls mit Komma getrennt werden - Parameter vom Typ `String` müssen in doppelte Anführungszeichen `"` eingeschlossen werden - Parameter vom Typ `Int` und vom Typ `Enum` müssen ohne Anführungszeichen angegeben werden + +## Features und Einschränkungen + +Zur Rekursionsvermeidung können leider die mit `metapage` getaggten Seiten nicht selbst in den +Page-Listings auftauchen. +Eine Seite welche die zuletzt aktualisierten Seiten enthält, kann also nur Seiten enthalten welche +nicht mit `metapage` getaggt sind. + +Seiten deren Pfad mit einem Unterstrich `_` beginnt werden ebenfalls nie in Page-Listings angezeigt. +Das wird beispielsweise auf der Topictreff-Seite verwendet damit das Topic-Template nicht unter den +neuen Topics aufgelistet wird. + +## Ausführen des Bots + +Damit der Bot Seiten bearbeiten darf muss die Umgebungsvariable `CTDO_WIKIJS_API_KEY` auf einen +gültigen Api-Key gesetzt sein. +Api-Keys für das WikiJs können hier generiert werden: [https://wiki.ctdo.de/a/api](https://wiki.ctdo.de/a/api).