blob: 367609c0651ed4f4269ecea6b3ae7bc846d5ee0c [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta NAME="AUDIENCE" CONTENT="NBUSER">
<meta NAME="TYPE" CONTENT="ARTICLE">
<meta name="author" content="Ruth Kusterer"/>
<link rel="stylesheet" type="text/css" href="https://netbeans.org/netbeans.css">
<title>Collaboration Module Quickstart</title>
</head>
<body>
<h1>Developer Collaboration Module Quickstart</h1>
<div class="feedback-box">
<a href="/about/contact_form.html?to=3&amp;subject=Feedback:%20Collaboration%20Quickstart%20Tutorial">Feedback</a>
</div>
<p><div class="articledate" style="margin-left: 0px;">
Contributed by <a href="mailto:kalali@gmail.com">Masoud Kalali</a>,
maintained and updated by <a href="mailto:ruth.kusterer@sun.com">Ruth Kusterer</a>
</div></p>
<p>
<br />
<div style="margin-left:10px;float:right;width:250px">
<div style="background-color:rgb(230,230,255);padding:5px;font-size:90%;">
<h4>Collaboration Features in Brief</h4>
<ul style="margin-left:-1em;">
<li>Chat in private or in public.</li>
<li>Share plain text, formatted code, and even complete Java projects.</li>
<li>Join via any XMPP/Jabber server
such as <a href="http://share.java.net">share.java.net</a>.</li>
<li>Maintain friends and conversations lists.</li>
</ul></font>
</div>
<img src="../../images_www/v6/features/ide-collaboration.png" style="padding-top:15px;padding-left:25px"/>
</div>
<P>
Talk code with other developers live over the network,
be it in your local team or on another continent!
<a href="http://collab.netbeans.org">NetBeans Developer Collaboration</a>
lets you chat and share code while keeping syntax coloring,
project file structure and formatting intact.
Collaboration enables you to review, edit and build shared sources
in real time together with remote developers.<br />
</p>
<p class="alert"><b>Note: Service for the public developer collaboration XMPP server share.java.net has been discontinued as of April 20, 2009.</b> Please use another <a href="http://xmpp.org/services/">public</a> XMMP server, or set up a <a href="http://wiki.netbeans.org/CollabServer">private</a> one.</p>
<p>This quickstart tutorial covers how to
<ol>
<li><a href="#install">Install the Collaboration Module</a></li>
<li><a href="#register">Register to a Collaboration Server</a></li>
<li><a href="#connect">Connect to a Collaboration Server</a></li>
<li><a href="#find">Find People and Conversations</a></li>
<li><a href="#join">Start or Join a Conversation</a></li>
<li><a href="#logout">Log Out and Log Back In</a></li>
<li><a href="#openfire">Optional: Set Up Your Own Collaboration Server</a></li>
</ol>
</p>
<p>This tutorial takes about 20 minutes to complete.</p>
<br clear="all" />
<h2><a name="install"></a>Install the Collaboration Module</h2>
<h3>For NetBeans IDE 6.0 or better</h3>
<ol>
<li>Open Netbeans IDE 6.0 or better and connect to the internet.</li><br />
<li>To download and install the Collaboration module for NetBeans,
choose <b>Tools &gt; Plugins</b> from the menu. The
Plugin Manager window opens.</li><br />
<li>Click the Available Plugins tab. The list of available plugins and packs will come up.
Select the item <b>Developer Collaboration</b> from the list and check the box.</li><br />
<li>Click the <b>Install</b> button to install the plugin into the IDE.
The Installer window lists all plugins scheduled for installation. Click <b>Next</b>.</li><br />
<li>The Plugin Manager will ask you to accept necessary licenses.
Read them and check <b>I Agree</b>. Click <b>Install</b>.</li><br />
</ol>
<h3>For NetBeans IDE 4.1, 5.0, and 5.5</h3>
<ol>
<li>Open Netbeans IDE and connect to the internet.</li><br />
<li>To download and install the Collaboration module,
choose <b>Tools &gt; Update Center</b> from the menu.
The Update Center window opens.</li><br />
<li>In the Update Center, make sure the box next to NetBeans Update Center is checked,
and click the <b>Next</b> button to access the Update Center. </li><br />
<li>After a few moments, the list of available modules will come up.
Select the item <b>Developer Collaboration</b> from the list
and click the <b>Add</b> button to add all the necessary components.</li><br />
<p class="align-center">
<a href="../../images_www/articles/collab/collab-7c50d91f.gif">
<img src="../../images_www/articles/collab/collab-7c50d91f.gif" class="b-none"></a>
<br /><b>Install Collaboration using the Update Center in NetBeans IDE 5.0 (Click to enlarge)</b></p>
<li>Press the <b>Next</b> button. The Update Wizard will ask
you to accept the necessary licenses. Read them and click <b>Agree</b> to
start downloading the Collaboration Module.</li><br />
<li>After the download is done, press the <b>Next</b> button.
The Update Wizard shows you an overview of the new module to be installed.
Press the <b>Finish</b> button to complete the installation.</li><br />
<li>If the Update Wizard asks you to restart the IDE,
click <b>Restart the IDE</b> to load the new module.
From version 5.0 beta 2 on restarting is no longer necessary.</li><br />
</ol>
<h3>The Collaboration Menu and Toolbar</h3>
<p>After the module has finished loading, you will be able to see the
Collaboration toolbar and the Collaboration menu in your IDE. Congratulations!</li><br />
<p class="align-center"><img src="../../images_www/articles/collab/collab-m2c8c959f.gif"
height="122" width="356"><br />
<b>Successful installation: The Collaboration Toolbar and menu are now visible</b>
</p>
<h2><a name="register"></a>Register to a Collaboration Server</h2>
<p>You need a <b>Collaboration account</b> before you can use the Collaboration feature.
If you do not have a Collaboration account yet,
follow these instructions to create one. It's free!</p>
<ol>
<li>To create a new Collaboration account,
choose <b>Collaboration &gt; Login</b> from the IDE's menu.
A new docked window will open on the right hand side of the IDE:
The Collaboration window.</li><br />
<p class="align-center"><img src="../../images_www/articles/collab/collab-47b69186.gif"
height="122" width="223">
<br /><b>The Collaboration Window</b></p>
<li>In the Collaboration window, click <b>Manage accounts</b>.
If this is your first account, a Registration Wizard window opens.</li><br />
<li>Check the box next to <b>"I want to register for
a new Collaboration account on share.java.net"</b>;
check the box to <b>Accept the license</b> and press the <b>Next</b> button.
(If you already have an account, check <b>I have an existing account</b>
instead and press <b>Next</b>.
Alternatively, you could also choose to create an account
on a different Collaboration server that you know.)</li><br />
<p class="align-center"><img src="../../images_www/articles/collab/collab-317e27af.gif"
height="335" width="665"><br /><b>The Registration Wizard</b></p>
<li>If your need a proxy to access the internet,
enter your proxy settings now and press <b>Next</b>.</li><br />
<li>
Enter a display name that will identify you on the Collaboration server
and press the <b>Next</b> button. </li><br />
<p class="align-center"><img src="../../images_www/articles/collab/collab-m1cb7239c.gif"><br />
<b>Enter display name</b></p>
<li>On the next page, enter your real name and email address.</li><br />
<p class="align-center"><img src="../../images_www/articles/collab/collab-m5d3c4823.gif"
height="306" width="602"><br><b>Enter real name and email</b></p>
<li>On the next page, provide a user name for your account
-- this is the name that
other users can search for on the Collaboration server to identify you.
Enter the password you want to use twice, and
then click <b>Finish</b> to complete the registration.</li><br />
<p class="align-center"><img src="../../images_www/articles/collab/collab-71156131.gif"
width="600"><br><b>Enter user name</b>
</p>
</ol>
<p>If you'd like to add more than one account, repeat these steps.
Note that when you click <b>Manage accounts</b> for the second time,
you will get an Account Management Window instead of the Wizard.
Click the <b>Add</b> button to access the Wizard and proceed
as described for the first account.
</p>
<h2><a name="connect"></a>Connect to a Collaboration server</h2>
<p>Your Collaboration account is now created.
The Collaboration window now displays a Login panel:
Enter your password and press the <b>Login</b> button to start using Collaboration.
</p>
<p class="align-center"><img src="../../images_www/articles/collab/collab-6d835125.gif"
height="223" width="194"><br><b>Log in to share.java.net</b></p>
<p>After you have logged in, the Collaboration window will show your Display name
and your friends and conversations list.
If this is your first time you log on, the lists will be empty.
</p>
<p class="align-center"><img src="../../images_www/articles/collab/collab-m2188a896.gif"
height="199" width="197"><br /><b>Collaboration window with friends and conversations list</b></p>
<p>In the upper part of the Collaboration window
you see a toolbar with four buttons:
The first button is the <b>Change Status</b> popup menu.
Use it to switch to one of the following status options:
<b>online</b> (green), <b>busy</b> (orange),
<b>away</b> (red) or <b>invisible</b> (gray).</p>
<p>Switch your status to online.
Next we will show you how to contact other users.</p>
<h2><a name="find"></a>Find people and conversations</h2>
<p>Look again at the toolbar in the upper part of the Collaboration window.
The second button is the <b>Add Contacts</b> button.
It lets you search and invite users to your friends list.
</p>
<ol>
<li>To add a user, click the <b>Add Contacts</b> button.
Enter a user name or a real name into the search field,
then click <b>Find</b> to search for an existing user.</li><br />
<li>Wait for the search result to show up and then
select a name from the "Select Users" window.
Click <b>OK</b> to add this user to your friends list. </li><br />
<li>Users can reject or accept invitations.
If they accept, you will from now on be notified
each time the selected users come online.</li><br />
</ol>
<p class="align-center"><img src="../../images_www/articles/collab/collab-m788ef4d4.gif"
height="480" width="448"><br /><b>Search for friends with the Add Contacts window</b></p>
<p>
The third toolbar button is the <b>Subscribe to Public Conversation</b> button.
It lets you search and join conversations.
There are a couple of public conversation on share.java.net
that you can join freely,
for instance <tt>netbeans</tt> and <tt>netbeans-platform</tt>.
</p>
<ol>
<li>To find a conversation, click the <b>Subscribe to Public Conversation</b>
button and enter a search keyword, then click <b>Find</b> to start the search. </li><br />
<li>Wait for the search result to show up and
select a conversation form the Select Conversation window. </li><br />
<li>Click <b>OK</b> to add the conversation to your Conversation list.
</ol><br />
<p class="align-center"><img src="../../images_www/articles/collab/collab-6c62a0eb.gif"
height="384" width="420"><br /><b>Search for conversations.</b></p>
<h2><a name="join"></a>Start or join a conversation</h2>
<p>Conversations can be public or private.
There are four ways to start a conversation:</p>
<ul>
<li>The IDE will notify you as soon as a user on your friends comes online
and available users will be marked with green dots.
Double-click any user you want to chat with,
and a new Conversation window will open in the IDE,
inviting the other party to talk to you.
The new conversation will appear in your Conversations list.
</li><br />
<li>
To join an existing conversation,
similarly double-click its node in the conversation list,
and a conversation window will open in the IDE.
</li><br />
<li>Take another look at the Collaboration Toolbar:
The fourth button is the <b>Start Conversation</b> button.
It lets you initiate a private
conversation and then invite people to it.</br>
To start a private conversation, select your display name
and then click the <b>Start Conversation</b> button.
(Note that the <b>Start Conversation</b> button is disabled
as long as any of the items
in your friends or conversations list is selected.)
</li><br />
<li>Alternatively, you can create
public conversations by right-clicking the Conversations node
and choosing <b>Create Public Conversation</b> from the context menu.
Public conversations are visible to all users
and everybody can join them.
You can grant either read or read/write access to users
who join your conversation.</li><br />
</ul>
<p class="align-center"><img src="../../images_www/articles/collab/collab1.jpg"
height="449" width="435"><br /><b>Invite other users</b></p>
<p>
Anytime after a new conversation window opens in the IDE,
you may inspect the list of participants
on the left side of the Collaboration window.
Click the <b>Invite</b> button
at the bottom left to prompt other users to join your conversation.
You can tell whether a user is already
on your friends list by a green dot next to his name.
</p>
<p>To share Java projects, drag and drop them with the mouse from the IDE's Projects
window to the shared area labeled <b>Drag files and projects here to share them</b>.
They are now fully visible and editable for your partners.</p>
<p class="align-center"><img src="../../images_www/articles/collab/collab-635ea219.jpg"
height="264" width="543"><br /><b>Discuss your Java code in a Collaboration conversation</b></p>
<h2><a name="logout">Log Out and Log Back In</h2>
<p>To quit a conversation, right-click the conversation and choose <b>Leave</b>
from the context menu, or click the closebox next to the conversation's title.
To log out from Collaboration, choose <b>Collaborate &gt; End All Sessions</b>
from the main menu.</p>
<p>
To log back in, choose <b>Collaborate &gt; Login</b>;
enter your account information, and click the <b>Login</b> button
to open the Collaboration window again.
</p>
<h2><a name="openfire">Optional: Set Up Your Own Collaboration Server</a></h2>
<p>If your firewall configuration does not allow you to use
a public external collaboration server like share.java.net,
e.g. because your company requires source code to remain protected,
you can set up your own internal server.
<p>On an internal host, install a collaboration server
that supports the XMPP (Jabber) protocol, for instance the free
<a href="http://www.igniterealtime.org/downloads/index.jsp#openfire">OpenFire</a> server.
(Tip: After installation, you will find the OperFire admin console by pointing your browser
to <tt>http://localhost:9090</tt>). Follow the previous instruction in this tutorial and
log in with your username to your custom hostname instead of share.java.net.
</p>
<h2>Next Steps</h2>
<ul>
<li>Hit F1 in a Collaboration window to get more help on this topic.</li>
<li>Watch a
<a href="https://netbeans.org/projects/obsolete/servlets/ProjectDocumentDownload?documentID=522">Flash Demo</a>
of what you can do with Collaboration.</li>
<li>Petr Nejedly's wiki article
<a href="http://wiki.netbeans.org/wiki/view/CollabServer">How to Set Up a
Private Server for NetBeans Developer Collaboration</a>.</li>
<li><a href="http://en.wikipedia.org/wiki/Pair_programming">Pair Programming</a></li>
<li><a href="https://netbeans.org/projects/obsolete/">Join the Collaboration project</a>
and create new Collablets.</li>
<li>Subscribe to the
<a href="https://netbeans.org/projects/obsolete/docs/mailing-lists.html">Collaboration Developer and User Mailing lists</a>.
</li>
</ul>
</body></html>