To provide your users a mini-chat, similar to the one Facebook is using, we made Jappix Mini.

Installation

Notice: an installation assistant is available on the Jappix Mini website.

To use it on your website, simply put this code on all your page head elements:

<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js"></script>
<script type="text/javascript" src="http://{YOUR_JAPPIX}/php/get.php?l=en&amp;t=js&amp;g=mini.xml"></script>
 
<script type="text/javascript">
        jQuery(document).ready(function() {
                // Define groupchats here
                MINI_GROUPCHATS = [];
                MINI_PASSWORDS = [];
                
                // Define chats here
                MINI_CHATS = [];
                
                // Add an animation
                MINI_ANIMATE = true;
                
                // Define the user nickname
                MINI_NICKNAME = "Nickname";
                
                // Random user nickname (if no nickname)
                MINI_RANDNICK = true;
                
                // Override the default session resource
                MINI_RESOURCE = "MyOwnResource";
                
                // Connect the user (autoconnect, show_pane, domain, username, password)
                // Notice: put true/false to autoconnect and show_pane
                // Notice: exclude "user" and "password" if using anonymous login
                launchMini(false, true, "jappix.com", "user", "password");
        });
</script>

If your website is yet using jQuery, you'd better removing the jQuery-related line! Note that we get jQuery from Google's CDN to improve performances, but you can also include jQuery from your own Jappix service by adding &f=jquery.js at the end of the Jappix Mini JS URL.

Replace l=en in the JS (script) URLs with "get.php" with your language. So that, if I am french, I will put l=fr.

Note that the default BOSH server you put in the hosts configuration will be used.

Configuration

Account connection

Then, simply fill the launchMini() function with the correct parameters. You can use PHP to fill this in your HTML page, depending on the website user who is logged in. Please note that if you use anonymous login, only put the domain, like this:

launchMini(false, true, "anonymous.jappix.com");

User nickname

To specify an user nickname (which can be generated with PHP from a database), you can use the MINI_NICKNAME global. Please note that you can safely remove it and the account nick will be used.

Groupchats to join

To automatically join groupchats when logged in, add them in the MINI_GROUPCHATS array, like this:

MINI_GROUPCHATS = ["jappix@conference.codingteam.net", "movim@muc.jappix.com"];

If you want to specify a password for a room to join, use the MINI_PASSWORDS array, with the elements sorted in the same order as they are in the groupchats array:

MINI_PASSWORDS = ["password_1", "password_2"];

Please note that you can safely remove all these stuffs, it will not hurt Jappix Mini!

Chats to open

As for groupchats, you can make Jappix Mini open chats with some users once connected. Add them in the MINI_CHATS array, like this:

MINI_CHATS = ["vanaryon@jappix.com", "julien@jappix.com"];

Extra-features

You can call the disconnectMini() function anytime and anywhere to reset Jappix Mini to its initial look and disconnect the user (if logged in).

Usage

Jappix Mini is pretty simple to use. Here are some tips on how you can use it best.

Keyboard shortcuts

We added some keyboard shortcuts to Jappix Mini to make it as easy to use as possible:

1. To show the next chat, press the Tabulate key
2. To close the current chat, press the Escape key
3. To navigate through buddies when roster is opened, use the Up and Down arrows
4. To start a new chat with a roster buddy, press Enter on the selected buddy
5. You can filter roster buddies to make things simpler, start to type the beginning of the buddy name to search for it

Mouse shortcuts

You can easily hide any Jappix Mini element using the mouse:

1. When the buddy list is opened, click away to hide it
2. When a chat is opened, double-click away to hide it