Thema's ShoutBox GUI based on the Pixx-designed PJIRC Interface
---------------------------------------------------------------

Webmaster's manual
------------------


Files
-----
  The following files are part of the Sbox GUI:
    sbox.cab : Sbox GUI for Internet Explorer VM.
    sbox.jar : Sbox GUI for Sun JVM.
    sbox-english.lng
    sbox-french.lng

Installation
------------

  Download PJirc v2.2.1 or later from 
  http://prdownloads.sourceforge.net/pjirc/pjirc_2_2_1_full.zip?download  
  Upload all files to your PJIRC directory, and add them to the file list 
  in the applet html fragment.
  
  If you have a page already configured for the Pixx GUI, it will be enough to
  simply change all Pixx references to Sbox. You can then think about adding new
  Sbox parameters.

All SBOX parameters are prefixed by 'sbox:'.

Additional Parameters
---------------------

  nickfieldfg : Changes the text colour in the NickField dialogue.   
  -----------	The values are those selected by the colorI parameter.

    Example :
      <param name="sbox:nickfieldfg" value="0">

  
  nickfieldbg : Changes the background colour in the NickField dialogue.   
  -----------	The values are those selected by the colorI parameter.

    Example :
      <param name="sbox:nickfieldbg" value="1">

  showmenubar : Shows or hides the top menu bar. Defaults to true.
  ----------- 
  
    Example :
      <param name="sbox:showmenubar" value="true">

  shownicklist : Shows or hides the nicklist panel. Defaults to true.
  ------------
    
    Example :
      <param name="sbox:shownicklist" value="true">
    
  showtaskbar : Shows or hides the taskbar panel. Defaults to true.
  -----------
    
    Example :
      <param name="sbox:showtaskbar" value="true">
    
  taskbarwest : Moves the taskbar panel to the left of the source. Defaults to false.
  -----------
    
    Example :
      <param name="sbox:taskbarwest" value="false">


