You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tika.apache.org by ju...@apache.org on 2012/08/05 18:24:10 UTC
svn commit: r1369615 [12/15] - 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/css/ src/site/apt/1.2/
Modified: tika/site/publish/1.2/formats.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.2/formats.html?rev=1369615&r1=1369614&r2=1369615&view=diff
==============================================================================
--- tika/site/publish/1.2/formats.html (original)
+++ tika/site/publish/1.2/formats.html Sun Aug 5 16:24:07 2012
@@ -1,255 +1,255 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<!--
- 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.
--->
-
-
-
-
-
-
-
-<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>
- <style type="text/css" media="all">
- @import url("../css/site.css");
- </style>
- <link rel="icon" type="image/png" href="../tikaNoText16.png" />
- <script type="text/javascript">
- function selectProvider(form) {
- provider = form.elements['searchProvider'].value;
- if (provider == "any") {
- if (Math.random() > 0.5) {
- provider = "lucid";
- } else {
- provider = "sl";
- }
- }
- if (provider == "lucid") {
- form.action = "http://search.lucidimagination.com/p:tika";
- } else if (provider == "sl") {
- form.action = "http://search-lucene.com/tika";
- }
- days = 90;
- date = new Date();
- date.setTime(date.getTime() + (days * 24 * 60 * 60 * 1000));
- expires = "; expires=" + date.toGMTString();
- document.cookie = "searchProvider=" + provider + expires + "; path=/";
- }
- function initProvider() {
- if (document.cookie.length>0) {
- cStart=document.cookie.indexOf("searchProvider=");
- if (cStart!=-1) {
- cStart=cStart + "searchProvider=".length;
- cEnd=document.cookie.indexOf(";", cStart);
- if (cEnd==-1) {
- cEnd=document.cookie.length;
- }
- provider = unescape(document.cookie.substring(cStart,cEnd));
- document.forms['searchform'].elements['searchProvider'].value = provider;
- }
- }
- document.forms['searchform'].elements['q'].focus();
- }
- </script>
- </head>
- <body onLoad="initProvider();">
- <div id="body">
- <div id="banner">
- <a href="http://tika.apache.org" id="bannerLeft" title="Apache Tika"
- ><img src="http://tika.apache.org/tika.png" alt="Apache Tika"
- width="292" height="100"/></a>
- <a href="http://www.apache.org/" id="bannerRight"
- title="The Apache Software Foundation"
- ><img src="http://tika.apache.org/asf-logo.gif" alt="The Apache Software Foundation"
- 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 al
l 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 h
ref="#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><a name="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="#apiorgapachetikaparserhtmlHtmlParser.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><a name="XML_and_der
ived_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="#apiorgapachetikaparserxmlDcXMLParser.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><a name="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="#apior
gapachetikaparsermicrosoftOfficeParser.html">OfficeParser</a> and <a href="#apiorgapachetikaparsermicrosoftooxmlOOXMLParser.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><a name="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="#apiorgapachetikaparserodfOpenDocumentParser.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><a name="Portable_Document_Format"></a></h3><p>The <a href="#apiorgapachetikaparserpdfPDFParser.html">PDFParser</a> class parsers Portable Document Format (PDF) docum
ents 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><a name="Electronic_Publication_Format"></a></h3><p>The <a href="#apiorgapachetikaparserepubEpubParser.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><a name="Rich_Text_Format"></a></h3><p>The <a href="#apiorgapachetikaparserrtfRTFParser.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><a name="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="#apiorgapachetikaparserpkgPackageParser.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><a name="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="#apiorgapachetikaparsertxtTXTParser.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><a name="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="#apiorgapachetikaparseraudioAudioParser.html">AudioParser</a> and <a href="#apiorgapachetikaparseraudioMidiParser.html">MidiParser</a> classes use standard javax.sound features to process simple audio formats, and the <a href="#apiorgapachetikaparsermp3Mp3Parser.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><a name="Image_formats"></a></h3><p>The <a href="#apiorgapachetikaparserimageImageParser.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="#apiorgapachetikaparserjpegJpegParser.html">JpegParser</a> class that uses the metadata-extractor library to suppor
ts Exif metadata extraction from Jpeg images.</p></div><div class="section"><h3><a name="Video_formats">Video formats</a><a name="Video_formats"></a></h3><p>Currently Tika only supports the Flash video format using a simple parsing algorithm implemented in the <a href="#apiorgapachetikaparserflvFLVParser">FLVParser</a> class.</p></div><div class="section"><h3><a name="Java_class_files_and_archives">Java class files and archives</a><a name="Java_class_files_and_archives"></a></h3><p>The <a href="#apiorgapachetikaparserasmClassParser">ClassParser</a> class extracts class names and method signatures from Java class files, and the <a href="#apiorgapachetikaparserpkgZipParser.html">ZipParser</a> class supports also jar archives.</p></div><div class="section"><h3><a name="The_mbox_format">The mbox format</a><a name="The_mbox_format"></a></h3><p>The <a href="#apiorgapachetikaparsermboxMboxParser.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">
- <h5>Apache Tika</h5>
- <ul>
-
- <li class="none">
- <a href="../index.html">Introduction</a>
- </li>
-
- <li class="none">
- <a href="../download.html">Download</a>
- </li>
-
- <li class="none">
- <a href="../mail-lists.html">Mailing Lists</a>
- </li>
-
- <li class="none">
- <a href="http://wiki.apache.org/tika/" class="externalLink">Tika Wiki</a>
- </li>
-
- <li class="none">
- <a href="https://issues.apache.org/jira/browse/TIKA" class="externalLink">Issue Tracker</a>
- </li>
- </ul>
- <h5>Documentation</h5>
- <ul>
-
-
-
-
-
-
-
-
-
- <li class="expanded">
- <a href="../1.2/index.html">Apache Tika 1.2</a>
- <ul>
-
- <li class="none">
- <a href="../1.2/gettingstarted.html">Getting Started</a>
- </li>
-
- <li class="none">
- <strong>Supported Formats</strong>
- </li>
-
- <li class="none">
- <a href="../1.2/parser.html">Parser API</a>
- </li>
-
- <li class="none">
- <a href="../1.2/parser_guide.html">Parser 5min Quick Start Guide</a>
- </li>
-
- <li class="none">
- <a href="../1.2/detection.html">Content and Language Detection</a>
- </li>
-
- <li class="none">
- <a href="../1.2/api/">API Documentation</a>
- </li>
- </ul>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../1.1/index.html">Apache Tika 1.1</a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../1.0/index.html">Apache Tika 1.0</a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../0.10/index.html">Apache Tika 0.10</a>
- </li>
- </ul>
- <h5>The Apache Software Foundation</h5>
- <ul>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">About</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/security/" class="externalLink">Security</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsorship</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
- </li>
- </ul>
-
- <div id="search">
- <h5>Search with Apache Solr</h5>
- <form action="http://search.lucidimagination.com/p:tika"
- method="get" id="searchform">
- <input type="text" id="query" name="q"/>
- <select name="searchProvider" id="searchProvider">
- <option value="any">provider</option>
- <option value="lucid">Lucid Find</option>
- <option value="sl">Search-Lucene</option>
- </select>
- <input type="submit" id="submit" value="Search" name="Search"
- onclick="selectProvider(this.form)"/>
- </form>
- </div>
-
- <div id="bookpromo">
- <h5>Books about Tika</h5>
- <p>
- <a href="http://manning.com/mattmann/" title="Tika in Action"
- ><img src="../mattmann_cover150.jpg"
- width="150" height="186"/></a>
- </p>
- </div>
- </div>
- </div>
- <div id="footer">
- <p>
- Copyright © 2012
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- Site powered by <a href="http://maven.apache.org/">Apache Maven</a>.
- Search powered by
- <a href="http://www.lucidimagination.com">Lucid Imagination</a>
- and <a href="http://sematext.com">Sematext</a>.
- <br/>
- Apache Tika, Tika, Apache, the Apache feather logo, and the Apache
- Tika project logo are trademarks of The Apache Software Foundation.
- </p>
- </div>
- </div>
- </body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<!--
+ 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.
+-->
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <title>Supported Document Formats</title>
+ <style type="text/css" media="all">
+ @import url("../css/site.css");
+ </style>
+ <link rel="icon" type="image/png" href="../tikaNoText16.png" />
+ <script type="text/javascript">
+ function selectProvider(form) {
+ provider = form.elements['searchProvider'].value;
+ if (provider == "any") {
+ if (Math.random() > 0.5) {
+ provider = "lucid";
+ } else {
+ provider = "sl";
+ }
+ }
+ if (provider == "lucid") {
+ form.action = "http://search.lucidimagination.com/p:tika";
+ } else if (provider == "sl") {
+ form.action = "http://search-lucene.com/tika";
+ }
+ days = 90;
+ date = new Date();
+ date.setTime(date.getTime() + (days * 24 * 60 * 60 * 1000));
+ expires = "; expires=" + date.toGMTString();
+ document.cookie = "searchProvider=" + provider + expires + "; path=/";
+ }
+ function initProvider() {
+ if (document.cookie.length>0) {
+ cStart=document.cookie.indexOf("searchProvider=");
+ if (cStart!=-1) {
+ cStart=cStart + "searchProvider=".length;
+ cEnd=document.cookie.indexOf(";", cStart);
+ if (cEnd==-1) {
+ cEnd=document.cookie.length;
+ }
+ provider = unescape(document.cookie.substring(cStart,cEnd));
+ document.forms['searchform'].elements['searchProvider'].value = provider;
+ }
+ }
+ document.forms['searchform'].elements['q'].focus();
+ }
+ </script>
+ </head>
+ <body onLoad="initProvider();">
+ <div id="body">
+ <div id="banner">
+ <a href="http://tika.apache.org" id="bannerLeft" title="Apache Tika"
+ ><img src="http://tika.apache.org/tika.png" alt="Apache Tika"
+ width="292" height="100"/></a>
+ <a href="http://www.apache.org/" id="bannerRight"
+ title="The Apache Software Foundation"
+ ><img src="http://tika.apache.org/asf-logo.gif" alt="The Apache Software Foundation"
+ 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 al
l 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 h
ref="#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="#apiorgapachetikaparserhtmlHtmlParser.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 gen
eric 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="#apiorgapachetikaparserxmlDcXMLParser.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="#apiorgapachetikaparsermicrosoftOfficeParser.html">OfficeParser</a> and <a href="#apiorgapachetikaparsermicrosoftooxmlOOXMLParser.ht
ml">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="#apiorgapachetikaparserodfOpenDocumentParser.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="#apiorgapachetikaparserpdfPDFParser.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 For
mat</a></h3><p>The <a href="#apiorgapachetikaparserepubEpubParser.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="#apiorgapachetikaparserrtfRTFParser.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="#apiorgapachetikaparserpkgPackageParser.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="#apiorgapachetikaparsertxtTXTParser.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="#apiorgapachetikaparseraudioAudioParser.html">AudioParser</a> and <a href="#apiorgapachetikaparseraudioMidiParser.html">MidiParser</a> classes use standard javax.sound features to process simple audio formats,
and the <a href="#apiorgapachetikaparsermp3Mp3Parser.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="#apiorgapachetikaparserimageImageParser.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="#apiorgapachetikaparserjpegJpegParser.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="#apiorgapachetikaparserflvFLVParser">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="#apiorgapachetikaparserasmClassParser">ClassParser</a> class extracts class names and method signatures from Java class files, and the <a href="#apiorgapachetikaparserpkgZipParser.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="#apiorgapachetikaparsermboxMboxParser.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">
+ <h5>Apache Tika</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../index.html">Introduction</a>
+ </li>
+
+ <li class="none">
+ <a href="../download.html">Download</a>
+ </li>
+
+ <li class="none">
+ <a href="../mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/tika/" class="externalLink">Tika Wiki</a>
+ </li>
+
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/TIKA" class="externalLink">Issue Tracker</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../1.2/index.html">Apache Tika 1.2</a>
+ <ul>
+
+ <li class="none">
+ <a href="../1.2/gettingstarted.html">Getting Started</a>
+ </li>
+
+ <li class="none">
+ <strong>Supported Formats</strong>
+ </li>
+
+ <li class="none">
+ <a href="../1.2/parser.html">Parser API</a>
+ </li>
+
+ <li class="none">
+ <a href="../1.2/parser_guide.html">Parser 5min Quick Start Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1.2/detection.html">Content and Language Detection</a>
+ </li>
+
+ <li class="none">
+ <a href="../1.2/api/">API Documentation</a>
+ </li>
+ </ul>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../1.1/index.html">Apache Tika 1.1</a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../1.0/index.html">Apache Tika 1.0</a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../0.10/index.html">Apache Tika 0.10</a>
+ </li>
+ </ul>
+ <h5>The Apache Software Foundation</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">About</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/security/" class="externalLink">Security</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsorship</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+
+ <div id="search">
+ <h5>Search with Apache Solr</h5>
+ <form action="http://search.lucidimagination.com/p:tika"
+ method="get" id="searchform">
+ <input type="text" id="query" name="q"/>
+ <select name="searchProvider" id="searchProvider">
+ <option value="any">provider</option>
+ <option value="lucid">Lucid Find</option>
+ <option value="sl">Search-Lucene</option>
+ </select>
+ <input type="submit" id="submit" value="Search" name="Search"
+ onclick="selectProvider(this.form)"/>
+ </form>
+ </div>
+
+ <div id="bookpromo">
+ <h5>Books about Tika</h5>
+ <p>
+ <a href="http://manning.com/mattmann/" title="Tika in Action"
+ ><img src="../mattmann_cover150.jpg"
+ width="150" height="186"/></a>
+ </p>
+ </div>
+ </div>
+ </div>
+ <div id="footer">
+ <p>
+ Copyright © 2012
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ Site powered by <a href="http://maven.apache.org/">Apache Maven</a>.
+ Search powered by
+ <a href="http://www.lucidimagination.com">Lucid Imagination</a>
+ and <a href="http://sematext.com">Sematext</a>.
+ <br/>
+ Apache Tika, Tika, Apache, the Apache feather logo, and the Apache
+ Tika project logo are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+ </body>
+</html>
Modified: tika/site/publish/1.2/gettingstarted.html
URL: http://svn.apache.org/viewvc/tika/site/publish/1.2/gettingstarted.html?rev=1369615&r1=1369614&r2=1369615&view=diff
==============================================================================
--- tika/site/publish/1.2/gettingstarted.html (original)
+++ tika/site/publish/1.2/gettingstarted.html Sun Aug 5 16:24:07 2012
@@ -1,352 +1,376 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<!--
- 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.
--->
-
-
-
-
-
-
-
-<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>
- <style type="text/css" media="all">
- @import url("../css/site.css");
- </style>
- <link rel="icon" type="image/png" href="../tikaNoText16.png" />
- <script type="text/javascript">
- function selectProvider(form) {
- provider = form.elements['searchProvider'].value;
- if (provider == "any") {
- if (Math.random() > 0.5) {
- provider = "lucid";
- } else {
- provider = "sl";
- }
- }
- if (provider == "lucid") {
- form.action = "http://search.lucidimagination.com/p:tika";
- } else if (provider == "sl") {
- form.action = "http://search-lucene.com/tika";
- }
- days = 90;
- date = new Date();
- date.setTime(date.getTime() + (days * 24 * 60 * 60 * 1000));
- expires = "; expires=" + date.toGMTString();
- document.cookie = "searchProvider=" + provider + expires + "; path=/";
- }
- function initProvider() {
- if (document.cookie.length>0) {
- cStart=document.cookie.indexOf("searchProvider=");
- if (cStart!=-1) {
- cStart=cStart + "searchProvider=".length;
- cEnd=document.cookie.indexOf(";", cStart);
- if (cEnd==-1) {
- cEnd=document.cookie.length;
- }
- provider = unescape(document.cookie.substring(cStart,cEnd));
- document.forms['searchform'].elements['searchProvider'].value = provider;
- }
- }
- document.forms['searchform'].elements['q'].focus();
- }
- </script>
- </head>
- <body onLoad="initProvider();">
- <div id="body">
- <div id="banner">
- <a href="http://tika.apache.org" id="bannerLeft" title="Apache Tika"
- ><img src="http://tika.apache.org/tika.png" alt="Apache Tika"
- width="292" height="100"/></a>
- <a href="http://www.apache.org/" id="bannerRight"
- title="The Apache Software Foundation"
- ><img src="http://tika.apache.org/asf-logo.gif" alt="The Apache Software Foundation"
- 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 d
ocument 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 Tik
a 1.2 build consists of a number of components and produces the following main binaries:</p><dl><dt>tika-core/target/tika-core-1.2.jar</dt><dd> Tika core library. Contains the core interfaces and classes of Tika, but none of the parser implementations. Depends only on Java 5.</dd><dt>tika-parsers/target/tika-parsers-1.2.jar</dt><dd> Tika parsers. Collection of classes that implement the Tika Parser interface based on various external parser libraries.</dd><dt>tika-app/target/tika-app-1.2.jar</dt><dd> Tika application. Combines the above libraries and all the external parser libraries into a single runnable jar with a GUI and a command line interface.</dd><dt>tika-bundle/target/tika-bundle-1.2.jar</dt><dd> Tika bundle. An OSGi bundle that 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, co
ntains the key interfaces and classes of Tika and can be used by itself if you don't need the full set of parsers from the tika-parsers component. The tika-core dependency looks like this:</p><div><pre> <dependency>
- <groupId>org.apache.tika</groupId>
- <artifactId>tika-core</artifactId>
- <version>1.2</version>
- </dependency></pre></div><p>If you want to use Tika to parse documents (instead of simply detecting document types, etc.), you'll want to depend on tika-parsers instead: </p><div><pre> <dependency>
- <groupId>org.apache.tika</groupId>
- <artifactId>tika-parsers</artifactId>
- <version>1.2</version>
- </dependency></pre></div><p>Note that adding this dependency will introduce a number of transitive dependencies to your project, including one on tika-core. You need to make sure that these dependencies won't conflict with your existing project dependencies. The listing below shows all the compile-scope dependencies of tika-parsers in the Tika 1.2 release.</p><div><pre>+- org.apache.tika:tika-core:jar:1.2:compile
-+- org.gagravarr:vorbis-java-tika:jar:0.1:compile
-| \- org.gagravarr:vorbis-java-core:jar:tests:0.1:runtime
-+- org.apache.felix:org.apache.felix.scr.annotations:jar:1.6.0:provided
-+- edu.ucar:netcdf:jar:4.2-min:compile
-| \- org.slf4j:slf4j-api:jar:1.5.6:compile
-+- org.apache.james:apache-mime4j-core:jar:0.7:compile
-+- org.apache.james:apache-mime4j-dom:jar:0.7:compile
-+- org.apache.commons:commons-compress:jar:1.3:compile
-+- commons-codec:commons-codec:jar:1.5:compile
-+- org.apache.pdfbox:pdfbox:jar:1.6.0:compile
-| +- org.apache.pdfbox:fontbox:jar:1.6.0:compile
-| +- org.apache.pdfbox:jempbox:jar:1.6.0:compile
-| \- commons-logging:commons-logging:jar:1.2.1:compile
-+- org.bouncycastle:bcmail-jdk15:jar:1.45:compile
-+- org.bouncycastle:bcprov-jdk15:jar:1.45:compile
-+- org.apache.poi:poi:jar:3.8-beta5:compile
-+- org.apache.poi:poi-scratchpad:jar:3.8-beta5:compile
-+- org.apache.poi:poi-ooxml:jar:3.8-beta5:compile
-| +- org.apache.poi:poi-ooxml-schemas:jar:3.8-beta5:compile
-| | \- org.apache.xmlbeans:xmlbeans:jar:2.3.0:compile
-| \- dom4j:dom4j:jar:1.6.1:compile
-+- org.apache.geronimo.specs:geronimo-stax-api_1.0_spec:jar:1.0.1:compile
-+- org.ccil.cowan.tagsoup:tagsoup:jar:1.2.1:compile
-+- asm:asm:jar:3.1:compile
-+- com.googlecode.mp4parser:isoparser:jar:1.0-beta-5:compile
-| \- net.sf.scannotation:scannotation:jar:1.0.2:compile
-| \- javassist:javassist:jar:3.6.0.GA:compile
-+- com.drewnoakes:metadata-extractor:jar:2.4.0-beta-1:compile
-+- de.l3s.boilerpipe:boilerpipe:jar:1.2.0:compile
-+- rome:rome:jar:0.9:compile
-| \- jdom:jdom:jar:1.0:compile
-+- org.gagravarr:vorbis-java-core:jar:0.1:compile
-+- junit:junit:jar:4.10:test
-| \- org.hamcrest:hamcrest-core:jar:1.2:test
-+- org.mockito:mockito-core:jar:1.7:test
-| \- org.objenesis:objenesis:jar:1.0:test
-\- org.slf4j:slf4j-log4j12:jar:1.5.6:test
- \- 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><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.2.jar"/>
- <pathelement location="path/to/tika-parsers-1.2.jar"/>
- <pathelement location="path/to/commons-logging-1.2.1.jar"/>
- <pathelement location="path/to/commons-compress-1.0.jar"/>
- <pathelement location="path/to/pdfbox-1.2.0-incubating.jar"/>
- <pathelement location="path/to/fontbox-1.2.0-incubator.jar"/>
- <pathelement location="path/to/jempbox-1.2.0-incubator.jar"/>
- <pathelement location="path/to/poi-3.6.jar"/>
- <pathelement location="path/to/poi-scratchpad-3.6.jar"/>
- <pathelement location="path/to/poi-ooxml-3.6.jar"/>
- <pathelement location="path/to/poi-ooxml-schemas-3.6.jar"/>
- <pathelement location="path/to/xmlbeans-2.3.0.jar"/>
- <pathelement location="path/to/dom4j-1.6.1.jar"/>
- <pathelement location="path/to/xml-apis-1.0.b2.jar"/>
- <pathelement location="path/to/geronimo-stax-api_1.0_spec-1.0.jar"/>
- <pathelement location="path/to/tagsoup-1.2.jar"/>
- <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.2.jar) can be used as a command line utility for extracting text content and metadata from all sorts of files. This runnable jar contains all the dependencies it needs, so you don't need to worry about classpath settings to run it.</p><p>The usage instructions are shown below.</p><div><pre>usage: java -jar tika-app-1.2.jar [option] [file]
-
-Options:
- -? or --help Print this usage message
- -v or --verbose Print debug level messages
- -g or --gui Start the Apache Tika GUI
- -x or --xml Output XHTML content (default)
- -h or --html Output HTML content
- -t or --text Output plain text content
- -m or --metadata Output only metadata
-
-Description:
- Apache Tika will parse the file(s) specified on the
- command line and output the extracted text content
- or metadata to standard output.
-
- Instead of a file name you can also specify the URL
- of a document to be parsed.
-
- If no file name or URL is specified (or the special
- name "-" is used), then the standard input stream
- is parsed.
-
- 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
-curl http://.../document.doc \
- | java -jar tika-app-1.2.jar --text \
- | grep -q keyword</pre></div></div>
- </div>
- <div id="sidebar">
- <div id="navigation">
- <h5>Apache Tika</h5>
- <ul>
-
- <li class="none">
- <a href="../index.html">Introduction</a>
- </li>
-
- <li class="none">
- <a href="../download.html">Download</a>
- </li>
-
- <li class="none">
- <a href="../mail-lists.html">Mailing Lists</a>
- </li>
-
- <li class="none">
- <a href="http://wiki.apache.org/tika/" class="externalLink">Tika Wiki</a>
- </li>
-
- <li class="none">
- <a href="https://issues.apache.org/jira/browse/TIKA" class="externalLink">Issue Tracker</a>
- </li>
- </ul>
- <h5>Documentation</h5>
- <ul>
-
-
-
-
-
-
-
-
-
- <li class="expanded">
- <a href="../1.2/index.html">Apache Tika 1.2</a>
- <ul>
-
- <li class="none">
- <strong>Getting Started</strong>
- </li>
-
- <li class="none">
- <a href="../1.2/formats.html">Supported Formats</a>
- </li>
-
- <li class="none">
- <a href="../1.2/parser.html">Parser API</a>
- </li>
-
- <li class="none">
- <a href="../1.2/parser_guide.html">Parser 5min Quick Start Guide</a>
- </li>
-
- <li class="none">
- <a href="../1.2/detection.html">Content and Language Detection</a>
- </li>
-
- <li class="none">
- <a href="../1.2/api/">API Documentation</a>
- </li>
- </ul>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../1.1/index.html">Apache Tika 1.1</a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../1.0/index.html">Apache Tika 1.0</a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../0.10/index.html">Apache Tika 0.10</a>
- </li>
- </ul>
- <h5>The Apache Software Foundation</h5>
- <ul>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">About</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/security/" class="externalLink">Security</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsorship</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
- </li>
- </ul>
-
- <div id="search">
- <h5>Search with Apache Solr</h5>
- <form action="http://search.lucidimagination.com/p:tika"
- method="get" id="searchform">
- <input type="text" id="query" name="q"/>
- <select name="searchProvider" id="searchProvider">
- <option value="any">provider</option>
- <option value="lucid">Lucid Find</option>
- <option value="sl">Search-Lucene</option>
- </select>
- <input type="submit" id="submit" value="Search" name="Search"
- onclick="selectProvider(this.form)"/>
- </form>
- </div>
-
- <div id="bookpromo">
- <h5>Books about Tika</h5>
- <p>
- <a href="http://manning.com/mattmann/" title="Tika in Action"
- ><img src="../mattmann_cover150.jpg"
- width="150" height="186"/></a>
- </p>
- </div>
- </div>
- </div>
- <div id="footer">
- <p>
- Copyright © 2012
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- Site powered by <a href="http://maven.apache.org/">Apache Maven</a>.
- Search powered by
- <a href="http://www.lucidimagination.com">Lucid Imagination</a>
- and <a href="http://sematext.com">Sematext</a>.
- <br/>
- Apache Tika, Tika, Apache, the Apache feather logo, and the Apache
- Tika project logo are trademarks of The Apache Software Foundation.
- </p>
- </div>
- </div>
- </body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<!--
+ 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.
+-->
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <title>Getting Started with Apache Tika</title>
+ <style type="text/css" media="all">
+ @import url("../css/site.css");
+ </style>
+ <link rel="icon" type="image/png" href="../tikaNoText16.png" />
+ <script type="text/javascript">
+ function selectProvider(form) {
+ provider = form.elements['searchProvider'].value;
+ if (provider == "any") {
+ if (Math.random() > 0.5) {
+ provider = "lucid";
+ } else {
+ provider = "sl";
+ }
+ }
+ if (provider == "lucid") {
+ form.action = "http://search.lucidimagination.com/p:tika";
+ } else if (provider == "sl") {
+ form.action = "http://search-lucene.com/tika";
+ }
+ days = 90;
+ date = new Date();
+ date.setTime(date.getTime() + (days * 24 * 60 * 60 * 1000));
+ expires = "; expires=" + date.toGMTString();
+ document.cookie = "searchProvider=" + provider + expires + "; path=/";
+ }
+ function initProvider() {
+ if (document.cookie.length>0) {
+ cStart=document.cookie.indexOf("searchProvider=");
+ if (cStart!=-1) {
+ cStart=cStart + "searchProvider=".length;
+ cEnd=document.cookie.indexOf(";", cStart);
+ if (cEnd==-1) {
+ cEnd=document.cookie.length;
+ }
+ provider = unescape(document.cookie.substring(cStart,cEnd));
+ document.forms['searchform'].elements['searchProvider'].value = provider;
+ }
+ }
+ document.forms['searchform'].elements['q'].focus();
+ }
+ </script>
+ </head>
+ <body onLoad="initProvider();">
+ <div id="body">
+ <div id="banner">
+ <a href="http://tika.apache.org" id="bannerLeft" title="Apache Tika"
+ ><img src="http://tika.apache.org/tika.png" alt="Apache Tika"
+ width="292" height="100"/></a>
+ <a href="http://www.apache.org/" id="bannerRight"
+ title="The Apache Software Foundation"
+ ><img src="http://tika.apache.org/asf-logo.gif" alt="The Apache Software Foundation"
+ 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 d
ocument describes how to build Apache Tika from sources and how to start using Tika in an application.</p></div><div class="section"><h2>Getting and building the sources<a name="Getting_and_building_the_sources"></a></h2><p>To build Tika from sources you first need to either <a href="../download.html">download</a> a source release or <a href="../source-repository.html">checkout</a> the latest sources from version control.</p><p>Once you have the sources, you can build them using the <a class="externalLink" href="http://maven.apache.org/">Maven 2</a> build system. Executing the following command in the base directory will build the sources and install the resulting artifacts in your local Maven repository.</p><div><pre>mvn install
+</pre></div><p>See the Maven documentation for more information about the available build options.</p><p>Note that you need Java 5 or higher to build Tika.</p></div><div class="section"><h2>Build artifacts<a name="Build_artifacts"></a></h2><p>The Tika 1.2 build consists of a number of components and produces the following main binaries:</p><dl><dt>tika-core/target/tika-core-1.2.jar</dt><dd> Tika core library. Contains the core interfaces and classes of Tika, but none of the parser implementations. Depends only on Java 5.</dd><dt>tika-parsers/target/tika-parsers-1.2.jar</dt><dd> Tika parsers. Collection of classes that implement the Tika Parser interface based on various external parser libraries.</dd><dt>tika-app/target/tika-app-1.2.jar</dt><dd> Tika application. Combines the above libraries and all the external parser libraries into a single runnable jar with a GUI and a command line interface.</dd><dt>tika-bundle/target/tika-bundle-1.2.jar</dt><dd> Tika bundle. An OSGi bun
dle that combines tika-parsers with non-OSGified parser libraries to make them easy to deploy in an OSGi environment.</dd></dl></div><div class="section"><h2>Using Tika as a Maven dependency<a name="Using_Tika_as_a_Maven_dependency"></a></h2><p>The core library, tika-core, contains the key interfaces and classes of Tika and can be used by itself if you don't need the full set of parsers from the tika-parsers component. The tika-core dependency looks like this:</p><div><pre> <dependency>
+ <groupId>org.apache.tika</groupId>
+ <artifactId>tika-core</artifactId>
+ <version>1.2</version>
+ </dependency>
+</pre></div><p>If you want to use Tika to parse documents (instead of simply detecting document types, etc.), you'll want to depend on tika-parsers instead: </p><div><pre> <dependency>
+ <groupId>org.apache.tika</groupId>
+ <artifactId>tika-parsers</artifactId>
+ <version>1.2</version>
+ </dependency>
+</pre></div><p>Note that adding this dependency will introduce a number of transitive dependencies to your project, including one on tika-core. You need to make sure that these dependencies won't conflict with your existing project dependencies. The listing below shows all the compile-scope dependencies of tika-parsers in the Tika 1.2 release.</p><div><pre>+- org.apache.tika:tika-core:jar:1.2:compile
++- org.gagravarr:vorbis-java-tika:jar:0.1:compile
+| \- org.gagravarr:vorbis-java-core:jar:tests:0.1:runtime
++- org.apache.felix:org.apache.felix.scr.annotations:jar:1.6.0:provided
++- edu.ucar:netcdf:jar:4.2-min:compile
+| \- org.slf4j:slf4j-api:jar:1.5.6:compile
++- org.apache.james:apache-mime4j-core:jar:0.7:compile
++- org.apache.james:apache-mime4j-dom:jar:0.7:compile
++- org.apache.commons:commons-compress:jar:1.3:compile
++- commons-codec:commons-codec:jar:1.5:compile
++- org.apache.pdfbox:pdfbox:jar:1.6.0:compile
+| +- org.apache.pdfbox:fontbox:jar:1.6.0:compile
+| +- org.apache.pdfbox:jempbox:jar:1.6.0:compile
+| \- commons-logging:commons-logging:jar:1.2.1:compile
++- org.bouncycastle:bcmail-jdk15:jar:1.45:compile
++- org.bouncycastle:bcprov-jdk15:jar:1.45:compile
++- org.apache.poi:poi:jar:3.8-beta5:compile
++- org.apache.poi:poi-scratchpad:jar:3.8-beta5:compile
++- org.apache.poi:poi-ooxml:jar:3.8-beta5:compile
+| +- org.apache.poi:poi-ooxml-schemas:jar:3.8-beta5:compile
+| | \- org.apache.xmlbeans:xmlbeans:jar:2.3.0:compile
+| \- dom4j:dom4j:jar:1.6.1:compile
++- org.apache.geronimo.specs:geronimo-stax-api_1.0_spec:jar:1.0.1:compile
++- org.ccil.cowan.tagsoup:tagsoup:jar:1.2.1:compile
++- asm:asm:jar:3.1:compile
++- com.googlecode.mp4parser:isoparser:jar:1.0-beta-5:compile
+| \- net.sf.scannotation:scannotation:jar:1.0.2:compile
+| \- javassist:javassist:jar:3.6.0.GA:compile
++- com.drewnoakes:metadata-extractor:jar:2.4.0-beta-1:compile
++- de.l3s.boilerpipe:boilerpipe:jar:1.2.0:compile
++- rome:rome:jar:0.9:compile
+| \- jdom:jdom:jar:1.0:compile
++- org.gagravarr:vorbis-java-core:jar:0.1:compile
+
+</pre></div></div><div class="section"><h2>Using Tika in an Ant project<a name="Using_Tika_in_an_Ant_project"></a></h2><p>Unless you use a dependency manager tool like <a class="externalLink" href="http://ant.apache.org/ivy/">Apache Ivy</a>, the easiest way to use Tika is to include either the tika-core or the tika-app jar in your classpath, depending on whether you want just the core functionality or also all the parser implementations.</p><div><pre><classpath>
+ ... <!-- your other classpath entries -->
+
+ <!-- either: -->
+ <pathelement location="path/to/tika-core-${tika.version}.jar"/>
+ <!-- or: -->
+ <pathelement location="path/to/tika-app-${tika.version}.jar"/>
+
+</classpath>
+</pre></div></div><div class="section"><h2>Using Tika as a command line utility<a name="Using_Tika_as_a_command_line_utility"></a></h2><p>The Tika application jar (tika-app-1.2.jar) can be used as a command line utility for extracting text content and metadata from all sorts of files. This runnable jar contains all the dependencies it needs, so you don't need to worry about classpath settings to run it.</p><p>The usage instructions are shown below.</p><div><pre>Options:
+ -? or --help Print this usage message
+ -v or --verbose Print debug level messages
+ -V or --version Print the Apache Tika version number
+
+ -g or --gui Start the Apache Tika GUI
+ -s or --server Start the Apache Tika server
+ -f or --fork Use Fork Mode for out-of-process extraction
+
+ -x or --xml Output XHTML content (default)
+ -h or --html Output HTML content
+ -t or --text Output plain text content
+ -T or --text-main Output plain text content (main content only)
+ -m or --metadata Output only metadata
+ -j or --json Output metadata in JSON
+ -y or --xmp Output metadata in XMP
+ -l or --language Output only language
+ -d or --detect Detect document type
+ -eX or --encoding=X Use output encoding X
+ -pX or --password=X Use document password X
+ -z or --extract Extract all attachements into current directory
+ --extract-dir=<dir> Specify target directory for -z
+ -r or --pretty-print For XML and XHTML outputs, adds newlines and
+ whitespace, for better readability
+
+ --create-profile=X
+ Create NGram profile, where X is a profile name
+ --list-parsers
+ List the available document parsers
+ --list-parser-details
+ List the available document parsers, and their supported mime types
+ --list-detectors
+ List the available document detectors
+ --list-met-models
+ List the available metadata models, and their supported keys
+ --list-supported-types
+ List all known media types and related information
+
+Description:
+ Apache Tika will parse the file(s) specified on the
+ command line and output the extracted text content
+ or metadata to standard output.
+
+ Instead of a file name you can also specify the URL
+ of a document to be parsed.
+
+ If no file name or URL is specified (or the special
+ name "-" is used), then the standard input stream
+ is parsed. If no arguments were given and no input
+ data is available, the GUI is started instead.
+
+- GUI mode
+
+ 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.
+
+- Server mode
+
+ Use the "--server" (or "-s") option to start the
+ Apache Tika server. The server will listen to the
+ ports you specify as one or more arguments.
+</pre></div><p>You can also use the jar as a component in a Unix pipeline or as an external tool in many scripting languages.</p><div><pre># Check if an Internet resource contains a specific keyword
+curl http://.../document.doc \
+ | java -jar tika-app-1.2.jar --text \
+ | grep -q keyword
+</pre></div></div>
+ </div>
+ <div id="sidebar">
+ <div id="navigation">
+ <h5>Apache Tika</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../index.html">Introduction</a>
+ </li>
+
+ <li class="none">
+ <a href="../download.html">Download</a>
+ </li>
+
+ <li class="none">
+ <a href="../mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/tika/" class="externalLink">Tika Wiki</a>
+ </li>
+
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/TIKA" class="externalLink">Issue Tracker</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../1.2/index.html">Apache Tika 1.2</a>
+ <ul>
+
+ <li class="none">
+ <strong>Getting Started</strong>
+ </li>
+
+ <li class="none">
+ <a href="../1.2/formats.html">Supported Formats</a>
+ </li>
+
+ <li class="none">
+ <a href="../1.2/parser.html">Parser API</a>
+ </li>
+
+ <li class="none">
+ <a href="../1.2/parser_guide.html">Parser 5min Quick Start Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1.2/detection.html">Content and Language Detection</a>
+ </li>
+
+ <li class="none">
+ <a href="../1.2/api/">API Documentation</a>
+ </li>
+ </ul>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../1.1/index.html">Apache Tika 1.1</a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../1.0/index.html">Apache Tika 1.0</a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../0.10/index.html">Apache Tika 0.10</a>
+ </li>
+ </ul>
+ <h5>The Apache Software Foundation</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">About</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/security/" class="externalLink">Security</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsorship</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+
+ <div id="search">
+ <h5>Search with Apache Solr</h5>
+ <form action="http://search.lucidimagination.com/p:tika"
+ method="get" id="searchform">
+ <input type="text" id="query" name="q"/>
+ <select name="searchProvider" id="searchProvider">
+ <option value="any">provider</option>
+ <option value="lucid">Lucid Find</option>
+ <option value="sl">Search-Lucene</option>
+ </select>
+ <input type="submit" id="submit" value="Search" name="Search"
+ onclick="selectProvider(this.form)"/>
+ </form>
+ </div>
+
+ <div id="bookpromo">
+ <h5>Books about Tika</h5>
+ <p>
+ <a href="http://manning.com/mattmann/" title="Tika in Action"
+ ><img src="../mattmann_cover150.jpg"
+ width="150" height="186"/></a>
+ </p>
+ </div>
+ </div>
+ </div>
+ <div id="footer">
+ <p>
+ Copyright © 2012
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ Site powered by <a href="http://maven.apache.org/">Apache Maven</a>.
+ Search powered by
+ <a href="http://www.lucidimagination.com">Lucid Imagination</a>
+ and <a href="http://sematext.com">Sematext</a>.
+ <br/>
+ Apache Tika, Tika, Apache, the Apache feather logo, and the Apache
+ Tika project logo are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+ </body>
+</html>