| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "https://www.w3.org/TR/html4/loose.dtd"> |
| |
| |
| <!-- ====================================================================== --> |
| <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! --> |
| <!-- ====================================================================== --> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> |
| <style type="text/css">@import "stylesheets/base.css";</style> |
| <meta name="author" value=" |
| Apache UIMA Documentation Team"> |
| <meta name="email" value="dev@uima.apache.org"> |
| |
| |
| |
| <title>Apache UIMA - One time setup</title> |
| |
| <!-- Begin Cookie Consent plugin by Silktide - https://silktide.com/cookieconsent --> |
| <!-- Commented out because implied consent is not compatible with GDPR --> |
| <!-- |
| <script type="text/javascript"> |
| window.cookieconsent_options = {"message":"This website uses cookies to ensure you get the best experience on our website","dismiss":"Got it!","learnMore":"More info","link":"https://uima.apache.org/privacy-policy.html","theme":"dark-bottom"}; |
| </script> |
| |
| <script type="text/javascript" src="/cookieconsent2/cookieconsent.min.js"></script> |
| --> |
| <!-- End Cookie Consent plugin --> |
| |
| <!-- Begin Google Analytics --> |
| <!-- Commented out because GA requires consent according to GDPR --> |
| <!-- |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-70846351-1', 'auto'); |
| ga('set', 'anonymizeIp', true); |
| ga('send', 'pageview'); |
| |
| </script> |
| --> |
| <!-- End Google Analytics --> |
| </head> |
| |
| <body> |
| <div class="topLogos"> |
| <table border="0" width="100%" cellspacing="0"> |
| <!-- TOP IMAGE --> |
| <tr> |
| <td align='LEFT'> |
| <a href="index.html"> |
| <img style="border: 1px solid black;" src="./images/UIMA_banner2tlpTm.png" alt="UIMA project logo" border="0"/> |
| </a> |
| </td> |
| <td align='CENTER'> |
| <div class="pageBanner">One time setup</div> |
| </td> |
| <td align='RIGHT'> |
| <a href="https://www.apache.org"> |
| <img src="./images/asf-logo-on-white-smallTm.png" alt="Apache UIMA" border="0"/> |
| </a> |
| </td> |
| </tr> |
| </table> |
| <hr noshade="" size="1"/> |
| </div> |
| <table border="0" width="100%" cellspacing="4"> |
| <tr> |
| <td align='RIGHT' colspan="2"> |
| <form method="get" action="https://www.google.com/search"> |
| Search the site |
| <input type="text" name="q" size="25" maxlength="255" value="" /> |
| <input type="hidden" name="sitesearch" value="https://uima.apache.org/" /> |
| <input name="Search" value="Search Site" type="submit"/> |
| </form> |
| </td> |
| </tr> |
| <tr> <!-- LEFT SIDE NAVIGATION --> |
| <td width="20%" valign="top"> |
| |
| |
| |
| |
| |
| |
| <!-- regular menu --> |
| <div class="navBar"> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">General</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./index.html">Home</a> |
| </div> |
| <div class="navBarItem"> <a href="./downloads.cgi">Downloads</a> |
| </div> |
| <div class="navBarItem"> <a href="./documentation.html">Documentation</a> |
| </div> |
| <div class="navBarItem"> <a href="./news.html">News</a> |
| </div> |
| <div class="navBarItem"> <a href="./publications.html">Publications</a> |
| </div> |
| <br style="line-height: .5em"/> |
| <div class="navBarItem"> <a href="https://issues.apache.org/jira/browse/uima" target="_blank" rel="noopener">Issue tracker <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/" target="_blank" rel="noopener">Wiki <img src="images/offsitelink.png"/></a> |
| </div> |
| <br style="line-height: .5em"/> |
| <div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/Powered+by+Apache+UIMA" target="_blank" rel="noopener">Powered By UIMA <img src="images/offsitelink.png"/></a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Community</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./get-involved.html">Get Involved</a> |
| </div> |
| <div class="navBarItem"> <a href="./mail-lists.html">Mailing Lists</a> |
| </div> |
| <div class="navBarItem"> <a href="./contribution-policy.html">Contribution Policies</a> |
| </div> |
| <div class="navBarItem"> <a href="./faq.html">FAQ</a> |
| </div> |
| <div class="navBarItem"> <a href="./project-guidelines.html">Project Guidelines</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Scaleout Frameworks</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./doc-uimaas-what.html">UIMA-AS</a> |
| </div> |
| <div class="navBarItem"> <a href="./doc-uimaducc-whatitam.html">UIMA-DUCC</a> |
| </div> |
| <div class="navBarItem"> <a href="./doc-uimaducc-demo.html">..Demo Page</a> |
| </div> |
| <div class="navBarItem"> <a href="http://uima-ducc-demo.apache.org:42133" target="_blank" rel="noopener">..Demo Live <img src="images/offsitelink.png"/></a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Components & Tools</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./sandbox.html#uima-addons-annotators">Annotators</a> |
| </div> |
| <div class="navBarItem"> <a href="./toolsServers.html">Tools & Servers</a> |
| </div> |
| <div class="navBarItem"> <a href="./sandbox.html">Addons and Sandbox</a> |
| </div> |
| <div class="navBarItem"> <a href="./ruta.html">UIMA Ruta</a> |
| </div> |
| <div class="navBarItem"> <a href="./uimafit.html">uimaFIT</a> |
| </div> |
| <div class="navBarItem"> <a href="./external-resources.html">External Resources</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Development</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./dev-quick.html">Quick Start: building</a> |
| </div> |
| <div class="navBarItem"> <a href="./building-uima.html">Building from Source</a> |
| </div> |
| <div class="navBarItem"> <a href="./one-time-setup.html">One-time setups</a> |
| </div> |
| <div class="navBarItem"> <a href="./svn.html">Source Code</a> |
| </div> |
| <div class="navBarItem"> <a href="./release.html">Doing a UIMA release</a> |
| </div> |
| <div class="navBarItem"> <a href="https://www.apache.org/security/committers.html" target="_blank" rel="noopener">Doing a CVE (Apache) <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="./eclipse-update-site.html">Eclipse Update Sites</a> |
| </div> |
| <div class="navBarItem"> <a href="./git.html">GIT</a> |
| </div> |
| <div class="navBarItem"> <a href="./codeConventions.html">Code Conventions</a> |
| </div> |
| <div class="navBarItem"> <a href="./uima-specification.html">UIMA Specification (OASIS)</a> |
| </div> |
| <div class="navBarItem"> <a href="./team-list.html">Project Team</a> |
| </div> |
| <div class="navBarItem"> <a href="./maven-design.html">Maven Use</a> |
| </div> |
| <div class="navBarItem"> <a href="./updating-website.html">Updating this Website</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Events and Conferences</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./coling14.html">COLING 2014</a> |
| </div> |
| <div class="navBarItem"> <a href="./gscl13.html">GSCL 2013</a> |
| </div> |
| <div class="navBarItem"> <a href="./iks09.html">IKS 2009</a> |
| </div> |
| <div class="navBarItem"> <a href="./gscl09.html">GSCL 2009</a> |
| </div> |
| <div class="navBarItem"> <a href="./lsm09.html">LSM 2009</a> |
| </div> |
| <div class="navBarItem"> <a href="./lrec08.html">LREC 2008</a> |
| </div> |
| <div class="navBarItem"> <a href="./gldv07.html">GLDV 2007</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">ASF</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="https://www.apache.org/licenses/" target="_blank" rel="noopener">License <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener">ASF Sponsors <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener">ASF Sponsorship <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="./security_report">Security</a> |
| </div> |
| </div> |
| </div> |
| </td> |
| <td width="80%" align="left" valign="top"> |
| <div class="sectionTable"> |
| <table class="sectionTable"> |
| <tr><td> |
| <a name="One time setup instructions for working with Apache UIMA source code"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> One time setup instructions for working with Apache UIMA source code</h1></a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="sectionBody"> |
| <p> |
| Here you will find information on how to set up various tools used in working with Apache UIMA™ source code, including: |
| <ul> |
| <li>Java - use a 1.5 JVM or later.</li> |
| <li><a href="#svn-setup">SVN</a></li> |
| <li><a href="#maven-setup">Maven</a></li> |
| <li><a href="#eclipse-setup">Eclipse</a></li> |
| </ul> |
| </p> |
| </blockquote> |
| </p> |
| </td></tr> |
| </table> |
| <div class="sectionTable"> |
| <table class="sectionTable" id='svn-setup'> |
| <tr><td> |
| <a name="One time setup for SVN"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> One time setup for SVN</h1></a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="sectionBody"> |
| <p>Install an svn client (not server) to use for command line invocation of SVN from |
| <a class="external" rel="nofollow noopener" target="_blank" href="https://subversion.apache.org/packages.html">https://subversion.apache.org/packages.html</a>. |
| Use the 1.6.x or later version. |
| For Windows platform, you may find it convenient to also install a windows shell extension for this, such |
| as the one from Tigris.org.</p> |
| <p>If you are using an IDE, you should obtain the SVN client for that IDE.</p> |
| <p>See <a href="svn.html">svn.html</a> for further details about accessing the source, |
| including accommodating firewalls.</p> |
| <p class="Note">Important:</p> |
| <p>Configure your SVN client to set the eol-style to native, for newly created files; see |
| <a target="_blank" rel="noopener" href="https://apache.org/dev/svn-eol-style.txt">https://apache.org/dev/svn-eol-style.txt</a> |
| for instructions on how to do this.</p> |
| </blockquote> |
| </p> |
| </td></tr> |
| </table> |
| <div class="sectionTable"> |
| <table class="sectionTable" id='maven-setup'> |
| <tr><td> |
| <a name="One time setup for Maven"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> One time setup for Maven</h1></a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="sectionBody"> |
| <ol><li>Download Maven 3.0 or later from |
| <a class="external" rel="nofollow noopener" target="_blank" href="https://maven.apache.org/download.html">https://maven.apache.org/download.html</a>.</li> |
| <li>Set up your path to use this version.</li> |
| <li>(Optional, but is needed for some JVM/platforms, to give the JVM enough room to build things). |
| Add the following environment variable for Maven: <br /> |
| <pre> Variable name: <code>MAVEN_OPTS</code><br /> |
| Value: <code>-Xmx800m -XX:MaxPermSize=256m</code></pre></li> |
| <!-- no longer needed because |
| snapshot repo now by design is specified when needed; that is, it is in the |
| common subproject parent pom --> |
| <!--li>If you plan to build from "trunk" which contains unreleased as-of-yet artifacts, you'll need |
| to have the build get access to UIMA's build tooling. This can be done in 2 ways: |
| <ol><li>Checkout the build tooling from svn (https://svn.apache.org/repos/asf/uima/build/trunk) and |
| build and install it into your local maven repository. To do the build and install, |
| go into the parent-poms/parent-pom-top directory, and do the "mvn install" command.</li> |
| <li>Change your maven settings.xml file to include the Apache snapshot repository in the set of repositories it |
| searches for artifacts. For general information on maven settings files, |
| see <a class="external" rel="nofollow noopener" target="_blank" rel="noopener" |
| href="https://maven.apache.org/settings.html">https://maven.apache.org/settings.html</a> and |
| <a class="external" rel="nofollow noopener" target="_blank" rel="noopener" |
| href="https://maven.apache.org/ref/3.0/maven-settings/settings.html"> |
| https://maven.apache.org/ref/3.0/maven-settings/settings.html</a>. |
| <p>To follow this approach, create a settings.xml file in the right location (usually ~/.m2/) and |
| add a setting for the repository.apache.org NEXUS snapshot repository. |
| There's an existing settings.xml you can use as a template, in the conf/ directory of the maven install. |
| Here's an example of how that could be done: |
| <pre><code><profile> |
| <id>local-build-configuration</id> |
| <repositories> |
| <repository> |
| <id>apache-nexus-snapshot</id> |
| <url>https://repository.apache.org/content/groups/snapshots-group/</url> |
| </repository> |
| </repositories> |
| <pluginRepositories> |
| <pluginRepository> |
| <id>apache-nexus-snapshot</id> |
| <url>https://repository.apache.org/content/groups/snapshots-group/</url> |
| </pluginRepository> |
| </pluginRepositories> |
| </profile> |
| |
| <activeProfiles> |
| <activeProfile>local-build-configuration</activeProfile> |
| </activeProfiles> |
| </code></pre></p></li></ol></li--> |
| </ol> |
| </blockquote> |
| </p> |
| </td></tr> |
| </table> |
| <div class="sectionTable"> |
| <table class="sectionTable" id='eclipse-setup'> |
| <tr><td> |
| <a name="One time setup for Eclipse"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> One time setup for Eclipse</h1></a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="sectionBody"> |
| <p>Install Eclipse version 3.7.2 or later.</p> |
| <p>Then: |
| <ol> |
| <li><p>Install the SVN support plugin <code>Subclipse</code> from |
| <a class="external" rel="nofollow noopener" target="_blank" href="https://subclipse.tigris.org/">https://subclipse.tigris.org/</a>. |
| Be sure to pick the version for 1.6.x or the 1.8.x SVN client. Either of these work with the Apache SVN, |
| but you cannot mix them - pick one and stick with it for all your SVN access (e.g., Eclipse, commandline, |
| TortiseSVN Windows shell extensions, etc.) |
| </p></li> |
| <li><p>Install m2e (latest recommended version) from the Eclipse update site: |
| <a class="external" rel="nofollow noopener" target="_blank" href="https://www.eclipse.org/m2e/">https://www.eclipse.org/m2e/</a>. |
| </p> </li> |
| <li><p>When checking out UIMA modules, one method known to work (others may be added) is to do the initial |
| check-out using the SVN command "svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk some-local-directory" |
| (This is just an example - you may need to check out different parts, branches, etc., please adjust the command as needed). |
| Then use the Eclipse menu File -> Import -> Import existing Maven projects and navigate to the directory where |
| you checked out the projects. The plugin will analyze what's there, and then offer to import all the projects. |
| You can just go ahead, or select some subset to import into Eclipse. |
| </p> |
| <p>You will likely (the first time) get some messages from m2e about missing connectors - and the offer from m2e to have |
| it search for them - you should permit this and it will then find and download and install (with your permission) |
| the connectors it needs to do the m2e build of the Maven projects.</p></li> |
| <!--li>You probably also want the m2eclipse SCM integration - this adds menus to SCM such as |
| <code>Checkout as Maven project</code>. To get this, add the Eclipse update site: |
| <a class="external" rel="nofollow noopener" target="_blank" rel="noopener" |
| href="https://m2eclipse.sonatype.org/sites/m2e-extras"> |
| https://m2eclipse.sonatype.org/sites/m2e-extras</a> |
| and then select |
| <ul><li>Maven SCM handler for Subclispe</li> |
| <li>Maven SCM Integration</li> |
| </ul> |
| </li> |
| </ol> |
| </p> |
| |
| </li--> |
| <!-- |
| <li>Use Eclipse<code> Preferences -> Maven -> Installations </code> to add the Maven 3.0 (or later) installation as the |
| default to use.</li> --> |
| <li>(Optional - if you are using m2e plugin to run Maven |
| build commands.) Use Eclipse <code>Preferences -> Java -> Installed JREs</code> |
| and select the JRE you will be using as the default, and click |
| "Edit" and add the default VM arguments from MAVEN_OPTS above.</li> |
| </ol> |
| </p> |
| </blockquote> |
| </p> |
| </td></tr> |
| </table> |
| </td> |
| </tr> |
| <!-- FOOTER --> |
| <tr><td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td></tr> |
| <tr><td colspan="2"> |
| <table class="pageFooter"> |
| <tr> |
| <td><a href="index.html">Home</a></td> |
| <td><a href="privacy-policy.html">Privacy Policy</a></td> |
| <td style="font-size:75%"> |
| Copyright © 2006-2013, The Apache Software Foundation.<br/> |
| Apache UIMA, UIMA, the Apache UIMA logo and the Apache Feather logo are trademarks of The Apache Software Foundation.<br/> |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| </td> |
| <td><a href="mailto:dev@uima.apache.org">Contact us</a></td> |
| </tr> |
| </table> |
| </td></tr> |
| </table> |
| </body> |
| </html> |
| |
