Tutorial for Psi 0.10

From PsiWiki

A New tutorial is up for Psi 0.11. Please note that it is still in beta. Give any comments in the Talk page.

TODO: add screenshots everywhere

Unfortunately, there is no up to date tutorial at this time. This tutorial needs to be updated to reflect the changes in Psi 0.10. If you can't manage without the screenshots, have a look over the old tutorial.


Contents

Welcome to Psi

Welcome to the Psi Jabber Client! Whether or not you've previously used Jabber, these documents will help you get started with the Jabber network. Psi is generally considered to be suitable for more advanced Jabber users, but these help files should see relative beginners up and chatting in no time.

About this Tutorial

First time users of Jabber and Psi should go once through the entire tutorial, without visiting related topics. This will help creating a general view over what Jabber and Psi are. Once you feel natural in using Psi, feel free to explore.

The Psi screenshots in this tutorial might not look exactly like your Psi. This is because Psi is a multiplatform application, running on Windows, Mac OS X and Linux. The only difference you will notice will be in the user interface design (the windows, buttons, lists, checkboxes). Everything else, even functionality, is kept the same on all platforms.

A little about Jabber

The power behind Psi comes from Jabber, an XML-based messaging protocol. The Jabber Instant Messaging system seems to have more in common with email than it does with IM - there are literally hundreds of Jabber servers around the world, and they are all interconnected. Unlike other IM systems that are controlled by single companies, if one Jabber server goes off the air, the rest of the network keeps on humming.

Getting started with Jabber

First you have to choose a jabber server.
There are a lot of free and commercial servers around there. Here is a list from jabber.org.
It shows some free servers that allows open registration of new users.
It also shows the server features (RSS Feeds, ICQ, MSN etc.)
Public Servers from jabber.org
The following discussion about choosing the right jabber server contains additional information: How do YOU choose your Jabber server?
Although the thread was started by IceRAM on the Psi forums some time ago it has not lost its relevance.

Getting started with Psi

Installation

To enjoy the true Psi experience, you first need to install Psi on your computer. Because this task is different from one platform to another, we have prepared a separate document for this (click here).

If you have managed to install Psi, please continue with the next section (First start).

First start

Upon first start-up you will be asked to provide your Jabber Account User details via the Psi - Add Account window. These details are used to automatically create a default user profile (a set of preferences) that reflect the particular way you have configured Psi for your personal use. (Advanced users please see About Profiles)

Creating an account

Creating a new Psi account
Enlarge
Creating a new Psi account

In the Add Account dialog-window type a name for your account. Choose a simple name, such as the Jabber server you plan on connecting to. Alternatively, you can call it a pet's name, or your favourite fruit. It's just a way to identify this account, and has no real importance.

If this is your first time using Jabber (and you do not have an established Jabber identity ie. myname@jabber.org) click the checkbox labeled Register new account. You need to register a new Jabber account to create your unique Jabber User identity. (New Jabber users please see next section).

If you already have a Jabber account somewhere, leave the box unchecked.

Click Add to continue.

Registering a new Jabber account

Registering a new Jabber account
Enlarge
Registering a new Jabber account

We're going to assume that if you've used Jabber before, you will understand how to enter your Jabber server details in the appropriate dialogs. If you've never used Jabber before, keep reading to learn how to get yourself a Jabber ID (also called a JID).

Registering an Account When registering a new Jabber account, you will be presented with the Register Account dialog, (left).

There are two parts to a Jabber ID, or JID. The first part is your username, and the second part is the server address. The JID is written like an email address: username@server.com. You can choose any username that you want, but keep in mind that it might already be taken if you try to register it on a very popular server.

There are a number of public servers available (see network list on jabber.org), but not all of them support all of Jabber's features. You might like to consider which Jabber services you'd like to use - such as groupchat or connection to legacy instant messaging like ICQ and MSN. All servers are interconnected, so you will be able to talk to your friends on other servers.

