installation-instructions.php - gerrit/www.eclipse.org/subversive - Git at Google

 <?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";

 	$sidebar = file_get_contents($_SERVER['DOCUMENT_ROOT'] . "/subversive/sidebars/download.php");

 	// 	# Paste your HTML content between the EOHTML markers!
 $html = <<<EOHTML

 	<div id="midcolumn">
 		<h1>Installation Instructions</h1>
 		<p>
 			Here you can find instructions on how to install Subversive using different types of Subversive distributions.
 		</p>
 		<h2>Introduction</h2>
 		<p>
 			The Subversive installation consists of installing the Subversive plug-in and Subversive SVN Connectors. The Subversive plug-in is developed as an Eclipse official project with an EPL license and is distributed from the Eclipse website. Subversive SVN Connectors are SVN libraries used by Subversive to communicate with SVN repositories. Those libraries are developed as open-source projects, but since their licenses are not EPL-compatible, they have to be distributed from an external website.
 		</p>
 		<p>
 			In order use Subversive, you have to install the Subversive plug-in and at least one Subversive SVN Connector that is compatible with your OS and the used SVN version. The Subversive plug-in includes references to available Subversive SVN Connectors, so after installing the Subversive plug-in, you are automatically prompted to install one or multiple connectors.
 		</p>
 		<iframe width="560" height="315" src="https://www.youtube.com/embed/04L4rkykWZw" frameborder="0" allowfullscreen></iframe>
 		<a name="phase1"></a>
 		<h2>Phase 1 - Installation of the Subversive Plug-In</h2>
 		<p>
 			Below you can find the instructions on how to install the 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 if you wish to install a stable Subversive version that is an integral part of the yearly Eclipse Simultaneous Release. It allows you to install the 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 dialog that appears, select a 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 a few seconds until the content of the selected update site is displayed under the combo-box.</li>
 			<li>Expand the <b>Collaboration</b> group and select the Subversive features that you would like to install. Certain Subversive features are required if you want to work with SVN, others are optional and offer some additional functionality. You can skip the optional features, if you wish.</li>
 			<li>Follow the next steps to install the selected Subversive features using the standard plug-in installation procedure. Reboot Eclipse after installation is complete.</li>
 			<li><a href="#phase2">Follow the 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 the 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 <b>Install</b> dialog that appears, press the <b>Add...</b> button and specify the path to an online or archived Subversive update site. You can find information about the available Subversive update sites on the <a href="/subversive/downloads.php">Downloads</a> page.</li>
 			<li>Select the required Subversive features to install and follow the standard plug-in installation procedure. Reboot Eclipse after installation is complete.</li>
 			<li><a href="#phase2">Follow the 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 is complete.</li>
 			<li><a href="#phase2">Follow the instructions below to install Subversive connectors</a>.</li>
 		</ul>
 		<a name="phase2"></a>
 		<h2>Phase 2 - Installation of Subversive SVN Connectors</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 the win32 version of Eclipse (x86 versions of Eclipse and Java running on Windows), you can install a JavaHL connector and its binaries (they're compatible with this platform only), and/or a SVNKit connector. For all other platforms (MacOS, Linux, etc.), you should install a platform-independent pure-Java SVNKit connector, or additionally install a package that contains JavaHL binaries for the target platform.</li>
 			<li>Check your SVN server version. Subversive SVN Connectors include certain 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 are compatible with your SVN server. Follow the standard SVN client-server compatibility notes to select the right connector.</li>
 		</ul>
 		<p>
 			If you've installed JavaHL connector on a non-Win32 platform or if you want to use a different set of JavaHL binaries, you should do the following:
 		</p>
 		<ul>
 			<li>Install a package, that contains JavaHL binaries for the target platform.</li>
 			<li>Ensure that all the libraries from the package are put into the folder listed in the PATH or LD_LIBRARY_PATH variables (on Windows or Unix platforms correspondingly).</li>
 			<li>Before starting Eclipse IDE, define <b>subversion.native.library</b> property. For example: -Dsubversion.native.library=C:/SlikSVN_JavaHL/libsvnjavahl-1.dll</li>
 		</ul>
 		<p>
 			If you wish, you can select multiple connectors and follow the installation procedure. After installation, you can switch the 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);
 ?>
	<?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";

	$sidebar = file_get_contents($_SERVER['DOCUMENT_ROOT'] . "/subversive/sidebars/download.php");

	// # Paste your HTML content between the EOHTML markers!
	$html = <<<EOHTML

	<div id="midcolumn">
	<h1>Installation Instructions</h1>
	<p>
	Here you can find instructions on how to install Subversive using different types of Subversive distributions.
	</p>
	<h2>Introduction</h2>
	<p>
	The Subversive installation consists of installing the Subversive plug-in and Subversive SVN Connectors. The Subversive plug-in is developed as an Eclipse official project with an EPL license and is distributed from the Eclipse website. Subversive SVN Connectors are SVN libraries used by Subversive to communicate with SVN repositories. Those libraries are developed as open-source projects, but since their licenses are not EPL-compatible, they have to be distributed from an external website.
	</p>
	<p>
	In order use Subversive, you have to install the Subversive plug-in and at least one Subversive SVN Connector that is compatible with your OS and the used SVN version. The Subversive plug-in includes references to available Subversive SVN Connectors, so after installing the Subversive plug-in, you are automatically prompted to install one or multiple connectors.
	</p>
	<iframe width="560" height="315" src="https://www.youtube.com/embed/04L4rkykWZw" frameborder="0" allowfullscreen></iframe>
	<a name="phase1"></a>
	<h2>Phase 1 - Installation of the Subversive Plug-In</h2>
	<p>
	Below you can find the instructions on how to install the 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 if you wish to install a stable Subversive version that is an integral part of the yearly Eclipse Simultaneous Release. It allows you to install the Subversive plug-in using an Eclipse update site for an Eclipse Simultaneous Release.
	</p>
	<ul>
	<li>Run Eclipse and select <b>Help</b> > <b>Install New Software...</b> from the main menu.</li>
	<li>On the dialog that appears, select a 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 a few seconds until the content of the selected update site is displayed under the combo-box.</li>
	<li>Expand the <b>Collaboration</b> group and select the Subversive features that you would like to install. Certain Subversive features are required if you want to work with SVN, others are optional and offer some additional functionality. You can skip the optional features, if you wish.</li>
	<li>Follow the next steps to install the selected Subversive features using the standard plug-in installation procedure. Reboot Eclipse after installation is complete.</li>
	<li><a href="#phase2">Follow the 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 the Eclipse Simultaneous Releases.
	</p>
	<ul>
	<li>Run Eclipse and select <b>Help</b> > <b>Install New Software...</b> from the main menu.</li>
	<li>In the <b>Install</b> dialog that appears, press the <b>Add...</b> button and specify the path to an online or archived Subversive update site. You can find information about the available Subversive update sites on the <a href="/subversive/downloads.php">Downloads</a> page.</li>
	<li>Select the required Subversive features to install and follow the standard plug-in installation procedure. Reboot Eclipse after installation is complete.</li>
	<li><a href="#phase2">Follow the 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 is complete.</li>
	<li><a href="#phase2">Follow the instructions below to install Subversive connectors</a>.</li>
	</ul>
	<a name="phase2"></a>
	<h2>Phase 2 - Installation of Subversive SVN Connectors</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 the win32 version of Eclipse (x86 versions of Eclipse and Java running on Windows), you can install a JavaHL connector and its binaries (they're compatible with this platform only), and/or a SVNKit connector. For all other platforms (MacOS, Linux, etc.), you should install a platform-independent pure-Java SVNKit connector, or additionally install a package that contains JavaHL binaries for the target platform.</li>
	<li>Check your SVN server version. Subversive SVN Connectors include certain 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 are compatible with your SVN server. Follow the standard SVN client-server compatibility notes to select the right connector.</li>
	</ul>
	<p>
	If you've installed JavaHL connector on a non-Win32 platform or if you want to use a different set of JavaHL binaries, you should do the following:
	</p>
	<ul>
	<li>Install a package, that contains JavaHL binaries for the target platform.</li>
	<li>Ensure that all the libraries from the package are put into the folder listed in the PATH or LD_LIBRARY_PATH variables (on Windows or Unix platforms correspondingly).</li>
	<li>Before starting Eclipse IDE, define <b>subversion.native.library</b> property. For example: -Dsubversion.native.library=C:/SlikSVN_JavaHL/libsvnjavahl-1.dll</li>
	</ul>
	<p>
	If you wish, you can select multiple connectors and follow the installation procedure. After installation, you can switch the connector using the main menu item <b>Window</b> > <b>Preferences</b> > <b>Team</b> (tree node) > <b>SVN</b> (tree node) > <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);
	?>