You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2007/04/12 14:44:33 UTC
svn commit: r527905 - in /lenya/docu/src/documentation/content/xdocs:
docs/1_4/reference/repository/index.xml site.xml
Author: andreas
Date: Thu Apr 12 05:44:31 2007
New Revision: 527905
URL: http://svn.apache.org/viewvc?view=rev&rev=527905
Log:
Updated 1.4 repository docs
Modified:
lenya/docu/src/documentation/content/xdocs/docs/1_4/reference/repository/index.xml
lenya/docu/src/documentation/content/xdocs/site.xml
Modified: lenya/docu/src/documentation/content/xdocs/docs/1_4/reference/repository/index.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/1_4/reference/repository/index.xml?view=diff&rev=527905&r1=527904&r2=527905
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/1_4/reference/repository/index.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/docs/1_4/reference/repository/index.xml Thu Apr 12 05:44:31 2007
@@ -21,8 +21,6 @@
</header>
<body>
- <note>This document is a draft. It does not reflect the current implementation, but will evolve alongside the code.</note>
-
<section>
<title>The Lenya Repository API</title>
<p>
@@ -34,74 +32,55 @@
the document type registry and allows to create sessions.</dd>
<dt><strong>Session</strong></dt>
<dd>A session provides access to the publications and methods for transaction handling. Pending
- changes are not written to the repository until the session is saved.</dd>
+ changes are not written to the repository until the session is committed.</dd>
<dt><strong>Publication</strong></dt>
<dd>A publication consists of an arbitrary set of areas.</dd>
<dt><strong>Area</strong></dt>
<dd>An area consists of a set of content nodes with a site structure associated to them.</dd>
- <dt><strong>Content</strong></dt>
- <dd>The content object provides access to the content nodes.</dd>
- <dt><strong>ContentNode</strong></dt>
- <dd>A content node holds several language versions of a content item. Each content node
- has an ID which is unique in its area. Each content node has a <em>document type</em>,
- which applies to all language versions of the node. When a content node is added, the
- document type must be specified. Only document types which are registered in the
- repository's document type registry are supported.</dd>
<dt><strong>Document</strong></dt>
- <dd>A document is a language version of a content item. Each document has the following properties:
+ <dd>
+ A document is a language version of a content item. A document is identified
+ within the area by
<ul>
- <li>the language,</li>
+ <li>
+ the <acronym title="Universally Unique Identifier">UUID</acronym> which is shared
+ by all translations of a document, and
+ </li>
+ <li>the language.</li>
+ </ul>
+ <p>
+ Furthermore, documents have the following properties:
+ </p>
+ <ul>
+ <li>the <em>resource type</em> which specifies the content model of the document,</li>
+ <li>the mime type,</li>
<li>the content length, and</li>
<li>the last modification date.</li>
</ul>
The document provides access to its content via the methods <code>getInputStream()</code>
and <code>getOutputStream()</code>.
</dd>
- <dt><strong>DocumentType</strong></dt>
- <dd>The document type of a content node denotes the type of contents which may be stored
- in its documents. A document type is identified by a unique name. It may provide a
- schema, which can be used to validate XML contents upon saving. Furthermore, the mime type
- of documents is defined by the document type.</dd>
- <dt><strong>MetaData</strong></dt>
- <dd>...</dd>
- <dt><strong>Site</strong></dt>
- <dd>The site object provides access to the site structure.</dd>
+ <dt><strong>Resource Type</strong></dt>
+ <dd>The resource type of a document denotes the type of contents which may be stored
+ in its documents. A resource type is identified by a unique name. It may provide a
+ schema, which can be used to validate XML contents upon saving.
+ For more information, refer to the <a href="site:resource-types">resource types</a>
+ documenation.
+ </dd>
+ <dt><strong>Meta Data</strong></dt>
+ <dd>For more information, refer to the <a href="site:metadata">meta data</a> documentation.</dd>
+ <dt><strong>SiteStructure</strong></dt>
+ <dd>This object provides access to the site structure.</dd>
<dt><strong>SiteNode</strong></dt>
<dd>The site structure is a tree consisting of site nodes. Each site node has an ID which
is unique among its siblings. Thus, a site node can be located using a unique path
- of the form <code>/sections/news/message003</code>.</dd>
+ of the form <code>/sections/news/message003</code>. A site node can reference exactly
+ one UUID, but it is possible to have multiple site nodes point to the same UUID.
+ A site node contains a <code>Link</code> object for each translation.
+ This means that <code>/en/news</code> and <code>/de/nachrichten</code> can point to different
+ translations of the same document.
+ </dd>
</dl>
- </section>
-
- <section>
- <title>Repository Layout</title>
-
- <p>
- Lenya ships with a content repository implementation which is based on the
- <a href="http://www.jcp.org/aboutJava/communityprocess/final/jsr170/">Java Content Repository</a> API.
- The JCR repository used by Lenya comprises a set of workspaces, each of which represent an area
- of the document structure. For each area that is declared by a publication, a repository workspace
- is created.
- </p>
- <p>
- Publications are orthogonal to workspaces. Each publication can declare its own set of areas.
- Thus, the set of workspaces in the Lenya repository derives from the union of all areas declared by publications.
- </p>
- <figure src="site:repositoryWorkspaces.img" alt="Repository Workspaces"/>
-
- <p>
- The children of the root node of a workspace are called <em>publication JCR nodes</em>. Each publication JCR node
- has two children:
- </p>
- <ul>
- <li>the <em>content</em> JCR node, and</li>
- <li>the <em>site</em> JCR node.</li>
- </ul>
- <p>
- The content JCR node can have an arbitrary number of child nodes, which are called <em>content </em>
- </p>
-
-
</section>
</body>
Modified: lenya/docu/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/site.xml?view=diff&rev=527905&r1=527904&r2=527905
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/site.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/site.xml Thu Apr 12 05:44:31 2007
@@ -144,6 +144,7 @@
<reference href="reference/" label="Technical Reference">
<sitemaps14 href="lenya-sitemaps.html" label="Overview of Lenya Sitemaps" />
+ <repository href="repository/index.html" label="Repository"/>
<ac-restricted href="ac.html" label="Access Control Specification"/>
<usecase-framework href="usecase-framework/" label="Usecase Framework">
<usecase-framework-overview href="index.html" label="Overview"/>
@@ -163,7 +164,6 @@
<siteprotocol href="site.html" label="site:"/>
</protocols>
<link-management href="link-management.html" label="Link Management"/>
- <repository href="repository/index.html" label="Repository"/>
</reference>
<javadoc1.4 href="../../../../apidocs/1.4/index.html" label="Core API"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org