MediaWiki/Bots und API

Aus Foxwiki

Bots

Es gibt verschiedene Tools, um automatisierte Änderungen an den Inhalten des Wikis vorzunehmen, wie zum Beispiel die Erweiterung Text ersetzen.

  • Aber in vielen Fällen sind die erforderlichen Bearbeitungen zu spezifisch, um von einem automatisierten Tool verarbeitet zu werden.
  • Für all diese Fälle gibt es Bots und die MediaWiki-API.

Ein Bot ist in der MediaWiki-Terminologie ein Skript, das eine oder mehrere bestimmte Arten von Bearbeitungen durchführt oder ein oder mehrere Datenelemente abruft.

  • Ein Bot kann in jeder Programmiersprache geschrieben werden: Er muss sich nur mit der MediaWiki-API verbinden, die die eigentliche Arbeit des Schreibens und Lesens von Daten übernimmt.
  • Die meisten der wichtigsten Programmiersprachen haben eine oder mehrere MediaWiki-API-Bibliotheken, die für sie geschrieben wurden, die sich um die Details der Anmeldung beim Wiki und die Verbindung zur API kümmern.
  • Aber auch ohne eine Bibliothek ist es nicht so schwer, einen MediaWiki-Bot zu erstellen – das Skript muss nur einige MediaWiki-URLs treffen.

Wenn ein Bot Änderungen an einem Wiki vornimmt, sollte er idealerweise als Benutzer angemeldet sein – und idealerweise sollte dieser Benutzer ein separates Konto sein, das der Gruppe „Bots“ hinzugefügt wird.

  • Sie können diese Art von Konten überall auf Wikipedia sehen – sie reparieren defekte <ref> -Tags, benennen Kategorien um, fügen Signaturen zu unsignierten Diskussionsseiten-Nachrichten hinzu usw.
  • In anderen Wikis sind sie etwas seltener, Einige kleinere Wikis machen jedoch erheblichen Gebrauch davon.

Diese Seite enthält einige Informationen und hilfreiche Links zum Erstellen und Ausführen von Bots:


MediaWiki-API

Die MediaWiki-API ist im Wesentlichen eine Reihe von URLs, auf die man zugreifen kann, um aus dem Wiki zu lesen und darin zu schreiben.

  • Sie beinhalten alle unterschiedliche Parameter, die an die Datei api.php übergeben werden.
  • Diese Datei befindet sich im selben Verzeichnis wie index.php; Wenn Ihr Wiki beispielsweise URLs der Form mywiki.com/w/index.php?title=...
  • hat, ist die Haupt-API-URL unter mywiki.com/w/api.php zu finden. (Für neuere Versionen von MediaWiki wird die API von der Special:Version-Seite verlinkt.)

Wenn Sie zu dieser Haupt-URL gehen, sehen Sie eine ziemlich ausführliche (automatisch generierte) Erklärung aller verfügbaren API-Aktionen.

  • API-Aktionen werden sowohl vom MediaWiki-Kern als auch von einer Reihe von Erweiterungen definiert.
  • Sie sehen auch eine Liste der verschiedenen Formate, in denen die Ergebnisse angezeigt werden können, einschließlich JSON und XML.
  • Wenn Sie beispielsweise „format=jsonfm“ zur URL hinzufügen, werden Ergebnisse in einem Pseudo-JSON-Format angezeigt, das Benutzer auf dem Bildschirm lesen können, während „format=json“ zu tatsächlichem Roh-JSON führt.

Wir werden hier nicht auf die Details aller verfügbaren API-Funktionen eingehen, aber Sie können sie unter api.php sehen – und Sie können auch mehr darüber lesen unter: