You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by un...@apache.org on 2004/09/26 13:08:57 UTC
svn commit: rev 47245 - in incubator/jackrabbit/trunk/xdocs: . arch arch/operate images style
Author: uncled
Date: Sun Sep 26 04:08:56 2004
New Revision: 47245
Added:
incubator/jackrabbit/trunk/xdocs/arch/operate/
incubator/jackrabbit/trunk/xdocs/arch/operate/index.xml
incubator/jackrabbit/trunk/xdocs/arch/operate/startup.xml
incubator/jackrabbit/trunk/xdocs/images/jackrabbitlogo.gif (contents, props changed)
incubator/jackrabbit/trunk/xdocs/style/
incubator/jackrabbit/trunk/xdocs/style/project.css
Modified:
incubator/jackrabbit/trunk/xdocs/arch/deploy.xml
incubator/jackrabbit/trunk/xdocs/arch/index.xml
incubator/jackrabbit/trunk/xdocs/arch/overview.xml
incubator/jackrabbit/trunk/xdocs/navigation.xml
Log:
Some more xdocs.
css: background-color fix
Modified: incubator/jackrabbit/trunk/xdocs/arch/deploy.xml
==============================================================================
--- incubator/jackrabbit/trunk/xdocs/arch/deploy.xml (original)
+++ incubator/jackrabbit/trunk/xdocs/arch/deploy.xml Sun Sep 26 04:08:56 2004
@@ -17,7 +17,7 @@
<document>
<properties>
- <title>Overview</title>
+ <title>Jackrabbit Deployment Models</title>
<author email="jackrabbit-dev@incubator.apache.org">Jackrabbit Documentation team</author>
<revision>$Id: $</revision>
</properties>
Modified: incubator/jackrabbit/trunk/xdocs/arch/index.xml
==============================================================================
--- incubator/jackrabbit/trunk/xdocs/arch/index.xml (original)
+++ incubator/jackrabbit/trunk/xdocs/arch/index.xml Sun Sep 26 04:08:56 2004
@@ -17,7 +17,7 @@
<document>
<properties>
- <title>Overview</title>
+ <title>Architecture Documentation</title>
<author email="jackrabbit-dev@incubator.apache.org">Jackrabbit Documentation team</author>
<revision>$Id: $</revision>
</properties>
Added: incubator/jackrabbit/trunk/xdocs/arch/operate/index.xml
==============================================================================
--- (empty file)
+++ incubator/jackrabbit/trunk/xdocs/arch/operate/index.xml Sun Sep 26 04:08:56 2004
@@ -0,0 +1,39 @@
+<?xml version="1.0"?>
+<!--
+ Copyright 2003-2004 The Apache Software Foundation
+
+ Licensed 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.
+ -->
+<document>
+
+ <properties>
+ <title>Jackrabbit operations explained</title>
+ <author email="jackrabbit-dev@incubator.apache.org">Jackrabbit Documentation team</author>
+ <revision>$Id: $</revision>
+ </properties>
+
+ <body>
+
+<section name="Core Content Repository Operations">
+<p>
+This section describes how the Core Repository of Jackrabbit
+operates, segmented into a number of common operations.
+</p>
+<p>
+<a href="startup.html">Start-up, Initialize and Configration</a><br />
+What happens on start-up? What can be configured? <a href="startup.html">more...</a>
+</p>
+</section>
+
+</body>
+</document>
Added: incubator/jackrabbit/trunk/xdocs/arch/operate/startup.xml
==============================================================================
--- (empty file)
+++ incubator/jackrabbit/trunk/xdocs/arch/operate/startup.xml Sun Sep 26 04:08:56 2004
@@ -0,0 +1,85 @@
+<?xml version="1.0"?>
+<!--
+ Copyright 2003-2004 The Apache Software Foundation
+
+ Licensed 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.
+ -->
+<document>
+
+ <properties>
+ <title>Core operations: Startup, Initialize and Configuration</title>
+ <author email="jackrabbit-dev@incubator.apache.org">Jackrabbit Documentation team</author>
+ <revision>$Id: $</revision>
+ </properties>
+
+ <body>
+
+<section name="Core Content Repository Operations: Startup, Initialize and Configuration">
+<p>
+The lifecycle of any Jackrabbit Content Repository starts with a call to one of
+the <code>RepositoryFactory.create()</code> methods passing optionally the source
+of a repository configuration file (which by convention is called <code>config.xml</code>)
+and the RepositoryFactoryHome, which points to a directory from which the
+Repository will continue reading further information for start-up and in
+many cases will store the actual data that is persisted in the repository and
+its workspaces.
+</p>
+<p>
+Not supplying the <code>RepositoryFactoryHome</code> will default to the
+users home dir from the System property <code>user.dir</code>.
+</p>
+<p>
+Not supplying the configuration file parameter will default to the value of
+<code>Repository.factory.config</code> System Property and if that is not set
+it will default to the <code>config.xml</code> in the
+<code>RepositoryFactoryHome</code>.
+</p>
+<p>
+Calling the <code>create()</code> method will instantiate the
+<code>RepositoryFactory</code> singleton that will then, through the
+<code>getRepository(String name)</code> method, serve as the factory for
+Repository instances.
+</p>
+<p>
+As per the <code>config.xml</code> a repository are started up with the
+respectively configured <code>RepositoryStore</code>, the <code>RepositoryStore</code>
+defines where the repository stores information that is visible for the entire
+Repository which includes things like the uuid of the root node, repository
+properties, the namespace registry, node type definitions or the version
+backing store in a file structure as follows.
+</p>
+<p>
+<source>
+./meta:
+rep.properties
+rootUUID
+
+./namespaces:
+ns_reg.properties
+
+./nodetypes:
+custom_nodetypes.xml
+
+./versions:
+</source>
+</p>
+<p>
+The RepositoryStore normally points to a regular (i.e. local) file system but is abstracted through an abstract FileSystem that can be configured to point to a different FileSystem implementation, in case the above information should be stored in a different data container.
+</p>
+<p>
+... to be continued ...
+</p>
+</section>
+
+</body>
+</document>
Modified: incubator/jackrabbit/trunk/xdocs/arch/overview.xml
==============================================================================
--- incubator/jackrabbit/trunk/xdocs/arch/overview.xml (original)
+++ incubator/jackrabbit/trunk/xdocs/arch/overview.xml Sun Sep 26 04:08:56 2004
@@ -17,7 +17,7 @@
<document>
<properties>
- <title>Overview</title>
+ <title>Jackrabbit Architecture Overview</title>
<author email="jackrabbit-dev@incubator.apache.org">Jackrabbit Documentation team</author>
<revision>$Id: $</revision>
</properties>
Added: incubator/jackrabbit/trunk/xdocs/images/jackrabbitlogo.gif
==============================================================================
Binary file. No diff available.
Modified: incubator/jackrabbit/trunk/xdocs/navigation.xml
==============================================================================
--- incubator/jackrabbit/trunk/xdocs/navigation.xml (original)
+++ incubator/jackrabbit/trunk/xdocs/navigation.xml Sun Sep 26 04:08:56 2004
@@ -18,14 +18,17 @@
<title>Jackrabbit</title>
<body>
<menu name="Apache Jackrabbit">
- <item name="Overview" href="/index.html" />
- <item name="Architecture Documentation" href="/arch/index.html" collapse="true">
- <item name="Overview" href="arch/overview.html"/>
- <item name="Deployment Options" href="arch/deploy.html"/>
+ <item name="Overview" href="/index.html" />
+ <item name="Architecture Doc" href="/arch/index.html" collapse="true">
+ <item name="Overview" href="/arch/overview.html"/>
+ <item name="Deployment Options" href="/arch/deploy.html"/>
+ <item name="Core Operations" href="/arch/operate/index.html" collapse="true">
+ <item name="Start-up, Initialize" href="/arch/operate/startup.html"/>
+ </item>
</item>
- <item name="API Documentation" href="/apidocs/index.html" target="_blank"/>
- <item name="Layout" href="/layout.html"/>
- <item name="Downloads" href="/downloads.html"/>
+ <item name="API Documentation" href="/apidocs/index.html" target="_blank"/>
+ <item name="Layout" href="/layout.html"/>
+ <item name="Downloads" href="/downloads.html"/>
</menu>
</body>
</project>
Added: incubator/jackrabbit/trunk/xdocs/style/project.css
==============================================================================
--- (empty file)
+++ incubator/jackrabbit/trunk/xdocs/style/project.css Sun Sep 26 04:08:56 2004
@@ -0,0 +1,2 @@
+BODY
+ { background-color: #fff }
\ No newline at end of file