You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tika.apache.org by dm...@apache.org on 2014/03/27 10:46:54 UTC
svn commit: r1582236 [10/14] - in /tika/site: publish/ publish/0.10/
publish/0.5/ publish/0.6/ publish/0.7/ publish/0.8/ publish/0.9/
publish/1.0/ publish/1.1/ publish/1.2/ publish/1.3/ publish/1.4/
publish/1.5/ src/site/
Modified: tika/site/publish/1.2/gettingstarted.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.2/gettingstarted.html?rev=1582236&r1=1582235&r2=1582236&view=diff
==============================================================================
--- tika/site/publish/1.2/gettingstarted.html (original)
+++ tika/site/publish/1.2/gettingstarted.html Thu Mar 27 09:46:52 2014
@@ -45,7 +45,7 @@
}
}
if (provider == "lucid") {
- form.action = "http://search.lucidimagination.com/p:tika";
+ form.action = "http://find.searchhub.org/p:tika";
} else if (provider == "sl") {
form.action = "http://search-lucene.com/tika";
}
@@ -84,15 +84,48 @@
width="387" height="100"/></a>
</div>
<div id="content">
- <!-- Licensed to the Apache Software Foundation (ASF) under one or more --><!-- contributor license agreements. See the NOTICE file distributed with --><!-- this work for additional information regarding copyright ownership. --><!-- The ASF licenses this file to You under the Apache License, Version 2.0 --><!-- (the "License"); you may not use this file except in compliance with --><!-- the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. --><div class="section"><h2>Getting Started with Apache Tika<a name="Getting_Started_with_Apache_Tika"></a></h2><p>This document
describes how to build Apache Tika from sources and how to start using Tika in an application.</p></div><div class="section"><h2>Getting and building the sources<a name="Getting_and_building_the_sources"></a></h2><p>To build Tika from sources you first need to either <a href="../download.html">download</a> a source release or <a href="../source-repository.html">checkout</a> the latest sources from version control.</p><p>Once you have the sources, you can build them using the <a class="externalLink" href="http://maven.apache.org/">Maven 2</a> build system. Executing the following command in the base directory will build the sources and install the resulting artifacts in your local Maven repository.</p><div><pre>mvn install</pre></div><p>See the Maven documentation for more information about the available build options.</p><p>Note that you need Java 5 or higher to build Tika.</p></div><div class="section"><h2>Build artifacts<a name="Build_artifacts"></a></h2><p>The Tika 1.2 build cons
ists of a number of components and produces the following main binaries:</p><dl><dt>tika-core/target/tika-core-1.2.jar</dt><dd> Tika core library. Contains the core interfaces and classes of Tika, but none of the parser implementations. Depends only on Java 5.</dd><dt>tika-parsers/target/tika-parsers-1.2.jar</dt><dd> Tika parsers. Collection of classes that implement the Tika Parser interface based on various external parser libraries.</dd><dt>tika-app/target/tika-app-1.2.jar</dt><dd> Tika application. Combines the above libraries and all the external parser libraries into a single runnable jar with a GUI and a command line interface.</dd><dt>tika-bundle/target/tika-bundle-1.2.jar</dt><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>Using Tika as a Maven dependency<a name="Using_Tika_as_a_Maven_dependency"></a></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><div><pre> <dependency>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more --><!-- contributor license agreements. See the NOTICE file distributed with --><!-- this work for additional information regarding copyright ownership. --><!-- The ASF licenses this file to You under the Apache License, Version 2.0 --><!-- (the "License"); you may not use this file except in compliance with --><!-- the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. --><div class="section">
+<h2>Getting Started with Apache Tika<a name="Getting_Started_with_Apache_Tika"></a></h2>
+<p>This document describes how to build Apache Tika from sources and how to start using Tika in an application.</p></div>
+<div class="section">
+<h2>Getting and building the sources<a name="Getting_and_building_the_sources"></a></h2>
+<p>To build Tika from sources you first need to either <a href="../download.html">download</a> a source release or <a href="../source-repository.html">checkout</a> the latest sources from version control.</p>
+<p>Once you have the sources, you can build them using the <a class="externalLink" href="http://maven.apache.org/">Maven 2</a> build system. Executing the following command in the base directory will build the sources and install the resulting artifacts in your local Maven repository.</p>
+<div>
+<pre>mvn install</pre></div>
+<p>See the Maven documentation for more information about the available build options.</p>
+<p>Note that you need Java 5 or higher to build Tika.</p></div>
+<div class="section">
+<h2>Build artifacts<a name="Build_artifacts"></a></h2>
+<p>The Tika 1.2 build consists of a number of components and produces the following main binaries:</p>
+<dl>
+<dt>tika-core/target/tika-core-1.2.jar</dt>
+<dd> Tika core library. Contains the core interfaces and classes of Tika, but none of the parser implementations. Depends only on Java 5.</dd>
+<dt>tika-parsers/target/tika-parsers-1.2.jar</dt>
+<dd> Tika parsers. Collection of classes that implement the Tika Parser interface based on various external parser libraries.</dd>
+<dt>tika-app/target/tika-app-1.2.jar</dt>
+<dd> Tika application. Combines the above libraries and all the external parser libraries into a single runnable jar with a GUI and a command line interface.</dd>
+<dt>tika-bundle/target/tika-bundle-1.2.jar</dt>
+<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>Using Tika as a Maven dependency<a name="Using_Tika_as_a_Maven_dependency"></a></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>
+<div>
+<pre> <dependency>
<groupId>org.apache.tika</groupId>
<artifactId>tika-core</artifactId>
<version>1.2</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><div><pre> <dependency>
+ </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>
+<div>
+<pre> <dependency>
<groupId>org.apache.tika</groupId>
<artifactId>tika-parsers</artifactId>
<version>1.2</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. The listing below shows all the compile-scope dependencies of tika-parsers in the Tika 1.2 release.</p><div><pre>+- org.apache.tika:tika-core:jar:1.2:compile
+ </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. The listing below shows all the compile-scope dependencies of tika-parsers in the Tika 1.2 release.</p>
+<div>
+<pre>+- org.apache.tika:tika-core:jar:1.2:compile
+- org.gagravarr:vorbis-java-tika:jar:0.1:compile
| \- org.gagravarr:vorbis-java-core:jar:tests:0.1:runtime
+- org.apache.felix:org.apache.felix.scr.annotations:jar:1.6.0:provided
@@ -125,7 +158,12 @@
+- rome:rome:jar:0.9:compile
| \- jdom:jdom:jar:1.0:compile
+- org.gagravarr:vorbis-java-core:jar:0.1:compile
-</pre></div></div><div class="section"><h2>Using Tika in an Ant project<a name="Using_Tika_in_an_Ant_project"></a></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><div><pre><classpath>
+</pre></div></div>
+<div class="section">
+<h2>Using Tika in an Ant project<a name="Using_Tika_in_an_Ant_project"></a></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>
+<div>
+<pre><classpath>
... <!-- your other classpath entries -->
<!-- either: -->
@@ -133,7 +171,13 @@
<!-- or: -->
<pathelement location="path/to/tika-app-${tika.version}.jar"/>
-</classpath></pre></div></div><div class="section"><h2>Using Tika as a command line utility<a name="Using_Tika_as_a_command_line_utility"></a></h2><p>The Tika application jar (tika-app-1.2.jar) can be used as a command line utility for extracting text content and metadata from all sorts of files. This runnable jar contains all the dependencies it needs, so you don't need to worry about classpath settings to run it.</p><p>The usage instructions are shown below.</p><div><pre>Options:
+</classpath></pre></div></div>
+<div class="section">
+<h2>Using Tika as a command line utility<a name="Using_Tika_as_a_command_line_utility"></a></h2>
+<p>The Tika application jar (tika-app-1.2.jar) can be used as a command line utility for extracting text content and metadata from all sorts of files. This runnable jar contains all the dependencies it needs, so you don't need to worry about classpath settings to run it.</p>
+<p>The usage instructions are shown below.</p>
+<div>
+<pre>Options:
-? or --help Print this usage message
-v or --verbose Print debug level messages
-V or --version Print the Apache Tika version number
@@ -195,7 +239,10 @@ Description:
Use the "--server" (or "-s") option to start the
Apache Tika server. The server will listen to the
- ports you specify as one or more arguments.</pre></div><p>You can also use the jar as a component in a Unix pipeline or as an external tool in many scripting languages.</p><div><pre># Check if an Internet resource contains a specific keyword
+ ports you specify as one or more arguments.</pre></div>
+<p>You can also use the jar as a component in a Unix pipeline or as an external tool in many scripting languages.</p>
+<div>
+<pre># Check if an Internet resource contains a specific keyword
curl http://.../document.doc \
| java -jar tika-app-1.2.jar --text \
| grep -q keyword</pre></div></div>
Modified: tika/site/publish/1.2/index.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.2/index.html?rev=1582236&r1=1582235&r2=1582236&view=diff
==============================================================================
--- tika/site/publish/1.2/index.html (original)
+++ tika/site/publish/1.2/index.html Thu Mar 27 09:46:52 2014
@@ -45,7 +45,7 @@
}
}
if (provider == "lucid") {
- form.action = "http://search.lucidimagination.com/p:tika";
+ form.action = "http://find.searchhub.org/p:tika";
} else if (provider == "sl") {
form.action = "http://search-lucene.com/tika";
}
@@ -84,7 +84,59 @@
width="387" height="100"/></a>
</div>
<div id="content">
- <!-- Licensed to the Apache Software Foundation (ASF) under one or more --><!-- contributor license agreements. See the NOTICE file distributed with --><!-- this work for additional information regarding copyright ownership. --><!-- The ASF licenses this file to You under the Apache License, Version 2.0 --><!-- (the "License"); you may not use this file except in compliance with --><!-- the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. --><div class="section"><h2>Apache Tika 1.2<a name="Apache_Tika_1.2"></a></h2><p>The most notable changes in Tika 1.2 over the pr
evious release are:</p><ul><li>Tika's JAX-RS based Network server now is based on Apache CXF, which is available in Maven Central and now allows the server module to be packaged and included in our release (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-593">TIKA-593</a>, <a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-901">TIKA-901</a>).</li><li>Tika: parseToString now lets you specify the max string length per-call, in addition to per-Tika-instance. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-870">TIKA-870</a>)</li><li>Tika now has the ability to detect FITS (Flexible Image Transport System) files (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-874">TIKA-874</a>).</li><li>Images: Fixed file handle leak in ImageParser. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-875">TIKA-875</a>)</li><li>iWork: Comments in Pages files are now extracted (<a class="exte
rnalLink" href="http://issues.apache.org/jira/browse/TIKA-907">TIKA-907</a>). Headers, footers and footnotes in Pages files are now extracted (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-906">TIKA-906</a>). Don't throw NullPointerException on passsword protected iWork files, even though we can't parse their contents yet (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-903">TIKA-903</a>). Text extracted from Keynote text boxes and bullet points no longer runs togethe (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-910">TIKA-910</a>). Also extract text for Pages documents created in layout mode (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-904">TIKA-904</a>). Table names are now extracted in Numbers documents (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-924">TIKA-924</a>). Content added to master slides is also extracted (<a class="externalLink" href="htt
p://issues.apache.org/jira/browse/TIKA-923">TIKA-923</a>).</li><li>Archive and compression formats: The Commons Compress dependency was upgraded from 1.3 to 1.4.1. With this change Tika can now parse also Unix dump archives and documents compressed using the XZ and Pack200 compression formats. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-932">TIKA-932</a>)<ul><li>KML: Tika now has basic support for Keyhole Markup Language documents (KML and KMZ) used by tools like Google Earth. See also http://www.opengeospatial.org/standards/kml/. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-941">TIKA-941</a>)</li><li>CLI: You can now use the TIKA_PASSWORD environment variable or the --password=X command line option to specify the password that Tika CLI should use for opening encrypted documents (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-943">TIKA-943</a>).</li><li>Character encodings: Tika's character encoding de
tection mechanism was improved by adding integration to the juniversalchardet library that implements Mozilla's universal charset detection algorithm. The slower ICU4J algorithms are still used as a fallback thanks to their wider coverage of custom character encodings. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-322">TIKA-322</a>, <a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-471">TIKA-471</a>)<ul><li>Charset parameter: Related to the character encoding improvements mentioned above, Tika now returns the detected character encoding as a "charset" parameter of the content type metadata field for text/plain and text/html documents. For example, instead of just "text/plain", the returned content type will be something like "text/plain; charset=UTF-8" for a UTF-8 encoded text document. Character encoding information is still present also in the content encoding metadata field for backwards compatibility,
but that field should be considered deprecated. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-431">TIKA-431</a>)</li><li>Extraction of embedded resources from OLE2 Office Documents, where the resource isn't another office document, has been fixed (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-948">TIKA-948</a>)</li></ul></li></ul></li></ul><p>The following people have contributed to Tika 1.2 by submitting or commenting on the issues resolved in this release:</p><ul><li>Albert L.</li><li>Andrew Jackson</li><li>Andrzej Bialecki</li><li>Antoni Mylka</li><li>Chris A. Mattmann</li><li>Chris Jones</li><li>Daniel Bonniot de Ruisselet</li><li>Emil Burzo</li><li>Erik Hetzner</li><li>Erik Peterson</li><li>Fausto Cruzeiro de Moraes</li><li>Gabriel Valencia</li><li>George Kappel</li><li>Ingo Renner</li><li>Jan Høydahl</li><li>Jeremy Anderson</li><li>Jerome Lacoste</li><li>John Mastarone</li><li>Jörg Ehrlich</li><li>Jukka Zitting</l
i><li>Ken Krugler</li><li>Marco Quaranta</li><li>Maxim Valyanskiy</li><li>Michael McCandless</li><li>Nick Burch</li><li>Niels Beekman</li><li>Peter May</li><li>Ray Gauss II</li><li>Rob Tulloh</li><li>Sasha Goodman</li><li>Shay Banon</li><li>Staffan Olsson</li><li>Torsten Krah</li></ul><p>See <a class="externalLink" href="http://s.apache.org/PSE">http://s.apache.org/PSE</a> for more details on these contributions.</p></div>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more --><!-- contributor license agreements. See the NOTICE file distributed with --><!-- this work for additional information regarding copyright ownership. --><!-- The ASF licenses this file to You under the Apache License, Version 2.0 --><!-- (the "License"); you may not use this file except in compliance with --><!-- the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. --><div class="section">
+<h2>Apache Tika 1.2<a name="Apache_Tika_1.2"></a></h2>
+<p>The most notable changes in Tika 1.2 over the previous release are:</p>
+<ul>
+<li>Tika's JAX-RS based Network server now is based on Apache CXF, which is available in Maven Central and now allows the server module to be packaged and included in our release (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-593">TIKA-593</a>, <a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-901">TIKA-901</a>).</li>
+<li>Tika: parseToString now lets you specify the max string length per-call, in addition to per-Tika-instance. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-870">TIKA-870</a>)</li>
+<li>Tika now has the ability to detect FITS (Flexible Image Transport System) files (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-874">TIKA-874</a>).</li>
+<li>Images: Fixed file handle leak in ImageParser. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-875">TIKA-875</a>)</li>
+<li>iWork: Comments in Pages files are now extracted (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-907">TIKA-907</a>). Headers, footers and footnotes in Pages files are now extracted (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-906">TIKA-906</a>). Don't throw NullPointerException on passsword protected iWork files, even though we can't parse their contents yet (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-903">TIKA-903</a>). Text extracted from Keynote text boxes and bullet points no longer runs togethe (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-910">TIKA-910</a>). Also extract text for Pages documents created in layout mode (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-904">TIKA-904</a>). Table names are now extracted in Numbers documents (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-924">TIKA-924</a>). Content added t
o master slides is also extracted (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-923">TIKA-923</a>).</li>
+<li>Archive and compression formats: The Commons Compress dependency was upgraded from 1.3 to 1.4.1. With this change Tika can now parse also Unix dump archives and documents compressed using the XZ and Pack200 compression formats. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-932">TIKA-932</a>)
+<ul>
+<li>KML: Tika now has basic support for Keyhole Markup Language documents (KML and KMZ) used by tools like Google Earth. See also http://www.opengeospatial.org/standards/kml/. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-941">TIKA-941</a>)</li>
+<li>CLI: You can now use the TIKA_PASSWORD environment variable or the --password=X command line option to specify the password that Tika CLI should use for opening encrypted documents (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-943">TIKA-943</a>).</li>
+<li>Character encodings: Tika's character encoding detection mechanism was improved by adding integration to the juniversalchardet library that implements Mozilla's universal charset detection algorithm. The slower ICU4J algorithms are still used as a fallback thanks to their wider coverage of custom character encodings. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-322">TIKA-322</a>, <a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-471">TIKA-471</a>)
+<ul>
+<li>Charset parameter: Related to the character encoding improvements mentioned above, Tika now returns the detected character encoding as a "charset" parameter of the content type metadata field for text/plain and text/html documents. For example, instead of just "text/plain", the returned content type will be something like "text/plain; charset=UTF-8" for a UTF-8 encoded text document. Character encoding information is still present also in the content encoding metadata field for backwards compatibility, but that field should be considered deprecated. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-431">TIKA-431</a>)</li>
+<li>Extraction of embedded resources from OLE2 Office Documents, where the resource isn't another office document, has been fixed (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-948">TIKA-948</a>)</li></ul></li></ul></li></ul>
+<p>The following people have contributed to Tika 1.2 by submitting or commenting on the issues resolved in this release:</p>
+<ul>
+<li>Albert L.</li>
+<li>Andrew Jackson</li>
+<li>Andrzej Bialecki</li>
+<li>Antoni Mylka</li>
+<li>Chris A. Mattmann</li>
+<li>Chris Jones</li>
+<li>Daniel Bonniot de Ruisselet</li>
+<li>Emil Burzo</li>
+<li>Erik Hetzner</li>
+<li>Erik Peterson</li>
+<li>Fausto Cruzeiro de Moraes</li>
+<li>Gabriel Valencia</li>
+<li>George Kappel</li>
+<li>Ingo Renner</li>
+<li>Jan Høydahl</li>
+<li>Jeremy Anderson</li>
+<li>Jerome Lacoste</li>
+<li>John Mastarone</li>
+<li>Jörg Ehrlich</li>
+<li>Jukka Zitting</li>
+<li>Ken Krugler</li>
+<li>Marco Quaranta</li>
+<li>Maxim Valyanskiy</li>
+<li>Michael McCandless</li>
+<li>Nick Burch</li>
+<li>Niels Beekman</li>
+<li>Peter May</li>
+<li>Ray Gauss II</li>
+<li>Rob Tulloh</li>
+<li>Sasha Goodman</li>
+<li>Shay Banon</li>
+<li>Staffan Olsson</li>
+<li>Torsten Krah</li></ul>
+<p>See <a class="externalLink" href="http://s.apache.org/PSE">http://s.apache.org/PSE</a> for more details on these contributions.</p></div>
</div>
<div id="sidebar">
<div id="navigation">
Modified: tika/site/publish/1.2/parser.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.2/parser.html?rev=1582236&r1=1582235&r2=1582236&view=diff
==============================================================================
--- tika/site/publish/1.2/parser.html (original)
+++ tika/site/publish/1.2/parser.html Thu Mar 27 09:46:52 2014
@@ -45,7 +45,7 @@
}
}
if (provider == "lucid") {
- form.action = "http://search.lucidimagination.com/p:tika";
+ form.action = "http://find.searchhub.org/p:tika";
} else if (provider == "sl") {
form.action = "http://search-lucene.com/tika";
}
@@ -84,28 +84,96 @@
width="387" height="100"/></a>
</div>
<div id="content">
- <!-- Licensed to the Apache Software Foundation (ASF) under one or more --><!-- contributor license agreements. See the NOTICE file distributed with --><!-- this work for additional information regarding copyright ownership. --><!-- The ASF licenses this file to You under the Apache License, Version 2.0 --><!-- (the "License"); you may not use this file except in compliance with --><!-- the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. --><div class="section"><h2>The Parser interface<a name="The_Parser_interface"></a></h2><p>The <a href="./api/org/apache/tika/par
ser/Parser.html">org.apache.tika.parser.Parser</a> interface is the key concept of Apache Tika. It hides the complexity of different file formats and parsing libraries while providing a simple and powerful mechanism for client applications to extract structured text content and metadata from all sorts of documents. All this is achieved with a single method:</p><div><pre>void parse(
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more --><!-- contributor license agreements. See the NOTICE file distributed with --><!-- this work for additional information regarding copyright ownership. --><!-- The ASF licenses this file to You under the Apache License, Version 2.0 --><!-- (the "License"); you may not use this file except in compliance with --><!-- the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. --><div class="section">
+<h2>The Parser interface<a name="The_Parser_interface"></a></h2>
+<p>The <a href="./api/org/apache/tika/parser/Parser.html">org.apache.tika.parser.Parser</a> interface is the key concept of Apache Tika. It hides the complexity of different file formats and parsing libraries while providing a simple and powerful mechanism for client applications to extract structured text content and metadata from all sorts of documents. All this is achieved with a single method:</p>
+<div>
+<pre>void parse(
InputStream stream, ContentHandler handler, Metadata metadata,
- ParseContext context) throws IOException, SAXException, TikaException;</pre></div><p>The <tt>parse</tt> method takes the document to be parsed and related metadata as input and outputs the results as XHTML SAX events and extra metadata. The parse context argument is used to specify context information (like the current local) that is not related to any individual document. The main criteria that lead to this design were:</p><dl><dt>Streamed parsing</dt><dd>The interface should require neither the client application nor the parser implementation to keep the full document content in memory or spooled to disk. This allows even huge documents to be parsed without excessive resource requirements.</dd><dt>Structured content</dt><dd>A parser implementation should be able to include structural information (headings, links, etc.) in the extracted content. A client application can use this information for example to better judge the relevance of different parts of the parsed document.</dd
><dt>Input metadata</dt><dd>A client application should be able to include metadata like the file name or declared content type with the document to be parsed. The parser implementation can use this information to better guide the parsing process.</dd><dt>Output metadata</dt><dd>A parser implementation should be able to return document metadata in addition to document content. Many document formats contain metadata like the name of the author that may be useful to client applications.</dd><dt>Context sensitivity</dt><dd>While the default settings and behaviour of Tika parsers should work well for most use cases, there are still situations where more fine-grained control over the parsing process is desirable. It should be easy to inject such context-specific information to the parsing process without breaking the layers of abstraction.</dd></dl><p>These criteria are reflected in the arguments of the <tt>parse</tt> method.</p><div class="section"><h3>Document input stream<a name="Docu
ment_input_stream"></a></h3><p>The first argument is an <a class="externalLink" href="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html">InputStream</a> for reading the document to be parsed.</p><p>If this document stream can not be read, then parsing stops and the thrown <a class="externalLink" href="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html">IOException</a> is passed up to the client application. If the stream can be read but not parsed (for example if the document is corrupted), then the parser throws a <a href="./api/org/apache/tika/exception/TikaException.html">TikaException</a>.</p><p>The parser implementation will consume this stream but <i>will not close it</i>. Closing the stream is the responsibility of the client application that opened it in the first place. The recommended pattern for using streams with the <tt>parse</tt> method is:</p><div><pre>InputStream stream = ...; // open the stream
+ ParseContext context) throws IOException, SAXException, TikaException;</pre></div>
+<p>The <tt>parse</tt> method takes the document to be parsed and related metadata as input and outputs the results as XHTML SAX events and extra metadata. The parse context argument is used to specify context information (like the current local) that is not related to any individual document. The main criteria that lead to this design were:</p>
+<dl>
+<dt>Streamed parsing</dt>
+<dd>The interface should require neither the client application nor the parser implementation to keep the full document content in memory or spooled to disk. This allows even huge documents to be parsed without excessive resource requirements.</dd>
+<dt>Structured content</dt>
+<dd>A parser implementation should be able to include structural information (headings, links, etc.) in the extracted content. A client application can use this information for example to better judge the relevance of different parts of the parsed document.</dd>
+<dt>Input metadata</dt>
+<dd>A client application should be able to include metadata like the file name or declared content type with the document to be parsed. The parser implementation can use this information to better guide the parsing process.</dd>
+<dt>Output metadata</dt>
+<dd>A parser implementation should be able to return document metadata in addition to document content. Many document formats contain metadata like the name of the author that may be useful to client applications.</dd>
+<dt>Context sensitivity</dt>
+<dd>While the default settings and behaviour of Tika parsers should work well for most use cases, there are still situations where more fine-grained control over the parsing process is desirable. It should be easy to inject such context-specific information to the parsing process without breaking the layers of abstraction.</dd></dl>
+<p>These criteria are reflected in the arguments of the <tt>parse</tt> method.</p>
+<div class="section">
+<h3>Document input stream<a name="Document_input_stream"></a></h3>
+<p>The first argument is an <a class="externalLink" href="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html">InputStream</a> for reading the document to be parsed.</p>
+<p>If this document stream can not be read, then parsing stops and the thrown <a class="externalLink" href="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html">IOException</a> is passed up to the client application. If the stream can be read but not parsed (for example if the document is corrupted), then the parser throws a <a href="./api/org/apache/tika/exception/TikaException.html">TikaException</a>.</p>
+<p>The parser implementation will consume this stream but <i>will not close it</i>. Closing the stream is the responsibility of the client application that opened it in the first place. The recommended pattern for using streams with the <tt>parse</tt> method is:</p>
+<div>
+<pre>InputStream stream = ...; // open the stream
try {
parser.parse(stream, ...); // parse the stream
} finally {
stream.close(); // close the stream
-}</pre></div><p>Some document formats like the OLE2 Compound Document Format used by Microsoft Office are best parsed as random access files. In such cases the content of the input stream is automatically spooled to a temporary file that gets removed once parsed. A future version of Tika may make it possible to avoid this extra file if the input document is already a file in the local file system. See <a class="externalLink" href="https://issues.apache.org/jira/browse/TIKA-153">TIKA-153</a> for the status of this feature request.</p></div><div class="section"><h3>XHTML SAX events<a name="XHTML_SAX_events"></a></h3><p>The parsed content of the document stream is returned to the client application as a sequence of XHTML SAX events. XHTML is used to express structured content of the document and SAX events enable streamed processing. Note that the XHTML format is used here only to convey structural information, not to render the documents for browsing!</p><p>The XHTML SAX events produc
ed by the parser implementation are sent to a <a class="externalLink" href="http://java.sun.com/j2se/1.5.0/docs/api/org/xml/sax/ContentHandler.html">ContentHandler</a> instance given to the <tt>parse</tt> method. If this the content handler fails to process an event, then parsing stops and the thrown <a class="externalLink" href="http://java.sun.com/j2se/1.5.0/docs/api/org/xml/sax/SAXException.html">SAXException</a> is passed up to the client application.</p><p>The overall structure of the generated event stream is (with indenting added for clarity):</p><div><pre><html xmlns="http://www.w3.org/1999/xhtml">
+}</pre></div>
+<p>Some document formats like the OLE2 Compound Document Format used by Microsoft Office are best parsed as random access files. In such cases the content of the input stream is automatically spooled to a temporary file that gets removed once parsed. A future version of Tika may make it possible to avoid this extra file if the input document is already a file in the local file system. See <a class="externalLink" href="https://issues.apache.org/jira/browse/TIKA-153">TIKA-153</a> for the status of this feature request.</p></div>
+<div class="section">
+<h3>XHTML SAX events<a name="XHTML_SAX_events"></a></h3>
+<p>The parsed content of the document stream is returned to the client application as a sequence of XHTML SAX events. XHTML is used to express structured content of the document and SAX events enable streamed processing. Note that the XHTML format is used here only to convey structural information, not to render the documents for browsing!</p>
+<p>The XHTML SAX events produced by the parser implementation are sent to a <a class="externalLink" href="http://java.sun.com/j2se/1.5.0/docs/api/org/xml/sax/ContentHandler.html">ContentHandler</a> instance given to the <tt>parse</tt> method. If this the content handler fails to process an event, then parsing stops and the thrown <a class="externalLink" href="http://java.sun.com/j2se/1.5.0/docs/api/org/xml/sax/SAXException.html">SAXException</a> is passed up to the client application.</p>
+<p>The overall structure of the generated event stream is (with indenting added for clarity):</p>
+<div>
+<pre><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>...</title>
</head>
<body>
...
</body>
-</html></pre></div><p>Parser implementations typically use the <a href="./api/org/apache/tika/sax/XHTMLContentHandler.html">XHTMLContentHandler</a> utility class to generate the XHTML output.</p><p>Dealing with the raw SAX events can be a bit complex, so Apache Tika comes with a number of utility classes that can be used to process and convert the event stream to other representations.</p><p>For example, the <a href="./api/org/apache/tika/sax/BodyContentHandler.html">BodyContentHandler</a> class can be used to extract just the body part of the XHTML output and feed it either as SAX events to another content handler or as characters to an output stream, a writer, or simply a string. The following code snippet parses a document from the standard input stream and outputs the extracted text content to standard output:</p><div><pre>ContentHandler handler = new BodyContentHandler(System.out);
-parser.parse(System.in, handler, ...);</pre></div><p>Another useful class is <a href="./api/org/apache/tika/parser/ParsingReader.html">ParsingReader</a> that uses a background thread to parse the document and returns the extracted text content as a character stream:</p><div><pre>InputStream stream = ...; // the document to be parsed
+</html></pre></div>
+<p>Parser implementations typically use the <a href="./api/org/apache/tika/sax/XHTMLContentHandler.html">XHTMLContentHandler</a> utility class to generate the XHTML output.</p>
+<p>Dealing with the raw SAX events can be a bit complex, so Apache Tika comes with a number of utility classes that can be used to process and convert the event stream to other representations.</p>
+<p>For example, the <a href="./api/org/apache/tika/sax/BodyContentHandler.html">BodyContentHandler</a> class can be used to extract just the body part of the XHTML output and feed it either as SAX events to another content handler or as characters to an output stream, a writer, or simply a string. The following code snippet parses a document from the standard input stream and outputs the extracted text content to standard output:</p>
+<div>
+<pre>ContentHandler handler = new BodyContentHandler(System.out);
+parser.parse(System.in, handler, ...);</pre></div>
+<p>Another useful class is <a href="./api/org/apache/tika/parser/ParsingReader.html">ParsingReader</a> that uses a background thread to parse the document and returns the extracted text content as a character stream:</p>
+<div>
+<pre>InputStream stream = ...; // the document to be parsed
Reader reader = new ParsingReader(parser, stream, ...);
try {
...; // read the document text using the reader
} finally {
reader.close(); // the document stream is closed automatically
-}</pre></div></div><div class="section"><h3>Document metadata<a name="Document_metadata"></a></h3><p>The third argument to the <tt>parse</tt> method is used to pass document metadata both in and out of the parser. Document metadata is expressed as an <a href="./api/org/apache/tika/metadata/Metadata.html">Metadata</a> object.</p><p>The following are some of the more interesting metadata properties:</p><dl><dt>Metadata.RESOURCE_NAME_KEY</dt><dd>The name of the file or resource that contains the document.<p>A client application can set this property to allow the parser to use file name heuristics to determine the format of the document.</p><p>The parser implementation may set this property if the file format contains the canonical name of the file (for example the Gzip format has a slot for the file name).</p></dd><dt>Metadata.CONTENT_TYPE</dt><dd>The declared content type of the document.<p>A client application can set this property based on for example a HTTP Content-Type header. The
declared content type may help the parser to correctly interpret the document.</p><p>The parser implementation sets this property to the content type according to which the document was parsed.</p></dd><dt>Metadata.TITLE</dt><dd>The title of the document.<p>The parser implementation sets this property if the document format contains an explicit title field.</p></dd><dt>Metadata.AUTHOR</dt><dd>The name of the author of the document.<p>The parser implementation sets this property if the document format contains an explicit author field.</p></dd></dl><p>Note that metadata handling is still being discussed by the Tika development team, and it is likely that there will be some (backwards incompatible) changes in metadata handling before Tika 1.0.</p></div><div class="section"><h3>Parse context<a name="Parse_context"></a></h3><p>The final argument to the <tt>parse</tt> method is used to inject context-specific information to the parsing process. This is useful for example when dealing wi
th locale-specific date and number formats in Microsoft Excel spreadsheets. Another important use of the parse context is passing in the delegate parser instance to be used by two-phase parsers like the <a href="./api/org/apache/parser/pkg/PackageParser.html">PackageParser</a> subclasses. Some parser classes allow customization of the parsing process through strategy objects in the parse context.</p></div><div class="section"><h3>Parser implementations<a name="Parser_implementations"></a></h3><p>Apache Tika comes with a number of parser classes for parsing <a href="./formats.html">various document formats</a>. You can also extend Tika with your own parsers, and of course any contributions to Tika are warmly welcome.</p><p>The goal of Tika is to reuse existing parser libraries like <a class="externalLink" href="http://www.pdfbox.org/">PDFBox</a> or <a class="externalLink" href="http://poi.apache.org/">Apache POI</a> as much as possible, and so most of the parser classes in Tika are a
dapters to such external libraries.</p><p>Tika also contains some general purpose parser implementations that are not targeted at any specific document formats. The most notable of these is the <a href="./api/org/apache/tika/parser/AutoDetectParser.html">AutoDetectParser</a> class that encapsulates all Tika functionality into a single parser that can handle any types of documents. This parser will automatically determine the type of the incoming document based on various heuristics and will then parse the document accordingly.</p></div></div>
+}</pre></div></div>
+<div class="section">
+<h3>Document metadata<a name="Document_metadata"></a></h3>
+<p>The third argument to the <tt>parse</tt> method is used to pass document metadata both in and out of the parser. Document metadata is expressed as an <a href="./api/org/apache/tika/metadata/Metadata.html">Metadata</a> object.</p>
+<p>The following are some of the more interesting metadata properties:</p>
+<dl>
+<dt>Metadata.RESOURCE_NAME_KEY</dt>
+<dd>The name of the file or resource that contains the document.
+<p>A client application can set this property to allow the parser to use file name heuristics to determine the format of the document.</p>
+<p>The parser implementation may set this property if the file format contains the canonical name of the file (for example the Gzip format has a slot for the file name).</p></dd>
+<dt>Metadata.CONTENT_TYPE</dt>
+<dd>The declared content type of the document.
+<p>A client application can set this property based on for example a HTTP Content-Type header. The declared content type may help the parser to correctly interpret the document.</p>
+<p>The parser implementation sets this property to the content type according to which the document was parsed.</p></dd>
+<dt>Metadata.TITLE</dt>
+<dd>The title of the document.
+<p>The parser implementation sets this property if the document format contains an explicit title field.</p></dd>
+<dt>Metadata.AUTHOR</dt>
+<dd>The name of the author of the document.
+<p>The parser implementation sets this property if the document format contains an explicit author field.</p></dd></dl>
+<p>Note that metadata handling is still being discussed by the Tika development team, and it is likely that there will be some (backwards incompatible) changes in metadata handling before Tika 1.0.</p></div>
+<div class="section">
+<h3>Parse context<a name="Parse_context"></a></h3>
+<p>The final argument to the <tt>parse</tt> method is used to inject context-specific information to the parsing process. This is useful for example when dealing with locale-specific date and number formats in Microsoft Excel spreadsheets. Another important use of the parse context is passing in the delegate parser instance to be used by two-phase parsers like the <a href="./api/org/apache/parser/pkg/PackageParser.html">PackageParser</a> subclasses. Some parser classes allow customization of the parsing process through strategy objects in the parse context.</p></div>
+<div class="section">
+<h3>Parser implementations<a name="Parser_implementations"></a></h3>
+<p>Apache Tika comes with a number of parser classes for parsing <a href="./formats.html">various document formats</a>. You can also extend Tika with your own parsers, and of course any contributions to Tika are warmly welcome.</p>
+<p>The goal of Tika is to reuse existing parser libraries like <a class="externalLink" href="http://www.pdfbox.org/">PDFBox</a> or <a class="externalLink" href="http://poi.apache.org/">Apache POI</a> as much as possible, and so most of the parser classes in Tika are adapters to such external libraries.</p>
+<p>Tika also contains some general purpose parser implementations that are not targeted at any specific document formats. The most notable of these is the <a href="./api/org/apache/tika/parser/AutoDetectParser.html">AutoDetectParser</a> class that encapsulates all Tika functionality into a single parser that can handle any types of documents. This parser will automatically determine the type of the incoming document based on various heuristics and will then parse the document accordingly.</p></div></div>
</div>
<div id="sidebar">
<div id="navigation">
Modified: tika/site/publish/1.2/parser_guide.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.2/parser_guide.html?rev=1582236&r1=1582235&r2=1582236&view=diff
==============================================================================
--- tika/site/publish/1.2/parser_guide.html (original)
+++ tika/site/publish/1.2/parser_guide.html Thu Mar 27 09:46:52 2014
@@ -45,7 +45,7 @@
}
}
if (provider == "lucid") {
- form.action = "http://search.lucidimagination.com/p:tika";
+ form.action = "http://find.searchhub.org/p:tika";
} else if (provider == "sl") {
form.action = "http://search-lucene.com/tika";
}
@@ -84,9 +84,31 @@
width="387" height="100"/></a>
</div>
<div id="content">
- <!-- Licensed to the Apache Software Foundation (ASF) under one or more --><!-- contributor license agreements. See the NOTICE file distributed with --><!-- this work for additional information regarding copyright ownership. --><!-- The ASF licenses this file to You under the Apache License, Version 2.0 --><!-- (the "License"); you may not use this file except in compliance with --><!-- the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. --><div class="section"><h2>Get Tika parsing up and running in 5 minutes<a name="Get_Tika_parsing_up_and_running_in_5_minutes"></
a></h2><p>This page is a quick start guide showing how to add a new parser to Apache Tika. Following the simple steps listed below your new parser can be running in only 5 minutes.</p><ul><li><a href="#Get_Tika_parsing_up_and_running_in_5_minutes">Get Tika parsing up and running in 5 minutes</a><ul><li><a href="#Getting_Started">Getting Started</a></li><li><a href="#Add_your_MIME-Type">Add your MIME-Type</a></li><li><a href="#Create_your_Parser_class">Create your Parser class</a></li><li><a href="#List_the_new_parser">List the new parser</a></li></ul></li></ul><div class="section"><h3><a name="Getting_Started">Getting Started</a></h3><p>The <a href="./gettingstarted.html">Getting Started</a> document describes how to build Apache Tika from sources and how to start using Tika in an application. Pay close attention and follow the instructions in the "Getting and building the sources" section.</p></div><div class="section"><h3><a name="Add_your_MIME-Type">Add your MIME-Type</
a></h3><p>You first need to modify <a class="externalLink" href="http://svn.apache.org/repos/asf/tika/trunk/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml">tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml</a> in order to Tika can map the file extension with its MIME-Type. You should add something like this:</p><div><pre> <mime-type type="application/hello">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more --><!-- contributor license agreements. See the NOTICE file distributed with --><!-- this work for additional information regarding copyright ownership. --><!-- The ASF licenses this file to You under the Apache License, Version 2.0 --><!-- (the "License"); you may not use this file except in compliance with --><!-- the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. --><div class="section">
+<h2>Get Tika parsing up and running in 5 minutes<a name="Get_Tika_parsing_up_and_running_in_5_minutes"></a></h2>
+<p>This page is a quick start guide showing how to add a new parser to Apache Tika. Following the simple steps listed below your new parser can be running in only 5 minutes.</p>
+<ul>
+<li><a href="#Get_Tika_parsing_up_and_running_in_5_minutes">Get Tika parsing up and running in 5 minutes</a>
+<ul>
+<li><a href="#Getting_Started">Getting Started</a></li>
+<li><a href="#Add_your_MIME-Type">Add your MIME-Type</a></li>
+<li><a href="#Create_your_Parser_class">Create your Parser class</a></li>
+<li><a href="#List_the_new_parser">List the new parser</a></li></ul></li></ul>
+<div class="section">
+<h3><a name="Getting_Started">Getting Started</a></h3>
+<p>The <a href="./gettingstarted.html">Getting Started</a> document describes how to build Apache Tika from sources and how to start using Tika in an application. Pay close attention and follow the instructions in the "Getting and building the sources" section.</p></div>
+<div class="section">
+<h3><a name="Add_your_MIME-Type">Add your MIME-Type</a></h3>
+<p>You first need to modify <a class="externalLink" href="http://svn.apache.org/repos/asf/tika/trunk/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml">tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml</a> in order to Tika can map the file extension with its MIME-Type. You should add something like this:</p>
+<div>
+<pre> <mime-type type="application/hello">
<glob pattern="*.hi"/>
- </mime-type></pre></div></div><div class="section"><h3><a name="Create_your_Parser_class">Create your Parser class</a></h3><p>Now, you need to create your new parser. This is a class that must implement the Parser interface offered by Tika. A very simple Tika Parser looks like this:</p><div><pre>/*
+ </mime-type></pre></div></div>
+<div class="section">
+<h3><a name="Create_your_Parser_class">Create your Parser class</a></h3>
+<p>Now, you need to create your new parser. This is a class that must implement the Parser interface offered by Tika. A very simple Tika Parser looks like this:</p>
+<div>
+<pre>/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
@@ -150,7 +172,13 @@ public class HelloParser implements Pars
throws IOException, SAXException, TikaException {
parse(stream, handler, metadata, new ParseContext());
}
-}</pre></div><p>Pay special attention to the definition of the SUPPORTED_TYPES static class field in the parser class that defines what MIME-Types it supports. </p><p>Is in the "parse" method where you will do all your work. This is, extract the information of the resource and then set the metadata.</p></div><div class="section"><h3><a name="List_the_new_parser">List the new parser</a></h3><p>Finally, you should explicitly tell the AutoDetectParser to include your new parser. This step is only needed if you want to use the AutoDetectParser functionality. If you figure out the correct parser in a different way, it isn't needed. </p><p>List your new parser in: <a class="externalLink" href="http://svn.apache.org/repos/asf/tika/trunk/tika-parsers/src/main/resources/META-INF/services/org.apache.tika.parser.Parser">tika-parsers/src/main/resources/META-INF/services/org.apache.tika.parser.Parser</a></p></div></div>
+}</pre></div>
+<p>Pay special attention to the definition of the SUPPORTED_TYPES static class field in the parser class that defines what MIME-Types it supports. </p>
+<p>Is in the "parse" method where you will do all your work. This is, extract the information of the resource and then set the metadata.</p></div>
+<div class="section">
+<h3><a name="List_the_new_parser">List the new parser</a></h3>
+<p>Finally, you should explicitly tell the AutoDetectParser to include your new parser. This step is only needed if you want to use the AutoDetectParser functionality. If you figure out the correct parser in a different way, it isn't needed. </p>
+<p>List your new parser in: <a class="externalLink" href="http://svn.apache.org/repos/asf/tika/trunk/tika-parsers/src/main/resources/META-INF/services/org.apache.tika.parser.Parser">tika-parsers/src/main/resources/META-INF/services/org.apache.tika.parser.Parser</a></p></div></div>
</div>
<div id="sidebar">
<div id="navigation">
Modified: tika/site/publish/1.3/detection.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.3/detection.html?rev=1582236&r1=1582235&r2=1582236&view=diff
==============================================================================
--- tika/site/publish/1.3/detection.html (original)
+++ tika/site/publish/1.3/detection.html Thu Mar 27 09:46:52 2014
@@ -45,7 +45,7 @@
}
}
if (provider == "lucid") {
- form.action = "http://search.lucidimagination.com/p:tika";
+ form.action = "http://find.searchhub.org/p:tika";
} else if (provider == "sl") {
form.action = "http://search-lucene.com/tika";
}
@@ -84,8 +84,56 @@
width="387" height="100"/></a>
</div>
<div id="content">
- <!-- Licensed to the Apache Software Foundation (ASF) under one or more --><!-- contributor license agreements. See the NOTICE file distributed with --><!-- this work for additional information regarding copyright ownership. --><!-- The ASF licenses this file to You under the Apache License, Version 2.0 --><!-- (the "License"); you may not use this file except in compliance with --><!-- the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. --><div class="section"><h2>Content Detection<a name="Content_Detection"></a></h2><p>This page gives you information on how conte
nt and language detection works with Apache Tika, and how to tune the behaviour of Tika.</p><ul><li><a href="#Content_Detection">Content Detection</a><ul><li><a href="#The_Detector_Interface">The Detector Interface</a></li><li><a href="#Mime_Magic_Detction">Mime Magic Detction</a></li><li><a href="#Resource_Name_Based_Detection">Resource Name Based Detection</a></li><li><a href="#Known_Content_Type_Detection">Known Content Type "Detection</a></li><li><a href="#The_default_Mime_Types_Detector">The default Mime Types Detector</a></li><li><a href="#Container_Aware_Detection">Container Aware Detection</a></li><li><a href="#Language_Detection">Language Detection</a></li></ul></li></ul><div class="section"><h3><a name="The_Detector_Interface">The Detector Interface</a></h3><p>The <a href="./api/org/apache/tika/detect/Detector.html">org.apache.tika.detect.Detector</a> interface is the basis for most of the content type detection in Apache Tika. All the different ways of detecting cont
ent all implement the same common method:</p><div><pre>MediaType detect(java.io.InputStream input,
- Metadata metadata) throws java.io.IOException</pre></div><p>The <tt>detect</tt> method takes the stream to inspect, and a <tt>Metadata</tt> object that holds any additional information on the content. The detector will return a <a href="./api/org/apache/tika/mime/MediaType.html">MediaType</a> object describing its best guess as to the type of the file.</p><p>In general, only two keys on the Metadata object are used by Detectors. These are <tt>Metadata.RESOURCE_NAME_KEY</tt> which should hold the name of the file (where known), and <tt>Metadata.CONTENT_TYPE</tt> which should hold the advertised content type of the file (eg from a webserver or a content repository).</p></div><div class="section"><h3><a name="Mime_Magic_Detction">Mime Magic Detction</a></h3><p>By looking for special ("magic") patterns of bytes near the start of the file, it is often possible to detect the type of the file. For some file types, this is a simple process. For others, typically c
ontainer based formats, the magic detection may not be enough. (More detail on detecting container formats below)</p><p>Tika is able to make use of a a mime magic info file, in the <a class="externalLink" href="http://www.freedesktop.org/standards/shared-mime-info">Freedesktop MIME-info</a> format to peform mime magic detection.</p><p>This is provided within Tika by <a href="./api/org/apache/tika/detect/MagicDetector.html">org.apache.tika.detect.MagicDetector</a>. It is most commonly access via <a href="./api/org/apache/tika/mime/MimeTypes.html">org.apache.tika.mime.MimeTypes</a>, normally sourced from the <tt>tika-mimetypes.xml</tt> file.</p></div><div class="section"><h3><a name="Resource_Name_Based_Detection">Resource Name Based Detection</a></h3><p>Where the name of the file is known, it is sometimes possible to guess the file type from the name or extension. Within the <tt>tika-mimetypes.xml</tt> file is a list of patterns which are used to identify the type from the filename.<
/p><p>However, because files may be renamed, this method of detection is quick but not always as accurate.</p><p>This is provided within Tika by <a href="./api/org/apache/tika/detect/NameDetector.html">org.apache.tika.detect.NameDetector</a>.</p></div><div class="section"><h3><a name="Known_Content_Type_Detection">Known Content Type "Detection</a></h3><p>Sometimes, the mime type for a file is already known, such as when downloading from a webserver, or when retrieving from a content store. This information can be used by detectors, such as <a href="./api/org/apache/tika/mime/MimeTypes.html">org.apache.tika.mime.MimeTypes</a>,</p></div><div class="section"><h3><a name="The_default_Mime_Types_Detector">The default Mime Types Detector</a></h3><p>By default, the mime type detection in Tika is provided by <a href="./api/org/apache/tika/mime/MimeTypes.html">org.apache.tika.mime.MimeTypes</a>. This detector makes use of <tt>tika-mimetypes.xml</tt> to power magic based and filename bas
ed detection.</p><p>Firstly, magic based detection is used on the start of the file. If the file is an XML file, then the start of the XML is processed to look for root elements. Next, if available, the filename (from <tt>Metadata.RESOURCE_NAME_KEY</tt>) is then used to improve the detail of the detection, such as when magic detects a text file, and the filename hints it's really a CSV. Finally, if available, the supplied content type (from <tt>Metadata.CONTENT_TYPE</tt>) is used to further refine the type.</p></div><div class="section"><h3><a name="Container_Aware_Detection">Container Aware Detection</a></h3><p>Several common file formats are actually held within a common container format. One example is the PowerPoint .ppt and Word .doc formats, which are both held within an OLE2 container. Another is Apple iWork formats, which are actually a series of XML files within a Zip file.</p><p>Using magic detection, it is easy to spot that a given file is an OLE2 document, or a Zip file.
Using magic detection alone, it is very difficult (and often impossible) to tell what kind of file lives inside the container.</p><p>For some use cases, speed is important, so having a quick way to know the container type is sufficient. For other cases however, you don't mind spending a bit of time (and memory!) processing the container to get a more accurate answer on its contents. For these cases, a container aware detector should be used.</p><p>Tika provides a wrapping detector in the parsers bundle, of <a href="./api/org/apache/tika/detect/ContainerAwareDetector.html">org.apache.tika.detect.ContainerAwareDetector</a>. This detector will check for certain known containers, and if found, will open them and detect the appropriate type based on the contents. If the file isn't a known container, it will fall back to another detector for the answer (most commonly the default <tt>MimeTypes</tt> detector)</p><p>Because this detector needs to read the whole file to process the container
, it must be used with a <a href="./api/org/apache/tika/io/TikaInputStream.html">org.apache.tika.io.TikaInputStream</a>. If called with a regular <tt>InputStream</tt>, then all work will be done by the fallback detector.</p><p>For more information on container formats and Tika, see <a class="externalLink" href="http://wiki.apache.org/tika/MetadataDiscussion"></a></p></div><div class="section"><h3><a name="Language_Detection">Language Detection</a></h3><p>Tika is able to help identify the language of a piece of text, which is useful when extracting text from document formats which do not include language information in their metadata.</p><p>The language detection is provided by <a href="./api/org/apache/tika/language/LanguageIdentifier.html">org.apache.tika.language.LanguageIdentifier</a></p></div></div>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more --><!-- contributor license agreements. See the NOTICE file distributed with --><!-- this work for additional information regarding copyright ownership. --><!-- The ASF licenses this file to You under the Apache License, Version 2.0 --><!-- (the "License"); you may not use this file except in compliance with --><!-- the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. --><div class="section">
+<h2>Content Detection<a name="Content_Detection"></a></h2>
+<p>This page gives you information on how content and language detection works with Apache Tika, and how to tune the behaviour of Tika.</p>
+<ul>
+<li><a href="#Content_Detection">Content Detection</a>
+<ul>
+<li><a href="#The_Detector_Interface">The Detector Interface</a></li>
+<li><a href="#Mime_Magic_Detction">Mime Magic Detction</a></li>
+<li><a href="#Resource_Name_Based_Detection">Resource Name Based Detection</a></li>
+<li><a href="#Known_Content_Type_Detection">Known Content Type "Detection</a></li>
+<li><a href="#The_default_Mime_Types_Detector">The default Mime Types Detector</a></li>
+<li><a href="#Container_Aware_Detection">Container Aware Detection</a></li>
+<li><a href="#Language_Detection">Language Detection</a></li></ul></li></ul>
+<div class="section">
+<h3><a name="The_Detector_Interface">The Detector Interface</a></h3>
+<p>The <a href="./api/org/apache/tika/detect/Detector.html">org.apache.tika.detect.Detector</a> interface is the basis for most of the content type detection in Apache Tika. All the different ways of detecting content all implement the same common method:</p>
+<div>
+<pre>MediaType detect(java.io.InputStream input,
+ Metadata metadata) throws java.io.IOException</pre></div>
+<p>The <tt>detect</tt> method takes the stream to inspect, and a <tt>Metadata</tt> object that holds any additional information on the content. The detector will return a <a href="./api/org/apache/tika/mime/MediaType.html">MediaType</a> object describing its best guess as to the type of the file.</p>
+<p>In general, only two keys on the Metadata object are used by Detectors. These are <tt>Metadata.RESOURCE_NAME_KEY</tt> which should hold the name of the file (where known), and <tt>Metadata.CONTENT_TYPE</tt> which should hold the advertised content type of the file (eg from a webserver or a content repository).</p></div>
+<div class="section">
+<h3><a name="Mime_Magic_Detction">Mime Magic Detction</a></h3>
+<p>By looking for special ("magic") patterns of bytes near the start of the file, it is often possible to detect the type of the file. For some file types, this is a simple process. For others, typically container based formats, the magic detection may not be enough. (More detail on detecting container formats below)</p>
+<p>Tika is able to make use of a a mime magic info file, in the <a class="externalLink" href="http://www.freedesktop.org/standards/shared-mime-info">Freedesktop MIME-info</a> format to peform mime magic detection.</p>
+<p>This is provided within Tika by <a href="./api/org/apache/tika/detect/MagicDetector.html">org.apache.tika.detect.MagicDetector</a>. It is most commonly access via <a href="./api/org/apache/tika/mime/MimeTypes.html">org.apache.tika.mime.MimeTypes</a>, normally sourced from the <tt>tika-mimetypes.xml</tt> file.</p></div>
+<div class="section">
+<h3><a name="Resource_Name_Based_Detection">Resource Name Based Detection</a></h3>
+<p>Where the name of the file is known, it is sometimes possible to guess the file type from the name or extension. Within the <tt>tika-mimetypes.xml</tt> file is a list of patterns which are used to identify the type from the filename.</p>
+<p>However, because files may be renamed, this method of detection is quick but not always as accurate.</p>
+<p>This is provided within Tika by <a href="./api/org/apache/tika/detect/NameDetector.html">org.apache.tika.detect.NameDetector</a>.</p></div>
+<div class="section">
+<h3><a name="Known_Content_Type_Detection">Known Content Type "Detection</a></h3>
+<p>Sometimes, the mime type for a file is already known, such as when downloading from a webserver, or when retrieving from a content store. This information can be used by detectors, such as <a href="./api/org/apache/tika/mime/MimeTypes.html">org.apache.tika.mime.MimeTypes</a>,</p></div>
+<div class="section">
+<h3><a name="The_default_Mime_Types_Detector">The default Mime Types Detector</a></h3>
+<p>By default, the mime type detection in Tika is provided by <a href="./api/org/apache/tika/mime/MimeTypes.html">org.apache.tika.mime.MimeTypes</a>. This detector makes use of <tt>tika-mimetypes.xml</tt> to power magic based and filename based detection.</p>
+<p>Firstly, magic based detection is used on the start of the file. If the file is an XML file, then the start of the XML is processed to look for root elements. Next, if available, the filename (from <tt>Metadata.RESOURCE_NAME_KEY</tt>) is then used to improve the detail of the detection, such as when magic detects a text file, and the filename hints it's really a CSV. Finally, if available, the supplied content type (from <tt>Metadata.CONTENT_TYPE</tt>) is used to further refine the type.</p></div>
+<div class="section">
+<h3><a name="Container_Aware_Detection">Container Aware Detection</a></h3>
+<p>Several common file formats are actually held within a common container format. One example is the PowerPoint .ppt and Word .doc formats, which are both held within an OLE2 container. Another is Apple iWork formats, which are actually a series of XML files within a Zip file.</p>
+<p>Using magic detection, it is easy to spot that a given file is an OLE2 document, or a Zip file. Using magic detection alone, it is very difficult (and often impossible) to tell what kind of file lives inside the container.</p>
+<p>For some use cases, speed is important, so having a quick way to know the container type is sufficient. For other cases however, you don't mind spending a bit of time (and memory!) processing the container to get a more accurate answer on its contents. For these cases, a container aware detector should be used.</p>
+<p>Tika provides a wrapping detector in the parsers bundle, of <a href="./api/org/apache/tika/detect/ContainerAwareDetector.html">org.apache.tika.detect.ContainerAwareDetector</a>. This detector will check for certain known containers, and if found, will open them and detect the appropriate type based on the contents. If the file isn't a known container, it will fall back to another detector for the answer (most commonly the default <tt>MimeTypes</tt> detector)</p>
+<p>Because this detector needs to read the whole file to process the container, it must be used with a <a href="./api/org/apache/tika/io/TikaInputStream.html">org.apache.tika.io.TikaInputStream</a>. If called with a regular <tt>InputStream</tt>, then all work will be done by the fallback detector.</p>
+<p>For more information on container formats and Tika, see <a class="externalLink" href="http://wiki.apache.org/tika/MetadataDiscussion"></a></p></div>
+<div class="section">
+<h3><a name="Language_Detection">Language Detection</a></h3>
+<p>Tika is able to help identify the language of a piece of text, which is useful when extracting text from document formats which do not include language information in their metadata.</p>
+<p>The language detection is provided by <a href="./api/org/apache/tika/language/LanguageIdentifier.html">org.apache.tika.language.LanguageIdentifier</a></p></div></div>
</div>
<div id="sidebar">
<div id="navigation">