When you've chosen a username and selected a server, they combine to form your JID. Type your JID into the Jabber ID field. Enter a password and confirm it, then click Register to attempt to register your username at your desired server. If you really must have that certain special username, you may have to try a few different servers until you find it available. After you successfully register, remember to tell your friends your JID so that they can find you.

Nearly finished

Going online
Enlarge
Going online

After successful registration, all you need to do is to go online! There is a little drop-down box at the bottom of the main Psi screen (called the Roster Window, shown on the right) that says "Offline". Select "Online", and you're ready to go! You should receive a welcome message from your Jabber server, but not always.

You should now enter some (information about yourself=link) to make it easier for people to find you later.

Personal Information - the vCard

Opening VCard
Enlarge
Opening VCard

To make it easier for your friends to find and identify you later, you should publish some details about yourself. None of the information you enter is sent back to the Psi team. It is stored on your Jabber server, where anyone can retrieve it.

The first thing to do is to open your vCard ("visit card"), which contains your personal information. Click the Psi button as shown on the right, and select Account Setup. Highlight your account and click the Modify button. The Account Properties dialog will appear. Note that there are four tabs across the top. Click the Details tab. You will then see a button named Edit Personal Details, click it to open the vCard editor (shown below).

Everything in a vCard is OPTIONAL. You are not required to fill it out at all. It is recommended that you at least enter some basic details about yourself, as it helps your friends to find you.

Go through all the tabs, and choose which details you wish to enter. When you are finished, click the Publish button to send your information to your Jabber server.

Services

Registering the GaduGadu Transport
Enlarge
Registering the GaduGadu Transport

So you're now a Jabber user, but you're having trouble converting your friends to the brave new world of Instant Messaging? Because Jabber can connect to other Instant Messaging networks, you can still communicate with your friends from other services. Since they're not native Jabber users, adding your friends from ICQ, AOL et al takes a few more steps.

Signing up with a Transport

If you haven't managed to convert all your friends to the wonderful world of Jabber, never fear! You are still able to talk to them... using a Jabber server feature called Transports.

Most people will probably want to add people from ICQ, so this example will demonstrate how to register with the ICQ Transport and add friends from ICQ. Registration with other Transports is basically the same. Note: You must have a valid account with the desired service before you can use it with Jabber.

Services Browser: On the right you can see the Services Browser. This is where you sign up with Jabber Transports, and can be found by selecting Service Discovery from the Psi menu. Note that the example shows the services on the Jabber server - jabber.rocks.cc. When you open the services browser, it will show the services on your Jabber server instead.

Note: Not all Jabber servers have transports installed! If your Jabber server doesn't have a certain transport, it will not be shown in your Services Browser! Additionally, jabber.rocks.cc is a private server; you will not be able to sign up with it.

To register with the ICQ transport, click its name in the Services Browser, and click the little key icon at the top. The registration form should appear, as shown below.

ICQ Registration: To register an ICQ account, type your ICQ User Identification Number (UIN) into the Username field. To register with AIM, type your Screenname instead. Enter your password, and click the Register button. You should immediately receive an Authorisation Request from the ICQ Transport. Authorise it, and it will be added to your roster under the Agents / Transports group.

From here, you probably want to add your friends who use the Service you just registered with...

The Jabber User Directory

When a Jabber user does a search for someone, they often search the Jabber User Directory, also known as the JUD. If you want your friends to be able to find you when they search the JUD, you should publish your details there.

Select the Jabber User Directory from the services list, and click the register button (the one that looks like a key).

The Registration form will appear, as shown on the left. You are free to enter as much or little information as you wish, but it is recommended that you enter at least three of the fields to make searching more effective. When you have finished entering your information, click the Register button to send your information to the JUD at Jabber.org. Congratulations, you are now an officially recognised Jabber user!

You might like to start adding friends to your roster next...

Adding Your Friends

The internet is a very large place, and it's often hard to locate your friends without a little help. Thankfully, if you already know your friends Jabber ID, it's only a few simple steps to add them.

Adding Jabber Users

