<commit_before><?xml version="1.0" encoding="UTF-8"?>
<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbookxi.rng" type="xml"?>
<!-- $Id$ -->
<book>
    <bookinfo>
        <graphic fileref="logo.jpg"/>
        
        <productname>Open Source Native XML Database</productname>
        <title>Eclipse setup</title>
        <date>August 2009</date>
        <author>
            <firstname>Loren</firstname>
            <surname>Cahlander</surname>
            <affiliation>
                <address format="linespecific">
                    <email>loren at syntactica.com</email>
                </address>
            </affiliation>
        </author>
    </bookinfo>
	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sidebar.xml"/>
    <chapter>
        <title>Eclipse setup</title>
        <section>
        <title>Overview</title>
        <para>This article demonstrates how to set up eclipse for developing eXist. It shows you how
            to check out the source from the Subversion repository, how to compile eXist and how to
            setup the debug configuration.</para>
    </section>
    <section>
        <title>Eclipse Setup</title>
        <para>Download and install Java 1.5 or 1.6</para>
        <para>Download and install eclipse</para>
        <para>Launch eclipse and add the Subclipse plug-ins</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse.png"/>
        </screenshot>
        <para>Install the subclipse plug-in for eclipse.</para>
        <para>Select Help-&gt;Software Updates...</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_software_update.png"/>
        </screenshot>
        <para>Click on Add Site...</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_add_site.png"/>
        </screenshot>
        <para>Enter: http://subclipse.tigris.org/update_1.4.x</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_add_subclipse.png"/>
        </screenshot>
        <para>Select all of the entries under http://subclipse.tigris.org/update_1.4.x</para>
        <para>Click on Install...</para>
    </section>
    <section>
        <title>Checkout eXist 1.3 from the SVN repository.</title>
        <para>Open the SVN Repository Exploring perspective.</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_perspective.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_svn_perspective.png"/>
        </screenshot>
        <para>Select Add SVN Repository</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_svn_action.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_add_svn_repository.png"/>
        </screenshot>
        <para>Enter https://exist.svn.sourceforge.net/svnroot/exist/trunk</para>
        <para>Click on Finish</para>
        <para>The repository will show up in the SVN Repositiries window.</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_exist_svn_repository.png"/>
        </screenshot>
        <para>Expand the view of the repository.</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_svn_exist_project.png"/>
        </screenshot>
        <para>Right click on the eXist project and select Checkout....</para>
        <screenshot>
            <graphic fileref="resources/eclipse/CheckOutAs.png"/>
        </screenshot>
        <para>Click on Finish</para>
    </section>
    <section>
        <title>Building eXist</title>
        <para>Adding the activation.jar file to the build path. This is necessary in order to be
            able to run the eclipse debugger on the eXist codebase.</para>
        <para>Right-click on the exist project and select Properties.</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_prjprop_build_path.png"/>
        </screenshot>
        <para>Select the Libraries tab.</para>
        <para>Click on Add Jars...</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_add_activation_jar.png"/>
        </screenshot>
        <para>Select /lib/user/activation-1.1.1.jar</para>
        <para>Click on OK.</para>
        <para>Close eclipse.</para>
        <para>Compiling exist from the command line within the exist-dev1.3 folder.</para>
        <para>Copy extensions/build.properties to extensions/local.build.properties. In extensions/local.build.properties, change all of the entries from false to true:</para>
        <para>Run:</para>
        <para>./build.sh clean</para>
        <para>./build.sh download-additional-jars</para>
        <para>./build.sh</para>
        <para>Restart eclipse.</para>
        <para>Refresh the project.</para>
    </section>
    <section>
        <title>Debug Configuration</title>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_main.png"/>
        </screenshot>
        <para>Select Java Application and click on New.</para>
        <para>Title it eXist Jetty run.</para>
        <para>Click on Browse... and select the eXist-1.3dev project.</para>
        <para>Enter org.exist.start.Main as the Main class.</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_arguments.png"/>
        </screenshot>
        <para>Select the Arguments tab.</para>
        <para>Enter jetty in the Program arguments field.</para>
        <para>If you wish to run Jetty on another port other than the default of 8080, then enter
            -Djetty.port={port number} in the VM arguments field.</para>
        <table>
            <title>Here is a list program arguments that can be used and their descriptions.</title>
            <tgroup cols="2">
                <colspec colnum="1" colname="col1" colwidth="2*"/>
                <colspec colnum="2" colname="col2" colwidth="3.5*"/>
                <thead>
                    <row>
                        <entry>Entry</entry>
                        <entry>Description</entry>
                    </row>
                </thead>
                <tbody>
                    <row>
                        <entry>jetty</entry>
                        <entry>Start eXist running within jetty</entry>
                    </row>
                </tbody>
            </tgroup>
        </table>
        <table>
            <title>Here is a list VM arguments that can be used and their descriptions.</title>
            <tgroup cols="2">
                <colspec colnum="1" colname="col1" colwidth="2*"/>
                <colspec colnum="2" colname="col2" colwidth="3.5*"/>
                <thead>
                    <row>
                        <entry>Entry</entry>
                        <entry>Description</entry>
                    </row>
                </thead>
                <tbody>
                    <row>
                        <entry>-Djetty.port={port number}</entry>
                        <entry>Start jetty on a port number other than 8080</entry>
                    </row>
                </tbody>
            </tgroup>
        </table>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_jre.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_classpath.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_source.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_environment.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_common.png"/>
        </screenshot>
    </section>
    <section>
        <title>Conclusion</title>
        <para>Your environment is now set up.</para>
    </section>
    </chapter>
