Team:IRC/HandbuchKubine
Aus Kubuntu-de.org Wiki
Inhaltsverzeichnis |
Wer ist kubine?
kubine ist der Channelbot in den #kubuntu-Channeln. kubine wird überlicherweise mit "sie" angesprochen, ist also ein weiblicher Bot. Sie hat die Aufgabe, einige Bereiche zu vereinfachen und Informationen auszugeben.
Allgemeines
Registrieren
kubine bietet die Möglichkeit, sich als Nutzer zu registrieren indem man ihr eine private Nachricht wie folgt schickt:
/msg kubine register <Name> <Passwort>
Unbedingt notwendig ist eine Registration nicht und die meisten Alltagsbefehle lassen sich auch so ausführen. Für einige Funktionen wird allerdings eine Registration benötigt. Auch um Rechte (wie die Factoids-Rechte) zu erhalten muss man registriert sein.
Identifizieren
In Zukunft kann man sich mit
/msg kubine identify <Name> <Passwort>
identifizieren.
Automatische Identifikation
Man kann den Befehl zum Identifizieren auch in die Liste der automatisch ausgeführten Befehle bei Verbinden zum Server schreiben, um beim Verbinden zum Server auch bei kubine identifiziert zu werden.
Bei Konversation findet man diese Option unter
Datei -> Serverliste -> Bearbeiten (des entsprechenden Servers) -> Befehle:
Bei mehren Befehlen sind diese mit ";" (Semikolon) zu trennen. Beispiel:
[andere Befehle];/msg kubine identify <Name> <Passwort>
Überprüfung auf Identifikation
Um zu prüfen, ob man identifiziert ist, kann man (im Channel oder Query) den Befehl
!whoami
benutzen. Falls man korrekt identifiziert ist, sollte nun der Name erscheinen, der bei der Registration angegeben wurde.
Ansprechen von kubine
Um einen Befehl von kubine auszulösen wird das "!" (Ausrufezeichen) verwendet.
<nick> !ping <kubine> pong
Factoids können mit !<schlüsselwort> abgefragt werden. Des weiteren gibt es einige eingebaute Befehle von kubine (wie !ping) und verschiedene Plugins und die Befehle derer. Welche Plugins es gibt und wie diese zu bedienen sind wird weiter unten erklärt.
Factoids
Als "Factoids" werden bei kubine die Informationen bezeichnet, die kubine auf Befehl zu !<Schlüsselwort> ausgibt, damit diese nicht ständig von den Supportern wiederholt werden müssen. Natürlich müssen ihr diese Informationen erst einmal beigebracht worden sein.
Ansich ist "Factoids" auch nur ein Plugin, wegen dessen Umfang und Bedeutung wird es hier aber gesondert behandelt. Man könnte auch sagen, dass kubines Hauptaufgabe das Speichern und Ausgeben von Factoids ist.
Abrufen und Suchen
Factoids werden, wie schon erwähnt, mit
!<Schlüsselwort>
abgerufen. <Schlüsselwort> muss dabei genau einem kubine bekannten Factoid-Schlüsselwort entsprechen.
Eine Möglichkeit, allgemeiner zu suchen, falls man sich nicht sicher ist, unter welchem Schlüsselwort ein Thema gespeichert sein könnte, gibt es folgenden Befehl:
!suche <Wort>
Dabei werden alle Factoids durchsucht und solche, in denen <Wort> vorkommt, aufgelistet oder, falls nur ein passendes Factoid gefunden wurde, dieses direkt angezeigt.
Beispiele:
<nick> !spenden <kubine> "spenden" : Unterstütze Kubuntu-de.org durch eine Spende! http://www.kubuntu-de.org/spenden ... <nick> !apt [nichts passiert, kubine kennt kein "apt"] <nick> !suche apt <kubine> "aptfix" : (1.) Sollte Adept nach einem Absturz [...] ... <nick> !suche meta <kubine> 'Metafrage' and 'Metapaket'
(Zeilen in [ ] sind Kommentare und nicht Teil des Chat-Protokolls)
Rechte
Für alle folgenden Befehle benötigt ihr Factoids-Rechte, damit nicht jeder daran herumspielen kann. Falls ihr selbige haben möchtet, meldet euch bei einem der Bot-Admins (!botadmins), nicht jeder erhält aber einfach so die Rechte.
Hinzufügen
Factoids fügt man mit
!lerne <Schlüsselwort> ist <Der Text ...>
hinzu. Man kann auch das selbe Schlüsselwort mehrfach verwenden. Dabei wird eine Liste angelegt und die zugeordneten Factoids nacheinander ausgegeben (siehe auch: Beispiel).
Löschen
Wenn ein Factoid nur eine zugeordnete Information hat, kann man es mit
!vergiss <Schlüsselwort>
löschen. Factoids, die mehrere Zuordnungen enthalten, können entweder vollständig mit
!vergiss <Schlüsselwort> *
gelöscht werden oder man löscht nur einzelne Zuordnungen:
!vergiss <Schlüsselwort> <Nummer>
Siehe auch: Beispiel.
Ändern
Vorhandene Factoids können auch bestehend geändert werden. Dies ist mit Regexp möglich. Einfachste Änderungen sind auch ohne Kenntnis von Regexp möglich, Regexp-Kenntnisse sind aber von Vorteil. Bei größeren Änderungen besser die Zuordnung löschen und den Punkt neu erstellen.
!ändere <Schlüsselwort> <Nummer> "<Regex>"
Wer !ändere auch ohne besondere Regexp-Kenntnisse benutzen möchte, kann sich folgende Kurzinformation zu Regexp im Bezug auf das Ändern der Factoids durchlesen.
Regexp
Ich werde hier nun nicht erklären, was ein Regex genau ist und was die Bedeutung ist. Dafür gibt es genug Tutorials/Anleitungen. Ich werde lediglich zeigen, wie man mit Hilfe von !ändere einfache Factoid-Änderungen vornehmen kann. (Die Bezeichnungen im folgenden Text beziehen sich auch nur auf das Ändern der Factoids und haben keinen Anspruch auf Vollständigkeit im Bezug auf die eigentliche Funktionsweise von Regexp!)
Aufbau
Ein Regex ist folgendermaßen aufgebaut:
s/Suchmuster/Ersatztext/Modifikatoren
| s | steht für "substitute", also "ersetzen" |
| / | Delimiter/Trennzeichen (muss nicht zwangsweise "/" sein, beliebiges nicht-alpha-nummerisches Zeichen, aber immer das gleiche!) |
| Suchmuster | ein Muster, nach dem gesucht werden soll und welches dann vollständig ersetzt werden soll |
| Ersatztext | Text, mit dem das gefundene Suchmuster ersetzt werden soll |
| Modifikatoren | muss nicht enthalten sein; verändern die Wirkungsweise der Ersetzung |
Jetzt genauer:
Suchmuster ist das Wort, der Satz oder auch das Regex-Muster, das/der gefunden werden soll. Dabei muss darauf geachtet werden, dass bestimmte Zeichen in Regexp eine besondere Wirkung haben und daher nicht einfach so verwendet werden können. Diese müssen dann mit einem Backslash ("\") escaped werden, damit sie als Literal im Text erkannt werden.
^ $ + * ? . | ( ) [ ] { } \
und das für den Delimiter gewählte Zeichen (i.d.R. "/") sind diese Sonderzeichen.
Ersatztext ist die Textphrase, mit der das gefundene Suchmuster ersetzt werden soll. Hier müssen nur noch Der Delimiter und der Backslash escaped werden. (Wenn im vorherigen Teil einfache Klammern ("(",")") benutzt wurden, kann auf die gefundenen Teilmuster mit "\<nummer>" zugegriffen werden.)
Modifikatoren sind zum Beispiel "i" oder "g". "i" wird verwendet, um im Muster Groß- und Kleinschreibung zu ignorieren und "g", um alle Suchmuster durch den Ersatztext ersetzen zu lassen.
Einfache Beispiele
s/foo/bar/
-> ersetzt das erste Vorkommen von "foo" durch "bar".
Variationen:
s/foo/bar/i
-> ersetzt das erste Vorkommen von "foo", "fOo", "FOO", usw. durch "bar".
s/foo/bar/g
-> ersetzt alle Vorkommen von "foo" durch "bar".
s/foo/bar/ig
-> ersetzt alle Vorkommen von "foo", "fOo", "FOO", usw. durch "bar".
Ein Beispiel zum Escapen:
s/\[Komentar\]/[Kommentar]/
-> ersetzt "[Komentar]" durch "[Kommentar]". Hierbei mussten die "[ ]" im Suchmuster escaped werden.
s/1\/3/1\/2/
-> ersetzt den Bruch "1/3" durch "1/2". Sowohl im Suchmuster, als auch im Ersatztext musste der Slash ("/") escaped werden.
