Bearbeiten von „WikiBot“

Der WikiBot ist ein Softwaresystem zur automatischen Aktualisierung von Wiki-Inhalten und zur Bereitstellung einer Wiki-Abfrage-API, die unter anderem von Chatbots verwendet werden kann.

== Automatisierte Wiki-Aktualisierung ==

Primärer Auslöser und Informationsquelle der automatischen Wikiseitenaktualisierung sind Änderungen an der [[Episodenliste]]. Wird diese Liste aktuell gehalten, so werden auch viele andere Seiteninhalte, die von diesen Informationen abhängen, stets vom Bot aktuell gehalten. 

=== Update-Routine ===

Jeden Tag um 00:00 Uhr (Systemzeit: CET) aktualisiert der Bot folgende Inhalte:
* [[Hauptseite]]: Was geschah am?
* [[Hauptseite]]: Schon gewusst?
* [[:Kategorie:Stream|Stream]]-Artikel:
** Ein neuer Streameintrag in der [[Episodenliste]] führt zur automatisierten Erstellung eines Streamartikels.
** Die Streamseiten der letzten 50 Streams werden geupdatet hinsichtlich Kategorien und Streamdetails-Tabelle.
* [[:Kategorie:Person|Personen]]-Artikel:
** Streammitwirkungen werden basierend auf Links in der Episodenliste aktualisiert.
* [[:Kategorie:Streamort|Streamort]]-Artikel:
** Anlegung neuer Streamortseiten, basierend auf toten (=roten) Links in der Episodenliste.
** Aktualisierung der Livestreams-Listen in Streamort-Artikeln.

=== Botflags ===

Botflags sind spezielle Belegungen eines <code>bot-flag</code>-Attributs eines [https://www.w3schools.com/tags/tag_div.asp HTML-Div-Elementes]. Sie zeigen dem Bot die Stellen im Wikitext an, in welchen er editieren darf. Dies bedeutet jedoch auch, dass alle manuellen Änderungen, die man innerhalb des <code>div</code>-Tags tätigt zeitnah überschrieben werden können und daher verloren gehen. 

 <nowiki><div bot-flag="FLAG_NAME">Alles hier drin wird vom Bot überschrieben</div></nowiki>

Als Best-Practice lässt man deshalb die Struktur dieser Tags unberührt. Je nach gewünschter Botfunktionalität kann aus einer Menge fest definierter Flags ausgewählt werden. Zu beachten ist jedoch, dass der Bot nur bestimmte Wiki-Artikel auf bestimmte Flagarten überprüft.  Eine Übersicht über alle Flags und ihren Zielbereich findet sich in der folgenden Tabelle.

{| class="wikitable"
|-
! scope="col"| Flagname
! scope="col"| Botaktion
! scope="col"| Zielartikel
|-

| <code>STREAM_MITWIRKUNGEN</code>
| Der Bot sucht in allen Zeilen der Episodenliste nach Links zu Personen und erstellt eine neue Episodenliste, die nur aus linkenthaltenden Zeilen besteht. Zusätzlich fügt er die Überschrift ''"Mitwirkungen bei SkylineTV LIVE"'' ein sowie einen kurzen Text in welchem Bereich (Guide/Kamera/Sprachstudio) die Mitwirkung wie oft erfolgte.
| Alle Artikel der [[:Kategorie:Person]]
|-

| <code>STREAMS_IN_ORT</code>
| Der Bot sucht in der Spalte "Ort" der Episodenliste nach allen Episoden, die an diesem Ort stattfanden (also in der Episodenliste entsprechend verlinkt sind). Diese Episoden werden in eine neue ortspezifische Episodenliste eingefügt. Zusätzlich wird die Überschrift: ''"Livestreams In ORT fand(en) bisher X Livestream(s) statt."'' eingefügt.
| Alle Artikel der [[:Kategorie:Streamort]]
|-

| <code>WAS_GESCHAH_AM</code>
| Der Bot findet in der Episodenliste alle Streams, die am heutigen Tag stattfanden und fügt sie in eine Liste ein.
| [[Hauptseite]]
|-

| <code>RANDOM_TRIVIA</code>
| Der Bot fügt eine Liste zufälliger Trivia aus dem gesamten Wiki ein (Voraussetzung: Sektion namens Trivia und einzelne Trivia-Punkte als Liste formatiert). Es werden mindestens 700- eichen Trivia eingefügt.
| [[Hauptseite]]
|-

| <code>STREAM_KATEGORIEN</code>
| Der Bot findet für eine Streamseite heraus, in welche Kategorien sie womöglich einsortiert werden soll. Dazu verwendet er Informationen aus der Episodenliste (Land, Ort, Titel (Drohne im Titel -> Drohnenstream, ...)), sowie die [https://wiki.openstreetmap.org/wiki/API API von OpenStreetMap], um das Bundesland herauszufinden, sollte sich der Stream in Deutschland abgespielt haben. Unterstützt werden auch mehrere Orte und mehrere Länder. <div style="color:red">Die OSM-API kann bei uneindeutigen Ortsnamen das falsche Bundesland herausfinden!</div>
| Die zeitlich 50 letzten Stream-Artikel, wie verlinkt in der [[Episodenliste]] seit 2022.
|-

| <code>STREAM_INFO_TABELLE</code>
| Der Bot fügt eine ausgefüllte [[Vorlage:Streamdaten]] für einen Stream ein, basierend auf Daten in der Episodenliste und Twitch-Daten (bei regulären Streams).
| Die zeitlich 50 letzten Stream-Artikel, wie verlinkt in der [[Episodenliste]] seit 2022.
|-

|}

== Wiki-Chatbot ==

Der WikiBot bietet eine Abfrage-API für Wikiinhalte. Dazu aktualisiert der Bot jeden Tag eine lokale Kopie des Wikis, um a) die Latenz der Abfrage zu erhöhen, b) das Wiki nicht mit ständigen Api-Requests zu belästigen und c), um zu verhindern, dass trollaffine Nutzer Wikiseiten absichtlich verändern, um etwaige angebundene Chatbots zum Posten dubioser Inhalte zu veranlassen.

