Changes between Version 1 and Version 2 of Development/Styles/LogFileFormat


Ignore:
Timestamp:
Aug 4, 2006 10:19:28 AM (12 years ago)
Author:
colloquy
Comment:

added who element

Legend:

Unmodified
Added
Removed
Modified
  • Development/Styles/LogFileFormat

    v1 v2  
    1414=== Content Model === 
    1515 
    16  envelope:: sender,message+ 
     16envelope ::= sender,message+ 
    1717 
    1818=== Attributes === 
     
    3232=== Content Model === 
    3333 
    34  event:: message,((old)?,who|(by,topic)) 
     34event ::= message,((old)?,who|(by,topic)) 
    3535 
    3636=== Attributes === 
     
    4242 occurred:: The full date and time when the event has happened. 
    4343 
     44=== Parents === 
     45 
     46These elements contain `event`: `log`. 
     47 
    4448=== Example === 
    4549 
    4650{{{ 
    47 <event id="SAUB4LX7RT" name="memberJoined" occurred="2006-08-02 18:00:57 +0200"><message><span class="member">nonex</span> joined the chat room.</message> 
     51<event id="SAUB4LX7RT" name="memberJoined" occurred="2006-08-02 18:00:57 +0200"> 
     52  <message><span class="member">nonex</span> joined the chat room.</message> 
     53  <who hostmask="nonex@xx.yy.net">nonex</who> 
     54</event> 
    4855}}} 
    4956 
     
    5663=== Content Model === 
    5764 
    58  log:: (envelope|event)+ 
     65log ::= (envelope|event)+ 
    5966 
    6067=== Attributes === 
     
    7885== message == 
    7986 
    80 Contains a text message of a irc user. 
     87Contains a text message of a irc user in XHTML format. 
    8188 
    8289=== Content Model === 
    8390 
    84  message:: (span|CDATA)* 
     91message ::= (<XHTML element>|CDATA)* 
    8592 
    8693=== Attributes === 
     
    112119=== Content Model === 
    113120 
    114  sender:: CDATA 
     121sender ::= CDATA 
    115122 
    116123=== Attributes === 
    117124 
    118  class:: The status of the sender in the chat room. This could be `operator` or `voice`. This attribute is optional. 
     125 buddy:: 
     126  Buddy. 
    119127 
    120  hostmask:: The hostmask of the sender of the message. 
     128 class:: 
     129  The status of the sender in the chat room. This could be `administrator`, `founder`, `half operator`, `operator`, `server operator` or `voice`. This attribute is optional. 
    121130 
    122  identifier:: The username of the sender of the message. This attribute is optional. 
     131 hostmask:: 
     132  The hostmask of the sender of the message. 
    123133 
    124  self:: `yes` if the sender is the user of this Colloquy client. This attribute is optional. 
     134 identifier:: 
     135  The username of the sender of the message. This attribute is optional. 
     136 
     137 
     138 nickname:: 
     139  The nickname of the sender of the message, if it's different from the display name. This attribute is optional. 
     140 
     141 self:: 
     142  `yes` if the sender is the user of this Colloquy client. This attribute is optional. 
    125143 
    126144 
     
    136154<sender hostmask="nonex@xx.yy.net" class="operator">nonex</sender> 
    137155}}} 
     156 
     157---- 
     158 
     159== who == 
     160 
     161Identifies the originator of an event. This is not always the same as the sender of the event. The text content of the element is the nickname of the person. 
     162 
     163=== Content Model === 
     164 
     165who ::= CDATA 
     166 
     167=== Attributes === 
     168 
     169 hostmask:: 
     170  The hostmask of the person. 
     171 
     172 class:: 
     173  The status of the person in the chat room. This could be `administrator`, `founder`, `half operator`, `operator`, `server operator` or `voice`. This attribute is optional. 
     174 
     175 self:: 
     176  `yes` if the person is the user of this Colloquy client. This attribute is optional. 
     177 
     178 
     179=== Parents === 
     180 
     181These elements contain `who`: `event`. 
     182 
     183=== Examples === 
     184 
     185See `event`.