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 [7/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/0.9/parser_guide.html
URL: http://svn.apache.org/viewvc/tika/site/publish/0.9/parser_guide.html?rev=1582236&r1=1582235&r2=1582236&view=diff
==============================================================================
--- tika/site/publish/0.9/parser_guide.html (original)
+++ tika/site/publish/0.9/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.0/detection.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.0/detection.html?rev=1582236&r1=1582235&r2=1582236&view=diff
==============================================================================
--- tika/site/publish/1.0/detection.html (original)
+++ tika/site/publish/1.0/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">
Modified: tika/site/publish/1.0/formats.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.0/formats.html?rev=1582236&r1=1582235&r2=1582236&view=diff
==============================================================================
--- tika/site/publish/1.0/formats.html (original)
+++ tika/site/publish/1.0/formats.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,68 @@
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>Supported Document Formats<a name="Supported_Document_Formats"></a></h2><p>This page lists all the do
cument formats supported by Apache Tika 0.6. 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><ul><li><a href="#HyperText_Markup_Language">HyperText Markup Language</a></li><li><a href="#XML_and_derived_formats">XML and derived formats</a></li><li><a href="#Microsoft_Office_document_formats">Microsoft Office document formats</a></li><li><a href="#OpenDocument_Format">OpenDocument Format</a></li><li><a href="#Portable_Document_Format">Portable Document Format</a></li><li><a href="#Electronic_Publication_Format">Electronic Publication Format</a></li><li><a href="#Rich_Text_Format">Rich Text Format</a></li><li><a href="#Compression_and_packaging_formats">Compression and packaging formats</a></li><li><a href="#Text_formats">Text formats</a></li><li><a href="#Audio_formats">Audio formats</a></li><li><a href="#Image_form
ats">Image formats</a></li><li><a href="#Video_formats">Video formats</a></li><li><a href="#Java_class_files_and_archives">Java class files and archives</a></li><li><a href="#The_mbox_format">The mbox format</a></li></ul></li></ul><div class="section"><h3><a name="HyperText_Markup_Language">HyperText Markup Language</a></h3><p>The HyperText Markup Language (HTML) is the lingua franca of the web. Tika uses the <a class="externalLink" href="http://home.ccil.org/~cowan/XML/tagsoup/">TagSoup</a> library to support virtually any kind of HTML found on the web. The output from the <a href="./api/org/apache/tika/parser/html/HtmlParser.html">HtmlParser</a> class is guaranteed to be well-formed and valid XHTML, and various heuristics are used to prevent things like inline scripts from cluttering the extracted text content.</p></div><div class="section"><h3><a name="XML_and_derived_formats">XML and derived formats</a></h3><p>The Extensible Markup Language (XML) format is a generic format that
can be used for all kinds of content. Tika has custom parsers for some widely used XML vocabularies like XHTML, OOXML and ODF, but the default <a href="./api/org/apache/tika/parser/xml/DcXMLParser.html">DcXMLParser</a> class simply extracts the text content of the document and ignores any XML structure. The only exception to this rule are Dublin Core metadata elements that are used for the document metadata.</p></div><div class="section"><h3><a name="Microsoft_Office_document_formats">Microsoft Office document formats</a></h3><p>Microsoft Office and some related applications produce documents in the generic OLE 2 Compound Document and Office Open XML (OOXML) formats. The older OLE 2 format was introduced in Microsoft Office version 97 and was the default format until Office version 2007 and the new XML-based OOXML format. The <a href="./api/org/apache/tika/parser/microsoft/OfficeParser.html">OfficeParser</a> and <a href="./api/org/apache/tika/parser/microsoft/ooxml/OOXMLParser.html"
>OOXMLParser</a> classes use <a class="externalLink" href="http://poi.apache.org/">Apache POI</a> libraries to support text and metadata extraction from both OLE2 and OOXML documents.</p></div><div class="section"><h3><a name="OpenDocument_Format">OpenDocument Format</a></h3><p>The OpenDocument format (ODF) is used most notably as the default format of the OpenOffice.org office suite. The <a href="./api/org/apache/tika/parser/odf/OpenDocumentParser.html">OpenDocumentParser</a> class supports this format and the earlier OpenOffice 1.0 format on which ODF is based.</p></div><div class="section"><h3><a name="Portable_Document_Format">Portable Document Format</a></h3><p>The <a href="./api/org/apache/tika/parser/pdf/PDFParser.html">PDFParser</a> class parsers Portable Document Format (PDF) documents using the <a class="externalLink" href="http://pdfbox.apache.org/">Apache PDFBox</a> library.</p></div><div class="section"><h3><a name="Electronic_Publication_Format">Electronic Publication
Format</a></h3><p>The <a href="./api/org/apache/tika/parser/epub/EpubParser.html">EpubParser</a> class supports the Electronic Publication Format (EPUB) used for many digital books.</p></div><div class="section"><h3><a name="Rich_Text_Format">Rich Text Format</a></h3><p>The <a href="./api/org/apache/tika/parser/rtf/RTFParser.html">RTFParser</a> class uses the standard javax.swing.text.rtf feature to extract text content from Rich Text Format (RTF) documents.</p></div><div class="section"><h3><a name="Compression_and_packaging_formats">Compression and packaging formats</a></h3><p>Tika uses the <a class="externalLink" href="http://commons.apache.org/compress/">Commons Compress</a> library to support various compression and packaging formats. The <a href="./api/org/apache/tika/parser/pkg/PackageParser.html">PackageParser</a> class and its subclasses first parse the top level compression or packaging format and then pass the unpacked document streams to a second parsing stage using the
parser instance specified in the parse context.</p></div><div class="section"><h3><a name="Text_formats">Text formats</a></h3><p>Extracting text content from plain text files seems like a simple task until you start thinking of all the possible character encodings. The <a href="./api/org/apache/tika/parser/txt/TXTParser.html">TXTParser</a> class uses encoding detection code from the <a class="externalLink" href="http://site.icu-project.org/">ICU</a> project to automatically detect the character encoding of a text document.</p></div><div class="section"><h3><a name="Audio_formats">Audio formats</a></h3><p>Tika can detect several common audio formats and extract metadata from them. Even text extraction is supported for some audio files that contain lyrics or other textual content. The <a href="./api/org/apache/tika/parser/audio/AudioParser.html">AudioParser</a> and <a href="./api/org/apache/tika/parser/audio/MidiParser.html">MidiParser</a> classes use standard javax.sound features to
process simple audio formats, and the <a href="./api/org/apache/tika/parser/mp3/Mp3Parser.html">Mp3Parser</a> class adds support for the widely used MP3 format.</p></div><div class="section"><h3><a name="Image_formats">Image formats</a></h3><p>The <a href="./api/org/apache/tika/parser/image/ImageParser.html">ImageParser</a> class uses the standard javax.imageio feature to extract simple metadata from image formats supported by the Java platform. More complex image metadata is available through the <a href="./api/org/apache/tika/parser/jpeg/JpegParser.html">JpegParser</a> class that uses the metadata-extractor library to supports Exif metadata extraction from Jpeg images.</p></div><div class="section"><h3><a name="Video_formats">Video formats</a></h3><p>Currently Tika only supports the Flash video format using a simple parsing algorithm implemented in the <a href="./api/org/apache/tika/parser/flv/FLVParser">FLVParser</a> class.</p></div><div class="section"><h3><a name="Java_class_fi
les_and_archives">Java class files and archives</a></h3><p>The <a href="./api/org/apache/tika/parser/asm/ClassParser">ClassParser</a> class extracts class names and method signatures from Java class files, and the <a href="./api/org/apache/tika/parser/pkg/ZipParser.html">ZipParser</a> class supports also jar archives.</p></div><div class="section"><h3><a name="The_mbox_format">The mbox format</a></h3><p>The <a href="./api/org/apache/tika/parser/mbox/MboxParser.html">MboxParser</a> can extract email messages from the mbox format used by many email archives and Unix-style mailboxes.</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>Supported Document Formats<a name="Supported_Document_Formats"></a></h2>
+<p>This page lists all the document formats supported by Apache Tika 0.6. 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>
+<ul>
+<li><a href="#HyperText_Markup_Language">HyperText Markup Language</a></li>
+<li><a href="#XML_and_derived_formats">XML and derived formats</a></li>
+<li><a href="#Microsoft_Office_document_formats">Microsoft Office document formats</a></li>
+<li><a href="#OpenDocument_Format">OpenDocument Format</a></li>
+<li><a href="#Portable_Document_Format">Portable Document Format</a></li>
+<li><a href="#Electronic_Publication_Format">Electronic Publication Format</a></li>
+<li><a href="#Rich_Text_Format">Rich Text Format</a></li>
+<li><a href="#Compression_and_packaging_formats">Compression and packaging formats</a></li>
+<li><a href="#Text_formats">Text formats</a></li>
+<li><a href="#Audio_formats">Audio formats</a></li>
+<li><a href="#Image_formats">Image formats</a></li>
+<li><a href="#Video_formats">Video formats</a></li>
+<li><a href="#Java_class_files_and_archives">Java class files and archives</a></li>
+<li><a href="#The_mbox_format">The mbox format</a></li></ul></li></ul>
+<div class="section">
+<h3><a name="HyperText_Markup_Language">HyperText Markup Language</a></h3>
+<p>The HyperText Markup Language (HTML) is the lingua franca of the web. Tika uses the <a class="externalLink" href="http://home.ccil.org/~cowan/XML/tagsoup/">TagSoup</a> library to support virtually any kind of HTML found on the web. The output from the <a href="./api/org/apache/tika/parser/html/HtmlParser.html">HtmlParser</a> class is guaranteed to be well-formed and valid XHTML, and various heuristics are used to prevent things like inline scripts from cluttering the extracted text content.</p></div>
+<div class="section">
+<h3><a name="XML_and_derived_formats">XML and derived formats</a></h3>
+<p>The Extensible Markup Language (XML) format is a generic format that can be used for all kinds of content. Tika has custom parsers for some widely used XML vocabularies like XHTML, OOXML and ODF, but the default <a href="./api/org/apache/tika/parser/xml/DcXMLParser.html">DcXMLParser</a> class simply extracts the text content of the document and ignores any XML structure. The only exception to this rule are Dublin Core metadata elements that are used for the document metadata.</p></div>
+<div class="section">
+<h3><a name="Microsoft_Office_document_formats">Microsoft Office document formats</a></h3>
+<p>Microsoft Office and some related applications produce documents in the generic OLE 2 Compound Document and Office Open XML (OOXML) formats. The older OLE 2 format was introduced in Microsoft Office version 97 and was the default format until Office version 2007 and the new XML-based OOXML format. The <a href="./api/org/apache/tika/parser/microsoft/OfficeParser.html">OfficeParser</a> and <a href="./api/org/apache/tika/parser/microsoft/ooxml/OOXMLParser.html">OOXMLParser</a> classes use <a class="externalLink" href="http://poi.apache.org/">Apache POI</a> libraries to support text and metadata extraction from both OLE2 and OOXML documents.</p></div>
+<div class="section">
+<h3><a name="OpenDocument_Format">OpenDocument Format</a></h3>
+<p>The OpenDocument format (ODF) is used most notably as the default format of the OpenOffice.org office suite. The <a href="./api/org/apache/tika/parser/odf/OpenDocumentParser.html">OpenDocumentParser</a> class supports this format and the earlier OpenOffice 1.0 format on which ODF is based.</p></div>
+<div class="section">
+<h3><a name="Portable_Document_Format">Portable Document Format</a></h3>
+<p>The <a href="./api/org/apache/tika/parser/pdf/PDFParser.html">PDFParser</a> class parsers Portable Document Format (PDF) documents using the <a class="externalLink" href="http://pdfbox.apache.org/">Apache PDFBox</a> library.</p></div>
+<div class="section">
+<h3><a name="Electronic_Publication_Format">Electronic Publication Format</a></h3>
+<p>The <a href="./api/org/apache/tika/parser/epub/EpubParser.html">EpubParser</a> class supports the Electronic Publication Format (EPUB) used for many digital books.</p></div>
+<div class="section">
+<h3><a name="Rich_Text_Format">Rich Text Format</a></h3>
+<p>The <a href="./api/org/apache/tika/parser/rtf/RTFParser.html">RTFParser</a> class uses the standard javax.swing.text.rtf feature to extract text content from Rich Text Format (RTF) documents.</p></div>
+<div class="section">
+<h3><a name="Compression_and_packaging_formats">Compression and packaging formats</a></h3>
+<p>Tika uses the <a class="externalLink" href="http://commons.apache.org/compress/">Commons Compress</a> library to support various compression and packaging formats. The <a href="./api/org/apache/tika/parser/pkg/PackageParser.html">PackageParser</a> class and its subclasses first parse the top level compression or packaging format and then pass the unpacked document streams to a second parsing stage using the parser instance specified in the parse context.</p></div>
+<div class="section">
+<h3><a name="Text_formats">Text formats</a></h3>
+<p>Extracting text content from plain text files seems like a simple task until you start thinking of all the possible character encodings. The <a href="./api/org/apache/tika/parser/txt/TXTParser.html">TXTParser</a> class uses encoding detection code from the <a class="externalLink" href="http://site.icu-project.org/">ICU</a> project to automatically detect the character encoding of a text document.</p></div>
+<div class="section">
+<h3><a name="Audio_formats">Audio formats</a></h3>
+<p>Tika can detect several common audio formats and extract metadata from them. Even text extraction is supported for some audio files that contain lyrics or other textual content. The <a href="./api/org/apache/tika/parser/audio/AudioParser.html">AudioParser</a> and <a href="./api/org/apache/tika/parser/audio/MidiParser.html">MidiParser</a> classes use standard javax.sound features to process simple audio formats, and the <a href="./api/org/apache/tika/parser/mp3/Mp3Parser.html">Mp3Parser</a> class adds support for the widely used MP3 format.</p></div>
+<div class="section">
+<h3><a name="Image_formats">Image formats</a></h3>
+<p>The <a href="./api/org/apache/tika/parser/image/ImageParser.html">ImageParser</a> class uses the standard javax.imageio feature to extract simple metadata from image formats supported by the Java platform. More complex image metadata is available through the <a href="./api/org/apache/tika/parser/jpeg/JpegParser.html">JpegParser</a> class that uses the metadata-extractor library to supports Exif metadata extraction from Jpeg images.</p></div>
+<div class="section">
+<h3><a name="Video_formats">Video formats</a></h3>
+<p>Currently Tika only supports the Flash video format using a simple parsing algorithm implemented in the <a href="./api/org/apache/tika/parser/flv/FLVParser">FLVParser</a> class.</p></div>
+<div class="section">
+<h3><a name="Java_class_files_and_archives">Java class files and archives</a></h3>
+<p>The <a href="./api/org/apache/tika/parser/asm/ClassParser">ClassParser</a> class extracts class names and method signatures from Java class files, and the <a href="./api/org/apache/tika/parser/pkg/ZipParser.html">ZipParser</a> class supports also jar archives.</p></div>
+<div class="section">
+<h3><a name="The_mbox_format">The mbox format</a></h3>
+<p>The <a href="./api/org/apache/tika/parser/mbox/MboxParser.html">MboxParser</a> can extract email messages from the mbox format used by many email archives and Unix-style mailboxes.</p></div></div>
</div>
<div id="sidebar">
<div id="navigation">
Modified: tika/site/publish/1.0/gettingstarted.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.0/gettingstarted.html?rev=1582236&r1=1582235&r2=1582236&view=diff
==============================================================================
--- tika/site/publish/1.0/gettingstarted.html (original)
+++ tika/site/publish/1.0/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.0 build cons
ists of a number of components and produces the following main binaries:</p><dl><dt>tika-core/target/tika-core-1.0.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.0.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.0.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.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><p>The core library, tika-core, contains the key interface
s 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.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>
+<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.0.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.0.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.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>
+<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.0</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.0</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.0 release.</p><div><pre> org.apache.tika:tika-parsers:bundle:1.0
+ </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.0 release.</p>
+<div>
+<pre> org.apache.tika:tika-parsers:bundle:1.0
+- org.apache.tika:tika-core:jar:1.0:compile
+- edu.ucar:netcdf:jar:4.2-min:compile
| \- org.slf4j:slf4j-api:jar:1.5.6:compile
@@ -118,7 +151,12 @@
+- com.drewnoakes:metadata-extractor:jar:2.4.0-beta-1:compile
+- de.l3s.boilerpipe:boilerpipe:jar:1.1.0:compile
+- 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><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>
+ \- 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>
+<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>
... <!-- your other classpath entries -->
<pathelement location="path/to/tika-core-1.0.jar"/>
<pathelement location="path/to/tika-parsers-1.0.jar"/>
@@ -139,7 +177,15 @@
<pathelement location="path/to/asm-3.1.jar"/>
<pathelement location="path/to/log4j-1.2.14.jar"/>
<pathelement location="path/to/metadata-extractor-2.4.0-beta-1.jar"/>
-</classpath></pre></div><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><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><pre>usage: java -jar tika-app-1.0.jar [option] [file]
+</classpath></pre></div>
+<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>
+<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>
+<pre>usage: java -jar tika-app-1.0.jar [option] [file]
Options:
-? or --help Print this usage message
@@ -165,7 +211,10 @@ Description:
Use the "--gui" (or "-g") option to start
the Apache Tika GUI. You can drag and drop files
from a normal file explorer to the GUI window to
- extract text content and metadata from the files.</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
+ extract text content and metadata from the files.</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.0.jar --text \
| grep -q keyword</pre></div></div>
Modified: tika/site/publish/1.0/index.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.0/index.html?rev=1582236&r1=1582235&r2=1582236&view=diff
==============================================================================
--- tika/site/publish/1.0/index.html (original)
+++ tika/site/publish/1.0/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,49 @@
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.0<a name="Apache_Tika_1.0"></a></h2><p>The most notable changes in Tika 1.0 over the pr
evious 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><li>Configuration: The context class loader of the current thread is no longer used as the default for loading configured parser and detector classes. You can still pass an explicit class loader to the configuration mechanism to get the previous behaviour. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-565">TIKA-565</a>).</li><li>OSGi: The tika-core bundle will now automatically pick up and use any available Parser and Detector service
s when deployed to an OSGi environment. The tika-parsers bundle provides such services based on for all the supported file formats for which the upstream parser library is available. If you don't want to track all the parser libraries as separate OSGi bundles, you can use the tika-bundle bundle that packages tika-parsers together with all its upstream dependencies. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-565">TIKA-565</a>).</li><li>RTF: Hyperlinks in RTF documents are now extracted as an <i>a href=...</i>...<i>/a</i> element (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-632">TIKA-632</a>). The RTF parser is also now more robust when encountering too many closing {'s vs. opening {'s (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-733">TIKA-733</a>).</li><li>MS Word: From Word (.doc) documents we now extract optional hyphen as Unicode zero-width space (U+200B), and non-breaking hyphen as Unicode non-b
reaking hyphen (U+2011). (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-711">TIKA-711</a>).</li><li>Outlook: Tika can now process also attachments in Outlook messages. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-396">TIKA-396</a>).</li><li>MS Office: Performance of extracting embedded office docs was improved. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-753">TIKA-753</a>).</li><li>PDF: The PDF parser now extracts paragraphs within each page (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-742">TIKA-742</a>) and can now optionally extract text from PDF annotations (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-738">TIKA-738</a>). There's also an option to enable (the default) or disable auto-space insertion (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-724">TIKA-724</a>). </li><li>Language detection: Tika can now detect Belar
usian, Catalan, Esperanto, Galician, Lithuanian (TIKA-582), Romanian, Slovak, Slovenian, and Ukrainian (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-681">TIKA-681</a>).</li><li>Java: Tika no longer ships retrotranslated Java 1.4 binaries along with the normal ones that work with Java 5 and higher. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-744">TIKA-744</a>).</li><li>OpenOffice documents: header/footer text is now extracted for text, presentation and spreadsheet documents (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-736">TIKA-736</a>).</li></ul><p>The following people have contributed to Tika 1.0 by submitting or commenting on the issues resolved in this release:</p><ul><li>Andrzej Bialecki</li><li>Antoni Mylka</li><li>Benson Margulies</li><li>Chris A. Mattmann</li><li>Cristian Vat</li><li>Dave Meikle</li><li>David Smiley</li><li>Dennis Adler</li><li>Erik Hetzner</li><li>Ingo Renner</li><li>Jeremias
Maerki</li><li>Jeremy Anderson</li><li>Jeroen van Vianen</li><li>John Bartak</li><li>Jukka Zitting</li><li>Julien Nioche</li><li>Ken Krugler</li><li>Mark Butler</li><li>Maxim Valyanskiy</li><li>Michael Bryant</li><li>Michael McCandless </li><li>Nick Burch</li><li>Pablo Queixalos</li><li>Uwe Schindler</li><li>Žygimantas Medelis</li></ul><p>See <a class="externalLink" href="http://s.apache.org/Zk6">http://s.apache.org/Zk6</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.0<a name="Apache_Tika_1.0"></a></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>
+<li>Configuration: The context class loader of the current thread is no longer used as the default for loading configured parser and detector classes. You can still pass an explicit class loader to the configuration mechanism to get the previous behaviour. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-565">TIKA-565</a>).</li>
+<li>OSGi: The tika-core bundle will now automatically pick up and use any available Parser and Detector services when deployed to an OSGi environment. The tika-parsers bundle provides such services based on for all the supported file formats for which the upstream parser library is available. If you don't want to track all the parser libraries as separate OSGi bundles, you can use the tika-bundle bundle that packages tika-parsers together with all its upstream dependencies. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-565">TIKA-565</a>).</li>
+<li>RTF: Hyperlinks in RTF documents are now extracted as an <i>a href=...</i>...<i>/a</i> element (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-632">TIKA-632</a>). The RTF parser is also now more robust when encountering too many closing {'s vs. opening {'s (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-733">TIKA-733</a>).</li>
+<li>MS Word: From Word (.doc) documents we now extract optional hyphen as Unicode zero-width space (U+200B), and non-breaking hyphen as Unicode non-breaking hyphen (U+2011). (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-711">TIKA-711</a>).</li>
+<li>Outlook: Tika can now process also attachments in Outlook messages. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-396">TIKA-396</a>).</li>
+<li>MS Office: Performance of extracting embedded office docs was improved. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-753">TIKA-753</a>).</li>
+<li>PDF: The PDF parser now extracts paragraphs within each page (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-742">TIKA-742</a>) and can now optionally extract text from PDF annotations (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-738">TIKA-738</a>). There's also an option to enable (the default) or disable auto-space insertion (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-724">TIKA-724</a>). </li>
+<li>Language detection: Tika can now detect Belarusian, Catalan, Esperanto, Galician, Lithuanian (TIKA-582), Romanian, Slovak, Slovenian, and Ukrainian (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-681">TIKA-681</a>).</li>
+<li>Java: Tika no longer ships retrotranslated Java 1.4 binaries along with the normal ones that work with Java 5 and higher. (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-744">TIKA-744</a>).</li>
+<li>OpenOffice documents: header/footer text is now extracted for text, presentation and spreadsheet documents (<a class="externalLink" href="http://issues.apache.org/jira/browse/TIKA-736">TIKA-736</a>).</li></ul>
+<p>The following people have contributed to Tika 1.0 by submitting or commenting on the issues resolved in this release:</p>
+<ul>
+<li>Andrzej Bialecki</li>
+<li>Antoni Mylka</li>
+<li>Benson Margulies</li>
+<li>Chris A. Mattmann</li>
+<li>Cristian Vat</li>
+<li>Dave Meikle</li>
+<li>David Smiley</li>
+<li>Dennis Adler</li>
+<li>Erik Hetzner</li>
+<li>Ingo Renner</li>
+<li>Jeremias Maerki</li>
+<li>Jeremy Anderson</li>
+<li>Jeroen van Vianen</li>
+<li>John Bartak</li>
+<li>Jukka Zitting</li>
+<li>Julien Nioche</li>
+<li>Ken Krugler</li>
+<li>Mark Butler</li>
+<li>Maxim Valyanskiy</li>
+<li>Michael Bryant</li>
+<li>Michael McCandless </li>
+<li>Nick Burch</li>
+<li>Pablo Queixalos</li>
+<li>Uwe Schindler</li>
+<li>Žygimantas Medelis</li></ul>
+<p>See <a class="externalLink" href="http://s.apache.org/Zk6">http://s.apache.org/Zk6</a> for more details on these contributions.</p></div>
</div>
<div id="sidebar">
<div id="navigation">