blob: 4ff0247a8a863b90f5b6c1852ea4daae9fb7ac8e [file] [log] [blame]
<?php
set_include_path($_SERVER['DOCUMENT_ROOT'] . "/eclipse.org-common" . PATH_SEPARATOR . $_SERVER['DOCUMENT_ROOT'] . "/projects" . PATH_SEPARATOR . get_include_path());
require_once($_SERVER['DOCUMENT_ROOT'] . "/eclipse.org-common/system/app.class.php");
require_once($_SERVER['DOCUMENT_ROOT'] . "/eclipse.org-common/system/nav.class.php");
require_once($_SERVER['DOCUMENT_ROOT'] . "/eclipse.org-common/system/menu.class.php");
$App = new App();
$Nav = new Nav();
$Menu = new Menu();
include($App->getProjectCommon());
$localVersion = false;
# Define these here, or in _projectCommon.php for site-wide values
$pageTitle = "Installation Instructions - Eclipse Subversive";
$pageKeywords = "subversive, installation, svn, subversion";
$pageAuthor = "Igor Vinnykov";
// # Paste your HTML content between the EOHTML markers!
$html = <<<EOHTML
<div id="midcolumn">
<h1>Installation Instructions</h1>
<p>
Here you can find instructions about Subversive installation using different types of Subversive distributions.
</p>
<h2>Introduction</h2>
<p>
Subversive installation consists of Subversive plug-in and Subversive SVN Connectors. Subversive plug-in is developed as an Eclipse official project with EPL license and is distributed from Eclipse website. Subversive SVN Connectors are SVN libraries used by Subversive to communicate with SVN repositories. These libraries are developed as open-source projects, but they have EPL-incompatible licenses, so they have to be distributed from an external website.
</p>
<p>
In order use Subversive, you have to install Subversive plug-in and at least one Subversive SVN Connector that is compatible with your OS and used SVN version. Subversive plug-in includes references to available Subversive SVN Connectors, so after Subversive plug-in installation you are automatically prompted to install one or multiple connectors.
</p>
<a name="phase1"></a>
<h2>Phase 1 - Subversive Plug-In Installation</h2>
<p>
Below you can find instructions how to install Subversive plug-in using different types of Subversive distributions.
</p>
<h4>Option 1 - Use an Eclipse Simultaneous Release Update Site</h4>
<p>
This method is recommended to use if you like to install a stable Subversive version, that is an integral part of a yearly Eclipse Simultaneous Release. It allows you to install Subversive plug-in using an Eclipse update site for an Eclipse simultaneous release.
</p>
<ul>
<li>Run Eclipse and select <b>Help</b> &gt; <b>Install New Software...</b> from the main menu.</li>
<li>On the appeared dialog select pre-configured simultaneous release update site in the <b>Work with</b> combo-box. For example, for the Juno release select the "Juno - http://download.eclipse.org/releases/juno" update site.</li>
<li>Wait few seconds until the content of the selected update site will be displayed under the combo-box.</li>
<li>Expand the <b>Collaboration</b> group and select Subversive features that you like to install. Some Subversive features are required if you like to work with SVN, other are optional and offer the additional functionality. You can skip optional features, if you like.</li>
<li>Follow the next steps to install the selected Subversive features using the standard plug-in installation procedure. Reboot Eclipse after installation.</li>
<li><a href="#phase2">Follow instructions below to install Subversive connectors</a>.</li>
</ul>
<h4>Option 2 - Use a Subversive Update Site</h4>
<p>
You can install Subversive using its online or archived update site. Use this method to install the Early Access Build that isn't available in Eclipse Simultaneous Releases.
</p>
<ul>
<li>Run Eclipse and select <b>Help</b> &gt; <b>Install New Software...</b> from the main menu.</li>
<li>In the appeared <b>Install</b> dialog press the <b>Add...</b> button and specify a path to online or archived Subversive update site. You can find information about available Subversive update sites on the <a href="/subversive/downloads.php">Downloads</a> page.</li>
<li>Select required Subversive features to install and follow the standard plug-in installation procedure. Reboot Eclipse after installation.</li>
<li><a href="#phase2">Follow instructions below to install Subversive connectors</a>.</li>
</ul>
<h4>Option 3 - Use Eclipse Marketplace Client</h4>
<p>
If you have Eclipse Marketplace Client installed, you can use it to install the latest stable release of Subversive.
</p>
<ul>
<li>Open Eclipse Marketplace Client and search for the Subversive project.</li>
<li>Click on the Install button next to the Subversive listing.</li>
<li>Select required Subversive features to install and follow the standard plug-in installation procedure. Reboot Eclipse after installation.</li>
<li><a href="#phase2">Follow instructions below to install Subversive connectors</a>.</li>
</ul>
<a name="phase2"></a>
<h2>Phase 2 - Subversive SVN Connectors Installation</h2>
<p>
Once the Subversive plug-in is installed and Eclipse is rebooted, Subversive automatically displays the dialog that shows Subversive SVN Connectors, compatible with the installed version of the plug-in. Alternatively you can install Subversive SVN Connectors from online and archived update sites for connectors. Visit <a href="http://www.polarion.com/products/svn/subversive/download.php?utm_source=eclipse.org&utm_medium=link&utm_campaign=subversive">Polarion.com</a> to get information about the available update sites.
</p>
<p>
You have to install at least one connector that is compatible with your OS and SVN server. To select the right connector follow these recommendations:
</p>
<ul>
<li>Check your platform. If you run win32 version of Eclipse (x86 versions of Eclipse and Java running on Windows), you can install <b>JavaHL connector</b>, that is compatible with this platform only and/or install <b>SVNKit connector</b>. For all other platforms (MacOS, Linux, etc.) you have to install platform-independent pure-Java <b>SVNKit connector</b>.</li>
<li>Check your SVN server version. Subversive SVN Connectors includes particular versions of SVN client modules. Usually every type of Subversive SVN Connectors (JavaHL and SVNKit) is available in different versions, so you have to select those that is compatible with your SVN server. Follow the standard SVN client-server compatibility notes to select the right connector.</li>
</ul>
<p>
If you like, you can select multiple connectors and follow steps to install them. After installation you can switch the used connector using the main menu item <b>Window</b> &gt; <b>Preferences</b> &gt; <b>Team</b> (tree node) &gt; <b>SVN</b> (tree node) &gt; <b>SVN Connector</b> (tab).
</p>
</div>
<div id="rightcolumn">
$sidebar
</div>
EOHTML;
# Generate the web page
$App->generatePage($theme, $Menu, $Nav, $pageAuthor, $pageKeywords, $pageTitle, $html);
?>