Introduzione: Cos'è ubot-it?

Per chi ha familiarità con il canale #ubuntu su Freenode, possiamo dire che ubot-it è il corrispettivo italiano del bot internazionale wiki:Ubuntu/Ubotu. In linea generale, ubot-it serve per dare, con un solo comando, quelle risposte che vengono date frequentemente con assoluta semplicità, come dimostrato dalla sintassi (vedere sotto).

Utilizzo di ubot-it

Questo bot permette di visualizzare, aggiungere, eliminare, cambiare, lockare (e quindi rendere non modificabili) e unlockare varie definizioni. BR Queste definizioni sono del tipo: "parola"-> "valore", dove "parola" è la parola da cercare (es.: "mp3"), e "valore" è la definizione per "parola" (es.: "vedere http://wiki.ubuntu-it.org/FormatiProprietari").

Visualizzare voci del database

Per visualizzare una voce del database, si hanno diverse possibilità, che cambiano solo per forma ma non per risultato:

1. ubot-it: <parola> (esempio: ubot-it: mp3)

2. !mp3

attachment:Icone/Piccole/note.png Da questo momento in poi la forma abbreviata e la forma estesa verranno usate arbitrariamente, ma, ovviamente, possono essere usate entrambe.

Se la parola cercata c'è, il bot vi restituirà la definizione cercata, altrimenti vi avviserà che non ci sono definizioni per quella parola.

Cercare voci nel database

Per cercare una voce nel database: !Factoids search <key> BRBR Esempio: !Factoids search gestione restituirà

'gestione programmi' : http://wiki.ubuntu-it.org/GestioneProgrammi

Mostrare ad un solo utente specifico la voce del database

Capita spesso che bisogna mostrare ad un solo utente la definizione piuttosto che a tutto il canale. Questo è possibile per mezzo dei nested-command. Se ad esempio vogliamo mostrare ad un utente che è off-topic in canale la possibilità di entrare in #ubuntu-it-chat, la sintassi è

tell <nick> [chat]

dove nick è il nick dell'utente.

Aggiungere voci nel database

attachment:Icone/Piccole/warning.png Vedere a fondo pagina il meccanismo dei permessi. BRBR

Per aggiungere una voce nel database si usa il comando learn. La sintassi è la seguente:

learn [<channel>] <key> = <value>

dove <channel> è il canale (nel caso di ubot-it può essere omesso, non verrà più specificato per il resto del documento), <key> è la parola da aggiungere e <value> è la definizione.

Esempio:BR !learn mp3 = vedere http://wiki.ubuntu-it.org/FormatiProprietari o http://help.ubuntu-it.org/guidabreezy/ch03.html#sect-music-and-moviesBR E' possibile inoltre avere più definizioni per la stessa parola (che si aggiungono come nell'esempio precedente una alla volta). Quando si cercherà di visualizzare la parola, verrà data una definizione del tipo "(#1)prima definizione (#2)seconda definizione (#3)....."

Creare alias per voci presenti nel database