Je nach Implementierung des API-Nutzers kann die Syntax zur Verwendung der Befehle leicht variieren. Im Folgenden wird davon ausgegangen, dass der Bot für einen Twitch-Chat angebunden wurde und Befehle deshalb mit einem Ausrufezeichen beginnen.

=== Übersicht der Befehle ===

Der Bot bietet in seiner aktuellen Version sieben Befehlstypen mit z.T. sehr unterschiedlichen Sucheigenschaften.

{| class="wikitable"
|-
! scope="col"| Befehl
! scope="col"| Parameter
! scope="col"| Zielbereich
! scope="col"| Antwortinhalte
! scope="col"| Art der Suche
! scope="col"| Backlink-Auflösung<ref>Eine Backlink-Auflösung bedeutet, dass alle Seitenaliase berücksichtigen werden, also Weiterleitungslinks von Seiten zu Hauptartikeln. Mit Backlink-Auflösung kann man beispielsweise sowohl mit der Suche nach <code>Elton</code>, als auch nach <code>Amoszool</code> die Hauptseite [[Elton]] erfragen. Ohne ginge dies nur mit der Suche nach <code>Elton</code>. Wiki-Ersteller können somit dynamisch einstellen, welche Suchbegriffe auf welche Seiten führen sollen, wenn sie entsprechende Weiterlinkungsseiten anlegen (wie eben die Seite [[Amoszool]]).</ref>
|-

|<code>!wiki</code>
| Keiner
| Keiner
| Link zur [[Hauptseite]]
| Keine
| Nicht nötig
|-

|<code>!wiki hilfe</code>
| Keiner
| Keiner
| Link zu [[WikiBot#Wiki-Chatbot]]
| Keine
| Nicht nötig
|-

|rowspan="2"| <code>!wiki trivia [parameter]</code>
| Keiner
| Alle nicht-geblacklisteten Wikiartikel
| Zufällige Trivia aus zufälligem Artikel
| Keine
| Nicht nötig
|-

| Artikeltitel
| Alle nicht-geblacklisteten Wikiartikel
| Zufällige Trivia aus spezifiziertem Wiki-Artikel
| [https://de.wikipedia.org/wiki/Unscharfe_Suche Fuzzy-Search] über Artikel-Titel im Zielbereich
| Ja
|-

|rowspan="2"| <code>!wiki streams [parameter]</code>
| Keiner
| Keiner
| Link zur [[Episodenliste]]
| Keine
| Nicht nötig
|-

| Artikeltitel oder (Teil-)Datum
| Artikel aus:
* [[:Kategorie:Person]]
* [[:Kategorie:Streamort]]
Dynamische Informationen aus [[Episodenliste]]
| Anzahl der Streams an Ort/mit Person/an einem Zeitpunkt (Jahr, Monat, Tag,  Wochentag beliebig kombinierbar)
| [https://de.wikipedia.org/wiki/Unscharfe_Suche Fuzzy-Search] über Artikel-Titel im Zielbereich, wenn (Teil-)Datum erkannt: Abfrage der Episodenliste
| Ja
|-

|rowspan="2"| <code>!wiki insider [parameter]</code>
| Keiner
| Keiner
| Link zur [[:Kategorie:Insider]]
| Keine
| Nicht nötig
|-

| Artikeltitel
| Artikel aus:
* [[:Kategorie:Insider]]
| Artikel-Anfangstext (Sektion 0)
|[https://de.wikipedia.org/wiki/Unscharfe_Suche Fuzzy-Search] über Artikel-Titel im Zielbereich
| Ja
|-

|rowspan="2"| <code>!wiki person [parameter]</code>
| Keiner
| Keiner
| Link zur [[:Kategorie:Person]]
| Keine
| Nicht nötig
|-

| Artikeltitel
| Artikel aus:
* [[:Kategorie:Person]]
| Artikel-Anfangstext (Sektion 0)
|[https://de.wikipedia.org/wiki/Unscharfe_Suche Fuzzy-Search] über Artikel-Titel im Zielbereich
| Ja
|-

|rowspan="2"| <code>!wiki suche [parameter]</code>
| Keiner
| Keiner
| Link zur Seite [[WikiBot#Abfragesprache für !wiki suche|WikiBot]].
| Keine
| Nicht nötig
|-

| Abfragebefehl
| Alle nicht-geblacklisteten Wikiartikel
| Titel des Suchergebnis-Artikels, Anzahl der Suchtreffer, ggbfs. Auszug aus dem Wikitext der Stelle(n), die auf den Suchbegriff passen
| [https://whoosh.readthedocs.io/en/latest/intro.html#what-is-whoosh Suchmaschinen-Suche] über gesamtes Wiki (Ausnahme: [[#Artikel-Blacklist|Blacklist]]). Suche im Wikitext oder explizit im Titel (<code>titel:"SkylineTV LIVE"</code>)
| Nein
|-

|}

=== Beispiele für valide Befehle ===

* <code><nowiki>!wiki trivia</nowiki></code>: Zufällige Trivia aus dem gesamten Wiki
* <code><nowiki>!wiki trivia 09.03.2022</nowiki></code>: Zufällige Trivia von der Streamseite [[09.03.2022_Monaco_und_Nizza|09.03.2022 Monaco und Nizza]]
* <code><nowiki>!wiki adam</nowiki></code>: Zufällige Trivia von der Seite [[Adam]]
* ...

* <code><nowiki>!wiki streams München</nowiki></code>: Anzahl der Streams in [[München]]
* <code><nowiki>!wiki streams Cynthia</nowiki></code>: Anzahl der Streams bei denen [[Cynthia]] mitwirkte.
* <code><nowiki>!wiki streams Donnerstag 2021</nowiki></code>: Anzahl der Streams, die an Donnerstagen im Jahr 2021 sattfanden.
* <code><nowiki>!wiki streams Donnerstag 13. Mai</nowiki></code>: Anzahl der Streams, die an einem 13. Mai stattfanden und auf einen Donnerstag fielen.
* <code><nowiki>!wiki streams 13. Mai 2021</nowiki></code>: Anzahl der Streams, die am 13. Mai 2021 stattfanden.
* ...

* <code><nowiki>!wiki insider brunnentv</nowiki></code>: Informationstext zu [[BrunnenTV]].
* <code><nowiki>!wiki insider Polizei Gifhorn</nowiki></code>: Informationstext zu [[Polizei Gifhorn]].
* ...

* <code><nowiki>!wiki person toast kawaii</nowiki></code>: Informationstext über [[Toast Kawaii]].
* <code><nowiki>!wiki person nick</nowiki></code>: Informationstext über [[Nick]].
* ...
* Beispiele zu <code><nowiki>!wiki suche [Parameter]</nowiki></code>, siehe [[WikiBot#Abfragesprache für !wiki suche|nächster Abschnitt]].

=== Abfragesprache für !wiki suche===

==== Normale Freitextsuche ==== 

Die normale Freitextsuche sucht nach den exakten Wörtern im Wikitext. Mehrere Wörter, die durch Leerzeichen getrennt sind, werden mit einem logischen Und verbunden.

Finde Artikel, die das Wort <code>Lego</code> enthalten:
 <nowiki>!wiki suche Lego</nowiki>

Finde Artikel, die das Wort <code>Lego</code> und <code>Star</code> und <code>Wars</code> enthalten:
 <nowiki>!wiki suche Lego Star Wars</nowiki>

Finde Artikel, die die Phrase <code>Der Herr segne dich</code> enthalten (genau in dieser Reihenfolge, Wörter direkt hintereinander):
 <nowiki>!wiki suche "Der Herr segne dich"</nowiki>

Finde Artikel, bei dem spätestens nach sechs Wörtern einmal Kassel nach dem Wort Zissel vorkommt:
 <nowiki>!wiki suche "Zissel Kassel"~6</nowiki>

==== Boolsche Operatoren ==== 

Mithilfe der boolschen Operatoren <code>AND</code>, <code>OR</code> und <code>NOT</code> und den Klammerausdrücken <code>(</code> und <code></code>), lassen sich komplexere Abfragen bilden.

Finde Artikel, die das Wort <code>Lego</code> enthalten, aber nicht Tim, um beispielsweise Streams zu erhalten, in denen zwar Lego vorkam, jedoch ohne Lego-Fan [[Tim Wawambo]]:
 <nowiki>!wiki suche Lego NOT Tim</nowiki>

Finde Artikel, die irgendwas mit dem Zisselfest zu tun haben, aber auch das Wort Bonusstream enthalten:
 <nowiki>!wiki suche (Elsa OR Zissel OR Kassel) AND Bonusstream</nowiki>

==== Suche nach Titeln ====

Normale Suchanfragen suchen standardmäßig im Wikitext. Wenn zusätzlich oder ausschließlich im Titel einer Seite gesucht werden soll, kann dies mit dem Feld-Präfix <code>titel:</code> geschehen.

Suche im Titel nach <code>Frankfurt</code> und nach <code>bauma</code> im Wikitext.
 <nowiki>wiki suche titel:Frankfurt bauma</nowiki>

Suche nach den Wörtern <code>Weihnachtsmarkt</code> und <code>Fulda</code> im Titel.
 <nowiki>!wiki suche titel:(Weihnachtsmarkt Fulda)</nowiki>

Eine exakte Titelsuche für einen bekannten Titel kann somit beispielsweise mit <code>titel:"Exakter Titel"</code> erfolgen.

==== Wildcard-Operatoren ====

Für einzelne Wörter existieren die Wildcard-Operatoren <code>*</code> (ersetzt beliebig viele Zeichen) und <code>?</code> (ersetzt ein Zeichen).
Eine Suche nach <code>!wikisearch *ramsam*</code> findet beispielsweise Artikel, die <code>Aramsamsam</code> enthalten.

==== Gewichtung von Abfrageelementen ====

Mit dem Operator <code>^</code> können einzelne Abfrageelemente eine höhere Gewichtung bei der Auswertung der Suchanfrage erhalten. Z.B. bedeutet  <code>!wikisearch (Elsa Zissel)^5 Hund</code>, dass Elsa und Zissel fünfmal wichtiger sind als andere Wörter, wie hier "Hund".

=== Artikel-Blacklist ===

Die Blacklist für Artikel ist ausschließlich für den Befehl <code>!wiki suche [Befehl]</code> und <code>!wiki trivia</code> relevant, da nur für diese ein gesamter Index für das Wiki angelegt wird. Alle anderen Suchbegriffe arbeiten ohnehin nur auf begrenzten Kategorie-Bereichen. Artikelnamen in der Blacklist werden nicht in diesen Index aufgenommen. Standardmäßig werden weder Diskussions-, Benutzer-, noch Spezialseiten indiziert. Zu den sonstigen ausgeschlossenen Artikeln gehören: Episodenliste, WikiBot, Sandbox, alle Seiten die mit Sandbox: beginnen.

== Fehler und Kontakt ==

Bei Fehlern, Verbesserungsvorschlägen oder Mitentwicklungsinteresse, nutze die [[Diskussion:WikiBot|Diskussionsseite]] oder kontaktiere [[Benutzer:Zeno]].

== Fußnoten ==
<references/>

[[Kategorie:Wiki]]