[Tik-devel] UPDATE: FAQ: How to use filters. (Applies to current cvs)

[Alfred E. <al...@us...>]

FAQ:   HOW TO USE THE FILTER SYSTEM



         1. Q:  When is it appropriate to use tik filters?
            Q:  When is it appropriate to use preproc filters?

            A:  If you're writing a package or component that needs to
                filter messages, use the tik filtering functions (located
                at the end of configandpkg.tcl).
    
                If you just want your own filters applied to IM's, CHAT's,
                etc. use preproc filters (see preproc.tcl in components)


         2. Q:  How do I make my own filters?

            A:  (For package writers) First thing to do is to create a
                function that contains your filter code:

                     proc Some_filter {msg args} {
                         ....Some code
                         return $filtered_msg
                     }

                msg          = the incoming text
                args         = additional arguments, like the $id used by
                               some chat filters
                filtered_msg = the text once you`re done with it

                Then you need to register it:

                     tik_register_filter connName type Some_filter

                connName           = $::SCREENNAME or * (usually *)
                type               = type of filter [see #3]
                Some_filter        = your function name

                (For people making there own) Use the gui for preproc 
                (under development) or check out the source of
                preproc.tcl.

         3. Q:  What are the filter types?

            A:  These are available for both the tik and preproc functions

                IM_OUT       --  outgoing IM`s
                IM_IN        --  incoming IM`s
                CHAT_OUT     --  outgoing CHAT`s
                CHAT_IN      --  incoming CHAT`s

                These are for available for just preproc

                OUT          --  both outgoing IM`s and CHAT`s
                IN           --  both incoming IM`s and CHAT`s


         4. Q:  How do I unload filters?

            A:  (For package writers) You use:

                      tik_unregister_filter connName type func

                in your "unload" routine where:

                connName    = $::SCREENNAME or * (usually *)
                type        = type of filter [see #3]
                func        = name of your filter function

                (For people making their own) Use the gui for preproc 
                (under development) or check out the source of 
                preproc.tcl.