attachment:Icone/Piccole/warning.png Vedere a fondo pagina il meccanismo dei permessi. BRBR Molte voci hanno una descrizione comune (ad esempio, "mp3", "wmv", "wma" sono tutti formati proprietari, e possono avere la stessa definizione.BR È quindi comodo creare (sempre seguendo l'esempio) solamente una voce "FormatiProprietari" come descritto nel punto precedente e poi creare uno o più alias ad essa. La sintassi è:

add <name> <alias>

Per cui, per l'esempio:

add mp3 FormatiProprietari
add wmv FormatiProprietari
etc....

Gli alias si rimuovono con il comando remove.

ATTENZIONE: Se la voce per cui si deve creare un alias contiene caratteri speciali ("-", "+", "*", etc...), il comando da dare è

add <name> [whatis #ubuntu-it <alias>]

Eliminare voci dal database

attachment:Icone/Piccole/warning.png Vedere a fondo pagina il meccanismo dei permessi. BRBR Per eliminare una voce dal database si usa il comando forget. La sintassi è la seguente:

forget [<channel>] <key> [<number>|*]

Il suo utilizzo è simile alla procedura per aggiungere voci. L'unica spiegazione da dare è quella che riguarda <number>. <number> non è necessario se c'è una sola definizione per quella voce, ma diventa necessario se ce ne sono più di una, quindi si deve aggiungere il numero della definizione che si vuole cancellare. Se si vogliono cancellare tutte le definizioni per quella parola, basta mettere "*" al posto del numero.

Modificare voci del database

attachment:Icone/Piccole/warning.png Vedere a fondo pagina il meccanismo dei permessi. BRBR Per modificare una voce nel database si usa il comando change. La sintassi è la seguente:

change [<channel>] <key> <number> <regexp>

Cambia la definizione numero <number> della voce <key> secondo <regexp>.

Rendere non modificabili alcune voci del database

attachment:Icone/Piccole/warning.png Vedere a fondo pagina il meccanismo dei permessi. BRBR Per bloccare una voce nel database si usa il comando lock. La sintassi è la seguente:

lock [<channel>] <key>

Blocca la/le definizione/i associate a <key> in modo che non possono essere modificate (rimosse o aggiunte).

Rendere modificabili alcune voci del database

attachment:Icone/Piccole/warning.png Vedere a fondo pagina il meccanismo dei permessi. BRBR

Significato opposto rispetto a lock, per cui rende le voci modificabili. Il comando è unlock

Far annunciare qualcosa nel canale dal bot

attachment:Icone/Piccole/warning.png Vedere a fondo pagina il meccanismo dei permessi. BRBR

Molto utile per informazioni di servizio, ovviamente utilizzabile dagli operatori. Il comando:

announce <testo da ''annunciare''>

Ovviamente ha senso se dato in query.

Utilizzo avanzato

Utilizzo in query

È possibile utilizzare anche il bot in query (privato). La sintassi cambia leggermente, perchè il comando deve contenere anche il nome del canale. Per esempio, per aggiungere una voce "comandi base" in query per il canale #ubuntu-it, il comando è

learn #ubuntu-it comandi base = http://wiki.ubuntu-it.org/ComandiBase

Vedere tutte le voci salvate nel database

Tutte le voci correntemente presenti nel database sono visibili alla pagina ["/Voci"] .

Comportamento in caso di errore

ubot-it risponderà con una combinazione di query/notice. In questo modo il canale sara' pulito e chi non vuole ricevere gli errori da ubot-it può ignorare le notice da esso provenienti.

Meccanismo dei permessi

Il bot non è aperto completamente agli utenti.BRBR Delle precedenti, alcune opzioni sono riservate ad alcuni utenti (come testimonia l'avviso all' inizio della definizione), che per ora sono:

Suggerire aggiunta delle voci

Se volete segnalare l'aggiunta di alcune voci, se uno dei precedenti utenti è presente nel canale, contattatelo e deciderà l'idoneità o meno della richiesta, altrimenti potete aggiungere la "voce -> definizione" sulla pagina ["/DaAggiungere"].

Per richiamare l'attenzione di tutti gli operatori, basta scrivere !ops.

Per dubbi e/o suggerimenti, potete contattare il LoCoTeam che gestisce il bot.

Risoluzione problemi noti

Nick con caratteri speciali

Se un nick contiene le parentesi quadre ( '[' e ']' ), potreste avere problemi nell'utilizzo del bot, poichè sono usate dal bot stesso per alcune operazioni. Tutto ciò che dovete fare per aggirare il problema è racchiudere il vostro nick all'interno delle virgolette. Esempio:

tell "nick[resto del nick nelle parentesi]" [mp3]

Altri?

Se riscontrate altri problemi potete scrivere al LoCoTeam.