====== Logbot ======
 
===== allgemeines =====

==== Installation vom Logbot ====

  * Standard ist, dass alle Dateien im Programmverzeichnis der Pichat.exe liegen
  * Sinnvoll ist die Verwendung der Systemordners %ProgrammFiles%
  * Standardinstallation erfolgt durch kopieren der DLL in das aktive Verzeichnis aus dem die Pichat.exe gestartet wird (muss nicht das Verzeichnis sein in dem auch die pichat.exe liegt!)
  * pichat-plugin.ini sollte manuell konfiguriert und angepasst werden

==== Ini-Einträge LogfileBaseDirectory und Logfile ====

  * Ist %X enthalten wird kein Logfile angelegt, da %X die Uhrzeit im Format hh:mm enthält!
  * Werden Gänsefüßchen verwendet (z.B. LogfileBaseDirectory="c:\Log\test\") wird kein Logfile angelegt.

  -> technische Beschränkung, generell wird kein " als Sonderzeichen verwendet, ("" würde falschen Dateinamen erzeugen)

==== verfügbare Variablen ====

Variablen der strftime werden (bis auf %X) verwendet
\\ http://linux.die.net/man/3/strftime
\\ http://msdn.microsoft.com/en-us/library/fe06s4ak(VS.71).aspx
 
  %c = Chatroom (lowercase)
  %C = Chatroom (Mixed case)
  %a = Wochentag/Weekday (Ww)
  %A = Weekday (Www)
  %b = Monat/Month (Mm)
  %B = Month (MMM)
  %d = Tag ( DD oder D?)
  %H = Hour (hh 0-24)
  %I = Hour (h 0-12)
  %j = Tag des Jahres (?)
  %m = Monat (MM) 
  %M = Minute (mm)
  %p = AM oder PM
  %S = Seconds (ss)
  %U = Calenderweek Week of year as decimal number, with Sunday as first day of week (00 – 53)
  %w = Wochentag (W 1-7 oder 0-6?) 
  %W = Calenderweek Week of year as decimal number, with Monday as first day of week (00 – 53)
  %x = date (mm\dd\yy) erzeugt Unterverzeichnisse 
  %y = Jahr (yy)
  %Y = Year (yyyy)
  %z = Zeitzone
  %Z = Zeitzone 

% followed by Hash (#) formats the outout of the variable

%#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#% 	# flag is ignored.
%#c 	Long date and time representation, appropriate for current locale. For example: "Tuesday, March 14, 1995, 12:41:29".
%#x 	Long date representation, appropriate to current locale. For example: "Tuesday, March 14, 1995".
%#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, %#Y 	Remove leading zeros (if any).

===== Featurerequests =====

==== Hinweis, dass gelogged wird ====
Ausgabe eines Hinweises wenn man einen Raum betritt in dem ein Logbot aktiv ist
\\ z.B. in der Art von motd oder wie Anna es macht (oder mein "alter" LogBot)
  
    *** Benutzer in Entrance: ADMINNAME Sara Anna wolfguru USERNAME
    <Anna> Hello USERNAME, welcome on this chat server. My name is Anna. Type !help if you need my help.
  
einfach:
  LogbotMessageText=Logbotmessage:Hello ~NICKNAME, This Room will be logged!
  
Luxus: 
    LogbotMessage=1 (schaltet die LogbotMessage ein oder aus)
    LogbotMessageText1=Logbotmessage:
    LogbotMessageText2=en:Hello ~NICKNAME
    LogbotMessageText3=en:This Room will be logged!
    LogbotMessageText4=de:Hallo ~NICKNAME
    LogbotMessageText5=de:Dieser Chatraum wird mitgelogged!
    LogbotMessageText6=ask the Admin for more Information about the logging...
  

==== Statusbefehl ====
**"einfachen status mit uebersicht der bots"**

einen Admin Befehl der das aktuelle Logfile inkl. lokalem Pfad anzeigt

z.B. !logfile
Anzeige im Chat: Logfile is: "C:\Log Files\Chat\2009\05\pichat_entrance_20090518.log"

einen Befehl der Informationen zur aktiven Instanz des Bot.Log anzeigt 
Satusanzeige: welcher Bot, Botname, Raumname, evtl. Roommode

z.B. !logstatus
Anzeige im Chat: active Bot.Log is: Sara42 (Chatroom: XYZ)

=== Kommentare ===
> ... würde sagen abwarten ... wer es braucht oder nutzt
>> bitte meldet Euch hierzu! FIXME

==== ChatroomsExeption ====
FIXME
  für den fall dass ChatroomsPermanent=1 ist könnte man eine 
  ChatroomsExeption=roomname1, roomname2, ... machen ... 
  nur so eine idee :D dann wäre 
  z.b. ChatroomsExeption=entrance und ChatroomsPermanent=1 
  dass alle permanenten nur nicht der entrance gelogged werden :) 

FIXME Hier ist Eure Meinung gefragt! Barucht man es oder nicht?


==== ChatroomBanTime ====

  [[featurerequests:fr1006]] Zeitangabe der ChatroomBanTime im logbot-logfile