You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by th...@apache.org on 2006/07/31 10:24:18 UTC
svn commit: r427042 [35/39] - in /lenya/site: community/ docs/ docs/1_2_x/
docs/1_2_x/components/ docs/1_2_x/components/accesscontrol/
docs/1_2_x/components/asset-management/ docs/1_2_x/components/authoring/
docs/1_2_x/components/deployment/ docs/1_2_x...
Added: lenya/site/docs/1_4/installation/subversion.html
URL: http://svn.apache.org/viewvc/lenya/site/docs/1_4/installation/subversion.html?rev=427042&view=auto
==============================================================================
--- lenya/site/docs/1_4/installation/subversion.html (added)
+++ lenya/site/docs/1_4/installation/subversion.html Mon Jul 31 01:24:07 2006
@@ -0,0 +1,316 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Lenya 1.4 Subversion Guide</title>
+<link type="text/css" href="../../../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../../../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../../../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../../../skin/profile.css" rel="stylesheet">
+<script src="../../../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../../../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../../../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../../../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://lenya.apache.org/">lenya</a><script src="../../../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href=""><img class="logoImage" alt="Lenya" src="../../../images/apache-lenya-light.png" title=""></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href=""></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="lenya.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with ');" size="25" name="q" id="query" type="text" value="Search the site with ">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../../../index.html">Project</a>
+</li>
+<li class="current">
+<a class="selected" href="../../../docs/index.html">Documentation</a>
+</li>
+<li>
+<a class="unselected" href="../../../community/index.html">Community</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="selected" href="../../../docs/1_4/index.html">Version 1.4</a><a class="unselected" href="../../../docs/modules/index.html">Modules</a><a class="unselected" href="../../../docs/1_2_x/index.html">Version 1.2</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../../../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Version 1.4</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../../docs/1_4/index.html">Index</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/faq.html">FAQs</a>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.3', '../../../skin/')" id="menu_selected_1.1.3Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Installation</div>
+<div id="menu_selected_1.1.3" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/index.html">Download</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Subversion Access</div>
+<div class="menupageitemgroup">
+<div class="menupageitem">
+<a href="#For+the+public">For the public</a>
+</div>
+<div class="menupageitem">
+<a href="#For+committers">For committers</a>
+</div>
+<div class="menupageitem">
+<a href="#View+Subversion">View Subversion</a>
+</div>
+<div class="menupageitem">
+<a href="#Subversion+Tips">Subversion Tips</a>
+</div>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/source_version.html">Install Instructions</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.4', '../../../skin/')" id="menu_1.1.4Title" class="menutitle">Concepts</div>
+<div id="menu_1.1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/publication.html">Publication</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/urlMapping.html">URL Mapping</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/authoring_live.html">Authoring and Live mode</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/wysiwyg.html">WYSIWYG</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5', '../../../skin/')" id="menu_1.1.5Title" class="menutitle">Technical Reference</div>
+<div id="menu_1.1.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/lenya-sitemaps.html">Overview of Lenya Sitemaps</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5.2', '../../../skin/')" id="menu_1.1.5.2Title" class="menutitle">Usecase Framework</div>
+<div id="menu_1.1.5.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/usecase-framework/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/usecase-framework/abstractusecase.html">AbstractUsecase</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/publication-templating/index.html">Publication Templating</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/resource-types.html">Resource Types</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/modules/index.html">Modules</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/metadata.html">Meta data</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5.7', '../../../skin/')" id="menu_1.1.5.7Title" class="menutitle">Protocols</div>
+<div id="menu_1.1.5.7" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/lenya.html">lenya:</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/lenyadoc.html">lenyadoc:</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/link-management.html">Link Management</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/notification.html">Notification</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/repository/index.html">Repository</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../apidocs/1.4/index.html">1.4 API (Javadoc)</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2">
+<a href="http://apachecon.com/"><img border="0" title="ApacheCon EU 2006" alt="ApacheCon EU 2006 - logo" src="http://www.eu.apachecon.com/konferenzen/apachecon06/images/header-left.gif" style="width: 150px;height: 50px;"></a>
+</div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="subversion.pdf"><img alt="PDF -icon" src="../../../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>Lenya 1.4 Subversion Guide</h1>
+
+
+<a name="N1000E"></a><a name="For+the+public"></a>
+<h2 class="h3">For the public</h2>
+<div class="section">
+<p>
+Start the shell of your choice and enter:
+</p>
+<pre class="code">
+svn co http://svn.apache.org/repos/asf/lenya/trunk lenya-1.4.x
+</pre>
+</div>
+
+
+<a name="N1001C"></a><a name="For+committers"></a>
+<h2 class="h3">For committers</h2>
+<div class="section">
+<p>
+Start the shell of your choice and enter:
+</p>
+<pre class="code">
+svn co https://svn.apache.org/repos/asf/lenya/trunk lenya-1.4.x
+ssh -l username svn.apache.org
+svnpasswd username
+exit
+</pre>
+</div>
+
+
+<a name="N1002A"></a><a name="View+Subversion"></a>
+<h2 class="h3">View Subversion</h2>
+<div class="section">
+<p>
+
+<a href="http://svn.apache.org/viewcvs.cgi/lenya/#dirlist">http://svn.apache.org/viewcvs.cgi/lenya/#dirlist</a>
+
+</p>
+</div>
+
+
+<a name="N10038"></a><a name="Subversion+Tips"></a>
+<h2 class="h3">Subversion Tips</h2>
+<div class="section">
+<p>
+Installing the SVN client with SSL enabled on Debian Woody:
+</p>
+<pre class="code">
+apt-get install openssl
+apt-get install libssl-dev (Important Header Files)
+
+./configure --with-ssl
+make
+make install (su)
+svn --version
+</pre>
+</div>
+
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2002-2005 <a href="http://www.apache.org/licenses/LICENSE-2.0">The Apache Software Foundation.</a>
+</div>
+<div id="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:dev@lenya.apache.org?subject=Feedback%C2%A0for%C2%A0docs/1_4/installation/subversion.html">dev@lenya.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: lenya/site/docs/1_4/installation/subversion.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: lenya/site/docs/1_4/installation/subversion.pdf
URL: http://svn.apache.org/viewvc/lenya/site/docs/1_4/installation/subversion.pdf?rev=427042&view=auto
==============================================================================
Binary file - no diff available.
Propchange: lenya/site/docs/1_4/installation/subversion.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: lenya/site/docs/1_4/reference/lenya-sitemaps.html
URL: http://svn.apache.org/viewvc/lenya/site/docs/1_4/reference/lenya-sitemaps.html?rev=427042&view=auto
==============================================================================
--- lenya/site/docs/1_4/reference/lenya-sitemaps.html (added)
+++ lenya/site/docs/1_4/reference/lenya-sitemaps.html Mon Jul 31 01:24:07 2006
@@ -0,0 +1,511 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Overview of the Lenya Sitemaps</title>
+<link type="text/css" href="../../../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../../../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../../../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../../../skin/profile.css" rel="stylesheet">
+<script src="../../../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../../../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../../../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../../../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://lenya.apache.org/">lenya</a><script src="../../../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href=""><img class="logoImage" alt="Lenya" src="../../../images/apache-lenya-light.png" title=""></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href=""></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="lenya.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with ');" size="25" name="q" id="query" type="text" value="Search the site with ">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../../../index.html">Project</a>
+</li>
+<li class="current">
+<a class="selected" href="../../../docs/index.html">Documentation</a>
+</li>
+<li>
+<a class="unselected" href="../../../community/index.html">Community</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="selected" href="../../../docs/1_4/index.html">Version 1.4</a><a class="unselected" href="../../../docs/modules/index.html">Modules</a><a class="unselected" href="../../../docs/1_2_x/index.html">Version 1.2</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../../../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Version 1.4</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../../docs/1_4/index.html">Index</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/faq.html">FAQs</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3', '../../../skin/')" id="menu_1.1.3Title" class="menutitle">Installation</div>
+<div id="menu_1.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/index.html">Download</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/subversion.html">Subversion Access</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/source_version.html">Install Instructions</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.4', '../../../skin/')" id="menu_1.1.4Title" class="menutitle">Concepts</div>
+<div id="menu_1.1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/publication.html">Publication</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/urlMapping.html">URL Mapping</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/authoring_live.html">Authoring and Live mode</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/wysiwyg.html">WYSIWYG</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.5', '../../../skin/')" id="menu_selected_1.1.5Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Technical Reference</div>
+<div id="menu_selected_1.1.5" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Overview of Lenya Sitemaps</div>
+<div class="menupageitemgroup">
+<div class="menupageitem">
+<a href="#Introduction">Introduction</a>
+</div>
+<div class="menupageitem">
+<a title="Authoring Area, Live Area, CMS GUI and several Publications" href="#Authoring+Area%2C+Live+Area%2C+CMS+GUI+and+several+Publications">Authoring Area, Liv...</a>
+</div>
+<div class="menupageitem">
+<a title="The Lenya URI space" href="#The+Lenya+URI+space">The Lenya URI space...</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5.2', '../../../skin/')" id="menu_1.1.5.2Title" class="menutitle">Usecase Framework</div>
+<div id="menu_1.1.5.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/usecase-framework/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/usecase-framework/abstractusecase.html">AbstractUsecase</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/publication-templating/index.html">Publication Templating</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/resource-types.html">Resource Types</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/modules/index.html">Modules</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/metadata.html">Meta data</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5.7', '../../../skin/')" id="menu_1.1.5.7Title" class="menutitle">Protocols</div>
+<div id="menu_1.1.5.7" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/lenya.html">lenya:</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/lenyadoc.html">lenyadoc:</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/link-management.html">Link Management</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/notification.html">Notification</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/repository/index.html">Repository</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../apidocs/1.4/index.html">1.4 API (Javadoc)</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2">
+<a href="http://apachecon.com/"><img border="0" title="ApacheCon EU 2006" alt="ApacheCon EU 2006 - logo" src="http://www.eu.apachecon.com/konferenzen/apachecon06/images/header-left.gif" style="width: 150px;height: 50px;"></a>
+</div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="lenya-sitemaps.pdf"><img alt="PDF -icon" src="../../../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>Overview of the Lenya Sitemaps</h1>
+
+
+<a name="N1000D"></a><a name="Introduction"></a>
+<h2 class="h3">Introduction</h2>
+<div class="section">
+<p>Lenya is based on Apache Cocoon. To understand how Lenya works, you should have at least some basic
+ Cocoon knowlege. Make sure you know what a Cocoon sitemap is and you understand matchers, generators,
+ transformers and serializers at least.</p>
+<p>Lenya uses some more Cocoon components, but if you can spot the matchers, generators, transformers and
+ serizalizers, you will be able to get a good first overview of the Lenya sitemaps.</p>
+<p>But Lenya is much more than just a collection of sitemaps and some XSLT stylesheets. Lenya builds on
+ the Cocoon foundation and extends the Cocoon framework with custom</p>
+<ul>
+
+<li>Matchers</li>
+
+<li>Actions</li>
+
+</ul>
+<p>Beyond these components, Lenya also defines two proprietary schemes:</p>
+<ul>
+
+<li>lenya:</li>
+
+<li>fallback:</li>
+
+</ul>
+<p>These schemes are linked to a custom input module that comes with Lenya, the</p>
+<ul>
+
+<li>PageEnvelope input module</li>
+
+</ul>
+</div>
+
+
+<a name="N1003B"></a><a name="Authoring+Area%2C+Live+Area%2C+CMS+GUI+and+several+Publications"></a>
+<h2 class="h3">Authoring Area, Live Area, CMS GUI and several Publications</h2>
+<div class="section">
+<p>A Lenya installation aggregates a number of different parts into
+ a single Cocoon application. By default, one instance of Lenya can be used
+ to edit and render an arbitrary number of publications which are entirely
+ independent of each other.</p>
+<p>There are different concepts of what a publication is, but for now,
+ let's assume each publication represents an independent website.</p>
+<p>Inside each publication, there are</p>
+<ul>
+
+<li>The authoring area</li>
+
+<li>The live area</li>
+
+<li>The CMS GUI components (Drop Down Menu, CMS screens, editos, ...)</li>
+
+</ul>
+<p>The URI space is used to organize all this.</p>
+</div>
+
+
+<a name="N1005A"></a><a name="The+Lenya+URI+space"></a>
+<h2 class="h3">The Lenya URI space</h2>
+<div class="section">
+<p>If you run Lenya in built-in Jetty servlet container, the Lenya webapp
+ is the root application of the container. Therefore http://localhost:8888/ will
+ already hit the Lenya root sitemap.</p>
+<p>In case you deployed lenya into a non-root context of any servlet container, the first
+ part of the URI will be handled by the container itself to match the responsible webapp.</p>
+<p>If you deployed lenya.war into Tomcat for example, you will most likely have to use
+ http://localhost:8080/lenya/ to get into the Lenya root sitemap.</p>
+<p>For the rest of this document, we pretend Lenya is the root webapp in your container
+ as this is the case with the built-in Jetty. Let's examine , what Lenya does in order to
+ render the document you see when you enter this URL:
+ <span class="codefrag">http://localhost:8888/default/authoring/tutorial/new_doctype.html</span>
+</p>
+<a name="N1006E"></a><a name="Part+1%3A+The+publication+ID"></a>
+<h3 class="h4">Part 1: The publication ID</h3>
+<p>The first part is the publication id <span class="codefrag">default</span> which selects the <em>Default
+ Publication</em>. There is a difference between the publication ID and the name of the publication.
+ The ID should be compatible to both the filesystem implementation as well as the URI encoding
+ because it will become both the name of the publication directory and a part of the URL. Therefore
+ it is good practice to stick to 7-bit ASCII with no spaces or special characters.</p>
+<p>In contrast, the display name of the publication (which will show up in the list of publications
+ on the main Lenya entry screen) can be longer and it can contain spaces as well as any
+ Unicode characters.</p>
+<p>The publication ID is used to mount the publication specific sitemap.xmap from
+ <span class="codefrag">$LENYA_HOME/pubs/{publication-id}</span>. The <span class="codefrag">map:mount</span> will strip the publication ID
+ from the URL, so the publication sitemap will just see the
+ <span class="codefrag">authoring/tutorial/new_doctype.html</span> portion. Nevertheless a publication has its ID
+ available through the page envelope. More on that later as we're not yet really inside the publication's
+ content.</p>
+<a name="N1008D"></a><a name="Part+2%3A+The+area"></a>
+<h3 class="h4">Part 2: The area</h3>
+<p>There are two possible areas.</p>
+<ul>
+
+<li>Authoring</li>
+
+<li>Live</li>
+
+</ul>
+<p>You can think of areas as of modes, as in "live mode" and "authoring mode". Live mode is
+ the view of the publication as it is supposed to be displayed on the website to the site
+ visitor. The authoring mode is used by editors and reviewers to edit the publication's content.</p>
+<p>Technically speaking, the first major difference between the authoring area and the live area is just
+ that in authoring mode the CMS menus are displayed. Following the WYSIWYG principle of Lenya,
+ the publication content is rendered the same way in authoring mode as it would be in live mode.</p>
+<p>Besides displaying the CMS menus or not, there are different copies of the underlying content
+ repository for the authoring and live areas. This allows the editors to edit a working copy
+ without affecting the live site. When a document is published after it was reviewed, it is
+ just beeing copied over to the live repository.</p>
+<p>If you're using the default filesystem repository of Lenya, you will find the two different
+ repositories under <span class="codefrag">$LENYA_HOME/lenya/pubs/content/authoring</span> and
+ <span class="codefrag">$LENYA_HOME/lenya/pubs/content/live</span>.</p>
+<p>As well as the publication ID the area is also stored in the page envelope. This will make
+ the actual area available to both the sitemap through the page envelope input module as well as
+ to the components in the Java layer of Lenya.</p>
+<p>At this point, Lenya parsed the URL to the point that is knows:</p>
+<ul>
+
+<li>which publication the request belongs to</li>
+
+<li>which repository is to be used, authoring or live</li>
+
+<li>wether to display the CMS menus or not</li>
+
+</ul>
+<a name="N100C3"></a><a name="CMS+Menus%2C+Usecases+and+CMS+screens"></a>
+<h4>CMS Menus, Usecases and CMS screens</h4>
+<p>Prior to finally turning over to the actual publication content, some remarks
+ on the CMS menus and CMS screens.</p>
+<p>Lenya uses so-called usecases to perform actions. There are usecases such as</p>
+<ul>
+
+<li>submit (a document)</li>
+
+<li>publish (a document)</li>
+
+<li>...</li>
+
+</ul>
+<p>The CMS menus are nothing but a convenience mechanism for the CMS user to trigger usecases.
+ As an alternative to choosing the "Workflow"->"Submit" menu option, you could as well append
+ <span class="codefrag">?lenya.usecase=submit</span> to the document URL. As soon as Lenya finds a lenya.usecase
+ request parameter it will branch into the <span class="codefrag">lenya/usecases/usecase.xmap</span> sitemap.</p>
+<p>All usecases start in the Lenya core. The core contains most of the common access control,
+ workflow and editing usecases. A publication can introduce publication specific usecases.</p>
+<p>Some usecases require CMS screens to be displayed. These are rendered through the usecase
+ sitemap portions as well. That way one could for example introduce a new skin for the CMS
+ screens just by means of the Cocoon sitemap.</p>
+<p>For details on usecases, have a look at the Lenya Usecase Framework.</p>
+<a name="N100EF"></a><a name="Part+3%3A+The+document+URL"></a>
+<h3 class="h4">Part 3: The document URL</h3>
+<p>Now it's the publication sitemap's task to take the document URL portion of the
+ original URL (<span class="codefrag">tutorial/new_doctype.html</span> in our example) and generate and
+ render the content page. This sounds easy, but turns out to be quite complex. This
+ portion is actually the heart and soul of every CMS. This is also where differnt
+ CMS have a lot of differences in terms of features and configurability.</p>
+<p>The easiest way to deal with this would be:</p>
+<ul>
+
+<li>Choose the appropriate content repository (authoring or live)</li>
+
+<li>Use the document URL to look for a file with that name and generate it.</li>
+
+<li>If necessary: Apply an XSLT stylesheet and serialize the result.</li>
+
+</ul>
+<p>Lenya can do a lot more here, such as:</p>
+<ul>
+
+<li>Use a publication specific mapper class to map the document URL to a backend
+ repository URL. This will allow you to hide the actual repository structure from
+ the website visitor.</li>
+
+<li>Apply some intelligence to decide what language version of the document to use.
+ For example, it no specific language version is requested, Lenya will choose the
+ default language. If there is a specific language requested, Lenya will apply a mapping
+ to built a back-end respository path to query for the requested language and generate this
+ if it is available. If the document is not available in the requested language, Lenya will
+ fall back to the default language again.</li>
+
+<li>Choose among a selection of different rendering pipelines based on the source document's
+ resource type. A resource type can be XHTML, but also any other XML format such as RSS,
+ SVG, SlideML or whatever.</li>
+
+</ul>
+<p>Most of this logic is implemented in the Java layer. The components are Avalon components
+ which are configured on a per-publication basis. In other words: One could implement and plug
+ in custom versions of these components.</p>
+<p>Only the mapping between input URL and the path used to access the repository in the backend
+ is implemented as an Avalon component in Java. The actual rendering of the document is done
+ by the means of Cocoon sitemaps, thus allowing anyone with Cocoon knowledge to make changes to
+ the rendering pipelines whithout having to write Java code.</p>
+<p>An example of an entirely different mapping between the document URL and the repository
+ is the Lenya Weblog publication that comes as a second sample with the Lenya distribution.</p>
+<a name="N10123"></a><a name="Part+4%3A+The+usecase+and+workflow+parameters+%28optional%29"></a>
+<h3 class="h4">Part 4: The usecase and workflow parameters (optional)</h3>
+<p>Right after the document URL there may be additional paramters, especially</p>
+<ul>
+
+<li>lenya.usecase and mabye</li>
+
+<li>lenya.step</li>
+
+</ul>
+<p>as well as maybe</p>
+<ul>
+
+<li>wf.event</li>
+
+</ul>
+<p>For an explaination of the usecase parameters, see the usecase framework.</p>
+<p>For an explaination of the workflow engine, see the workflow engine (coming soon).</p>
+<a name="N10145"></a><a name="The+%22lenya%3A%22+scheme"></a>
+<h3 class="h4">The "lenya:" scheme</h3>
+<p>When reading the sitemaps in Lenya 1.4 you probably came across the lenya-scheme, often also referred to as the lenya protocol. For example, in the doctypes.xmap, you will find this section: </p>
+<pre class="code">
+ <!-- parametrized doctype matcher -->
+ <!-- pattern="{rendertype}/{area}/{doctype}/{document-path}" -->
+ <map:match pattern="*/*/*/**.xml">
+ <map:generate src="lenya:/{4}.xml"/>
+ <map:transform src="fallback://xslt/{3}2xhtml.xsl">
+
+</pre>
+<p>The lenya: scheme just needs the document path to locate the source document, i.e. lenya:/concepts/index_en.xml. All other elements of the actual storage location of the document (publication id and area) will be read from the page envelope and interpreted in the LenyaSourceFactory. </p>
+<p>In other words: The lenya: scheme hides the storage implementation details from the sitemap. </p>
+<a name="N10158"></a><a name="What+is+a+scheme%3F"></a>
+<h4>What is a scheme?</h4>
+<p>The lenya scheme is a virtual protocol in Cocoon, similar to the cocoon and context scheme. </p>
+<p>Note: In case you are not familiar with the latest official naming of the components of a URI or you still think that a URL is the same as a URI, please read this: <a href="http://www.bernzilla.com/item.php?id=100"> http://www.bernzilla.com/item.php?id=100</a>. </p>
+<p>The two sentence summary: </p>
+<p>The URI <a href="http://lenya.apache.org/"> http://lenya.apache.org/</a> is a URL. The URL is a special case of a URI. "http" is the scheme, which in a URL referes directly to a TCP/IP protocol. The part left of the colon (http) defines how the part right of the colon (//lenya.apache.org/) is to be interpreted by selecting an appropriate handler. </p>
+<p>The JDK provides build-in mechanisms to handle many common schemes such as file, http, ftp and some more. But Cocoon adds an additional layer through its Excalibur SourceResolver system, see: <a href="http://excalibur.apache.org/sourceresolve/index.html"> http://excalibur.apache.org/sourceresolve/index.html</a>. </p>
+<p>Lenya hooks in there with the LenyaSourceFactory which defines the lenya schema. The actual implementation is in the org.apache.lenya.cms.cocoon.source.LenyaSourceFactory class, see </p>
+<ul>
+
+<li>
+<p>
+<a href="http://lenya.apache.org/apidocs/1.4/org/apache/lenya/cms/cocoon/source/LenyaSourceFactory.html">LenyaSourceFactory JavaDoc</a>
+</p>
+
+
+</li>
+
+<li>
+<p>
+<a href="http://svn.apache.org/viewcvs.cgi/lenya/trunk/src/java/org/apache/lenya/cms/cocoon/source/LenyaSourceFactory.java"> LenyaSourceFactory source code</a>
+</p>
+
+</li>
+
+</ul>
+</div>
+
+
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2002-2005 <a href="http://www.apache.org/licenses/LICENSE-2.0">The Apache Software Foundation.</a>
+</div>
+<div id="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:dev@lenya.apache.org?subject=Feedback%C2%A0for%C2%A0docs/1_4/reference/lenya-sitemaps.html">dev@lenya.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: lenya/site/docs/1_4/reference/lenya-sitemaps.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: lenya/site/docs/1_4/reference/lenya-sitemaps.pdf
URL: http://svn.apache.org/viewvc/lenya/site/docs/1_4/reference/lenya-sitemaps.pdf?rev=427042&view=auto
==============================================================================
Binary file - no diff available.
Propchange: lenya/site/docs/1_4/reference/lenya-sitemaps.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: lenya/site/docs/1_4/reference/link-management.html
URL: http://svn.apache.org/viewvc/lenya/site/docs/1_4/reference/link-management.html?rev=427042&view=auto
==============================================================================
--- lenya/site/docs/1_4/reference/link-management.html (added)
+++ lenya/site/docs/1_4/reference/link-management.html Mon Jul 31 01:24:07 2006
@@ -0,0 +1,291 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Link Management</title>
+<link type="text/css" href="../../../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../../../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../../../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../../../skin/profile.css" rel="stylesheet">
+<script src="../../../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../../../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../../../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../../../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://lenya.apache.org/">lenya</a><script src="../../../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href=""><img class="logoImage" alt="Lenya" src="../../../images/apache-lenya-light.png" title=""></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href=""></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="lenya.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with ');" size="25" name="q" id="query" type="text" value="Search the site with ">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../../../index.html">Project</a>
+</li>
+<li class="current">
+<a class="selected" href="../../../docs/index.html">Documentation</a>
+</li>
+<li>
+<a class="unselected" href="../../../community/index.html">Community</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="selected" href="../../../docs/1_4/index.html">Version 1.4</a><a class="unselected" href="../../../docs/modules/index.html">Modules</a><a class="unselected" href="../../../docs/1_2_x/index.html">Version 1.2</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../../../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Version 1.4</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../../docs/1_4/index.html">Index</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/faq.html">FAQs</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3', '../../../skin/')" id="menu_1.1.3Title" class="menutitle">Installation</div>
+<div id="menu_1.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/index.html">Download</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/subversion.html">Subversion Access</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/source_version.html">Install Instructions</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.4', '../../../skin/')" id="menu_1.1.4Title" class="menutitle">Concepts</div>
+<div id="menu_1.1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/publication.html">Publication</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/urlMapping.html">URL Mapping</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/authoring_live.html">Authoring and Live mode</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/wysiwyg.html">WYSIWYG</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.5', '../../../skin/')" id="menu_selected_1.1.5Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Technical Reference</div>
+<div id="menu_selected_1.1.5" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/lenya-sitemaps.html">Overview of Lenya Sitemaps</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5.2', '../../../skin/')" id="menu_1.1.5.2Title" class="menutitle">Usecase Framework</div>
+<div id="menu_1.1.5.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/usecase-framework/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/usecase-framework/abstractusecase.html">AbstractUsecase</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/publication-templating/index.html">Publication Templating</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/resource-types.html">Resource Types</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/modules/index.html">Modules</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/metadata.html">Meta data</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5.7', '../../../skin/')" id="menu_1.1.5.7Title" class="menutitle">Protocols</div>
+<div id="menu_1.1.5.7" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/lenya.html">lenya:</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/lenyadoc.html">lenyadoc:</a>
+</div>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Link Management</div>
+<div class="menupageitemgroup">
+<div class="menupageitem">
+<a href="#Introduction">Introduction</a>
+</div>
+<div class="menupageitem">
+<a title="Syntax for Internal Links" href="#Syntax+for+Internal+Links">Syntax for Internal...</a>
+</div>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/notification.html">Notification</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/repository/index.html">Repository</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../apidocs/1.4/index.html">1.4 API (Javadoc)</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2">
+<a href="http://apachecon.com/"><img border="0" title="ApacheCon EU 2006" alt="ApacheCon EU 2006 - logo" src="http://www.eu.apachecon.com/konferenzen/apachecon06/images/header-left.gif" style="width: 150px;height: 50px;"></a>
+</div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="link-management.pdf"><img alt="PDF -icon" src="../../../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>Link Management</h1>
+
+
+<a name="N1000D"></a><a name="Introduction"></a>
+<h2 class="h3">Introduction</h2>
+<div class="section">
+<p>Link Managements deals with internal links, i.e. documents
+ that refer to other documents within the same publication. In Lenya 1.2, links
+ are rewritten each time the URL of the target document changes (see
+ section <a href="../../../docs/1_2_x/components/link-management/link-management.html">Link Management</a> in the Lenya 1.2 documentation).
+ This behaviour will probably not be ported to 1.4, since URL-based links will be replaced by
+ UUID-based links.
+ </p>
+</div>
+
+
+<a name="N1001B"></a><a name="Syntax+for+Internal+Links"></a>
+<h2 class="h3">Syntax for Internal Links</h2>
+<div class="section">
+<p>
+ Until the UUID-based link syntax is introduced, internal links have the following syntax:
+ </p>
+<pre class="code">/<publication-id>/<area><document-url></pre>
+<p>
+ Examples:
+ </p>
+<ul>
+
+<li>
+<span class="codefrag">/default/authoring/doctypes/xhtml_en.html</span>
+</li>
+
+<li>
+<span class="codefrag">/yourpub/live/news/2006-02-03.html</span>
+</li>
+
+</ul>
+</div>
+
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2002-2005 <a href="http://www.apache.org/licenses/LICENSE-2.0">The Apache Software Foundation.</a>
+</div>
+<div id="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:dev@lenya.apache.org?subject=Feedback%C2%A0for%C2%A0docs/1_4/reference/link-management.html">dev@lenya.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: lenya/site/docs/1_4/reference/link-management.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: lenya/site/docs/1_4/reference/link-management.pdf
URL: http://svn.apache.org/viewvc/lenya/site/docs/1_4/reference/link-management.pdf?rev=427042&view=auto
==============================================================================
Binary file - no diff available.
Propchange: lenya/site/docs/1_4/reference/link-management.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: lenya/site/docs/1_4/reference/metadata.html
URL: http://svn.apache.org/viewvc/lenya/site/docs/1_4/reference/metadata.html?rev=427042&view=auto
==============================================================================
--- lenya/site/docs/1_4/reference/metadata.html (added)
+++ lenya/site/docs/1_4/reference/metadata.html Mon Jul 31 01:24:07 2006
@@ -0,0 +1,433 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Meta Data</title>
+<link type="text/css" href="../../../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../../../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../../../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../../../skin/profile.css" rel="stylesheet">
+<script src="../../../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../../../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../../../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../../../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://lenya.apache.org/">lenya</a><script src="../../../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href=""><img class="logoImage" alt="Lenya" src="../../../images/apache-lenya-light.png" title=""></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href=""></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="lenya.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with ');" size="25" name="q" id="query" type="text" value="Search the site with ">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../../../index.html">Project</a>
+</li>
+<li class="current">
+<a class="selected" href="../../../docs/index.html">Documentation</a>
+</li>
+<li>
+<a class="unselected" href="../../../community/index.html">Community</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="selected" href="../../../docs/1_4/index.html">Version 1.4</a><a class="unselected" href="../../../docs/modules/index.html">Modules</a><a class="unselected" href="../../../docs/1_2_x/index.html">Version 1.2</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../../../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Version 1.4</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../../docs/1_4/index.html">Index</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/faq.html">FAQs</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3', '../../../skin/')" id="menu_1.1.3Title" class="menutitle">Installation</div>
+<div id="menu_1.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/index.html">Download</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/subversion.html">Subversion Access</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/installation/source_version.html">Install Instructions</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.4', '../../../skin/')" id="menu_1.1.4Title" class="menutitle">Concepts</div>
+<div id="menu_1.1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/publication.html">Publication</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/urlMapping.html">URL Mapping</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/authoring_live.html">Authoring and Live mode</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/concepts/wysiwyg.html">WYSIWYG</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.5', '../../../skin/')" id="menu_selected_1.1.5Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Technical Reference</div>
+<div id="menu_selected_1.1.5" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/lenya-sitemaps.html">Overview of Lenya Sitemaps</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5.2', '../../../skin/')" id="menu_1.1.5.2Title" class="menutitle">Usecase Framework</div>
+<div id="menu_1.1.5.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/usecase-framework/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/usecase-framework/abstractusecase.html">AbstractUsecase</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/publication-templating/index.html">Publication Templating</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/resource-types.html">Resource Types</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/modules/index.html">Modules</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Meta data</div>
+<div class="menupageitemgroup">
+<div class="menupageitem">
+<a href="#Introduction">Introduction</a>
+</div>
+<div class="menupageitem">
+<a title="Registering Meta Data Element Sets" href="#Registering+Meta+Data+Element+Sets">Registering Meta Da...</a>
+</div>
+<div class="menupageitem">
+<a title="Accessing Meta Data" href="#Accessing+Meta+Data">Accessing Meta Data...</a>
+</div>
+<div class="menupageitem">
+<a title="The Meta Data Input Module" href="#The+Meta+Data+Input+Module">The Meta Data Input...</a>
+</div>
+<div class="menupageitem">
+<a href="#Storage">Storage</a>
+</div>
+<div class="menupageitem">
+<a href="#Implementation">Implementation</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5.7', '../../../skin/')" id="menu_1.1.5.7Title" class="menutitle">Protocols</div>
+<div id="menu_1.1.5.7" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/lenya.html">lenya:</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/protocols/lenyadoc.html">lenyadoc:</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/link-management.html">Link Management</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/notification.html">Notification</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/1_4/reference/repository/index.html">Repository</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../apidocs/1.4/index.html">1.4 API (Javadoc)</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2">
+<a href="http://apachecon.com/"><img border="0" title="ApacheCon EU 2006" alt="ApacheCon EU 2006 - logo" src="http://www.eu.apachecon.com/konferenzen/apachecon06/images/header-left.gif" style="width: 150px;height: 50px;"></a>
+</div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="metadata.pdf"><img alt="PDF -icon" src="../../../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>Meta Data</h1>
+
+<a name="N1000E"></a><a name="Introduction"></a>
+<h2 class="h3">Introduction</h2>
+<div class="section">
+<p>
+ Meta data are organized in <em>element sets</em>.
+ An element set is identified using a namespace URI.
+ Each element set can supply a fixed set of elements.
+ An element is identified using a name. An element can
+ be <em>editable</em>, and it can support <em>multiple values</em>.
+ </p>
+</div>
+
+
+<a name="N10021"></a><a name="Registering+Meta+Data+Element+Sets"></a>
+<h2 class="h3">Registering Meta Data Element Sets</h2>
+<div class="section">
+<p>Element sets are declared using patch files for <span class="codefrag">cocoon.xconf</span>.
+ When the application starts up, they are registered with the <span class="codefrag">MetaDataRegistry</span>.
+ Here's an example:</p>
+<pre class="code"><xconf xpath="/cocoon/meta-data"
+ unless="/cocoon/meta-data/component-instance
+ [@name = 'http://apache.org/lenya/metadata/media/1.0']">
+ <component-instance name="http://apache.org/lenya/metadata/media/1.0"
+ class="org.apache.lenya.cms.metadata.ConfigurableElementSet">
+ <element name="filename" multiple="false"/>
+ <element name="format" multiple="false"/>
+ <element name="extent" multiple="false"/>
+ <element name="width" multiple="false"/>
+ <element name="height" multiple="false"/>
+ <element name="caption" multiple="false" editable="true"/>
+ </component-instance>
+</xconf></pre>
+</div>
+
+
+<a name="N10035"></a><a name="Accessing+Meta+Data"></a>
+<h2 class="h3">Accessing Meta Data</h2>
+<div class="section">
+<p>Here's an example for accessing the meta data of a document:</p>
+<pre class="code">
+MetaData meta = document.getMetaData("http://myproject.org/metadata/1.0");
+String description = meta.getFirstValue("description");
+String[] references = meta.getValues("references");
+</pre>
+<p>To find out which element sets are registered, you can access
+ the <span class="codefrag">MetaDataRegistry</span>:</p>
+<pre class="code">
+MetaDataRegistry registry = null;
+try {
+ registry = (MetaDataRegistry) this.manager.lookup(MetaDataRegistry.ROLE);
+ String[] namespaces = registry.getNamespaceUris();
+ ...
+}
+finally {
+ if (registry != null) {
+ this.manager.release(registry);
+ }
+}
+</pre>
+</div>
+
+
+<a name="N1004D"></a><a name="The+Meta+Data+Input+Module"></a>
+<h2 class="h3">The Meta Data Input Module</h2>
+<div class="section">
+<p>You can use the <span class="codefrag">MetaDataModule</span> to make an element set accessible
+ in Cocoon sitemaps. To declare it, use a patch file for <span class="codefrag">cocoon.xconf</span>:</p>
+<pre class="code"><xconf xpath="/cocoon/input-modules"
+ unless="/cocoon/input-modules/component-instance[@name = 'mymeta']">
+ <component-instance logger="sitemap.modules.input.mymeta" name="mymeta"
+ class="org.apache.lenya.cms.cocoon.components.modules.input.MetaDataModule"
+ namespace="http://myproject.org/metadata/1.0"/>
+</xconf></pre>
+<p>Now you can access the meta data in your pipelines:</p>
+<pre class="code"><map:transform src="...">
+ <map:parameter name="description" value="{mymeta:description}"/>
+</map:transform></pre>
+</div>
+
+
+<a name="N10068"></a><a name="Storage"></a>
+<h2 class="h3">Storage</h2>
+<div class="section">
+<p>In 1.4.x meta data is stored separately from the document content but in the same
+ directory (index_{lang}.meta).
+ A typical sample for a meta data XML document may be the following:
+ </p>
+<pre class="code"><metadata xmlns="http://apache.org/lenya/metadata/1.0">
+ <element-set namespace="http://apache.org/lenya/metadata/media/1.0">
+ <element key="width">
+ <value>300</value>
+ </element>
+ <element key="height">
+ <value>374</value>
+ </element>
+ <element key="extent">
+ <value>30291</value>
+ </element>
+ <element key="filename">
+ <value>hello-world.jpg</value>
+ </element>
+ <element key="format">
+ <value>image/jpeg</value>
+ </element>
+ </element-set>
+ <element-set namespace="http://purl.org/dc/elements/1.1/">
+ <element key="creator">
+ <value>lenya</value>
+ </element>
+ <element key="title">
+ <value>Hello World</value>
+ </element>
+ <element key="date">
+ <value>2006-07-20 22:44:37</value>
+ </element>
+ <element key="language">
+ <value>en</value>
+ </element>
+ </element-set>
+ <element-set namespace="http://apache.org/lenya/metadata/document/1.0">
+ <element key="extension">
+ <value>jpg</value>
+ </element>
+ <element key="resourceType">
+ <value>resource</value>
+ </element>
+ <element key="contentType">
+ <value>xml</value>
+ </element>
+ </element-set>
+</metadata>
+ </pre>
+</div>
+
+<a name="N10076"></a><a name="Implementation"></a>
+<h2 class="h3">Implementation</h2>
+<div class="section">
+<p>Like nearly all new modules/functionality the meta data usecases are
+ following the new <strong>fallback</strong> concept. Meaning you are
+ using the core contracts as long you are <strong>not</strong> overriding them with
+ your own implementation. To override a core implementation you just
+ need to place your custom implementation to the right path in you pub
+ and lenya will try to pick it up from there.</p>
+<a name="N10085"></a><a name="Create+meta+data"></a>
+<h3 class="h4">Create meta data</h3>
+<p>Upon creation of a document a set of sample meta data is presented
+ in the creation form. This values are partially filled in by the user
+ (subject, desciption, etc.) and partly by the system (creator,
+ creation data). This is done with the <span class="codefrag">site.create</span>
+ usecase (lenya.usecase=site.create).</p>
+<p> To tell lenya that you want as
+ well create a set of custom meta data, you need to extend the
+ usecase handler and modify your
+ implementation of the <span class="codefrag">create.jx</span> form.</p>
+<div class="note">
+<div class="label">Custom implementation of create.jx</div>
+<div class="content"> An
+ <strong>example</strong> of an implementation can be found in
+ <span class="codefrag">{$default-pub}/lenya/usecases/site/create.jx</span>. Just
+ change it and see what comes out. BTW if you need it in your custom
+ pub just mind the path. ;-)</div>
+</div>
+<a name="N100A2"></a><a name="Display%2Fmodify+meta+data"></a>
+<h3 class="h4">Display/modify meta data</h3>
+<p>The display of meta data is handled by the usecase
+ <span class="codefrag">tab.meta</span>. All editable meta data are presented by the form.</p>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2002-2005 <a href="http://www.apache.org/licenses/LICENSE-2.0">The Apache Software Foundation.</a>
+</div>
+<div id="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:dev@lenya.apache.org?subject=Feedback%C2%A0for%C2%A0docs/1_4/reference/metadata.html">dev@lenya.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: lenya/site/docs/1_4/reference/metadata.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: lenya/site/docs/1_4/reference/metadata.pdf
URL: http://svn.apache.org/viewvc/lenya/site/docs/1_4/reference/metadata.pdf?rev=427042&view=auto
==============================================================================
Binary file - no diff available.
Propchange: lenya/site/docs/1_4/reference/metadata.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: lenya/site/docs/1_4/reference/modules/index.html
URL: http://svn.apache.org/viewvc/lenya/site/docs/1_4/reference/modules/index.html?rev=427042&view=auto
==============================================================================
--- lenya/site/docs/1_4/reference/modules/index.html (added)
+++ lenya/site/docs/1_4/reference/modules/index.html Mon Jul 31 01:24:07 2006
@@ -0,0 +1,494 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Modules</title>
+<link type="text/css" href="../../../../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../../../../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../../../../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../../../../skin/profile.css" rel="stylesheet">
+<script src="../../../../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../../../../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../../../../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../../../../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://lenya.apache.org/">lenya</a><script src="../../../../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href=""><img class="logoImage" alt="Lenya" src="../../../../images/apache-lenya-light.png" title=""></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href=""></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="lenya.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with ');" size="25" name="q" id="query" type="text" value="Search the site with ">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../../../../index.html">Project</a>
+</li>
+<li class="current">
+<a class="selected" href="../../../../docs/index.html">Documentation</a>
+</li>
+<li>
+<a class="unselected" href="../../../../community/index.html">Community</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="selected" href="../../../../docs/1_4/index.html">Version 1.4</a><a class="unselected" href="../../../../docs/modules/index.html">Modules</a><a class="unselected" href="../../../../docs/1_2_x/index.html">Version 1.2</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../../../../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../../../../skin/images/chapter_open.gif');">Version 1.4</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../../../docs/1_4/index.html">Index</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/faq.html">FAQs</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3', '../../../../skin/')" id="menu_1.1.3Title" class="menutitle">Installation</div>
+<div id="menu_1.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../../docs/1_4/installation/index.html">Download</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/installation/subversion.html">Subversion Access</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/installation/source_version.html">Install Instructions</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.4', '../../../../skin/')" id="menu_1.1.4Title" class="menutitle">Concepts</div>
+<div id="menu_1.1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../../docs/1_4/concepts/publication.html">Publication</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/concepts/urlMapping.html">URL Mapping</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/concepts/authoring_live.html">Authoring and Live mode</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/concepts/wysiwyg.html">WYSIWYG</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.5', '../../../../skin/')" id="menu_selected_1.1.5Title" class="menutitle" style="background-image: url('../../../../skin/images/chapter_open.gif');">Technical Reference</div>
+<div id="menu_selected_1.1.5" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/lenya-sitemaps.html">Overview of Lenya Sitemaps</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5.2', '../../../../skin/')" id="menu_1.1.5.2Title" class="menutitle">Usecase Framework</div>
+<div id="menu_1.1.5.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/usecase-framework/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/usecase-framework/abstractusecase.html">AbstractUsecase</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/publication-templating/index.html">Publication Templating</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/resource-types.html">Resource Types</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Modules</div>
+<div class="menupageitemgroup">
+<div class="menupageitem">
+<a href="#Introduction">Introduction</a>
+</div>
+<div class="menupageitem">
+<a title="Implementing a module" href="#Implementing+a+module">Implementing a modu...</a>
+</div>
+<div class="menupageitem">
+<a title="The Module Descriptor File" href="#The+Module+Descriptor+File">The Module Descript...</a>
+</div>
+<div class="menupageitem">
+<a title="Implementing Usecases in Modules" href="#Implementing+Usecases+in+Modules">Implementing Usecas...</a>
+</div>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/metadata.html">Meta data</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5.7', '../../../../skin/')" id="menu_1.1.5.7Title" class="menutitle">Protocols</div>
+<div id="menu_1.1.5.7" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/protocols/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/protocols/lenya.html">lenya:</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/protocols/lenyadoc.html">lenyadoc:</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/link-management.html">Link Management</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/notification.html">Notification</a>
+</div>
+<div class="menuitem">
+<a href="../../../../docs/1_4/reference/repository/index.html">Repository</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../../apidocs/1.4/index.html">1.4 API (Javadoc)</a>
+</div>
+</div>
+<div id="credit">
+<hr>
+<a href="http://forrest.apache.org/"><img border="0" title="Built with Apache Forrest" alt="Built with Apache Forrest - logo" src="../../../../images/built-with-forrest-button.png" style="width: 88px;height: 31px;"></a>
+</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../../../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2">
+<a href="http://apachecon.com/"><img border="0" title="ApacheCon EU 2006" alt="ApacheCon EU 2006 - logo" src="http://www.eu.apachecon.com/konferenzen/apachecon06/images/header-left.gif" style="width: 150px;height: 50px;"></a>
+</div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="index.pdf"><img alt="PDF -icon" src="../../../../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>Modules</h1>
+
+
+<a name="N1000D"></a><a name="Introduction"></a>
+<h2 class="h3">Introduction</h2>
+<div class="section">
+<p>
+ Modules are packages providing a certain set of resources or functionality.
+ </p>
+<p>Examples:</p>
+<ul>
+
+<li>a resource type (e.g., docbook module)</li>
+
+<li>a repository implementation (e.g., jdbc module)</li>
+
+<li>a collection of XSLTs (e.g., content2svg module)</li>
+
+</ul>
+<p>
+ Some modules are included in the Lenya distribution:
+ </p>
+<ul>
+
+<li>
+<strong>lucene</strong> - search functionality</li>
+
+<li>
+<strong>sitetree</strong> - manage documents in a tree-like structure</li>
+
+<li>
+<strong>jcr</strong> - store content in a <a href="http://www.jcp.org/en/jsr/detail?id=170">JCR</a> repository</li>
+
+<li>
+<strong>xhtml</strong> - XHTML-based resource type</li>
+
+<li>
+<strong>links</strong> - resource type to manage link lists</li>
+
+<li>
+<strong>lenyadoc</strong> - adds the <span class="codefrag">lenyadoc://</span> protocol</li>
+
+</ul>
+</div>
+
+
+<a name="N10051"></a><a name="Implementing+a+module"></a>
+<h2 class="h3">Implementing a module</h2>
+<div class="section">
+<p>
+ All resources of a module are located in a single directory.
+ The following is an example directory structure, all files are optional
+ and depend on the nature of the module.
+ </p>
+<pre class="code">
+mymodule/
+ config/ configuration files
+ cocoon-xconf/ patches for cocoon.xconf
+ components.xconf
+ usecases/
+ mymodule.jx usecase view
+ java/
+ src/ Java source files
+ lib/ Java libraries
+ xslt/ XSLT stylesheets
+ module.xml module descriptor
+ sitemap.xmap main module sitemap
+</pre>
+<p>To add a module to your Lenya installation, declare it in <span class="codefrag">local.build.properties</span>:</p>
+<pre class="code">
+modules.root.dirs=src/modules:src/webapp/lenya/pubs/default/modules:/home/john/modules/mymodule
+</pre>
+<p>
+ When the module is deployed, the following steps are executed:
+ </p>
+<ul>
+
+<li>the module files are copied to <span class="codefrag">context://lenya/modules</span>
+</li>
+
+<li>Java sources are compiled, libraries are installed</li>
+
+<li>
+<span class="codefrag">cocoon.xconf</span> is patched</li>
+
+</ul>
+</div>
+
+
+<a name="N1007C"></a><a name="The+Module+Descriptor+File"></a>
+<h2 class="h3">The Module Descriptor File</h2>
+<div class="section">
+<p>
+ Each module must be described using a <em>module descriptor</em> XML file
+ <span class="codefrag">module.xml</span>, located in the root directory of the module.
+ The descriptor is validated when the module is deployed, so be careful! :)
+ </p>
+<p>
+ A typical module descriptor looks like this:
+ </p>
+<pre class="code"><module xmlns="http://apache.org/lenya/module/1.0">
+ <id>org.myproject.lenya.modules.myeditor</id>
+ <depends module="org.apache.lenya.modules.usecase"/>
+ <depends module="org.apache.lenya.modules.webdav"/>
+ <package>org.myproject.lenya.modules</package>
+ <version>0.1-dev</version>
+ <name>My Own Editor</name>
+ <lenya-version>1.4-dev</lenya-version>
+ <description>
+ This is my own editor.
+ For more information, visit http://myproject.org/editor.
+ </description>
+</module></pre>
+<p>
+ The <span class="codefrag">id</span> must start with the <span class="codefrag">package</span> of the module.
+ It is not allowed to deploy two modules with the same ID.
+ </p>
+<p>If your module uses code from other modules, you have to add
+ a <span class="codefrag"><depends></span> for each of these modules.</p>
+</div>
+
+
+<a name="N100A2"></a><a name="Implementing+Usecases+in+Modules"></a>
+<h2 class="h3">Implementing Usecases in Modules</h2>
+<div class="section">
+<a name="N100A8"></a><a name="Declaring+the+Usecase"></a>
+<h3 class="h4">Declaring the Usecase</h3>
+<p>
+ For example, imagine you implement a <span class="codefrag">newsletter</span> module, containing a <span class="codefrag">send</span> usecase.
+ To declare usecases, add a patch file for <span class="codefrag">cocoon.xconf</span>, for instance <span class="codefrag">newsletter/config/cocoon-xconf/usecases.xconf</span>:
+ </p>
+<pre class="code"><xconf xpath="/cocoon/usecases"
+ unless="/cocoon/usecases/component-instance[@name = 'newsletter.send']">
+ <component-instance name="newsletter.send"
+ logger="lenya.usecases.newsletter.send"
+ class="org.myproject.lenya.newsletter.usecases.Send">
+ <view template="modules/newsletter/usecases/send.jx" menu="false"/>
+ </component-instance>
+</xconf></pre>
+<p>
+ As you can see in the view declaration, the JX templates are typically stored in the <span class="codefrag"><module>/usecases</span>
+ directory. The Java source files go into the <span class="codefrag"><module>/java/src</span> directory, they are compiled
+ automatically by the Lenya build process.
+ </p>
+<a name="N100CB"></a><a name="Calling+the+Module+Sitemap"></a>
+<h3 class="h4">Calling the Module Sitemap</h3>
+<p>
+ The following URL syntax is used to make a call to a module sitemap:
+ </p>
+<pre class="code">cocoon://modules/<module>/**</pre>
+<p>
+ The module sitemap is located at <span class="codefrag">newsletter/sitemap.xmap</span>. To request
+ the latest newsletter and display it on the confirmation screen using the CInclude approach
+ (for more information, see documentation about the usecase framework), you could for instance use
+ the URI <span class="codefrag">cocoon://modules/newsletter/latestNewsletter.xml</span>:
+ </p>
+<pre class="code"><page:page
+ xmlns:jx="http://apache.org/cocoon/templates/jx/1.0"
+ xmlns:page="http://apache.org/cocoon/lenya/cms-page/1.0"
+ xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:i18n="http://apache.org/cocoon/i18n/2.1"
+ xmlns:cinclude="http://apache.org/cocoon/include/1.0"
+ >
+
+ <page:body>
+ <h1><i18n:text>Send Newsletter</i18n:text></h1>
+ <form>
+ ...
+ <jx:import uri="templates/messages.jx"/>
+
+ <cinclude:includexml>
+ <cinclude:src>cocoon://modules/newsletter/latestNewsletter.xml</cinclude:src>
+ </cinclude:includexml>
+
+ <input name="submit" type="submit" value="Send Newsletter"/>
+ </form>
+ </page:body>
+</page:page></pre>
+<p>
+ Another useful option is to use a module URL as the usecase view, e.g. to export some XML.
+ Note that the attribute <span class="codefrag">uri</span> is used instead of <span class="codefrag">template</span>.
+ The usecase class <span class="codefrag">DummyUsecase</span> can be used because no Java code shall be
+ executed.
+ </p>
+<pre class="code"><xconf xpath="/cocoon/usecases"
+ unless="/cocoon/usecases/component-instance[@name = 'newsletter.download']">
+ <component-instance name="newsletter.send"
+ logger="lenya.usecases.newsletter.send"
+ class="org.apache.lenya.cms.usecase.DummyUsecase">
+ <view uri="cocoon://modules/newsletter/downloadNewsletter.xml"/>
+ </component-instance>
+</xconf></pre>
+<a name="N100F6"></a><a name="Adding+Menu+Items"></a>
+<h3 class="h4">Adding Menu Items</h3>
+<p>
+ A module can provide menu items which are added to the publication menu.
+ To insert the menu items of a module, you have to add the module declaration to <span class="codefrag">publication.xconf</span>:
+ </p>
+<pre class="code"><publication>
+ ...
+ <module name="newsletter"/>
+ ...
+</publication></pre>
+<p>
+ If there is a <span class="codefrag">menus.xmap</span> sitemap in the module's root directory, a
+ request of the form <span class="codefrag"><area>.xml</span> is sent into this sitemap.
+ The matching pipeline could look like this:
+ </p>
+<pre class="code"><map:match pattern="**">
+ <map:generate type="serverpages" src="config/menu.xsp"/>
+ <map:serialize type="xml"/>
+</map:match>
+</pre>
+<p>
+ The server page <span class="codefrag"><module>/config/menu.xsp</span> delivers a menu XML
+ which includes the items to be inserted:
+ </p>
+<pre class="code"><xsp:page ...>
+ <menu>
+ <menus>
+ <menu i18n:attr="name" name="File">
+ <block admin="false">
+ <item uc:usecase="newsletter.send" href="?">
+ <i18n:text>Send Newsletter</i18n:text>
+ </item>
+ </block>
+ </menu>
+ </menus>
+ </menu>
+</xsp:page></pre>
+</div>
+
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2002-2005 <a href="http://www.apache.org/licenses/LICENSE-2.0">The Apache Software Foundation.</a>
+</div>
+<div id="logos"></div>
+<div id="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:dev@lenya.apache.org?subject=Feedback%C2%A0for%C2%A0docs/1_4/reference/modules/index.html">dev@lenya.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: lenya/site/docs/1_4/reference/modules/index.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: lenya/site/docs/1_4/reference/modules/index.pdf
URL: http://svn.apache.org/viewvc/lenya/site/docs/1_4/reference/modules/index.pdf?rev=427042&view=auto
==============================================================================
Binary file - no diff available.
Propchange: lenya/site/docs/1_4/reference/modules/index.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org