Benutzer:ComillaBot/Anleitung

Die folgenden Schritte dokumentieren Installation, Einsatz und Konfiguration des Wikipedia-Bots ComillaBot.

Download und Installation

Java

Um ComillaBot einsetzen zu können, ist eine funktionierende Java-Laufzeitumgebung (Version 1.6 von Sun oder dazu kompatibel) erforderlich. Ist eine solche nicht vorhanden, muss sie installiert werden. Die Vorgehensweise hierzu ist abhängig vom eingesetzten Betriebssystem. Es bietet sich der Download von www.java.com an, bei vielen Linux-Distributionen existiert auch alternativ die Möglichkeit zur Installation über die jeweiligen Repositories.

JETERS

Comilla basiert auf JETERS (Java Extensible Text Replacement System), einem für unterschiedliche Zwecke einsetzbaren Wiki-Botsystem. JETERS ist auf jeters.sourceforge.net erhältlich.

Comilla

Der Download von Comilla selbst ist hier möglich. Die Datei „Comilla.jar“ aus dem Zip muss in den „components“-Ordner von JETERS platziert werden.

Einsatz

Programmstart

Ist die JavaVM als Standardprogramm für .jar-Dateien gesetzt, lässt sich das Programm abhängig vom Betriebssystem durch Öffnen (auf den meisten Desktopumgebungen per Doppelklick) der Datei JETERS.jar starten. Alternativmöglichkeiten, etwa das Anlegen eines Links auf JETERS.jar, müssten dann ebenso problemlos möglich sein.

Sollte das zuvor beschriebene Verfahren nicht erfolgreich oder nicht gewünscht sein, kann der Aufruf aus der Kommandozeile erfolgen. Hier muss zunächst in den Ordner gewechselt werden (der zugehörige Befehl lautet üblicherweise cd Verzeichnisname), der die Datei JETERS.jar enthält. Daraufhin ist der Java-Interpreter mit der Datei JETERS.jar aufzurufen. Der Befehl hierfür lautet

java -jar JETERS.jar

Aufrufparameter

Das Verhalten von JETERS kann beim Programmstart mit verschiedenen Parametern beeinflusst werden. Eine Liste solcher Parameter erhält man mit java -jar JETERS.jar --help. Soll JETERS beispielsweise mit dem Comilla-Replacer und Lese- und Schreibzugriff auf ein MediaWiki gestartet werden, ist java -jar JETERS.jar --nohome --input MediaWikiIO --output MediaWikiIO --replacer ComillaReplacer aufzurufen. Dadurch ist die Auswahl beim Programmstart nicht mehr nötig. Um zusätzlich den ISBNChecker zu verwenden (vorausgesetzt, er befindet sich im components-Ordner), ist der Aufruf java -jar JETERS.jar --replacer 2 ComillaReplacer ISBNChecker geeignet.

Probleme

Die häufigsten Fehler (etwa die Meldung „Bad version number in .class file“) sind auf eine veraltete oder inkompatible Java-Version zurückzuführen. In diesem Fall sollte die neueste verfügbare Version installiert und zugleich sichergestellt werden, dass keine Reste von früheren Versionen im System verblieben sind. Mit einem Aufruf von java -version lässt sich prüfen, auf welche Runtimeversion zurückgegriffen wird.

Treten speziell bei der Bearbeitung umfangreicher Texte Fehler auf, kann dies an fehlendem Speicher für die JavaVM liegen. Hier kann das Erweitern des Aufrufs mit einem der folgenden Parameter Abhilfe schaffen:

-Xms<size>  set initial Java heap size

-Xmx<size>  set maximum Java heap size
-Xss<size>  set java thread stack size

Beispiel: java -Xss1M -jar JETERS.jar --help

Konfiguration

Allgemeines

Das JETERS-System erlaubt es, individuelle Einstellungen vorzunehmen, dies geschieht über XML-Konfigurationsdateien im Verzeichnis .JETERS unterhalb von user.home (betriebssystemabhängiges Verzeichnis). Unter Linux handelt es sich um das Homeverzeichnis des Benutzers (~), in einer Windows-XP-Umgebung findet sich .JETERS in einem der Verzeichnisse unterhalb von „Dokumente und Einstellungen“. Konfigurationsdateien mit Standardwerten werden beim ersten Programmstart generiert. Jeder Wert in den Dateien ist nach einem bestimmten Schema aufgebaut. Ein Beispiel:
<conf name="changesBgColorNew" type="string">blue</conf>

