<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ ModeShape (http://www.modeshape.org)
  ~
  ~ See the COPYRIGHT.txt file distributed with this work for information
  ~ regarding copyright ownership.  Some portions may be licensed
  ~ to Red Hat, Inc. under one or more contributor license agreements.
  ~ See the AUTHORS.txt file in the distribution for a full listing of 
  ~ individual contributors.
  ~
  ~ ModeShape is free software. Unless otherwise indicated, all code in ModeShape
  ~ is licensed to you under the terms of the GNU Lesser General Public License as
  ~ published by the Free Software Foundation; either version 2.1 of
  ~ the License, or (at your option) any later version.
  ~
  ~ ModeShape is distributed in the hope that it will be useful,
  ~ but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  ~ or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
  ~ for more details.
  ~
  ~ You should have received a copy of the GNU Lesser General Public License
  ~ along with this distribution; if not, write to:
  ~ Free Software Foundation, Inc.
  ~ 51 Franklin Street, Fifth Floor
  ~ Boston, MA  02110-1301  USA
  -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % CustomDTD SYSTEM "custom.dtd">
%CustomDTD;
]>
<book lang="en">
	<bookinfo>
		<title>ModeShape</title>
		<subtitle>Reference Guide</subtitle>
		<releaseinfo>&versionNumber;</releaseinfo>
		<productnumber>&versionNumber;</productnumber>
		<mediaobject>
			<imageobject role="fo">
				<imagedata fileref="modeshape-logo.png" align="center"/>
			</imageobject>
			<imageobject role="html">
				<imagedata fileref="modeshape-logo.png" depth="3cm"/>
			</imageobject>
		</mediaobject>
		<copyright>
			<year>&copyrightYear;</year>
			<holder>&copyrightHolder;</holder>
		</copyright>
		<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/author_group.xml"/>
	</bookinfo>
	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/preface.xml"/>
	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/introduction.xml"/>
	<part id="core-part">
		<title>ModeShape Core</title>
		<partintro>
			<para>
			  The ModeShape project organizes the codebase into a number of subprojects.  The most fundamental are those 
			  <emphasis>core libraries</emphasis>, including the graph API, connector framework, sequencing framework,
			  as well as the configuration and engine in which all the components run.  These are all topics covered
			  in this part of the document.
			</para>
			<para>The ModeShape implementation of the <ulink url="&JSR283;">JCR API</ulink> as well as some other
			  JCR-related components are covered in the <link linkend="jcr-part">next part</link>.
			</para>
		</partintro>
		<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/core/execution_context.xml"/>
	  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/core/graph.xml"/>
	  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/core/connector.xml"/>
	  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/core/sequencing.xml"/>
	</part>
	<part id="jcr-part">
		<title>ModeShape JCR</title>
		<partintro>
			<para>
			  The ModeShape project provides an implementation of the <ulink url="&JSR283;">JCR 2.0 API</ulink>, which is
			  built on top of the <link linkend="core-part">core libraries</link> discussed earlier.  This implementation
			  as well as a number of JCR-related components are described in this part of the document.
				But before talking about how to use the JCR API with a ModeShape repository, first we need to
				show how to set up a ModeShape engine.
			</para>
		</partintro>
	  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/jcr/configuration.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/jcr/jcr.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/jcr/query_and_search.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/jcr/web_access.xml"/>
  </part>
	<part id="provided-connectors-part">
		<title>Connector Library</title>
		<partintro>
			<para>
			  The ModeShape project provides a number of <link linkend="connector_framework">connectors</link> out-of-the-box.
			  These are ready to be used by simply including them in the classpath and <link linkend="configuration">configuring</link>
			  them as a repository source.
			</para>
		</partintro>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/connectors/in_memory.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/connectors/file_system.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/connectors/jdbc_storage.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/connectors/jcr.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/connectors/federation.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/connectors/subversion.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/connectors/jboss_cache.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/connectors/infinispan.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/connectors/disk.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/connectors/jdbc_metadata.xml"/>
	</part>
	<part id="provided-sequencers-part">
		<title>Sequencer Library</title>
		<partintro>
			<para>
			  The ModeShape project provides a number of <link linkend="sequencing_framework">sequencers</link> out-of-the-box.
			  These are ready to be used by simply including them in the classpath and <link linkend="configuration">configuring</link>
			  them appropriately.
			</para>
		</partintro>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/compact_node_types.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/xml.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/xsd.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/wsdl.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/zip.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/microsoft_office.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/java_source.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/java_class.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/image.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/mp3.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/ddl.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/text.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/teiid_model.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/sequencers/teiid_vdb.xml"/>
	</part>
	<part id="provided-mime-type-detectors-part">
		<title>MIME Type Detector Library</title>
		<partintro>
			<para>
			  The ModeShape project provides a number of <link linkend="mime-type-detectors">MIME type detectors</link> out-of-the-box.
			  These are ready to be used by simply including them in the classpath and 
			  configuring ModeShape to use them.
			</para>
		</partintro>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/mime_type_detectors/aperture.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/mime_type_detectors/custom_detectors.xml"/>
	</part>
	<part id="provided-text-extractors-part">
		<title>Text Extractor Library</title>
		<partintro>
			<para>
			  The ModeShape project provides a number of <link linkend="text-extractors">text extractors</link> out-of-the-box.
			  These are ready to be used by simply including them in the classpath and 
			  configuring ModeShape to use them.
			</para>
		</partintro>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/text_extractors/teiid_extractor.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/text_extractors/tika_extractor.xml"/>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/text_extractors/custom_extractors.xml"/>
	</part>
	<part id="administration-part">
		<title>Administration and Monitoring</title>
		<partintro>
			<para>
			  The ModeShape project provides an RHQ plugin for use in the Administrative Console available in JBossAS. 
			  The console is accessible at http://{host}:{port}/admin-console.
			</para>
		</partintro>
  	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/administration/admin_console.xml"/>
	</part>
	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/future.xml"/>
</book>
