====== Greenstone Subversion (SVN) Repository ======


The Greenstone source code is kept under version-control in a [[http://subversion.apache.org |subversion]] repository. For information about using SVN see [[en:developer:using_svn|this page]], or the [[http://svnbook.red-bean.com/|subversion book]].

  * Repository Root:  [[https://svn.greenstone.org]]
  * Repository Browser: [[https://trac.greenstone.org/browser]]

===== Repository Structure =====

The basic structure of the repository is

**https://svn.greenstone.org/**
  * **deprecated**     Some code that is no longer used
  * **documentation**  Legacy manuals and tutorial source
  * **documented-examples**    Source for the greenstone 2 documented example collections
  * **gs2-extensions**     A collection of extensions to enhance the functionality of Greenstone 2, such as pdf-box, imagemagick, gnome-lib etc
  * **gs3-extensions**     A collection of extensions to enhance the functionality of Greenstone 3, such as solr, pharos image search, MAT (metadata analysis tool) etc
  * **local**   A handy set of setup script files for Greenstone 2 and 3 on different operating systems.
  * **main**    The main source code area
  * **other-projects**    Other related projects that are not part of Greenstone
  * **test-collections**    Some collections that we use for testing Greenstone

The ''main'' area is where the core source code lives. It is made up of ''branches'', ''tags'' and ''trunk''. The trunk is the main line of development of the source code. Tags are used to mark the repository at each release point. Branches are used to develop features on the sideline without disrupting the main trunk.

The important projects inside main are:

https://svn.greenstone.org/main/trunk/
  * **gli**
  * **greenstone2**
  * **greenstone3**
  * **gs2build**

gs2build is a package of greenstone 2 collection building code that is used by the greenstone 3 software.


===== Greenstone checkout =====

<tabbox Greenstone3>
To checkout the Greenstone 3 source code from our server do the following:

<code>svn co https://svn.greenstone.org/main/trunk/greenstone3 greenstone3</code>

Then from the greenstone3 folder, run 

<code>ant prepare</code>
This will checkout gli, gs2build and download any additional files it needs.

<code>ant install</code>
compiles and installs the code.

Once you have the code you may update it at any time by changing to the greenstone3 directory and running:

<code>ant svnupdate</code>  will update all the code through svn, or
<code>ant update</code>  will update, clean then recompile and install.


Please see our [[Compiling_Greenstone3 | compiling page]] for notes about compiling Greenstone.
<tabbox Greenstone2>

To checkout the Greenstone 2 source code from our server do the following:

<code>svn co https://svn.greenstone.org/main/trunk/greenstone2 greenstone2</code>

To checkout the Greenstone Librarian Interface source code, change to the greenstone2 directory and do the following:

<code>svn co https://svn.greenstone.org/main/trunk/gli gli</code>

Once you have the code you may update it at any time by changing to the greenstone2 directory and typing:

<code>svn update</code>
<code>svn update gli</code>


Please see our [[Compiling_Greenstone2 | compiling page]] for notes about compiling Greenstone.
</tabbox>

===== Notes =====

====Line Endings====

All of the line endings in the repository files are linux-style (\n) line endings. We ask that you do not check in files which do not conform to this standard. Therefore, we recommend finding a suitable editor for your platform, which uses this style of line ending.