Hinter „name“ folgt der Name der Option, hinter „type“ der Datentyp (siehe unten). Zwischen dem öffnenden und dem schließenden Tag befindet sich der eigentliche Wert der Einstellung (hier: „blue“). Änderungen sollten sich auf letzteren Wert beschränken.

mögliche Datentypen

integer oder long	Ein ganzzahliger Wert, wie 1, -13 oder 4711
float oder double	Eine Kommazahl, wie 2.5, -23.4 oder auch 10.0
string	Eine Zeichenfolge
boolean	Ein Wert, der nur wahr (1) oder falsch (0) sein kann

Grundsätzlich gilt aber: Nicht jeder durch den Datentyp erlaubte Wert muss im jeweiligen Kontext Sinn ergeben.

(Hinweis: In Konfigurationsdateien bitte keine typografisch korrekten Minuszeichen verwenden.)

Einzelne Konfigurationsmöglichkeiten

Datei	name	type	Beschreibung
Core.xml	defaultComponentUI	string	Die einzusetzende Benutzerschnittstelle. Standardmäßig stehen net.sf.jeters.JETERS_GUI (grafisch) und net.sf.jeters.JETERS_CUI (Kommandozeile, eingeschränkte Funktionalität) zur Auswahl.
	defaultComponentInput	string	Die Quelle für den zu bearbeitenden Text. Standardmäßig stehen net.sf.jeters.MediaWikiIO (MediaWiki-Systeme), net.sf.jeters.FileIO (lädt Text aus Datei) und net.sf.jeters.UserIO (Text wird über die Benutzeroberfläche eingegeben/eingefügt) zur Auswahl.
	defaultComponentOutput	string	Möglichkeiten, den fertig bearbeiteten Text auszugeben. Die Auswahlmöglichkeiten entsprechen defaultComponentInput.
	defaultComponentReplacer	string	Die Klasse, die die eigentliche Ersetzungsfunktionalität enthält. Für Comilla ist ComillaReplacer auszuwählen. Mit JETERS wird außerdem net.sf.jeters.RegExReplacer_User mitgeliefert, das eine benutzerdefinierte Ersetzung auf RegEx-Basis durchführt.
	componentDirectoryPath	string	Das Verzeichnis, in dem die Komponenten abgelegt werden.
	showHomeView	boolean	Bestimmt, ob dem Benutzerinterface die Möglichkeit gegeben werden soll, eine Übersichts- und Komponentenwahlansicht vor dem Beginn des eigentlichen Bearbeitungsprozesses zu zeigen.
	outputUnchangedTexts	boolean	Bestimmt, ob auch bei unveränderten Texten die Outputkomponente aktiviert werden soll. Ist etwa beim Abarbeiten ganzer Kategorien in einem MediaWiki hilfreich, da so alle fehlerfreien Artikel einfach übersprungen werden können.
ComillaReplacer.xml	debug	boolean	Aktiviert Ausgabe von Debuginformationen auf der Kommandozeile.
	minRatingDescription	integer	Die Einstufung, die eine Änderung mindestens erhalten haben muss, um angezeigt zu werden. Übliche Werte liegen zwischen 1 (Standard) und 5.
	minTotalRatingDescription	integer	Die Einstufung, die eine Änderung mindestens erhalten haben muss, um angezeigt zu werden. Anders als minRatingDescription erhöht sich die Bewertung einer Änderung hier, wenn sie mehrmals vorkommt.
	minRatingSummary	integer	Mindestvoraussetzungen, um in den Bearbeitungskommentar aufgenommen zu werden. Entsprechen ansonsten min(Total)RatingDescription.
	minTotalRatingSummary	integer
	summaryEntryLimit	integer	Obere Grenze für die Anzahl der Änderungen, die im Bearbeitungskommentar aufgezählt werden.
	summaryEntryLimit	integer	Obere Grenze für die Anzahl der Detailinformationen, die im Bearbeitungskommentar in Klammern hinter einer Änderung aufgezählt werden.
	description	string	Erklärender Text, der im Bearbeitungskommentar vor die Auflistung der Detailinformationen gesetzt wird.
	removeWhitespace	boolean	Gibt an, ob Comilla überflüssige Leerzeichen aus Artikeln entfernen soll, etwa mehr als ein Leerzeichen zwischen zwei Wörtern. (Solche Leerzeichen werden von der MediaWiki-Software aber ohnehin nicht angezeigt)
	removeWhitespace	boolean	Gibt an, ob Comilla überflüssige Leerzeichen aus Artikeln entfernen soll.
	splitEnumerationAfter	integer	Aufzählungen werden nach dieser Anzahl an Spiegelstrichen in separat zu behandelnde Bearbeitungsbereiche geteilt, was die Übersichtlichkeit erhöhen kann. 0 bewirkt, dass Aufzählungen generell als Gesamtheit bearbeitet werden.