</book>
<commit_msg>[ignore] adding sobversion macro for date<commit_after><?xml version="1.0" encoding="UTF-8"?>
<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbookxi.rng" type="xml"?>
<!-- $Id$ -->
<book>
    <bookinfo>
        <graphic fileref="logo.jpg"/>
        
        <productname>Open Source Native XML Database</productname>
        <title>Eclipse setup</title>
        <date>$Date$</date>
        <author>
            <firstname>Loren</firstname>
            <surname>Cahlander</surname>
            <affiliation>
                <address format="linespecific">
                    <email>loren at syntactica.com</email>
                </address>
            </affiliation>
        </author>
    </bookinfo>
	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sidebar.xml"/>
    <chapter>
        <title>Eclipse setup</title>
        <section>
        <title>Overview</title>
        <para>This article demonstrates how to set up eclipse for developing eXist. It shows you how
            to check out the source from the Subversion repository, how to compile eXist and how to
            setup the debug configuration.</para>
    </section>
    <section>
        <title>Eclipse Setup</title>
        <para>Download and install Java 1.5 or 1.6</para>
        <para>Download and install eclipse</para>
        <para>Launch eclipse and add the Subclipse plug-ins</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse.png"/>
        </screenshot>
        <para>Install the subclipse plug-in for eclipse.</para>
        <para>Select Help-&gt;Software Updates...</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_software_update.png"/>
        </screenshot>
        <para>Click on Add Site...</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_add_site.png"/>
        </screenshot>
        <para>Enter: http://subclipse.tigris.org/update_1.4.x</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_add_subclipse.png"/>
        </screenshot>
        <para>Select all of the entries under http://subclipse.tigris.org/update_1.4.x</para>
        <para>Click on Install...</para>
    </section>
    <section>
        <title>Checkout eXist 1.3 from the SVN repository.</title>
        <para>Open the SVN Repository Exploring perspective.</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_perspective.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_svn_perspective.png"/>
        </screenshot>
        <para>Select Add SVN Repository</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_svn_action.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_add_svn_repository.png"/>
        </screenshot>
        <para>Enter https://exist.svn.sourceforge.net/svnroot/exist/trunk</para>
        <para>Click on Finish</para>
        <para>The repository will show up in the SVN Repositiries window.</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_exist_svn_repository.png"/>
        </screenshot>
        <para>Expand the view of the repository.</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_svn_exist_project.png"/>
        </screenshot>
        <para>Right click on the eXist project and select Checkout....</para>
        <screenshot>
            <graphic fileref="resources/eclipse/CheckOutAs.png"/>
        </screenshot>
        <para>Click on Finish</para>
    </section>
    <section>
        <title>Building eXist</title>
        <para>Adding the activation.jar file to the build path. This is necessary in order to be
            able to run the eclipse debugger on the eXist codebase.</para>
        <para>Right-click on the exist project and select Properties.</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_prjprop_build_path.png"/>
        </screenshot>
        <para>Select the Libraries tab.</para>
        <para>Click on Add Jars...</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_add_activation_jar.png"/>
        </screenshot>
        <para>Select /lib/user/activation-1.1.1.jar</para>
        <para>Click on OK.</para>
        <para>Close eclipse.</para>
        <para>Compiling exist from the command line within the exist-dev1.3 folder.</para>
        <para>Copy extensions/build.properties to extensions/local.build.properties. In extensions/local.build.properties, change all of the entries from false to true:</para>
        <para>Run:</para>
        <para>./build.sh clean</para>
        <para>./build.sh download-additional-jars</para>
        <para>./build.sh</para>
        <para>Restart eclipse.</para>
        <para>Refresh the project.</para>
    </section>
    <section>
        <title>Debug Configuration</title>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_main.png"/>
        </screenshot>
        <para>Select Java Application and click on New.</para>
        <para>Title it eXist Jetty run.</para>
        <para>Click on Browse... and select the eXist-1.3dev project.</para>
        <para>Enter org.exist.start.Main as the Main class.</para>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_arguments.png"/>
        </screenshot>
        <para>Select the Arguments tab.</para>
        <para>Enter jetty in the Program arguments field.</para>
        <para>If you wish to run Jetty on another port other than the default of 8080, then enter
            -Djetty.port={port number} in the VM arguments field.</para>
        <table>
            <title>Here is a list program arguments that can be used and their descriptions.</title>
            <tgroup cols="2">
                <colspec colnum="1" colname="col1" colwidth="2*"/>
                <colspec colnum="2" colname="col2" colwidth="3.5*"/>
                <thead>
                    <row>
                        <entry>Entry</entry>
                        <entry>Description</entry>
                    </row>
                </thead>
                <tbody>
                    <row>
                        <entry>jetty</entry>
                        <entry>Start eXist running within jetty</entry>
                    </row>
                </tbody>
            </tgroup>
        </table>
        <table>
            <title>Here is a list VM arguments that can be used and their descriptions.</title>
            <tgroup cols="2">
                <colspec colnum="1" colname="col1" colwidth="2*"/>
                <colspec colnum="2" colname="col2" colwidth="3.5*"/>
                <thead>
                    <row>
                        <entry>Entry</entry>
                        <entry>Description</entry>
                    </row>
                </thead>
                <tbody>
                    <row>
                        <entry>-Djetty.port={port number}</entry>
                        <entry>Start jetty on a port number other than 8080</entry>
                    </row>
                </tbody>
            </tgroup>
        </table>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_jre.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_classpath.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_source.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_environment.png"/>
        </screenshot>
        <screenshot>
            <graphic fileref="resources/eclipse/eclipse_debug_config_common.png"/>
        </screenshot>
    </section>
    <section>
        <title>Conclusion</title>
        <para>Your environment is now set up.</para>
    </section>
    </chapter>
</book>

{'fraction_non_alphanumeric': 0.122469196953749, 'fraction_numerical': 0.006563061110767135, 'mean_word_length': 1.974037930399558, 'pattern_counts': {'":': 0, '<': 493, '<?xml version=': 2, '>': 493, 'https://': 2, 'lorem ipsum': 0, 'www.': 4, 'xml': 10}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6393939', 'n_tokens_mistral': 4741, 'n_tokens_neox': 4541, 'n_words': 1022}