If you know your friend's Jabber ID (JID), then it's quite easy to add them to your roster. Click the Psi menu button, and select Add a Contact. The Add User dialog will appear.

Type your friend's JID into the Jabber ID field. The example shows my friend's JID as myfriendfred@his_server.com. You will also see that I have typed his name into the Nickname field. This is entirely optional. If you don't type a nickname in, Psi will show his JID in the roster. You are able to change the JID to a nickname later, if you wish.

Jabber supports dividing your friends up into Groups for ease of finding them on a very long roster. If you have already created some groups, you are able to select one from the list provided. You are also able to create a new group by deleting the <None> group and typing in your new group name.

If you want to be able to see your friend when they're online, you should Request authorization when adding. The next option - Close window after adding - closes the Add User window after you've added one friend. If you want to add another friend immediately after this one, uncheck the box.

Add your friend to your roster by clicking the Add button. A message box will appear saying that the addition has succeeded. To learn how to send them messages, you may like to read the Messaging and Chat section next...

Adding friends on other Instant Messaging services

If you have successfully registered with a Jabber Transport to connect to your desired Instant Messaging System (AOL, ICQ, MSN, Yahoo etc), you can now add your friends who use that system. To begin adding your friends, click the Psi menu and select Add a contact.

Adding an ICQ User When the Add User dialog appears, select the appropriate service from the list at the top. Enter the person's Screenname or User Identification Number (UIN) into the Screenname field, and click the Get Jabber ID button. The details will be transferred to the fields below, in a format understood by Jabber.

You can now enter a Nickname for this person if you wish, but you are able to change it later as well. Choose a group for this person, and click the Add button. A message should popup saying that the addition was successful, and the person should appear on your roster as offline. They will appear online after they grant you authorisation.

You are probably wondering how to chat with your friends...

Messaging and Chat

Just like some other Instant Messaging systems you may have used in the past, Jabber has two methods of talking to your friends - Messages and Chat. When you first created your profile, you would have selected which was the default for you.

Regular Messages

This is the best type to use if you want to simply dash off a quick message to someone. If Message is your default event, double-clicking a friend's name in your roster will bring up the regular message window, shown on the right. If Message is not your default, right-click on their name and select Send Message. The different parts of the window are described below.

  1. To: This is the person to whom you wish to send a message.
  2. Identity List: Your current Jabber Account is shown in the Identity list. You can change this if you want your message to appear to come from another account.
  3. Subject Line: Like email, you can type a subject line. It's entirely optional.
  4. Message Body: This is where you type your message.
  5. Send Button: After typing your message, press this button to send it away into the Jabber network. Alternatively, you can press Control-Enter.
  6. URL Button: If you want to attach an URL with your message, press the little world icon to attach it. You can still type URLs directly into your message body.
  7. User Info: Clicking this icon will bring up your friend's User Information, also called a vCard.
  8. History: You can get details on previous conversations with this icon.

Chats

If you want to carry on a conversation for a while, using a Chat window is a great idea. It stores the history of your conversation right there in front of you. If you have Chat as the default, double-clicking a friend's name in your roster will bring up a Chat Window. If Chat isn't your default, right-click on their name and select Open Chat Window.

  1. To: This is the identity of the person to whom you are chatting.
  2. Current Account: Your current Account name is shown here.
  3. Chat Pane: Your current conversation is shown here. Your ramblings are coloured red, and your friend's musings are coloured blue.
  4. Entry Pane: Click in this pane and begin typing. Press the Enter key to send it to your friend.
  5. Encryption Icon: You can encrypt this chat by clicking this icon. Note that the icon will only be active if you have enabled encryption in your account preferences, and so has your friend.
  6. User Info: Clicking this icon will bring up your friend's User Information, also called a vCard.
  7. History: You can get details on previous conversations with this icon.

To close a Chat Window, press the Escape key on your keyboard.

Multi User Chat (Groupchat)

You can meet with your friends in a groupchat room - similar to an IRC channel. Find out how here. With Psi, you have the possibility to gather