
// MANUAL NICK CONNECTION FILE for mIRCStats
// mIRCStats is (C) Mikko 'Ave' Auvinen

// (NOTE: lines starting with "//" or "##" are comment lines..)


// THE PURPOSE OF THE NICK FILE

// Although mIRCStats does its best to automatically connect nicks that belong to the 
// same person together, it's sometimes not possible to know only by looking at the log 
// file which nicks should be connected together (or which should be kept separated).
//
// Here you can define nick connection rules that mIRCStats uses to connect nicks
// together when creating stats.
//
// You can also define various properties for nicks that are used in several stats sections.


// FILE STRUCTURE
//
// Nick file is structured in sections. Section starts with an identifier that is surrounded
// in brackets []. The identifier tells mIRCStats when the rules in that section should be
// used: 
// - The [common] section is used everytime the nick file is read.
// - [#channelname] section is used only when section name matches the channelname for which
//   mIRCStats is generating stats for at that point.
//
// Section identifier is followed by the actual nick rules, one line for each person. 


// NICK CONNECTION FILTERS

// With nick filters you can tell mIRCStats which nicks actually do belong to same person, 
// and which don't. You can use wildcards which make your life much easier, because many 
// people use several nicks like "Nick", "Nick_work", "Nick_sauna", "NckSurfin", "PartyNick" etc.. 
//
// In these situations you could just tell mIRCStats that every nick which fits into
// filters "*nick* ; nck*" is actually just one person.


// NICK SEPARATION WITH FILTERS
//
// If someone named "Nelly" is occasionally using Nick's computer, you can separate her
// by defining another person with filter "nelly", so after this "Nick" and "Nelly" will
// never be connected again.. 

// You can also include '*' in the filter if Nelly is using nicks like "Nelly_play" etc..
//
// If you need to separate two persons who use nicks like 'Sam' and 'Samantha' with some
// additions after those names (like "_Work", "_sleep"), you can do it by entering them in the
// right order. mIRCStats searches for matching nick filter from top to bottom, so if you
// put filter "samantha*" to the list first, and "sam*" on the next line - mIRCStats will
// separate these two persons correctly. Now Samantha's nicks are screened out with the
// first filter, Sam's nicks match with the second filter. 
//
// Vice versa it wouldn't work, because it that case both nicks would fit into "sam*" 
// filter. 
//
// (Scroll down for [#example] section to see how above rules can be defined).


// NICK PROPERTIES
//
// In addition to nick connection filters, you can also define properties for each nick.
// These are used for example when nick is displayed in the stats page, when controlling nick's mode
// statuses, in Personal Stats, and Property stats (5 stats sections) completely rely on your
// nick property definitions (eg. lists activity by age, gender, city etc...)
//
//    - Connection rules can be divided into multiple lines by starting the
//      extra lines with >> -characters
//      
//    - Current tags which can be used to define properties for each person:
//      NAME      - Full name of the person (possibly a large logo)
//      SHORTNAME - Nickname in text or possibly a very small logo
//      URL       - http:// to person's homepage or other link of interest
//      IMAGE     - Picture to be shown in nick's personal stats section
//      SLOGAN    - Slogan to be shown in nick's personal stats section
//      BIRTHDAY  - Date of birth as 31.12.1980 or 12/31/1980
//      COUNTRY   - Country (or country reference key) of the person
//      CITY      - City (or city reference key) of the person
//      TEAM      - Team (or team reference key) of the person
//      MODE      - Definitions which override nick properties read from log.
//                  (A comma-separated list of following possible values):
//                  * MALE, FEMALE            - Gender of the person
//                  * BOY, GIRL               - same as previous
//                  * ISOP, NOTOP             - For controlling OP status
//                  * ISVOICE, NOTVOICE       - For controlling VOICE status
//                  * ISHALFOP, NOTHALFOP     - For controlling HALFOP status
//                  * ISFOUNDER, NOTFOUNDER   - For controlling IRC Operator status
//                  * ISADMIN, NOTADMIN       - For controlling Channel Admin status
//                  * ISSPECIAL, NOTSPECIAL   - For controlling Specia status (see the help)
//                  * ISNORMAL                - Same as "NOTOP, NOTHALFOP, NOTVOICE,
//                                                       NOTFOUNDER, NOTADMIN, NOTSPECIAL"
//                  * ISEXCLUDED, NOTEXCLUDED - For excluding nick from stats
//                  * ISBOT                   - Bot status (Currently same as ISEXCLUDED, but
//                                              have more meaning in future versions)     
//                  * HIDE_AGE                - Don't show the age of this person in the stats
//                  
// With a registered version you can also include HTML-codes to names, 
// which means that you can put there almost anything - custom font styles, images etc..



// LIMITATIONS: Unregistered version handles only two first nick connection lines,
//              This is just to demonstrate the capabilities of mIRCStats nick connection.
//
//              Please register your version to get your personal registration code.
//	          Registered version can handle any number of nick connection rules and 
//	          also HTML codes in screen names are allowed!
//
//	          Run the program for further info. 



// ADDITIONAL INFO

// Wildcards you can use in filters:
// * = any number of characters (example "Mic" and "Micky" would both fit into "mic*")
// ? = exactly one character    (example "Micky" would fit into "Mick?")

// You can have any number of filters per line (=person), but separate them with ';'

// Filters are case-insensitive, so it same whether you write "NiCK*" or "nick*".

// ---------------------------------------------------------------------------------------



// Nick connection info starts from here. Take some time to study the [#example]-section,
// after that just define your own sections for channels you are on like [#mychannel] etc..


// [common] section: These nick connection rules are loaded for every channel
// Note that example line is commented out with //-characters.

// Hint: Only define those people in [common] section that are in all (or most) of the 
// channels that you create stats for. Putting all rules of all channels under [common] 
// section dramatically slows down stats generation. Use channel specific sections
// instead for most of your nick rule definitions.

[common]

// NAME=Ave ;URL = http://www.nic.fi/~mauvinen/; ave*        //This line is commented out



// This is a channel specific section for irc channel #example.
// Please read more about properties NAME and URL from above.

[#example]

NAME=<i>Nick</i> ; URL = http://www.com/~nick ; *nick* ; nck* ; 
Nelly*; MODE=ISOP
samantha*; MODE=FEMALE
sam*; MODE=MALE



// here's some other samples

[#example2] 

NAME=<img src="http://www.myserver.fi/~nick/friends/pics/snacky.gif"> ; Sn?cky*
Pete* ; Petr?s ; NAME=Peter ; URL = http://www.server.fi/peter
number6* ; n6_*; MODE=MALE; TEAM=SSW
donnax* ; donx*; MODE=FEMALE, ISOP; CITY=JKL



// feel free to add here your own sections for channels you are on. like [#channelname]
// Generate stats and output the debug log with full nick info to see that mIRCStats
// has interpreted your definitions correctly.


[#mychannel]

jab?a*; MODE=ISOP
ja?mi*n*
*H-R*
g?nz?*
*sko
donnax*;donx*

