Author: nick
Date: Sat Nov 14 16:23:57 2015
New Revision: 1714341
URL: http://svn.apache.org/viewvc?rev=1714341&view=rev
Log:
Add Gradle and Ivy instructions
Modified:
tika/site/publish/1.11/gettingstarted.html
tika/site/src/site/apt/1.11/gettingstarted.apt
Modified: tika/site/publish/1.11/gettingstarted.html
URL:
http://svn.apache.org/viewvc/tika/site/publish/1.11/gettingstarted.html?rev=1714341&r1=1714340&r2=1714341&view=diff
==============================================================================
--- tika/site/publish/1.11/gettingstarted.html (original)
+++ tika/site/publish/1.11/gettingstarted.html Sat Nov 14 16:23:57 2015
@@ -111,33 +111,45 @@
<dd> Tika bundle. An OSGi bundle that combines tika-parsers with non-OSGified
parser libraries to make them easy to deploy in an OSGi
environment.</dd></dl></div>
<div class="section">
<h2><a name="Using_Tika_as_a_Maven_dependency"></a>Using Tika as a Maven
dependency</h2>
-<p>The core library, tika-core, contains the key interfaces and classes of
Tika and can be used by itself if you don't need the full set of parsers from
the tika-parsers component. The tika-core dependency looks like this:</p>
+<p>The core library, <tt> tika-core </tt>, contains the key interfaces and
classes of Tika and can be used by itself if you don't need the full set of
parsers from the <tt> tika-parsers </tt> component. The tika-core dependency
looks like this:</p>
<div>
<pre> <dependency>
<groupId>org.apache.tika</groupId>
<artifactId>tika-core</artifactId>
- <version>...</version>
+ <version>1.11</version>
</dependency></pre></div>
-<p>If you want to use Tika to parse documents (instead of simply detecting
document types, etc.), you'll want to depend on tika-parsers instead: </p>
+<p>If you want to use Tika to parse documents (instead of simply detecting
document types, etc.), you'll want to depend on <tt> tika-parsers </tt>
instead: </p>
<div>
<pre> <dependency>
<groupId>org.apache.tika</groupId>
<artifactId>tika-parsers</artifactId>
- <version>...</version>
+ <version>1.11</version>
</dependency></pre></div>
<p>Note that adding this dependency will introduce a number of transitive
dependencies to your project, including one on tika-core. You need to make sure
that these dependencies won't conflict with your existing project dependencies.
You can use the following command in the tika-parsers directory to get a full
listing of all the dependencies.</p>
<div>
<pre>$ mvn dependency:tree | grep :compile</pre></div></div>
<div class="section">
+<h2><a name="Using_Tika_in_a_Gradle-built_project"></a>Using Tika in a
Gradle-built project</h2>
+<p>To add a dependency on Apache Tika to your Gradle built project, including
the full set of parsers, you should depend on the <tt> tika-parsers </tt>
artifact:</p>
+<div>
+<pre>dependencies {
+ runtime 'org.apache.tika:tika-parsers:1.11'
+}</pre></div></div>
+<div class="section">
<h2><a name="Using_Tika_in_an_Ant_project"></a>Using Tika in an Ant
project</h2>
-<p>Unless you use a dependency manager tool like <a class="externalLink"
href="http://ant.apache.org/ivy/";>Apache Ivy</a>, the easiest way to use Tika
is to include either the tika-core or the tika-app jar in your classpath,
depending on whether you want just the core functionality or also all the
parser implementations.</p>
+<p>If you are using <a class="externalLink"
href="http://ant.apache.org/ivy/";>Apache Ivy</a> as your dependency manager
tool with Ant, then to include Tika with the full set of parsers, you should
depend on the <tt> tika-parsers </tt> artifact like this:</p>
+<div>
+<pre> <dependencies>
+ <dependency org="org.apache.tika"
name="tika-parsers" rev="1.11"/>
+ </dependencies></pre></div>
+<p>Otherwise, probably the easiest way to use Tika is to include the full <tt>
tika-app </tt> jar on your classpath. For just core functionality, you can add
the <tt> tika-core </tt> jar, but be aware that the full set of parsers have a
large number of dependencies which must be included which is very fiddly to do
by hand with Ant! To include Tika in your Ant project, you should do something
like:</p>
<div>
<pre><classpath>
... <!-- your other classpath entries -->
- <!-- either: -->
+ <!-- either: Tika Core only, no parsers -->
<pathelement
location="path/to/tika-core-${tika.version}.jar"/>
- <!-- or: -->
+ <!-- or: Tika with all Parsers-->
<pathelement
location="path/to/tika-app-${tika.version}.jar"/>
</classpath></pre></div></div>
Modified: tika/site/src/site/apt/1.11/gettingstarted.apt
URL:
http://svn.apache.org/viewvc/tika/site/src/site/apt/1.11/gettingstarted.apt?rev=1714341&r1=1714340&r2=1714341&view=diff
==============================================================================
--- tika/site/src/site/apt/1.11/gettingstarted.apt (original)
+++ tika/site/src/site/apt/1.11/gettingstarted.apt Sat Nov 14 16:23:57 2015
@@ -71,26 +71,27 @@ Build artifacts
Using Tika as a Maven dependency
- The core library, tika-core, contains the key interfaces and classes of Tika
- and can be used by itself if you don't need the full set of parsers from
- the tika-parsers component. The tika-core dependency looks like this:
+ The core library, <<< tika-core >>>, contains the key interfaces and classes
+ of Tika and can be used by itself if you don't need the full set of parsers
+ from the <<< tika-parsers >>> component. The tika-core dependency looks like
+ this:
---
<dependency>
<groupId>org.apache.tika</groupId>
<artifactId>tika-core</artifactId>
- <version>...</version>
+ <version>1.11</version>
</dependency>
---
If you want to use Tika to parse documents (instead of simply detecting
- document types, etc.), you'll want to depend on tika-parsers instead:
+ document types, etc.), you'll want to depend on <<< tika-parsers >>> instead:
---
<dependency>
<groupId>org.apache.tika</groupId>
<artifactId>tika-parsers</artifactId>
- <version>...</version>
+ <version>1.11</version>
</dependency>
---
@@ -104,21 +105,44 @@ Using Tika as a Maven dependency
$ mvn dependency:tree | grep :compile
---
+Using Tika in a Gradle-built project
+
+ To add a dependency on Apache Tika to your Gradle built project,
+ including the full set of parsers, you should depend on the
+ <<< tika-parsers >>> artifact:
+
+---
+dependencies {
+ runtime 'org.apache.tika:tika-parsers:1.11'
+}
+---
+
Using Tika in an Ant project
- Unless you use a dependency manager tool like
- {{{http://ant.apache.org/ivy/}Apache Ivy}}, the easiest way to use
- Tika is to include either the tika-core or the tika-app jar in your
- classpath, depending on whether you want just the core functionality
- or also all the parser implementations.
+ If you are using {{{http://ant.apache.org/ivy/}Apache Ivy}} as your
+ dependency manager tool with Ant, then to include Tika with the full set
+ of parsers, you should depend on the <<< tika-parsers >>> artifact like this:
+
+---
+ <dependencies>
+ <dependency org="org.apache.tika" name="tika-parsers" rev="1.11"/>
+ </dependencies>
+---
+
+ Otherwise, probably the easiest way to use Tika is to include the full
+ <<< tika-app >>> jar on your classpath. For just core functionality, you
+ can add the <<< tika-core >>> jar, but be aware that the full set of
+ parsers have a large number of dependencies which must be included which
+ is very fiddly to do by hand with Ant! To include Tika in your Ant project,
+ you should do something like:
---
<classpath>
... <!-- your other classpath entries -->
- <!-- either: -->
+ <!-- either: Tika Core only, no parsers -->
<pathelement location="path/to/tika-core-${tika.version}.jar"/>
- <!-- or: -->
+ <!-- or: Tika with all Parsers-->
<pathelement location="path/to/tika-app-${tika.version}.jar"/>
</classpath>
