You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tika.apache.org by ma...@apache.org on 2013/07/04 03:40:46 UTC
svn commit: r1499614 [6/7] - 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/ src/site/
src/site/apt/ src/site/apt/1.3/ src/site/apt/...
Modified: tika/site/publish/mail-lists.html
URL: http://svn.apache.org/viewvc/tika/site/publish/mail-lists.html?rev=1499614&r1=1499613&r2=1499614&view=diff
==============================================================================
--- tika/site/publish/mail-lists.html (original)
+++ tika/site/publish/mail-lists.html Thu Jul 4 01:40:44 2013
@@ -123,31 +123,31 @@
<li class="expanded">
- <a href="1.3/index.html">Apache Tika 1.3</a>
+ <a href="1.4/index.html">Apache Tika 1.4</a>
<ul>
<li class="none">
- <a href="1.3/gettingstarted.html">Getting Started</a>
+ <a href="1.4/gettingstarted.html">Getting Started</a>
</li>
<li class="none">
- <a href="1.3/formats.html">Supported Formats</a>
+ <a href="1.4/formats.html">Supported Formats</a>
</li>
<li class="none">
- <a href="1.3/parser.html">Parser API</a>
+ <a href="1.4/parser.html">Parser API</a>
</li>
<li class="none">
- <a href="1.3/parser_guide.html">Parser 5min Quick Start Guide</a>
+ <a href="1.4/parser_guide.html">Parser 5min Quick Start Guide</a>
</li>
<li class="none">
- <a href="1.3/detection.html">Content and Language Detection</a>
+ <a href="1.4/detection.html">Content and Language Detection</a>
</li>
<li class="none">
- <a href="1.3/api/">API Documentation</a>
+ <a href="1.4/api/">API Documentation</a>
</li>
</ul>
</li>
@@ -161,7 +161,7 @@
<li class="collapsed">
- <a href="1.2/index.html">Apache Tika 1.2</a>
+ <a href="1.3/index.html">Apache Tika 1.3</a>
</li>
@@ -173,7 +173,7 @@
<li class="collapsed">
- <a href="1.1/index.html">Apache Tika 1.1</a>
+ <a href="1.2/index.html">Apache Tika 1.2</a>
</li>
@@ -185,7 +185,7 @@
<li class="collapsed">
- <a href="1.0/index.html">Apache Tika 1.0</a>
+ <a href="1.1/index.html">Apache Tika 1.1</a>
</li>
@@ -197,7 +197,7 @@
<li class="collapsed">
- <a href="0.10/index.html">Apache Tika 0.10</a>
+ <a href="1.0/index.html">Apache Tika 1.0</a>
</li>
</ul>
<h5>The Apache Software Foundation</h5>
Modified: tika/site/publish/project-info.html
URL: http://svn.apache.org/viewvc/tika/site/publish/project-info.html?rev=1499614&r1=1499613&r2=1499614&view=diff
==============================================================================
--- tika/site/publish/project-info.html (original)
+++ tika/site/publish/project-info.html Thu Jul 4 01:40:44 2013
@@ -125,31 +125,31 @@
<li class="expanded">
- <a href="1.3/index.html">Apache Tika 1.3</a>
+ <a href="1.4/index.html">Apache Tika 1.4</a>
<ul>
<li class="none">
- <a href="1.3/gettingstarted.html">Getting Started</a>
+ <a href="1.4/gettingstarted.html">Getting Started</a>
</li>
<li class="none">
- <a href="1.3/formats.html">Supported Formats</a>
+ <a href="1.4/formats.html">Supported Formats</a>
</li>
<li class="none">
- <a href="1.3/parser.html">Parser API</a>
+ <a href="1.4/parser.html">Parser API</a>
</li>
<li class="none">
- <a href="1.3/parser_guide.html">Parser 5min Quick Start Guide</a>
+ <a href="1.4/parser_guide.html">Parser 5min Quick Start Guide</a>
</li>
<li class="none">
- <a href="1.3/detection.html">Content and Language Detection</a>
+ <a href="1.4/detection.html">Content and Language Detection</a>
</li>
<li class="none">
- <a href="1.3/api/">API Documentation</a>
+ <a href="1.4/api/">API Documentation</a>
</li>
</ul>
</li>
@@ -163,7 +163,7 @@
<li class="collapsed">
- <a href="1.2/index.html">Apache Tika 1.2</a>
+ <a href="1.3/index.html">Apache Tika 1.3</a>
</li>
@@ -175,7 +175,7 @@
<li class="collapsed">
- <a href="1.1/index.html">Apache Tika 1.1</a>
+ <a href="1.2/index.html">Apache Tika 1.2</a>
</li>
@@ -187,7 +187,7 @@
<li class="collapsed">
- <a href="1.0/index.html">Apache Tika 1.0</a>
+ <a href="1.1/index.html">Apache Tika 1.1</a>
</li>
@@ -199,7 +199,7 @@
<li class="collapsed">
- <a href="0.10/index.html">Apache Tika 0.10</a>
+ <a href="1.0/index.html">Apache Tika 1.0</a>
</li>
</ul>
<h5>The Apache Software Foundation</h5>
@@ -267,35 +267,3 @@
</div>
</body>
</html>
- </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/source-repository.html
URL: http://svn.apache.org/viewvc/tika/site/publish/source-repository.html?rev=1499614&r1=1499613&r2=1499614&view=diff
==============================================================================
--- tika/site/publish/source-repository.html (original)
+++ tika/site/publish/source-repository.html Thu Jul 4 01:40:44 2013
@@ -126,31 +126,31 @@ http-proxy-port = 3128
<li class="expanded">
- <a href="1.3/index.html">Apache Tika 1.3</a>
+ <a href="1.4/index.html">Apache Tika 1.4</a>
<ul>
<li class="none">
- <a href="1.3/gettingstarted.html">Getting Started</a>
+ <a href="1.4/gettingstarted.html">Getting Started</a>
</li>
<li class="none">
- <a href="1.3/formats.html">Supported Formats</a>
+ <a href="1.4/formats.html">Supported Formats</a>
</li>
<li class="none">
- <a href="1.3/parser.html">Parser API</a>
+ <a href="1.4/parser.html">Parser API</a>
</li>
<li class="none">
- <a href="1.3/parser_guide.html">Parser 5min Quick Start Guide</a>
+ <a href="1.4/parser_guide.html">Parser 5min Quick Start Guide</a>
</li>
<li class="none">
- <a href="1.3/detection.html">Content and Language Detection</a>
+ <a href="1.4/detection.html">Content and Language Detection</a>
</li>
<li class="none">
- <a href="1.3/api/">API Documentation</a>
+ <a href="1.4/api/">API Documentation</a>
</li>
</ul>
</li>
@@ -164,7 +164,7 @@ http-proxy-port = 3128
<li class="collapsed">
- <a href="1.2/index.html">Apache Tika 1.2</a>
+ <a href="1.3/index.html">Apache Tika 1.3</a>
</li>
@@ -176,7 +176,7 @@ http-proxy-port = 3128
<li class="collapsed">
- <a href="1.1/index.html">Apache Tika 1.1</a>
+ <a href="1.2/index.html">Apache Tika 1.2</a>
</li>
@@ -188,7 +188,7 @@ http-proxy-port = 3128
<li class="collapsed">
- <a href="1.0/index.html">Apache Tika 1.0</a>
+ <a href="1.1/index.html">Apache Tika 1.1</a>
</li>
@@ -200,7 +200,7 @@ http-proxy-port = 3128
<li class="collapsed">
- <a href="0.10/index.html">Apache Tika 0.10</a>
+ <a href="1.0/index.html">Apache Tika 1.0</a>
</li>
</ul>
<h5>The Apache Software Foundation</h5>
Modified: tika/site/publish/team-list.html
URL: http://svn.apache.org/viewvc/tika/site/publish/team-list.html?rev=1499614&r1=1499613&r2=1499614&view=diff
==============================================================================
--- tika/site/publish/team-list.html (original)
+++ tika/site/publish/team-list.html Thu Jul 4 01:40:44 2013
@@ -142,31 +142,31 @@ window.onLoad = init();
<li class="expanded">
- <a href="1.3/index.html">Apache Tika 1.3</a>
+ <a href="1.4/index.html">Apache Tika 1.4</a>
<ul>
<li class="none">
- <a href="1.3/gettingstarted.html">Getting Started</a>
+ <a href="1.4/gettingstarted.html">Getting Started</a>
</li>
<li class="none">
- <a href="1.3/formats.html">Supported Formats</a>
+ <a href="1.4/formats.html">Supported Formats</a>
</li>
<li class="none">
- <a href="1.3/parser.html">Parser API</a>
+ <a href="1.4/parser.html">Parser API</a>
</li>
<li class="none">
- <a href="1.3/parser_guide.html">Parser 5min Quick Start Guide</a>
+ <a href="1.4/parser_guide.html">Parser 5min Quick Start Guide</a>
</li>
<li class="none">
- <a href="1.3/detection.html">Content and Language Detection</a>
+ <a href="1.4/detection.html">Content and Language Detection</a>
</li>
<li class="none">
- <a href="1.3/api/">API Documentation</a>
+ <a href="1.4/api/">API Documentation</a>
</li>
</ul>
</li>
@@ -180,7 +180,7 @@ window.onLoad = init();
<li class="collapsed">
- <a href="1.2/index.html">Apache Tika 1.2</a>
+ <a href="1.3/index.html">Apache Tika 1.3</a>
</li>
@@ -192,7 +192,7 @@ window.onLoad = init();
<li class="collapsed">
- <a href="1.1/index.html">Apache Tika 1.1</a>
+ <a href="1.2/index.html">Apache Tika 1.2</a>
</li>
@@ -204,7 +204,7 @@ window.onLoad = init();
<li class="collapsed">
- <a href="1.0/index.html">Apache Tika 1.0</a>
+ <a href="1.1/index.html">Apache Tika 1.1</a>
</li>
@@ -216,7 +216,7 @@ window.onLoad = init();
<li class="collapsed">
- <a href="0.10/index.html">Apache Tika 0.10</a>
+ <a href="1.0/index.html">Apache Tika 1.0</a>
</li>
</ul>
<h5>The Apache Software Foundation</h5>
Added: tika/site/src/site/apt/1.3/detection.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/1.3/detection.apt?rev=1499614&view=auto
==============================================================================
--- tika/site/src/site/apt/1.3/detection.apt (added)
+++ tika/site/src/site/apt/1.3/detection.apt Thu Jul 4 01:40:44 2013
@@ -0,0 +1,152 @@
+ -----------------
+ Content Detection
+ -----------------
+
+~~ 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.
+
+Content Detection
+
+ This page gives you information on how content and language detection
+ works with Apache Tika, and how to tune the behaviour of Tika.
+
+%{toc|section=1|fromDepth=1}
+
+* {The Detector Interface}
+
+ The
+ {{{./api/org/apache/tika/detect/Detector.html}org.apache.tika.detect.Detector}}
+ 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:
+
+---
+MediaType detect(java.io.InputStream input,
+ Metadata metadata) throws java.io.IOException
+---
+
+ The <<<detect>>> method takes the stream to inspect, and a
+ <<<Metadata>>> object that holds any additional information on
+ the content. The detector will return a
+ {{{./api/org/apache/tika/mime/MediaType.html}MediaType}} object describing
+ its best guess as to the type of the file.
+
+ In general, only two keys on the Metadata object are used by Detectors.
+ These are <<<Metadata.RESOURCE_NAME_KEY>>> which should hold the name
+ of the file (where known), and <<<Metadata.CONTENT_TYPE>>> which should
+ hold the advertised content type of the file (eg from a webserver or
+ a content repository).
+
+
+* {Mime Magic Detction}
+
+ 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)
+
+ Tika is able to make use of a a mime magic info file, in the
+ {{{http://www.freedesktop.org/standards/shared-mime-info}Freedesktop MIME-info}}
+ format to peform mime magic detection.
+
+ This is provided within Tika by
+ {{{./api/org/apache/tika/detect/MagicDetector.html}org.apache.tika.detect.MagicDetector}}. It is most commonly access via
+ {{{./api/org/apache/tika/mime/MimeTypes.html}org.apache.tika.mime.MimeTypes}},
+ normally sourced from the <<<tika-mimetypes.xml>>> file.
+
+
+* {Resource Name Based Detection}
+
+ Where the name of the file is known, it is sometimes possible to guess
+ the file type from the name or extension. Within the
+ <<<tika-mimetypes.xml>>> file is a list of patterns which are used to
+ identify the type from the filename.
+
+ However, because files may be renamed, this method of detection is quick
+ but not always as accurate.
+
+ This is provided within Tika by
+ {{{./api/org/apache/tika/detect/NameDetector.html}org.apache.tika.detect.NameDetector}}.
+
+
+* {Known Content Type "Detection}
+
+ 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
+ {{{./api/org/apache/tika/mime/MimeTypes.html}org.apache.tika.mime.MimeTypes}},
+
+
+* {The default Mime Types Detector}
+
+ By default, the mime type detection in Tika is provided by
+ {{{./api/org/apache/tika/mime/MimeTypes.html}org.apache.tika.mime.MimeTypes}}.
+ This detector makes use of <<<tika-mimetypes.xml>>> to power
+ magic based and filename based detection.
+
+ 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 <<<Metadata.RESOURCE_NAME_KEY>>>) 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 <<<Metadata.CONTENT_TYPE>>>)
+ is used to further refine the type.
+
+
+* {Container Aware Detection}
+
+ 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.
+
+ 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.
+
+ 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.
+
+ Tika provides a wrapping detector in the parsers bundle, of
+ {{{./api/org/apache/tika/detect/ContainerAwareDetector.html}org.apache.tika.detect.ContainerAwareDetector}}.
+ 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
+ <<<MimeTypes>>> detector)
+
+ Because this detector needs to read the whole file to process the
+ container, it must be used with a
+ {{{./api/org/apache/tika/io/TikaInputStream.html}org.apache.tika.io.TikaInputStream}}.
+ If called with a regular <<<InputStream>>>, then all work will be done
+ by the fallback detector.
+
+ For more information on container formats and Tika, see
+ {{{http://wiki.apache.org/tika/MetadataDiscussion}}}
+
+
+* {Language Detection}
+
+ 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.
+
+ The language detection is provided by
+ {{{./api/org/apache/tika/language/LanguageIdentifier.html}org.apache.tika.language.LanguageIdentifier}}
Added: tika/site/src/site/apt/1.3/formats.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/1.3/formats.apt?rev=1499614&view=auto
==============================================================================
--- tika/site/src/site/apt/1.3/formats.apt (added)
+++ tika/site/src/site/apt/1.3/formats.apt Thu Jul 4 01:40:44 2013
@@ -0,0 +1,145 @@
+ --------------------------
+ Supported Document Formats
+ --------------------------
+
+~~ 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.
+
+Supported Document Formats
+
+ 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.
+
+%{toc|section=1|fromDepth=1}
+
+* {HyperText Markup Language}
+
+ The HyperText Markup Language (HTML) is the lingua franca of the web.
+ Tika uses the {{{http://home.ccil.org/~cowan/XML/tagsoup/}TagSoup}}
+ library to support virtually any kind of HTML found on the web.
+ The output from the
+ {{{api/org/apache/tika/parser/html/HtmlParser.html}HtmlParser}} 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.
+
+* {XML and derived formats}
+
+ 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
+ {{{api/org/apache/tika/parser/xml/DcXMLParser.html}DcXMLParser}}
+ 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.
+
+* {Microsoft Office document formats}
+
+ 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
+ {{{api/org/apache/tika/parser/microsoft/OfficeParser.html}OfficeParser}}
+ and
+ {{{api/org/apache/tika/parser/microsoft/ooxml/OOXMLParser.html}OOXMLParser}}
+ classes use {{{http://poi.apache.org/}Apache POI}} libraries to support
+ text and metadata extraction from both OLE2 and OOXML documents.
+
+* {OpenDocument Format}
+
+ The OpenDocument format (ODF) is used most notably as the default format
+ of the OpenOffice.org office suite. The
+ {{{api/org/apache/tika/parser/odf/OpenDocumentParser.html}OpenDocumentParser}}
+ class supports this format and the earlier OpenOffice 1.0 format on which
+ ODF is based.
+
+* {Portable Document Format}
+
+ The {{{api/org/apache/tika/parser/pdf/PDFParser.html}PDFParser}} class
+ parsers Portable Document Format (PDF) documents using the
+ {{{http://pdfbox.apache.org/}Apache PDFBox}} library.
+
+* {Electronic Publication Format}
+
+ The {{{api/org/apache/tika/parser/epub/EpubParser.html}EpubParser}} class
+ supports the Electronic Publication Format (EPUB) used for many digital
+ books.
+
+* {Rich Text Format}
+
+ The {{{api/org/apache/tika/parser/rtf/RTFParser.html}RTFParser}} class
+ uses the standard javax.swing.text.rtf feature to extract text content
+ from Rich Text Format (RTF) documents.
+
+* {Compression and packaging formats}
+
+ Tika uses the {{{http://commons.apache.org/compress/}Commons Compress}}
+ library to support various compression and packaging formats. The
+ {{{api/org/apache/tika/parser/pkg/PackageParser.html}PackageParser}}
+ 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.
+
+* {Text formats}
+
+ Extracting text content from plain text files seems like a simple task
+ until you start thinking of all the possible character encodings. The
+ {{{api/org/apache/tika/parser/txt/TXTParser.html}TXTParser}} class uses
+ encoding detection code from the {{{http://site.icu-project.org/}ICU}}
+ project to automatically detect the character encoding of a text document.
+
+* {Audio formats}
+
+ 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
+ {{{api/org/apache/tika/parser/audio/AudioParser.html}AudioParser}}
+ and {{{api/org/apache/tika/parser/audio/MidiParser.html}MidiParser}}
+ classes use standard javax.sound features to process simple audio
+ formats, and the
+ {{{api/org/apache/tika/parser/mp3/Mp3Parser.html}Mp3Parser}} class
+ adds support for the widely used MP3 format.
+
+* {Image formats}
+
+ The {{{api/org/apache/tika/parser/image/ImageParser.html}ImageParser}}
+ 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
+ {{{api/org/apache/tika/parser/jpeg/JpegParser.html}JpegParser}} class
+ that uses the metadata-extractor library to supports Exif metadata
+ extraction from Jpeg images.
+
+* {Video formats}
+
+ Currently Tika only supports the Flash video format using a simple
+ parsing algorithm implemented in the
+ {{{api/org/apache/tika/parser/flv/FLVParser}FLVParser}} class.
+
+* {Java class files and archives}
+
+ The {{{api/org/apache/tika/parser/asm/ClassParser}ClassParser}} class
+ extracts class names and method signatures from Java class files, and
+ the {{{api/org/apache/tika/parser/pkg/ZipParser.html}ZipParser}} class
+ supports also jar archives.
+
+* {The mbox format}
+
+ The {{{api/org/apache/tika/parser/mbox/MboxParser.html}MboxParser}} can
+ extract email messages from the mbox format used by many email archives
+ and Unix-style mailboxes.
Added: tika/site/src/site/apt/1.3/gettingstarted.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/1.3/gettingstarted.apt?rev=1499614&view=auto
==============================================================================
--- tika/site/src/site/apt/1.3/gettingstarted.apt (added)
+++ tika/site/src/site/apt/1.3/gettingstarted.apt Thu Jul 4 01:40:44 2013
@@ -0,0 +1,208 @@
+ --------------------------------
+ Getting Started with Apache Tika
+ --------------------------------
+
+~~ 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.
+
+Getting Started with Apache Tika
+
+ This document describes how to build Apache Tika from sources and
+ how to start using Tika in an application.
+
+Getting and building the sources
+
+ To build Tika from sources you first need to either
+ {{{../download.html}download}} a source release or
+ {{{../source-repository.html}checkout}} the latest sources from
+ version control.
+
+ Once you have the sources, you can build them using the
+ {{{http://maven.apache.org/}Maven 2}} build system. Executing the
+ following command in the base directory will build the sources
+ and install the resulting artifacts in your local Maven repository.
+
+---
+mvn install
+---
+
+ See the Maven documentation for more information about the available
+ build options.
+
+ Note that you need Java 5 or higher to build Tika.
+
+Build artifacts
+
+ The Tika build consists of a number of components and produces
+ the following main binaries:
+
+ [tika-core/target/tika-core-*.jar]
+ Tika core library. Contains the core interfaces and classes of Tika,
+ but none of the parser implementations. Depends only on Java 5.
+
+ [tika-parsers/target/tika-parsers-*.jar]
+ Tika parsers. Collection of classes that implement the Tika Parser
+ interface based on various external parser libraries.
+
+ [tika-app/target/tika-app-*.jar]
+ Tika application. Combines the above components and all the external
+ parser libraries into a single runnable jar with a GUI and a command
+ line interface.
+
+ [tika-bundle/target/tika-bundle-*.jar]
+ Tika bundle. An OSGi bundle that combines tika-parsers with non-OSGified
+ parser libraries to make them easy to deploy in an OSGi environment.
+
+Using Tika as a Maven dependency
+
+ The core library, tika-core, contains the key interfaces and classes of Tika
+ and can be used by itself if you don't need the full set of parsers from
+ the tika-parsers component. The tika-core dependency looks like this:
+
+---
+ <dependency>
+ <groupId>org.apache.tika</groupId>
+ <artifactId>tika-core</artifactId>
+ <version>...</version>
+ </dependency>
+---
+
+ If you want to use Tika to parse documents (instead of simply detecting
+ document types, etc.), you'll want to depend on tika-parsers instead:
+
+---
+ <dependency>
+ <groupId>org.apache.tika</groupId>
+ <artifactId>tika-parsers</artifactId>
+ <version>...</version>
+ </dependency>
+---
+
+ Note that adding this dependency will introduce a number of
+ transitive dependencies to your project, including one on tika-core.
+ You need to make sure that these dependencies won't conflict with your
+ existing project dependencies. You can use the following command in
+ the tika-parsers directory to get a full listing of all the dependencies.
+
+---
+$ mvn dependency:tree | grep :compile
+---
+
+Using Tika in an Ant project
+
+ Unless you use a dependency manager tool like
+ {{{http://ant.apache.org/ivy/}Apache Ivy}}, the easiest way to use
+ Tika is to include either the tika-core or the tika-app jar in your
+ classpath, depending on whether you want just the core functionality
+ or also all the parser implementations.
+
+---
+<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>
+---
+
+Using Tika as a command line utility
+
+ The Tika application jar (tika-app-*.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.
+
+ The usage instructions are shown below.
+
+---
+usage: java -jar tika-app.jar [option...] [file|port...]
+
+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.
+---
+
+ You can also use the jar as a component in a Unix pipeline or
+ as an external tool in many scripting languages.
+
+---
+# Check if an Internet resource contains a specific keyword
+curl http://.../document.doc \
+ | java -jar tika-app.jar --text \
+ | grep -q keyword
+---
Added: tika/site/src/site/apt/1.3/index.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/1.3/index.apt?rev=1499614&view=auto
==============================================================================
--- tika/site/src/site/apt/1.3/index.apt (added)
+++ tika/site/src/site/apt/1.3/index.apt Thu Jul 4 01:40:44 2013
@@ -0,0 +1,115 @@
+ ---------------
+ Apache Tika 1.3
+ ---------------
+
+~~ 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.
+
+Apache Tika 1.3
+
+ The most notable changes in Tika 1.3 over the previous release are:
+
+ * Mimetype definitions added for more common programming languages, including common extensions, but not magic patterns. ({{{http://issues.apache.org/jira/browse/TIKA-1055}TIKA-1055}})
+
+ * MS Word: When a Word (.doc) document contains embedded files or links to external documents, Tika now places a div class="embedded" id="_XXX"/ placeholder into the XHTML so you can see where in the main text the embedded document occurred ({{{http://issues.apache.org/jira/browse/TIKA-956}TIKA-956}}, {{{http://issues.apache.org/jira/browse/TIKA-1019}TIKA-1019}}).
+
+ * Embedded Wordpad/RTF documents are now recognized ({{{http://issues.apache.org/jira/browse/TIKA-982}TIKA-982}}).
+
+ * PDF: Text from pop-up annotations is now extracted ({{{http://issues.apache.org/jira/browse/TIKA-981}TIKA-981}}). Text from bookmarks is now extracted ({{{http://issues.apache.org/jira/browse/TIKA-1035}TIKA-1035}}).
+
+ * PKCS7: Detached signatures no longer through NullPointerException ({{{http://issues.apache.org/jira/browse/TIKA-986}TIKA-986}}).
+
+ * iWork: The chart name for charts embedded in numbers documents is now extracted ({{{http://issues.apache.org/jira/browse/TIKA-918}TIKA-918}}).
+
+ * CLI: TikaCLI -m now handles multi-valued metadata keys correctly (previously it only printed the first value). ({{{http://issues.apache.org/jira/browse/TIKA-920}TIKA-920}})
+
+ * MS Word (.docx): When a Word (.docx) document contains embedded files, Tika now places a div class="embedded" id="XXX"/ into the XHTML so you can see where in the main text the embedded document occurred. The id (rId) is included in the Metadata of each embedded document as the new Metadata.EMBEDDED_RELATIONSHIP_ID key, and TikaCLI prepends the rId (if present) onto the filename it extracts ({{{http://issues.apache.org/jira/browse/TIKA-989}TIKA-989}}). Fixed NullPointerException when style is null ({{{http://issues.apache.org/jira/browse/TIKA-1006}TIKA-1006}}). Text inside text boxes is now extracted ({{{http://issues.apache.org/jira/browse/TIKA-1005}TIKA-1005}}).
+
+ * RTF: Page, word, character count and creation date metadata are now extracted for RTF documents ({{{http://issues.apache.org/jira/browse/TIKA-999}TIKA-999}}).
+MS PowerPoint (.pptx): When a PowerPoint (.pptx) document contains embedded files, Tika now places a div class="embedded" id="XXX"/ into the XHTML so you can see where in the main text the embedded document occurred. The id (rId) is included in the Metadata of each embedded document as the new Metadata.EMBEDDED_RELATIONSHIP_ID key, and TikaCLI prepends the rId (if present) onto the filename it extracts ({{{http://issues.apache.org/jira/browse/TIKA-997}TIKA-997}}, {{{http://issues.apache.org/jira/browse/TIKA-1032}TIKA-1032}}).
+MS PowerPoint (.ppt): When a PowerPoint (.ppt) document contains embedded files, Tika now places a div class="embedded" id="XXX"/ into the XHTML so you can see where in the main text the embedded document occurred ({{{http://issues.apache.org/jira/browse/TIKA--1025}TIKA-1025}}). Text from the master slide is now extracted ({{{http://issues.apache.org/jira/browse/TIKA-712}TIKA-712}}).
+
+ * MHTML: fixed Null charset name exception when a mime part has an unrecognized charset ({{{http://issues.apache.org/jira/browse/TIKA-1011}TIKA-1011}}).
+
+ * MP3: if an ID3 tag was encoded in UTF-16 with only the BOM then on certain JVMs this would incorrectly extract the BOM as the tag's value ({{{http://issues.apache.org/jira/browse/TIKA-1024}TIKA-1024}}).
+
+ * ZIP: placeholders (div class="embedded" id="<entry name"/>) are now left in the XHTML so you can see where each archive member appears ({{{http://issues.apache.org/jira/browse/TIKA-1036}TIKA-1036}}). TikaCLI would hit FileNotFoundException when extracting files that were under sub-directories from a ZIP archive, because it failed to create the parent directories first ({{{http://issues.apache.org/jira/browse/TIKA-1031}TIKA-1031}}).
+
+ * XML: a space character is now added before each element ({{{http://issues.apache.org/jira/browse/TIKA-1048}TIKA-1048}})
+
+ The following people have contributed to Tika 1.3 by submitting or
+ commenting on the issues resolved in this release:
+
+ * Andrew Jackson
+
+ * Arthur Meneau
+
+ * Benoit MAGGI
+
+ * Bernhard Berger
+
+ * Chris A. Mattmann
+
+ * Christoph Brill
+
+ * Daniel Bonniot de Ruisselet
+
+ * David A. Patterson
+
+ * David Morana
+
+ * Emmanuel Hugonnet
+
+ * Erik Peterson
+
+ * Gary Karasiuk
+
+ * John Conwell
+
+ * Jonas Wilhelmsson
+
+ * Jukka Zitting
+
+ * Karel Zacek
+
+ * Ken Krugler
+
+ * Maciej Lizewski
+
+ * Marco Quaranta
+
+ * Markus Jelsma
+
+ * Michael McCandless
+
+ * Nick Burch
+
+ * Oliver Heger
+
+ * Paolo Nacci
+
+ * Qian Diao
+
+ * Ray Gauss II
+
+ * Richard Eccles
+
+ * Ryan McKinley
+
+ * Shinichiro Abe
+
+ * Sture Svensson
+
+ See {{http://s.apache.org/lYv}} for more details on these contributions.
Added: tika/site/src/site/apt/1.3/parser.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/1.3/parser.apt?rev=1499614&view=auto
==============================================================================
--- tika/site/src/site/apt/1.3/parser.apt (added)
+++ tika/site/src/site/apt/1.3/parser.apt Thu Jul 4 01:40:44 2013
@@ -0,0 +1,245 @@
+ --------------------
+ The Parser interface
+ --------------------
+
+~~ 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.
+
+The Parser interface
+
+ The
+ {{{api/org/apache/tika/parser/Parser.html}org.apache.tika.parser.Parser}}
+ interface is the key concept of Apache Tika. It hides the complexity of
+ different file formats and parsing libraries while providing a simple and
+ powerful mechanism for client applications to extract structured text
+ content and metadata from all sorts of documents. All this is achieved
+ with a single method:
+
+---
+void parse(
+ InputStream stream, ContentHandler handler, Metadata metadata,
+ ParseContext context) throws IOException, SAXException, TikaException;
+---
+
+ The <<<parse>>> method takes the document to be parsed and related metadata
+ as input and outputs the results as XHTML SAX events and extra metadata.
+ The parse context argument is used to specify context information (like
+ the current local) that is not related to any individual document.
+ The main criteria that lead to this design were:
+
+ [Streamed parsing] The interface should require neither the client
+ application nor the parser implementation to keep the full document
+ content in memory or spooled to disk. This allows even huge documents
+ to be parsed without excessive resource requirements.
+
+ [Structured content] A parser implementation should be able to
+ include structural information (headings, links, etc.) in the extracted
+ content. A client application can use this information for example to
+ better judge the relevance of different parts of the parsed document.
+
+ [Input metadata] A client application should be able to include metadata
+ like the file name or declared content type with the document to be
+ parsed. The parser implementation can use this information to better
+ guide the parsing process.
+
+ [Output metadata] A parser implementation should be able to return
+ document metadata in addition to document content. Many document
+ formats contain metadata like the name of the author that may be useful
+ to client applications.
+
+ [Context sensitivity] While the default settings and behaviour of Tika
+ parsers should work well for most use cases, there are still situations
+ where more fine-grained control over the parsing process is desirable.
+ It should be easy to inject such context-specific information to the
+ parsing process without breaking the layers of abstraction.
+
+ []
+
+ These criteria are reflected in the arguments of the <<<parse>>> method.
+
+* Document input stream
+
+ The first argument is an
+ {{{http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html}InputStream}}
+ for reading the document to be parsed.
+
+ If this document stream can not be read, then parsing stops and the thrown
+ {{{http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html}IOException}}
+ is passed up to the client application. If the stream can be read but
+ not parsed (for example if the document is corrupted), then the parser
+ throws a {{{api/org/apache/tika/exception/TikaException.html}TikaException}}.
+
+ The parser implementation will consume this stream but <will not close it>.
+ Closing the stream is the responsibility of the client application that
+ opened it in the first place. The recommended pattern for using streams
+ with the <<<parse>>> method is:
+
+---
+InputStream stream = ...; // open the stream
+try {
+ parser.parse(stream, ...); // parse the stream
+} finally {
+ stream.close(); // close the stream
+}
+---
+
+ Some document formats like the OLE2 Compound Document Format used by
+ Microsoft Office are best parsed as random access files. In such cases the
+ content of the input stream is automatically spooled to a temporary file
+ that gets removed once parsed. A future version of Tika may make it possible
+ to avoid this extra file if the input document is already a file in the
+ local file system. See
+ {{{https://issues.apache.org/jira/browse/TIKA-153}TIKA-153}} for the status
+ of this feature request.
+
+* XHTML SAX events
+
+ The parsed content of the document stream is returned to the client
+ application as a sequence of XHTML SAX events. XHTML is used to express
+ structured content of the document and SAX events enable streamed
+ processing. Note that the XHTML format is used here only to convey
+ structural information, not to render the documents for browsing!
+
+ The XHTML SAX events produced by the parser implementation are sent to a
+ {{{http://java.sun.com/j2se/1.5.0/docs/api/org/xml/sax/ContentHandler.html}ContentHandler}}
+ instance given to the <<<parse>>> method. If this the content handler
+ fails to process an event, then parsing stops and the thrown
+ {{{http://java.sun.com/j2se/1.5.0/docs/api/org/xml/sax/SAXException.html}SAXException}}
+ is passed up to the client application.
+
+ The overall structure of the generated event stream is (with indenting
+ added for clarity):
+
+---
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>...</title>
+ </head>
+ <body>
+ ...
+ </body>
+</html>
+---
+
+ Parser implementations typically use the
+ {{{apidocs/org/apache/tika/sax/XHTMLContentHandler.html}XHTMLContentHandler}}
+ utility class to generate the XHTML output.
+
+ Dealing with the raw SAX events can be a bit complex, so Apache Tika
+ comes with a number of utility classes that can be used to process and
+ convert the event stream to other representations.
+
+ For example, the
+ {{{api/org/apache/tika/sax/BodyContentHandler.html}BodyContentHandler}}
+ class can be used to extract just the body part of the XHTML output and
+ feed it either as SAX events to another content handler or as characters
+ to an output stream, a writer, or simply a string. The following code
+ snippet parses a document from the standard input stream and outputs the
+ extracted text content to standard output:
+
+---
+ContentHandler handler = new BodyContentHandler(System.out);
+parser.parse(System.in, handler, ...);
+---
+
+ Another useful class is
+ {{{api/org/apache/tika/parser/ParsingReader.html}ParsingReader}} that
+ uses a background thread to parse the document and returns the extracted
+ text content as a character stream:
+
+---
+InputStream stream = ...; // the document to be parsed
+Reader reader = new ParsingReader(parser, stream, ...);
+try {
+ ...; // read the document text using the reader
+} finally {
+ reader.close(); // the document stream is closed automatically
+}
+---
+
+* Document metadata
+
+ The third argument to the <<<parse>>> method is used to pass document
+ metadata both in and out of the parser. Document metadata is expressed
+ as an {{{api/org/apache/tika/metadata/Metadata.html}Metadata}} object.
+
+ The following are some of the more interesting metadata properties:
+
+ [Metadata.RESOURCE_NAME_KEY] The name of the file or resource that contains
+ the document.
+
+ A client application can set this property to allow the parser to use
+ file name heuristics to determine the format of the document.
+
+ The parser implementation may set this property if the file format
+ contains the canonical name of the file (for example the Gzip format
+ has a slot for the file name).
+
+ [Metadata.CONTENT_TYPE] The declared content type of the document.
+
+ A client application can set this property based on for example a HTTP
+ Content-Type header. The declared content type may help the parser to
+ correctly interpret the document.
+
+ The parser implementation sets this property to the content type according
+ to which the document was parsed.
+
+ [Metadata.TITLE] The title of the document.
+
+ The parser implementation sets this property if the document format
+ contains an explicit title field.
+
+ [Metadata.AUTHOR] The name of the author of the document.
+
+ The parser implementation sets this property if the document format
+ contains an explicit author field.
+
+ []
+
+ Note that metadata handling is still being discussed by the Tika development
+ team, and it is likely that there will be some (backwards incompatible)
+ changes in metadata handling before Tika 1.0.
+
+* Parse context
+
+ The final argument to the <<<parse>>> method is used to inject
+ context-specific information to the parsing process. This is useful
+ for example when dealing with locale-specific date and number formats
+ in Microsoft Excel spreadsheets. Another important use of the parse
+ context is passing in the delegate parser instance to be used by
+ two-phase parsers like the
+ {{{api/org/apache/parser/pkg/PackageParser.html}PackageParser}} subclasses.
+ Some parser classes allow customization of the parsing process through
+ strategy objects in the parse context.
+
+* Parser implementations
+
+ Apache Tika comes with a number of parser classes for parsing
+ {{{formats.html}various document formats}}. You can also extend Tika
+ with your own parsers, and of course any contributions to Tika are
+ warmly welcome.
+
+ The goal of Tika is to reuse existing parser libraries like
+ {{{http://www.pdfbox.org/}PDFBox}} or
+ {{{http://poi.apache.org/}Apache POI}} as much as possible, and so most
+ of the parser classes in Tika are adapters to such external libraries.
+
+ Tika also contains some general purpose parser implementations that are
+ not targeted at any specific document formats. The most notable of these
+ is the {{{apidocs/org/apache/tika/parser/AutoDetectParser.html}AutoDetectParser}}
+ class that encapsulates all Tika functionality into a single parser that
+ can handle any types of documents. This parser will automatically determine
+ the type of the incoming document based on various heuristics and will then
+ parse the document accordingly.
Added: tika/site/src/site/apt/1.3/parser_guide.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/1.3/parser_guide.apt?rev=1499614&view=auto
==============================================================================
--- tika/site/src/site/apt/1.3/parser_guide.apt (added)
+++ tika/site/src/site/apt/1.3/parser_guide.apt Thu Jul 4 01:40:44 2013
@@ -0,0 +1,135 @@
+ --------------------------------------------
+ Get Tika parsing up and running in 5 minutes
+ --------------------------------------------
+ Arturo Beltran
+ --------------------------------------------
+
+~~ 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.
+
+Get Tika parsing up and running in 5 minutes
+
+ 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.
+
+%{toc|section=1|fromDepth=1}
+
+* {Getting Started}
+
+ The {{{gettingstarted.html}Getting Started}} 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.
+
+
+* {Add your MIME-Type}
+
+ You first need to modify {{{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}}
+ in order to Tika can map the file extension with its MIME-Type. You should add something like this:
+
+---
+ <mime-type type="application/hello">
+ <glob pattern="*.hi"/>
+ </mime-type>
+---
+
+* {Create your Parser class}
+
+ 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:
+
+---
+/*
+ * 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.
+ *
+ * @Author: Arturo Beltran
+ */
+package org.apache.tika.parser.hello;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Collections;
+import java.util.Set;
+
+import org.apache.tika.exception.TikaException;
+import org.apache.tika.metadata.Metadata;
+import org.apache.tika.mime.MediaType;
+import org.apache.tika.parser.ParseContext;
+import org.apache.tika.parser.Parser;
+import org.apache.tika.sax.XHTMLContentHandler;
+import org.xml.sax.ContentHandler;
+import org.xml.sax.SAXException;
+
+public class HelloParser implements Parser {
+
+ private static final Set<MediaType> SUPPORTED_TYPES = Collections.singleton(MediaType.application("hello"));
+ public static final String HELLO_MIME_TYPE = "application/hello";
+
+ public Set<MediaType> getSupportedTypes(ParseContext context) {
+ return SUPPORTED_TYPES;
+ }
+
+ public void parse(
+ InputStream stream, ContentHandler handler,
+ Metadata metadata, ParseContext context)
+ throws IOException, SAXException, TikaException {
+
+ metadata.set(Metadata.CONTENT_TYPE, HELLO_MIME_TYPE);
+ metadata.set("Hello", "World");
+
+ XHTMLContentHandler xhtml = new XHTMLContentHandler(handler, metadata);
+ xhtml.startDocument();
+ xhtml.endDocument();
+ }
+
+ /**
+ * @deprecated This method will be removed in Apache Tika 1.0.
+ */
+ public void parse(
+ InputStream stream, ContentHandler handler, Metadata metadata)
+ throws IOException, SAXException, TikaException {
+ parse(stream, handler, metadata, new ParseContext());
+ }
+}
+---
+
+ Pay special attention to the definition of the SUPPORTED_TYPES static class
+ field in the parser class that defines what MIME-Types it supports.
+
+ 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.
+
+* {List the new parser}
+
+ 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.
+
+ List your new parser in:
+ {{{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}}
+
+
Added: tika/site/src/site/apt/1.4/detection.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/1.4/detection.apt?rev=1499614&view=auto
==============================================================================
--- tika/site/src/site/apt/1.4/detection.apt (added)
+++ tika/site/src/site/apt/1.4/detection.apt Thu Jul 4 01:40:44 2013
@@ -0,0 +1,152 @@
+ -----------------
+ Content Detection
+ -----------------
+
+~~ 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.
+
+Content Detection
+
+ This page gives you information on how content and language detection
+ works with Apache Tika, and how to tune the behaviour of Tika.
+
+%{toc|section=1|fromDepth=1}
+
+* {The Detector Interface}
+
+ The
+ {{{./api/org/apache/tika/detect/Detector.html}org.apache.tika.detect.Detector}}
+ 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:
+
+---
+MediaType detect(java.io.InputStream input,
+ Metadata metadata) throws java.io.IOException
+---
+
+ The <<<detect>>> method takes the stream to inspect, and a
+ <<<Metadata>>> object that holds any additional information on
+ the content. The detector will return a
+ {{{./api/org/apache/tika/mime/MediaType.html}MediaType}} object describing
+ its best guess as to the type of the file.
+
+ In general, only two keys on the Metadata object are used by Detectors.
+ These are <<<Metadata.RESOURCE_NAME_KEY>>> which should hold the name
+ of the file (where known), and <<<Metadata.CONTENT_TYPE>>> which should
+ hold the advertised content type of the file (eg from a webserver or
+ a content repository).
+
+
+* {Mime Magic Detction}
+
+ 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)
+
+ Tika is able to make use of a a mime magic info file, in the
+ {{{http://www.freedesktop.org/standards/shared-mime-info}Freedesktop MIME-info}}
+ format to peform mime magic detection.
+
+ This is provided within Tika by
+ {{{./api/org/apache/tika/detect/MagicDetector.html}org.apache.tika.detect.MagicDetector}}. It is most commonly access via
+ {{{./api/org/apache/tika/mime/MimeTypes.html}org.apache.tika.mime.MimeTypes}},
+ normally sourced from the <<<tika-mimetypes.xml>>> file.
+
+
+* {Resource Name Based Detection}
+
+ Where the name of the file is known, it is sometimes possible to guess
+ the file type from the name or extension. Within the
+ <<<tika-mimetypes.xml>>> file is a list of patterns which are used to
+ identify the type from the filename.
+
+ However, because files may be renamed, this method of detection is quick
+ but not always as accurate.
+
+ This is provided within Tika by
+ {{{./api/org/apache/tika/detect/NameDetector.html}org.apache.tika.detect.NameDetector}}.
+
+
+* {Known Content Type "Detection}
+
+ 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
+ {{{./api/org/apache/tika/mime/MimeTypes.html}org.apache.tika.mime.MimeTypes}},
+
+
+* {The default Mime Types Detector}
+
+ By default, the mime type detection in Tika is provided by
+ {{{./api/org/apache/tika/mime/MimeTypes.html}org.apache.tika.mime.MimeTypes}}.
+ This detector makes use of <<<tika-mimetypes.xml>>> to power
+ magic based and filename based detection.
+
+ 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 <<<Metadata.RESOURCE_NAME_KEY>>>) 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 <<<Metadata.CONTENT_TYPE>>>)
+ is used to further refine the type.
+
+
+* {Container Aware Detection}
+
+ 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.
+
+ 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.
+
+ 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.
+
+ Tika provides a wrapping detector in the parsers bundle, of
+ {{{./api/org/apache/tika/detect/ContainerAwareDetector.html}org.apache.tika.detect.ContainerAwareDetector}}.
+ 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
+ <<<MimeTypes>>> detector)
+
+ Because this detector needs to read the whole file to process the
+ container, it must be used with a
+ {{{./api/org/apache/tika/io/TikaInputStream.html}org.apache.tika.io.TikaInputStream}}.
+ If called with a regular <<<InputStream>>>, then all work will be done
+ by the fallback detector.
+
+ For more information on container formats and Tika, see
+ {{{http://wiki.apache.org/tika/MetadataDiscussion}}}
+
+
+* {Language Detection}
+
+ 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.
+
+ The language detection is provided by
+ {{{./api/org/apache/tika/language/LanguageIdentifier.html}org.apache.tika.language.LanguageIdentifier}}
Added: tika/site/src/site/apt/1.4/formats.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/1.4/formats.apt?rev=1499614&view=auto
==============================================================================
--- tika/site/src/site/apt/1.4/formats.apt (added)
+++ tika/site/src/site/apt/1.4/formats.apt Thu Jul 4 01:40:44 2013
@@ -0,0 +1,145 @@
+ --------------------------
+ Supported Document Formats
+ --------------------------
+
+~~ 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.
+
+Supported Document Formats
+
+ 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.
+
+%{toc|section=1|fromDepth=1}
+
+* {HyperText Markup Language}
+
+ The HyperText Markup Language (HTML) is the lingua franca of the web.
+ Tika uses the {{{http://home.ccil.org/~cowan/XML/tagsoup/}TagSoup}}
+ library to support virtually any kind of HTML found on the web.
+ The output from the
+ {{{api/org/apache/tika/parser/html/HtmlParser.html}HtmlParser}} 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.
+
+* {XML and derived formats}
+
+ 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
+ {{{api/org/apache/tika/parser/xml/DcXMLParser.html}DcXMLParser}}
+ 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.
+
+* {Microsoft Office document formats}
+
+ 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
+ {{{api/org/apache/tika/parser/microsoft/OfficeParser.html}OfficeParser}}
+ and
+ {{{api/org/apache/tika/parser/microsoft/ooxml/OOXMLParser.html}OOXMLParser}}
+ classes use {{{http://poi.apache.org/}Apache POI}} libraries to support
+ text and metadata extraction from both OLE2 and OOXML documents.
+
+* {OpenDocument Format}
+
+ The OpenDocument format (ODF) is used most notably as the default format
+ of the OpenOffice.org office suite. The
+ {{{api/org/apache/tika/parser/odf/OpenDocumentParser.html}OpenDocumentParser}}
+ class supports this format and the earlier OpenOffice 1.0 format on which
+ ODF is based.
+
+* {Portable Document Format}
+
+ The {{{api/org/apache/tika/parser/pdf/PDFParser.html}PDFParser}} class
+ parsers Portable Document Format (PDF) documents using the
+ {{{http://pdfbox.apache.org/}Apache PDFBox}} library.
+
+* {Electronic Publication Format}
+
+ The {{{api/org/apache/tika/parser/epub/EpubParser.html}EpubParser}} class
+ supports the Electronic Publication Format (EPUB) used for many digital
+ books.
+
+* {Rich Text Format}
+
+ The {{{api/org/apache/tika/parser/rtf/RTFParser.html}RTFParser}} class
+ uses the standard javax.swing.text.rtf feature to extract text content
+ from Rich Text Format (RTF) documents.
+
+* {Compression and packaging formats}
+
+ Tika uses the {{{http://commons.apache.org/compress/}Commons Compress}}
+ library to support various compression and packaging formats. The
+ {{{api/org/apache/tika/parser/pkg/PackageParser.html}PackageParser}}
+ 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.
+
+* {Text formats}
+
+ Extracting text content from plain text files seems like a simple task
+ until you start thinking of all the possible character encodings. The
+ {{{api/org/apache/tika/parser/txt/TXTParser.html}TXTParser}} class uses
+ encoding detection code from the {{{http://site.icu-project.org/}ICU}}
+ project to automatically detect the character encoding of a text document.
+
+* {Audio formats}
+
+ 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
+ {{{api/org/apache/tika/parser/audio/AudioParser.html}AudioParser}}
+ and {{{api/org/apache/tika/parser/audio/MidiParser.html}MidiParser}}
+ classes use standard javax.sound features to process simple audio
+ formats, and the
+ {{{api/org/apache/tika/parser/mp3/Mp3Parser.html}Mp3Parser}} class
+ adds support for the widely used MP3 format.
+
+* {Image formats}
+
+ The {{{api/org/apache/tika/parser/image/ImageParser.html}ImageParser}}
+ 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
+ {{{api/org/apache/tika/parser/jpeg/JpegParser.html}JpegParser}} class
+ that uses the metadata-extractor library to supports Exif metadata
+ extraction from Jpeg images.
+
+* {Video formats}
+
+ Currently Tika only supports the Flash video format using a simple
+ parsing algorithm implemented in the
+ {{{api/org/apache/tika/parser/flv/FLVParser}FLVParser}} class.
+
+* {Java class files and archives}
+
+ The {{{api/org/apache/tika/parser/asm/ClassParser}ClassParser}} class
+ extracts class names and method signatures from Java class files, and
+ the {{{api/org/apache/tika/parser/pkg/ZipParser.html}ZipParser}} class
+ supports also jar archives.
+
+* {The mbox format}
+
+ The {{{api/org/apache/tika/parser/mbox/MboxParser.html}MboxParser}} can
+ extract email messages from the mbox format used by many email archives
+ and Unix-style mailboxes.
Added: tika/site/src/site/apt/1.4/gettingstarted.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/1.4/gettingstarted.apt?rev=1499614&view=auto
==============================================================================
--- tika/site/src/site/apt/1.4/gettingstarted.apt (added)
+++ tika/site/src/site/apt/1.4/gettingstarted.apt Thu Jul 4 01:40:44 2013
@@ -0,0 +1,208 @@
+ --------------------------------
+ Getting Started with Apache Tika
+ --------------------------------
+
+~~ 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.
+
+Getting Started with Apache Tika
+
+ This document describes how to build Apache Tika from sources and
+ how to start using Tika in an application.
+
+Getting and building the sources
+
+ To build Tika from sources you first need to either
+ {{{../download.html}download}} a source release or
+ {{{../source-repository.html}checkout}} the latest sources from
+ version control.
+
+ Once you have the sources, you can build them using the
+ {{{http://maven.apache.org/}Maven 2}} build system. Executing the
+ following command in the base directory will build the sources
+ and install the resulting artifacts in your local Maven repository.
+
+---
+mvn install
+---
+
+ See the Maven documentation for more information about the available
+ build options.
+
+ Note that you need Java 5 or higher to build Tika.
+
+Build artifacts
+
+ The Tika build consists of a number of components and produces
+ the following main binaries:
+
+ [tika-core/target/tika-core-*.jar]
+ Tika core library. Contains the core interfaces and classes of Tika,
+ but none of the parser implementations. Depends only on Java 5.
+
+ [tika-parsers/target/tika-parsers-*.jar]
+ Tika parsers. Collection of classes that implement the Tika Parser
+ interface based on various external parser libraries.
+
+ [tika-app/target/tika-app-*.jar]
+ Tika application. Combines the above components and all the external
+ parser libraries into a single runnable jar with a GUI and a command
+ line interface.
+
+ [tika-bundle/target/tika-bundle-*.jar]
+ Tika bundle. An OSGi bundle that combines tika-parsers with non-OSGified
+ parser libraries to make them easy to deploy in an OSGi environment.
+
+Using Tika as a Maven dependency
+
+ The core library, tika-core, contains the key interfaces and classes of Tika
+ and can be used by itself if you don't need the full set of parsers from
+ the tika-parsers component. The tika-core dependency looks like this:
+
+---
+ <dependency>
+ <groupId>org.apache.tika</groupId>
+ <artifactId>tika-core</artifactId>
+ <version>...</version>
+ </dependency>
+---
+
+ If you want to use Tika to parse documents (instead of simply detecting
+ document types, etc.), you'll want to depend on tika-parsers instead:
+
+---
+ <dependency>
+ <groupId>org.apache.tika</groupId>
+ <artifactId>tika-parsers</artifactId>
+ <version>...</version>
+ </dependency>
+---
+
+ Note that adding this dependency will introduce a number of
+ transitive dependencies to your project, including one on tika-core.
+ You need to make sure that these dependencies won't conflict with your
+ existing project dependencies. You can use the following command in
+ the tika-parsers directory to get a full listing of all the dependencies.
+
+---
+$ mvn dependency:tree | grep :compile
+---
+
+Using Tika in an Ant project
+
+ Unless you use a dependency manager tool like
+ {{{http://ant.apache.org/ivy/}Apache Ivy}}, the easiest way to use
+ Tika is to include either the tika-core or the tika-app jar in your
+ classpath, depending on whether you want just the core functionality
+ or also all the parser implementations.
+
+---
+<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>
+---
+
+Using Tika as a command line utility
+
+ The Tika application jar (tika-app-*.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.
+
+ The usage instructions are shown below.
+
+---
+usage: java -jar tika-app.jar [option...] [file|port...]
+
+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.
+---
+
+ You can also use the jar as a component in a Unix pipeline or
+ as an external tool in many scripting languages.
+
+---
+# Check if an Internet resource contains a specific keyword
+curl http://.../document.doc \
+ | java -jar tika-app.jar --text \
+ | grep -q keyword
+---
Added: tika/site/src/site/apt/1.4/index.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/1.4/index.apt?rev=1499614&view=auto
==============================================================================
--- tika/site/src/site/apt/1.4/index.apt (added)
+++ tika/site/src/site/apt/1.4/index.apt Thu Jul 4 01:40:44 2013
@@ -0,0 +1,115 @@
+ ---------------
+ Apache Tika 1.4
+ ---------------
+
+~~ 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.
+
+Apache Tika 1.4
+
+ The most notable changes in Tika 1.4 over the previous release are:
+
+ * Removed a test HTML file with a poorly chosen GPL text in it
+ ({{{http://issues.apache.org/jira/browse/TIKA-1129}TIKA-1129}}).
+
+ * Improvements to tika-server to allow it to produce text/html and
+ text/xml content ({{{http://issues.apache.org/jira/browse/TIKA-1126}TIKA-1126}},
+ {{{http://issues.apache.org/jira/browse/TIKA-1127}TIKA-1127}}).
+
+ * Improvements were made to the Compressor Parser to handle g'zipped files
+ that require the decompressConcatenated option set to true
+ ({{{http://issues.apache.org/jira/browse/TIKA-1096}TIKA-1096}}).
+
+ * Addressed a typographic error that was preventing from detection of
+ awk files
+ ({{{http://issues.apache.org/jira/browse/TIKA-1081}TIKA-1081}}).
+
+ * Added a new end-point to Tika's JAX-RS REST server that only detects
+ the media-type based on a small portion of the document submitted
+ ({{{http://issues.apache.org/jira/browse/TIKA-1047}TIKA-1047}}).
+
+ * RTF: Ordered and unordered lists are now extracted
+ ({{{http://issues.apache.org/jira/browse/TIKA-1062}TIKA-1062}}).
+
+ * MP3: Audio duration is now extracted
+ ({{{http://issues.apache.org/jira/browse/TIKA-991}TIKA-991}})
+
+ * Java .class files: upgraded from ASM 3.1 to ASM 4.1 for parsing
+ the Java bytecodes ({{{http://issues.apache.org/jira/browse/TIKA-1053}TIKA-1053}}).
+
+ * Mime Types: Definitions extended to optionally include Link (URL) and
+ UTI, along with details for several common formats
+ ({{{http://issues.apache.org/jira/browse/TIKA-1012}TIKA-1012}} /
+ {{{http://issues.apache.org/jira/browse/TIKA-1083}TIKA-1083}})
+
+ * Exceptions when parsing OLE10 embedded documents, when parsing
+ summary information from Office documents, and when saving
+ embedded documennts in TikaCLI are now logged instead
+ of aborting extraction
+ ({{{http://issues.apache.org/jira/browse/TIKA-1074}TIKA-1074}})
+
+ * MS Word: line tabular character is now replaced with newline
+ ({{{http://issues.apache.org/jira/browse/TIKA-1128}TIKA-1128}})
+
+ * XML: ElementMetadataHandlers can now optionally accept duplicate
+ and empty values
+ ({{{http://issues.apache.org/jira/browse/TIKA-1133}TIKA-1133}})
+
+ The following people have contributed to Tika 1.4 by submitting or
+ commenting on the issues resolved in this release:
+
+ * Axel Dörfler
+
+ * Bernhard Berger
+
+ * Chris A. Mattmann
+
+ * Dave Meikle
+
+ * David Morana
+
+ * Giuseppe Totaro
+
+ * Gregory Chanan
+
+ * Jérémie Lesage
+
+ * Jukka Zitting
+
+ * Konstantin Privezentsev
+
+ * Lee Graber
+
+ * Lewis John McGibbney
+
+ * Marco Quaranta
+
+ * Markus Jelsma
+
+ * Michael McCandless
+
+ * Nick Burch
+
+ * Raimund Merkert
+
+ * Ray Gauss II
+
+ * Ryan McKinley
+
+ * T. Schmidt
+
+ * Vincent Massol
+
+ See {{http://s.apache.org/JPY}} for more details on these contributions.