You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by gr...@apache.org on 2005/05/15 16:43:15 UTC
svn commit: r170224 - in /lenya/docu/src/documentation/content/xdocs:
1_2_x/how-to/cms_menus.xml site.xml
Author: gregor
Date: Sun May 15 07:43:14 2005
New Revision: 170224
URL: http://svn.apache.org/viewcvs?rev=170224&view=rev
Log:
Added CMS menus documentation to the site.
Added:
lenya/docu/src/documentation/content/xdocs/1_2_x/how-to/cms_menus.xml
Modified:
lenya/docu/src/documentation/content/xdocs/site.xml
Added: lenya/docu/src/documentation/content/xdocs/1_2_x/how-to/cms_menus.xml
URL: http://svn.apache.org/viewcvs/lenya/docu/src/documentation/content/xdocs/1_2_x/how-to/cms_menus.xml?rev=170224&view=auto
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/1_2_x/how-to/cms_menus.xml (added)
+++ lenya/docu/src/documentation/content/xdocs/1_2_x/how-to/cms_menus.xml Sun May 15 07:43:14 2005
@@ -0,0 +1,166 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 1999-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.
+-->
+
+<!-- $Id: index.xml 55543 2004-10-26 00:14:59Z gregor $ -->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+
+<document>
+ <header>
+ <title>CMS Menus How-To</title>
+ </header>
+ <body>
+<p>The CMS Menus are the menu options in Lenya that are available only in authoring mode and that are used by the editor, reviewer or admin to trigger operations such as editing, deleting or publishing a page and the like. CMS Menus are completely different and have nothing in common with the navigational menus in your publication! </p>
+<p>In other words: The site navigation is what the readers in the Live view will see, while the CMS Menus are only visible in the authoring area. </p>
+
+<section><title id="head-d4956a0675807cf9a821ed7373a9f0ac8b2c4283">Why care about CMS Menus</title>
+
+<p>Most of the time the CMS Menus can be seen as a part of the Lenya application and should just work. But sometimes it will be necessary to introduce additional menu options if your publication has any special operations that need to be accessible through a menu option. Sometimes you might also find that a menu option is grayed out when you think it should be accessible. In that case understanding the anatomy of the CMS menus will help you in debugging the problem. </p>
+
+</section><section><title id="head-8e7bea88bc6cc2c0ef5910f4785f11121b6ebde2">Lenya Core Documentation</title>
+
+<p>There is some information on the CMS Menus in the official Lenya documentation, but it's hidden in a pleace where you might not expect it. So here's a link: <a href="site:menubar">Menubar documentation</a> </p>
+<p>Make sure you read that before continuing reading this page here! </p>
+<p>Unfortunately the picture on the page mentioned above is a bit misleading. You might think that "Usecases" and "Workflow" steps in read in the right part of the picture refer to XSLT stylesheets which are applied using the XSLT transformer. This is not the case! They are own transformers implemted directly in the Lenya Java layer: </p>
+
+<pre>
+ <map:transformer name="workflowmenu" logger="lenya.sitemap.transformer.workflowmenu" src="org.apache.lenya.cms.cocoon.transformation.WorkflowMenuTransformer"/>
+ <map:transformer name="usecasemenu" logger="lenya.sitemap.transformer.usecasemenu" src="org.apache.lenya.cms.cocoon.transformation.UsecaseMenuTransformer"/>
+
+</pre>
+<p>Nevertheless they do exactly what is described in the picture: They disable menu options if they are not accessible because </p>
+<ul>
+<li><p> executing the usecase requires a role which the user belonging to the current session is lacking or </p>
+</li>
+<li><p> the current workflow state of the document forbidds the usecase </p>
+</li>
+</ul>
+
+</section><section><title id="head-f06da7765bdcb4fdb7ca94cedada41bafeee1d5b">Introducing a new menu option</title>
+
+<p>First of all, before you start adding a new menu option to the CMS menus, ask yourself what usecase should be linked to that menu option and if the usecase exists already. If you find out that you need a new usecase as well, it is up to you if you first implement the new usecase and test it manuelly by invoking the appropriate URIs and then add the menu option or do it vice versa. It is just important that you understand that it will take both: The usecase and the menu option to enable new functionality for the user. </p>
+<p>According to the page on the core documentation mentioned above, the CMS menus are defined in an XML document like this: </p>
+
+<pre>
+<menu
+ xmlns="http://apache.org/cocoon/lenya/menubar/1.0"
+ xmlns:uc="http://apache.org/cocoon/lenya/usecase/1.0"
+ xmlns:wf="http://apache.org/cocoon/lenya/workflow/1.0">
+
+ ...
+
+ <item wf:event="edit"
+ uc:usecase="edit-forms"
+ uc:step="open" href="?...">Edit with Forms</item>
+
+ ...
+
+
+</menu>
+</pre>
+
+</section><section><title id="head-717f7a242c8db5f6fb81e54e27fcbcf590009452">Edit generic.xsp to add the item for the menu option</title>
+
+<p>In practive this XML is generated of an XSP which you can find in </p>
+<p><tt>lenya/pubs/<your-pub>/config/menus/generic.xsp</tt> </p>
+<p>Edit this XSP to add your new menu item! </p>
+<p>The XSP is used in the following section of global-sitemap.xmap: </p>
+
+<pre>
+ <map:match pattern="lenya-page/*/*/**">
+ <map:generate src="cocoon:/menu-xml/{1}/{2}/{3}"/>
+
+ <map:call resource="i18n"/>
+
+ <map:act type="resource-exists" src="lenya/pubs/{1}/config/workflow/">
+ <map:transform type="workflowmenu"/>
+
+ </map:act>
+
+ <map:act type="resource-exists" src="lenya/pubs/{1}/config/ac/usecase-policies.xml">
+ <map:transform type="usecasemenu"/>
+ </map:act>
+
+ <map:transform src="lenya/xslt/menu/menu2xhtml.xsl">
+
+ <map:parameter name="contextprefix" value="{request:contextPath}"/>
+ <map:parameter name="publicationid" value="{1}"/>
+ <map:parameter name="completearea" value="{2}"/>
+ <map:parameter name="documentarea" value="{page-envelope:area}"/>
+ <map:parameter name="documenturl" value="{page-envelope:document-url}"/>
+ <map:parameter name="documentid" value="{page-envelope:document-id}"/>
+
+ <map:parameter name="userid" value="{access-control:user-id}"/>
+ <map:parameter name="servertime" value="{date-i18n:currentDate}"/>
+ <map:parameter name="workflowstate" value="{workflow:state}"/>
+ <map:parameter name="islive" value="{workflow:variable.is_live}"/>
+ </map:transform>
+
+ <map:call resource="i18n"/>
+
+ <map:transform src="lenya/xslt/menu/menu2xslt.xsl">
+ <map:parameter name="contextprefix" value="{request:contextPath}"/>
+ <map:parameter name="publicationid" value="{1}"/>
+ <map:parameter name="area" value="{2}"/>
+ <map:parameter name="documenturl" value="{page-envelope:document-url}"/>
+ </map:transform>
+
+ <map:serialize type="xml"/>
+ </map:match>
+</pre>
+<p>The <tt><map:generate src="cocoon:/menu-xml/{1}/{2}/{3}"/></tt> is an internal pipeline, which can be found in the same file: </p>
+
+<pre>
+ <!-- menu-xml/{publication-id}/... -->
+
+ <map:match pattern="menu-xml/*/**" internal-only="true">
+ <map:mount uri-prefix="menu-xml/{1}/" src="lenya/pubs/{1}/menus.xmap" check-reload="true" reload-method="synchron"/>
+ </map:match>
+</pre>
+<p>This mounts the <tt>lenya/pubs/<your-pub>/menus.xmap</tt> sitemap snippet from the publication which then will decide weather we are in live or authoring mode and generate the menu definition from the publication specific menu.xsp: </p>
+
+<pre>
+ <map:match pattern="live/**">
+ <map:generate type="serverpages" src="../../content/menus/live.xsp"/>
+ <map:serialize type="xml"/>
+ </map:match>
+
+ <map:match pattern="**">
+
+ <map:generate type="serverpages" src="config/menus/generic.xsp"/>
+ <map:serialize type="xml"/>
+ </map:match>
+
+ </map:pipeline>
+</pre>
+
+</section><section><title id="head-3c7c7b03da78f976501b3a61c43af692d6ced2c4">Double-check usecase and workflow configuration</title>
+
+<p>If you look back at the <tt>lenya-page/*/*/**</tt> matcher in global-sitemap.xmap above, the menus are built by: </p>
+<ul>
+<li><p> generating the menu definition from the XSP (which we edited already) </p>
+</li>
+<li><p> applying the workflowmenu and usecasemenu transformers </p>
+</li>
+<li><p> using <tt>lenya/xslt/menu/menu2xhtml.xsl</tt> to generate the XHTML </p>
+
+</li>
+</ul>
+<p>This means if you added your new menu option to the XSP it should show up in the menu. But it might be grayed out. </p>
+<p>If this is the case, either the workflowmenu or the usecasemneu transformer decided based on the workflow configuration or based on the usecase policy that this option is not available to this user at this point in time. You may want to check the appropriate configurations to check why this is the case. </p>
+<p>The usecase configuration can be found in <tt>lenya/pubs/<your-pub>/config/ac/usecase-policies.xml</tt> </p></section> </body>
+</document>
\ No newline at end of file
Modified: lenya/docu/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/lenya/docu/src/documentation/content/xdocs/site.xml?rev=170224&r1=170223&r2=170224&view=diff
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/site.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/site.xml Sun May 15 07:43:14 2005
@@ -108,6 +108,7 @@
<newmimetype href="new_mime_type.html" label="Adding Mime Types"/>
<sitenavigation href="site_navigation.html" label="Site Navigation"/>
<ldapauthentication href="ldap_authentication.html" label="LDAP Authentication"/>
+ <cmsmenus href="cms_menus.html" label="CMS Menus"/>
</howtos>
<components href="components/" label="Components">
<accesscontrol href="accesscontrol/" label="Access Control">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org