Modified: tika/site/publish/0.7/parser_guide.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.7/parser_guide.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.7/parser_guide.html (original) +++ tika/site/publish/0.7/parser_guide.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Get Tika parsing up and running in 5 minutes</title> + <title>Apache Tika – Get Tika parsing up and running in 5 minutes</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="Get_Tika_parsing_up_and_running_in_5_minutes"></a>Get Tika parsing up and running in 5 minutes</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>
Modified: tika/site/publish/0.8/detection.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.8/detection.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.8/detection.html (original) +++ tika/site/publish/0.8/detection.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Content Detection</title> + <title>Apache Tika – Content Detection</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="Content_Detection"></a>Content Detection</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> Modified: tika/site/publish/0.8/formats.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.8/formats.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.8/formats.html (original) +++ tika/site/publish/0.8/formats.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Supported Document Formats</title> + <title>Apache Tika – Supported Document Formats</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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>Supported Document Formats<a name="Supported_Document_Formats"></a></h2> +<h2><a name="Supported_Document_Formats"></a>Supported Document Formats</h2> <p>This page lists all the document formats supported by Apache Tika 0.8. Follow the links to the various parser class javadocs for more detailed information about each document format and how it is parsed by Tika.</p> <ul> <li><a href="#Supported_Document_Formats">Supported Document Formats</a> Modified: tika/site/publish/0.8/gettingstarted.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.8/gettingstarted.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.8/gettingstarted.html (original) +++ tika/site/publish/0.8/gettingstarted.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Getting Started with Apache Tika</title> + <title>Apache Tika – Getting Started with Apache Tika</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,10 +85,10 @@ </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> +<h2><a name="Getting_Started_with_Apache_Tika"></a>Getting Started with Apache Tika</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> +<h2><a name="Getting_and_building_the_sources"></a>Getting and building the sources</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> @@ -96,7 +96,7 @@ <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> +<h2><a name="Build_artifacts"></a>Build artifacts</h2> <p>The Tika 0.8 build consists of a number of components and produces the following main binaries:</p> <dl> <dt>tika-core/target/tika-core-0.8.jar</dt> @@ -108,7 +108,7 @@ <dt>tika-bundle/target/tika-bundle-0.8.jar</dt> <dd> Tika bundle. An OSGi bundle that includes everything you need to use all Tika functionality 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> +<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> <div> <pre> <dependency> @@ -145,7 +145,7 @@ +- log4j:log4j:jar:1.2.14:compile \- com.drewnoakes:metadata-extractor:jar:2.4.0-beta-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> +<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>, to use Tika in you application you can include the Tika jar files and the dependencies individually.</p> <div> <pre><classpath> @@ -173,7 +173,7 @@ <p>An easy way to gather all these libraries is to run "mvn dependency:copy-dependencies" in the tika-parsers source directory. This will copy all Tika dependencies to the <tt>target/dependencies</tt> directory.</p> <p>Alternatively you can simply drop the entire tika-app jar to your classpath to get all of the above dependencies in a single archive.</p></div> <div class="section"> -<h2>Using Tika as a command line utility<a name="Using_Tika_as_a_command_line_utility"></a></h2> +<h2><a name="Using_Tika_as_a_command_line_utility"></a>Using Tika as a command line utility</h2> <p>The Tika application jar (tika-app-0.8.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> Modified: tika/site/publish/0.8/index.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.8/index.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.8/index.html (original) +++ tika/site/publish/0.8/index.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Apache Tika 0.8</title> + <title>Apache Tika – Apache Tika 0.8</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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 0.8<a name="Apache_Tika_0.8"></a></h2> +<h2><a name="Apache_Tika_0.8"></a>Apache Tika 0.8</h2> <p>The most notable changes in Tika 0.8 over the previous release are:</p> <ul> <li>Language identification is now dynamically configurable, managed via a config file loaded from the classpath. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-490";>TIKA-490</a>)</li> Modified: tika/site/publish/0.8/parser.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.8/parser.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.8/parser.html (original) +++ tika/site/publish/0.8/parser.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - The Parser interface</title> + <title>Apache Tika – The Parser interface</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="The_Parser_interface"></a>The Parser interface</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( @@ -105,7 +105,7 @@ <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> +<h3><a name="Document_input_stream"></a>Document input stream</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> @@ -118,7 +118,7 @@ try { }</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> +<h3><a name="XHTML_SAX_events"></a>XHTML SAX events</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> @@ -147,7 +147,7 @@ try { reader.close(); // the document stream is closed automatically }</pre></div></div> <div class="section"> -<h3>Document metadata<a name="Document_metadata"></a></h3> +<h3><a name="Document_metadata"></a>Document metadata</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> @@ -167,10 +167,10 @@ try { <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> +<h3><a name="Parse_context"></a>Parse context</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> +<h3><a name="Parser_implementations"></a>Parser implementations</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://pdfbox.apache.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> Modified: tika/site/publish/0.8/parser_guide.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.8/parser_guide.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.8/parser_guide.html (original) +++ tika/site/publish/0.8/parser_guide.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Get Tika parsing up and running in 5 minutes</title> + <title>Apache Tika – Get Tika parsing up and running in 5 minutes</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="Get_Tika_parsing_up_and_running_in_5_minutes"></a>Get Tika parsing up and running in 5 minutes</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> Modified: tika/site/publish/0.9/detection.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.9/detection.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.9/detection.html (original) +++ tika/site/publish/0.9/detection.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Content Detection</title> + <title>Apache Tika – Content Detection</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="Content_Detection"></a>Content Detection</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> Modified: tika/site/publish/0.9/formats.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.9/formats.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.9/formats.html (original) +++ tika/site/publish/0.9/formats.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Supported Document Formats</title> + <title>Apache Tika – Supported Document Formats</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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>Supported Document Formats<a name="Supported_Document_Formats"></a></h2> +<h2><a name="Supported_Document_Formats"></a>Supported Document Formats</h2> <p>This page lists all the document formats supported by Apache Tika 0.9. Follow the links to the various parser class javadocs for more detailed information about each document format and how it is parsed by Tika.</p> <ul> <li><a href="#Supported_Document_Formats">Supported Document Formats</a> Modified: tika/site/publish/0.9/gettingstarted.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.9/gettingstarted.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.9/gettingstarted.html (original) +++ tika/site/publish/0.9/gettingstarted.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Getting Started with Apache Tika</title> + <title>Apache Tika – Getting Started with Apache Tika</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,10 +85,10 @@ </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> +<h2><a name="Getting_Started_with_Apache_Tika"></a>Getting Started with Apache Tika</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> +<h2><a name="Getting_and_building_the_sources"></a>Getting and building the sources</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> @@ -96,7 +96,7 @@ <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> +<h2><a name="Build_artifacts"></a>Build artifacts</h2> <p>The Tika 0.9 build consists of a number of components and produces the following main binaries:</p> <dl> <dt>tika-core/target/tika-core-0.9.jar</dt> @@ -108,7 +108,7 @@ <dt>tika-bundle/target/tika-bundle-0.9.jar</dt> <dd> Tika bundle. An OSGi bundle that includes everything you need to use all Tika functionality 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> +<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> <div> <pre> <dependency> @@ -152,7 +152,7 @@ \- rome:rome:jar:0.9:provided \- jdom:jdom:jar:1.0:provided</pre></div></div> <div class="section"> -<h2>Using Tika in an Ant project<a name="Using_Tika_in_an_Ant_project"></a></h2> +<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>, to use Tika in you application you can include the Tika jar files and the dependencies individually.</p> <div> <pre><classpath> @@ -180,7 +180,7 @@ <p>An easy way to gather all these libraries is to run "mvn dependency:copy-dependencies" in the tika-parsers source directory. This will copy all Tika dependencies to the <tt>target/dependencies</tt> directory.</p> <p>Alternatively you can simply drop the entire tika-app jar to your classpath to get all of the above dependencies in a single archive.</p></div> <div class="section"> -<h2>Using Tika as a command line utility<a name="Using_Tika_as_a_command_line_utility"></a></h2> +<h2><a name="Using_Tika_as_a_command_line_utility"></a>Using Tika as a command line utility</h2> <p>The Tika application jar (tika-app-0.9.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> Modified: tika/site/publish/0.9/index.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.9/index.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.9/index.html (original) +++ tika/site/publish/0.9/index.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Apache Tika 0.9</title> + <title>Apache Tika – Apache Tika 0.9</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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 0.9<a name="Apache_Tika_0.9"></a></h2> +<h2><a name="Apache_Tika_0.9"></a>Apache Tika 0.9</h2> <p>The most notable changes in Tika 0.9 over the previous release are:</p> <ul> <li>A critical bugfix preventing metadata from printing to the command line when the underlying Parser didn't generate XHTML output was fixed. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-596";>TIKA-596</a>)</li> Modified: tika/site/publish/0.9/parser.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.9/parser.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.9/parser.html (original) +++ tika/site/publish/0.9/parser.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - The Parser interface</title> + <title>Apache Tika – The Parser interface</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="The_Parser_interface"></a>The Parser interface</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( @@ -105,7 +105,7 @@ <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> +<h3><a name="Document_input_stream"></a>Document input stream</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> @@ -118,7 +118,7 @@ try { }</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> +<h3><a name="XHTML_SAX_events"></a>XHTML SAX events</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> @@ -147,7 +147,7 @@ try { reader.close(); // the document stream is closed automatically }</pre></div></div> <div class="section"> -<h3>Document metadata<a name="Document_metadata"></a></h3> +<h3><a name="Document_metadata"></a>Document metadata</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> @@ -167,10 +167,10 @@ try { <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> +<h3><a name="Parse_context"></a>Parse context</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> +<h3><a name="Parser_implementations"></a>Parser implementations</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://pdfbox.apache.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> Modified: tika/site/publish/0.9/parser_guide.html URL: http://svn.apache.org/viewvc/tika/site/publish/0.9/parser_guide.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/0.9/parser_guide.html (original) +++ tika/site/publish/0.9/parser_guide.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Get Tika parsing up and running in 5 minutes</title> + <title>Apache Tika – Get Tika parsing up and running in 5 minutes</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="Get_Tika_parsing_up_and_running_in_5_minutes"></a>Get Tika parsing up and running in 5 minutes</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> Modified: tika/site/publish/1.0/detection.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.0/detection.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.0/detection.html (original) +++ tika/site/publish/1.0/detection.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Content Detection</title> + <title>Apache Tika – Content Detection</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="Content_Detection"></a>Content Detection</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> Modified: tika/site/publish/1.0/formats.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.0/formats.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.0/formats.html (original) +++ tika/site/publish/1.0/formats.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Supported Document Formats</title> + <title>Apache Tika – Supported Document Formats</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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>Supported Document Formats<a name="Supported_Document_Formats"></a></h2> +<h2><a name="Supported_Document_Formats"></a>Supported Document Formats</h2> <p>This page lists all the document formats supported by Apache Tika 1.0. Follow the links to the various parser class javadocs for more detailed information about each document format and how it is parsed by Tika.</p> <ul> <li><a href="#Supported_Document_Formats">Supported Document Formats</a> Modified: tika/site/publish/1.0/gettingstarted.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.0/gettingstarted.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.0/gettingstarted.html (original) +++ tika/site/publish/1.0/gettingstarted.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Getting Started with Apache Tika</title> + <title>Apache Tika – Getting Started with Apache Tika</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,10 +85,10 @@ </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> +<h2><a name="Getting_Started_with_Apache_Tika"></a>Getting Started with Apache Tika</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> +<h2><a name="Getting_and_building_the_sources"></a>Getting and building the sources</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> @@ -96,7 +96,7 @@ <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> +<h2><a name="Build_artifacts"></a>Build artifacts</h2> <p>The Tika 1.0 build consists of a number of components and produces the following main binaries:</p> <dl> <dt>tika-core/target/tika-core-1.0.jar</dt> @@ -108,7 +108,7 @@ <dt>tika-bundle/target/tika-bundle-1.0.jar</dt> <dd> Tika bundle. An OSGi bundle that includes everything you need to use all Tika functionality 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> +<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> <div> <pre> <dependency> @@ -153,7 +153,7 @@ +- rome:rome:jar:0.9:compile \- jdom:jdom:jar:1.0:compile</pre></div></div> <div class="section"> -<h2>Using Tika in an Ant project<a name="Using_Tika_in_an_Ant_project"></a></h2> +<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>, to use Tika in you application you can include the Tika jar files and the dependencies individually.</p> <div> <pre><classpath> @@ -181,7 +181,7 @@ <p>An easy way to gather all these libraries is to run "mvn dependency:copy-dependencies" in the tika-parsers source directory. This will copy all Tika dependencies to the <tt>target/dependencies</tt> directory.</p> <p>Alternatively you can simply drop the entire tika-app jar to your classpath to get all of the above dependencies in a single archive.</p></div> <div class="section"> -<h2>Using Tika as a command line utility<a name="Using_Tika_as_a_command_line_utility"></a></h2> +<h2><a name="Using_Tika_as_a_command_line_utility"></a>Using Tika as a command line utility</h2> <p>The Tika application jar (tika-app-1.0.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> Modified: tika/site/publish/1.0/index.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.0/index.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.0/index.html (original) +++ tika/site/publish/1.0/index.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Apache Tika 0.8</title> + <title>Apache Tika – Apache Tika 0.8</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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.0<a name="Apache_Tika_1.0"></a></h2> +<h2><a name="Apache_Tika_1.0"></a>Apache Tika 1.0</h2> <p>The most notable changes in Tika 1.0 over the previous release are:</p> <ul> <li>API: All methods, classes and interfaces that were marked as deprecated in Tika 0.10 have been removed to clean up the API (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-703";>TIKA-703</a>). You may need to adjust and recompile client code accordingly. The declared OSGi package versions are now 1.0, and will thus not resolve for client bundles that still refer to 0.x versions (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-565";>TIKA-565</a>).</li> Modified: tika/site/publish/1.0/parser.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.0/parser.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.0/parser.html (original) +++ tika/site/publish/1.0/parser.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - The Parser interface</title> + <title>Apache Tika – The Parser interface</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="The_Parser_interface"></a>The Parser interface</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( @@ -105,7 +105,7 @@ <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> +<h3><a name="Document_input_stream"></a>Document input stream</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> @@ -118,7 +118,7 @@ try { }</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> +<h3><a name="XHTML_SAX_events"></a>XHTML SAX events</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> @@ -147,7 +147,7 @@ try { reader.close(); // the document stream is closed automatically }</pre></div></div> <div class="section"> -<h3>Document metadata<a name="Document_metadata"></a></h3> +<h3><a name="Document_metadata"></a>Document metadata</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> @@ -167,10 +167,10 @@ try { <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> +<h3><a name="Parse_context"></a>Parse context</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> +<h3><a name="Parser_implementations"></a>Parser implementations</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://pdfbox.apache.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> Modified: tika/site/publish/1.0/parser_guide.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.0/parser_guide.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.0/parser_guide.html (original) +++ tika/site/publish/1.0/parser_guide.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Get Tika parsing up and running in 5 minutes</title> + <title>Apache Tika – Get Tika parsing up and running in 5 minutes</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="Get_Tika_parsing_up_and_running_in_5_minutes"></a>Get Tika parsing up and running in 5 minutes</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> Modified: tika/site/publish/1.1/detection.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.1/detection.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.1/detection.html (original) +++ tika/site/publish/1.1/detection.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Content Detection</title> + <title>Apache Tika – Content Detection</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="Content_Detection"></a>Content Detection</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> Modified: tika/site/publish/1.1/formats.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.1/formats.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.1/formats.html (original) +++ tika/site/publish/1.1/formats.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Supported Document Formats</title> + <title>Apache Tika – Supported Document Formats</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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>Supported Document Formats<a name="Supported_Document_Formats"></a></h2> +<h2><a name="Supported_Document_Formats"></a>Supported Document Formats</h2> <p>This page lists all the document formats supported by Apache Tika 1.1. Follow the links to the various parser class javadocs for more detailed information about each document format and how it is parsed by Tika.</p> <ul> <li><a href="#Supported_Document_Formats">Supported Document Formats</a> Modified: tika/site/publish/1.1/gettingstarted.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.1/gettingstarted.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.1/gettingstarted.html (original) +++ tika/site/publish/1.1/gettingstarted.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Getting Started with Apache Tika</title> + <title>Apache Tika – Getting Started with Apache Tika</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,10 +85,10 @@ </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> +<h2><a name="Getting_Started_with_Apache_Tika"></a>Getting Started with Apache Tika</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> +<h2><a name="Getting_and_building_the_sources"></a>Getting and building the sources</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> @@ -96,7 +96,7 @@ <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> +<h2><a name="Build_artifacts"></a>Build artifacts</h2> <p>The Tika 1.1 build consists of a number of components and produces the following main binaries:</p> <dl> <dt>tika-core/target/tika-core-1.1.jar</dt> @@ -108,7 +108,7 @@ <dt>tika-bundle/target/tika-bundle-1.1.jar</dt> <dd> Tika bundle. An OSGi bundle that includes everything you need to use all Tika functionality 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> +<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> <div> <pre> <dependency> @@ -166,7 +166,7 @@ \- log4j:log4j:jar:1.2.14:test </pre></div></div> <div class="section"> -<h2>Using Tika in an Ant project<a name="Using_Tika_in_an_Ant_project"></a></h2> +<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>, to use Tika in you application you can include the Tika jar files and the dependencies individually.</p> <div> <pre><classpath> @@ -194,7 +194,7 @@ <p>An easy way to gather all these libraries is to run "mvn dependency:copy-dependencies" in the tika-parsers source directory. This will copy all Tika dependencies to the <tt>target/dependencies</tt> directory.</p> <p>Alternatively you can simply drop the entire tika-app jar to your classpath to get all of the above dependencies in a single archive.</p></div> <div class="section"> -<h2>Using Tika as a command line utility<a name="Using_Tika_as_a_command_line_utility"></a></h2> +<h2><a name="Using_Tika_as_a_command_line_utility"></a>Using Tika as a command line utility</h2> <p>The Tika application jar (tika-app-1.1.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> Modified: tika/site/publish/1.1/index.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.1/index.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.1/index.html (original) +++ tika/site/publish/1.1/index.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - Apache Tika 0.8</title> + <title>Apache Tika – Apache Tika 0.8</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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.1<a name="Apache_Tika_1.1"></a></h2> +<h2><a name="Apache_Tika_1.1"></a>Apache Tika 1.1</h2> <p>The most notable changes in Tika 1.1 over the previous release are:</p> <ul> <li>Link Extraction: The rel attribute is now extracted from links per the LinkConteHandler. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-824";>TIKA-824</a>)</li> Modified: tika/site/publish/1.1/parser.html URL: http://svn.apache.org/viewvc/tika/site/publish/1.1/parser.html?rev=1710509&r1=1710508&r2=1710509&view=diff ============================================================================== --- tika/site/publish/1.1/parser.html (original) +++ tika/site/publish/1.1/parser.html Mon Oct 26 04:40:33 2015 @@ -29,7 +29,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Tika - The Parser interface</title> + <title>Apache Tika – The Parser interface</title> <style type="text/css" media="all"> @import url("../css/site.css"); </style> @@ -85,7 +85,7 @@ </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> +<h2><a name="The_Parser_interface"></a>The Parser interface</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( @@ -105,7 +105,7 @@ <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> +<h3><a name="Document_input_stream"></a>Document input stream</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> @@ -118,7 +118,7 @@ try { }</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> +<h3><a name="XHTML_SAX_events"></a>XHTML SAX events</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> @@ -147,7 +147,7 @@ try { reader.close(); // the document stream is closed automatically }</pre></div></div> <div class="section"> -<h3>Document metadata<a name="Document_metadata"></a></h3> +<h3><a name="Document_metadata"></a>Document metadata</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> @@ -167,10 +167,10 @@ try { <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> +<h3><a name="Parse_context"></a>Parse context</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> +<h3><a name="Parser_implementations"></a>Parser implementations</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://pdfbox.apache.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>