Original Parameters
-------------------

  colorI, with I a figure : Tells the applet to modify the given color index to
  ------                    the given color.

          The following color codes are defined :
             0 : black
             1 : white
             2 : dark gray
             3 : gray
             4 : light gray
             5 : foreground
             6 : background
             7 : selection
             8 : event
             9 : close
            10 : voice
            11 : operator
            12 : halfoperator
            13 : male ASL
            14 : female ASL
            15 : unknown ASL

    Example :
      <param name="sbox:color1" value="C0C000">

  helppage : configures the help page to be opened in a new browser window when
  --------   the help button is clicked by the user on the interface.

    Example :
      <param name="sbox:helppage" value="http://www.yahoo.com">

  timestamp : switches on or off the timestamp option. By default, timestamping
  ---------   is not activated.

    Example :
      <param name="sbox:timestamp" value="true">

  highlight : enable or disable highlights. If highlights are not enabled, no
  ---------   highlight will be performed, regardless of any other highlight
              option. By default, highlights are disabled.

    Example :
      <param name="highlight" value="true">

  highlightnick : if highlight is enabled, any received message containing the
  -------------   current user nick will be highlighted. By default, nick
                  highlight is switched off.

    Example :
      <param name="sbox:highlightnick" value="true">

  highlightcolor : if highlight is enabled, specifies the highlight color to be
  --------------   used. By default, highlight color is 5.

    Example :
      <param name="sbox:highlightcolor" value="9">

  highlightwords : if highlight is enabled, gives a list of words triggering
  --------------   highlight. Words are separated using spaces.

    Example :
      <param name="sbox:highlightwords" value="word1 word2 word3">


  showconnect : enable or disable connect menu button visibility. By default,
  -----------   the connect button is visible.

    Example :
      <param name="sbox:showconnect" value="true">

  showchanlist : enable or disable chanlist menu button visibility. By default,
  ------------   the chanlist button is visible.

    Example :
      <param name="sbox:showchanlist" value="true">

  showabout : enable or disable about menu button visibility. By default, the
  ---------   about button is visible.

    Example :
      <param name="sbox:showabout" value="true">

  showhelp : enable or disable help menu button visibility. By default, the
  --------   help button is visible.

    Example :
      <param name="sbox:showhelp" value="true">

  nicklistwidth : set the width, in pixel, of the right channels nicklist bar.
  -------------   Default value is 130.

    Example :
      <param name="sbox:nicklistwidth" value="130">

  nickfield : show a nick input field in the bottom right of the application.
  ---------   By default, this option is disabled.

    Example :
      <param name="sbox:nickfield" value="false">

  styleselector : control the style selector visibility. By default, style
  -------------   selector is not visible.

    Example :
      <param name="sbox:styleselector" value="true">
  
  setfontonstyle : control the "font selector on style selector" visibility.
  --------------   By default, the font selector is disabled.

    Example :
      <param name="sbox:setfontonstyle" value="true">
   
  showclose : set whether the close box button should be visible or not. By
  ---------   default, close button is visible.

    Example :
      <param name="sbox:showclose" value="false">

  showstatus : set whether the status window should be visible or not. By
  ----------   default, status window is visible.

    Example :
      <param name="sbox:showstatus" value="false">

  automaticqueries : enable or disable the automatic query popup when
  ----------------   user double click on another nickname. By default,
                     automatic queries are enabled.

    Example :
      <param name="sbox:automaticqueries" value="false">

  configurepopup : master switch for manual popup configuration. Must be
  --------------   set in order to use popupmenustringI and
                   popupmenucommandI_J parameters. By default, master
                   popup configuration switch is disabled.

    Example :
      <param name="sbox:configurepopup" value="true">

  popupmenustringI : configure the Ith line of the nickname popup menu.
  ----------------   This parameter only set the caption, the action to
                     be performed is customized using popupmenucommandI_J.
                     A '--' caption acts as a separation line.

    Example :
      <param name="sbox:popupmenustring1" value="Whois">
      <param name="sbox:popupmenustring2" value="Kick + Ban">


  popupmenucommandI_J : configure the Jth command of the Ith line of the
  -------------------   nickname popup menu. %1 will be replaced by the
                        nickname, %2 by the source name, %3 by the
                        user ASL (if available) or full name information,
                        and %4 will always be replaced by the full name
                        information.

    Example :
      <param name="sbox:popupmenucommand1_1" value="/whois %1">
      <param name="sbox:popupmenucommand2_1" value="/mode %2 -o %1">
      <param name="sbox:popupmenucommand2_2" value="/mode %2 +b %1">
      <param name="sbox:popupmenucommand2_3" value="/kick %2 %1">


  mouseXXX : advanced mouse configuration for event XXX. First parameter
  --------   is mouse button number (1=left mouse button), second is
             number of clicks for the vent (2=double click). The following
             mouse events are known :
             - nickquery : query open
             - urlopen : url open
             - channeljoin : channel joining
             - nickpopup : popup menu on nickname
             - taskbarpopup : popup menu on the bottom taskbar

    Example :
      <param name="sbox:mouseurlopen" value="3 1">

  showchannelX : set whether the X channel event notifications should
  ------------   be displayed on the channel. By default,
                 all notifications are displayed except youjoin.
                 Defined events are
                   - nickchanged
                   - nickmodeapply
                   - modeapply
                   - topicchanged
                   - nickquit
                   - nickkick
                   - nickpart
                   - nickjoin
                   - youjoin

    Example :
      <param name="sbox:showchannelnickchanged" value="false">


  showdock : set whether the docking button should be visible or not.
  --------   by default, the docking button is visible.

    Example :
      <param name="sbox:showdock" value="false">

  dockingconfigI : configure the default docking behaviour for the
  --------------   sources. By default, all sources will remain
                   undocked. Syntax is sourcetype sourcename dock
                   or sourcetype sourcename undock.

    Example :
      <param name="sbox:dockingconfig1" value="none+ChanList all undock">

  scrollspeed : set the topic scrolling speed. A value of 0 keeps the topic
  -----------   static. Default value is 0.

    Example :
      <param name="sbox:scrollspeed" value="20">

  leaveonundockedwindowclose : set whether the source should be left when
  --------------------------   the undocked window is closed. By default,
                               this is false and the source is docked back.

    Example :
      <param name="sbox:leaveonundockedwindowclose" value="true">


  nickprefix : Defines the nickname display prefix. Escape codes can be
  ----------   defined as following: \b toggle bold
                                     \u toggle underline
                                     \o toggle reverse
                                      \s add blank space
                                     \kX,Y toggle color X,Y
               Default Value is '<'

    Example:
      <param name="sbox:nickprefix" value="<\b">

  nickpostfix : Defines the nickname display postfix. Escape codes can be
  -----------   defined as following: \b toggle bold
                                      \u toggle underline
                                      \o toggle reverse
                                      \s add blank space
                                      \kX,Y toggle color X,Y
                Default Value is '>\s'

    Example :
      <param name="sbox:nickpostfix" value="\b>\s">

  displayentertexthere : Enables the "Enter text here..." text that
  --------------------   will be displayed upon new source creation
                         in the text input field. Default value is false.

    Example :
      <param name="sbox:displayentertexthere" value="true">

  ignoreallmouseevents : Disables any mouse-related events. By default,
  --------------------   this is false.

    Example :
      <param name="sbox:ignoreallmouseevents" value="true">

  hideundockedsources : Removes the undocked sources from the taskbar.
  -------------------   By default, this is not enabled.

    Example :
      <param name="sbox:hideundockedsources" value="true">

  displaychannelXXX : Enable or disable channel topic details.
  -----------------   By default, all details are enabled.
                      XXX can be: name the channel name
                                  mode the channel mode
                                  count the user count
                                  topic the channel topic

    Example :
      <param name="sbox:displaychannelmode" value="false">

Runtime commands
----------------

The Sbox gui adds some commands:

dock : dock the active source
undock : undock the active source
color %c : set the current color to %c. For instance /color 4,2
bold %b : set the bold status, with %b being either 1 or 0.
underline %u : set the underline status, with %u being either 1 or 0.
focus %type %source : set the focus to the given source
highlight %word : add the given word into the highlight word list. Only
    has effect if highlight is set to true.
unhighlight %word : remove the given word from the highlight word list. Only
    has effect if highlight is set to true.

Contacts
--------

Pixx PJIRC GUI is developed by Plouf - plouf@pjirc.com
Have a look to http://www.pjirc.com/ for news about PJIRC.

Sbox PJIRC GUI is developed by Thema thema@adnd.com and is
distributed under the same terms and conditions as the
Pixx interface, and the PJirc applet.