UI_JETERS_GUI.xml	useSystemLookAndFeel	boolean	Legt fest, ob JETERS versuchen soll, das Aussehen nativer Software zu imitieren.
	showToolTips	boolean	Bestimmt, ob beim Verweilen des Mauszeigers über einem Bedienelement Hilfetexte eingeblendet werden sollen.
	cutUnchangedParts	boolean	Bestimmt, ob Textteile, die nicht geändert wurden, bei der Darstellung von alter und neuer Version ausgeblendet werden sollen.
	forceShowChanges	boolean	Zeigt alle Änderungen. Ist dies deaktiviert, werden als unwesentlich betrachtete Änderungen ohne Rückfrage vorgenommen.
	changesFontColorOld	string	Um im Rahmen der Änderungsübersicht Passagen des Ausgangstextes, die geändert wurden, zu kennzeichnen, wird solcher Text in dieser Farbe dargestellt. Farben werden wie in HTML-Dokumenten angegeben.
	changesBgColorOld	string	Um im Rahmen der Änderungsübersicht Passagen des Ausgangstextes, die geändert wurden, zu kennzeichnen, wird solcher Text mit dieser Farbe hinterlegt. Farben werden wie in HTML-Dokumenten angegeben.
	changesFontColorOld	string	Um im Rahmen der Änderungsübersicht Passagen des Ersetzungsresultats zu kennzeichnen, die sich gegenüber dem Ausgangstext geändert haben, zu kennzeichnen, wird solcher Text in dieser Farbe dargestellt. Farben werden wie in HTML-Dokumenten angegeben.
	changesBgColorOld	string	Um im Rahmen der Änderungsübersicht Passagen des Ersetzungsresultats zu kennzeichnen, die sich gegenüber dem Ausgangstext geändert haben, wird solcher Text mit dieser Farbe hinterlegt. Farben werden wie in HTML-Dokumenten angegeben.
	editFrameLineWrap	boolean	Bestimmt, ob die Zeilen im Bearbeitungsfenster am Ende des Textfeldes umgebrochen werden sollen (1), oder ob vertikal gescrollt werden muss (0).
	mainFrameSizeX	integer	Größe des Hauptfensters in horizontaler Richtung.
	mainFrameSizeY	integer	Größe des Hauptfensters in vertikaler Richtung.
	mainFramePositionX	integer	Abstand des Hauptfensters zum linken Bildschirmrand.
	mainFramePositionY	integer	Abstand des Hauptfensters zum oberen Bildschirmrand.
	editFrameSizeX	integer	Größe des Bearbeitungsfensters in horizontaler Richtung.
	editFrameSizeY	integer	Größe des Bearbeitungsfensters in vertikaler Richtung.
	showLabelInDiffView	boolean	Ist dieser Wert auf 1 (true) gesetzt, wird in der Änderungsanzeige der Titel des gerade bearbeiteten Textes angezeigt.
UI_JETERS_CUI.xml	showHelpTexts	boolean	Bestimmt, ob auf der Kommandozeile ausführlichere Beschreibungen zu den geforderten Eingaben angezeigt werden.
MediaWikiIO.xml	urlMediaWiki	string	URL des MediaWiki-Systems, auf das zugegriffen werden soll, etwa http://de.wikipedia.org/w/index.php für die deutsche, http://en.wikipedia.org/w/index.php für die englische Wikipedia.
	username	string	Benutzername und Passwort für den Account, der für Bearbeitungen eingesetzt werden soll. Stehen hier keine Angaben, werden die Daten vom Programm zur Laufzeit abgefragt.
	password	string
	showOverviewBeforeWriting	boolean	Legt fest, ob vor dem endgültigen Ändern eines Artikels zunächst noch ein Überblick angezeigt werden soll.
	showArticleInBrowser	boolean	Wenn 1 (true), wird ein Artikel zu Beginn der Bearbeitung im Standardbrowser geöffnet.

Bitte beachten: Diese Auflistung ist unvollständig. Unter anderen Programmversionen fehlen außerdem möglicherweise einige der genannten Möglichkeiten.