------------------------
                       Jackrabbit Index Filters
                       ------------------------

~~ 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.

Jackrabbit Index Filters

   This is the Index Filters component of the Apache Jackrabbit project.
   This component contains filter classes that allow Jackrabbit to
   extract text content from binary properties for full text indexing.

* Supported document formats

   The following document formats and MIME types are currently supported:

     * Microsoft Word
       [org.apache.jackrabbit.core.query.MsWordTextFilter]

       * <<<application/vnd.ms-word>>>

       * <<<application/msword>>>

     * Microsoft Excel
       [org.apache.jackrabbit.core.query.MsExcelTextFilter]

       * <<<application/vnd.ms-excel>>>

     * Microsoft PowerPoint
       [org.apache.jackrabbit.core.query.MsPowerPointTextFilter] 

       * <<<application/vnd.ms-powerpoint>>>

       * <<<application/mspowerpoint>>>

     * Portable Document Format (PDF)
       [org.apache.jackrabbit.core.query.PdfTextFilter]

       * <<<application/pdf>>>

     * OpenOffice.org
       [org.apache.jackrabbit.core.query.OpenOfficeTextFilter]

       * <<<application/vnd.oasis.opendocument.database>>>

       * <<<application/vnd.oasis.opendocument.formula>>>

       * <<<application/vnd.oasis.opendocument.graphics>>>

       * <<<application/vnd.oasis.opendocument.presentation>>>

       * <<<application/vnd.oasis.opendocument.spreadsheet>>>

       * <<<application/vnd.oasis.opendocument.text>>>

     * Rich Text Format (RTF)
       [org.apache.jackrabbit.core.query.RTFTextFilter]

       * <<<application/rtf>>>

     * HyperText Markup Language (HTML)
       [org.apache.jackrabbit.core.query.HTMLTextFilter]

       * <<<text/html>>>

     * Extensible Markup Language (XML)
       [org.apache.jackrabbit.core.query.XMLTextFilter]

       * <<<text/xml>>>

* Using the index filters

   To use these index filters with the Jackrabbit Core:

     [[1]] add the jackrabbit-index-filters jar file and the dependencies
           defined in the Maven POM in the Jackrabbit classpath, and

     [[2]] add the fully qualified class names listed above in the
           "textFilterClasses" parameter of the "SearchIndex" configuration
           element of a Jackrabbit workspace configuration file
           (workspace.xml).

* More information

   See the javadocs of org.apache.jackrabbit.core.query.TextFilter in the
   {{{core.html}Jackrabbit Core}} compoment for more information.