Return-Path: 
 <forrest-dev-return-7773-apmail-xml-forrest-dev-archive=xml.apache.org@xml.apache.org>
Delivered-To: apmail-xml-forrest-dev-archive@www.apache.org
Received: (qmail 94911 invoked from network); 7 Oct 2003 09:19:17 -0000
Received: from daedalus.apache.org (HELO mail.apache.org) (208.185.179.12)
  by minotaur-2.apache.org with SMTP; 7 Oct 2003 09:19:17 -0000
Received: (qmail 30727 invoked by uid 500); 7 Oct 2003 09:18:50 -0000
Delivered-To: apmail-xml-forrest-dev-archive@xml.apache.org
Received: (qmail 30692 invoked by uid 500); 7 Oct 2003 09:18:50 -0000
Mailing-List: contact forrest-dev-help@xml.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:forrest-dev-help@xml.apache.org>
list-unsubscribe: <mailto:forrest-dev-unsubscribe@xml.apache.org>
list-post: <mailto:forrest-dev@xml.apache.org>
Reply-To: forrest-dev@xml.apache.org
Delivered-To: mailing list forrest-dev@xml.apache.org
Received: (qmail 30681 invoked from network); 7 Oct 2003 09:18:50 -0000
Received: from unknown (HELO postfix3-1.free.fr) (213.228.0.44)
  by daedalus.apache.org with SMTP; 7 Oct 2003 09:18:50 -0000
Received: from lns-p19-7-82-65-224-91.adsl.proxad.net
 (lns-p19-7-82-65-224-91.adsl.proxad.net [82.65.224.91])
	by postfix3-1.free.fr (Postfix) with ESMTP id 5C08FC4F98
	for <forrest-dev@xml.apache.org>; Tue,  7 Oct 2003 11:18:57 +0200 (CEST)
From: Eric BURGHARD <eburghar@free.fr>
To: forrest-dev@xml.apache.org
Subject: Re: [CONTRIB] auto generation of menus
Date: Tue, 7 Oct 2003 02:59:54 +0200
User-Agent: KMail/1.5.3
References: <200310032312.04821.eburghar@free.fr>
 <20031006064742.GB2395@expresso.localdomain>
In-Reply-To: <20031006064742.GB2395@expresso.localdomain>
MIME-Version: 1.0
Content-Type: Multipart/Mixed;
  boundary="Boundary-00=_KAhg/oB9gKMqpI9"
Message-Id: <200310070259.54950.eburghar@free.fr>
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N
X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N


--Boundary-00=_KAhg/oB9gKMqpI9
Content-Type: text/plain;
  charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

Le Lundi 06 Octobre 2003 08:47, Jeff Turner a =E9crit :
> On Fri, Oct 03, 2003 at 11:12:04PM +0200, Eric BURGHARD wrote:
> > Hi,
> >
> > I've made some modifications to directory2book.xsl (which generate side
> > menu based on directory content):
> > -little cleanup (expected-extension argument no more needed)
> > -kind of control on which items are present or not
> > -allow parametrable sorting of menu-items
> > -easily extensible.
>
> Nice.  I've committed it with some modifications:
>
>  - Used the existing pathutils.xsl instead of substring-last.xsl
>  - I didn't understand the purpose of documentdirectory.xsl, so I put its
>    enhanced get-label template in directory2book.xml.  Any reason to
>    separate it out, other than to demonstrate its 'overridability'?
>
;-)

Yeah, in fact, directory2book.xsl is not specificly designed to be used wit=
h=20
XPathDirectoryGenerator. Right ? After a simple DirectoryGenerator you've g=
ot=20
no dir:xpath nodeset in the result. So is there any good reason to compute=
=20
the menu-items labels from inexistants tags and rely on the default behavio=
r=20
which take them from the filenames ?

On the other side, when you apply documentdirectory2book.xsl you say=20
indirectly your intention to scan directory full of document-v20 compliant=
=20
xml. This stylesheet rely on XPathDirectoryGenerator because the get-label=
=20
template make use of dir:xpath contents.

If you've got docbook directories, perhaps you want to get the labels from=
=20
something else than <meta name=3D"short-title"/> (the meta tag could possib=
ly=20
not exists in docbook or exists in another branch than document/header, i=20
don't know). So just edit a new docbookdirectory2book.xsl which only need t=
o=20
override the get-label with something like:

<xsl:template name=3D"get-label">
 <xsl:value-of select=3D"dir:xpath/whatever-tab"/>
</xsl:template>

and modify your sitemap.xmap accordingly

<map:generate label=3D"debug" src=3D"content/xdocs/{1}{2}" type=3D"xpathdir=
ectory">
  <map:parameter name=3D"xpath" value=3D"//whatever-tab">
  </map:generate>
  <map:transform src=3D"resources/stylesheets/docbookdirectory2book.xsl"/>
  <map:serialize type=3D"xml">
</map:generate>

In the last version of my directory2book.xsl (attached) I also define a=20
get-href named template. That way you can easily compute the urls served by=
=20
menu-items. Example: for my simple gallery i use a jpegdirectory2book.xsl=20
which is quite simple and clear:

    <xsl:import href=3D"directory2book.xsl"/>
    <xsl:output doctype-public=3D"-//APACHE//DTD Cocoon Documentation Book=
=20
V1.0//EN" doctype-system=3D"book-cocoon-v10.dtd"/>

    <!-- link to screen oriented jpegs -->
    <xsl:template name=3D"get-href">
        <xsl:param name=3D"corename"/>
        <xsl:value-of select=3D"concat($corename, '-1024.jpg')"/>
    </xsl:template>

</xsl:stylesheet>

for each of my jpegs i've got a menu-item item which link to something like=
=20
img-1024.jpg which refer to img.jpg with a 1024 pixels height.

Somewhere in my sitemap.xmap i've got this to generate jpeg at a given heig=
ht.

<map:match pattern=3D"(.*)-([0-9]*).jpg" type=3D"regexp">
  <map:read src=3D"content/xdocs/{1}.jpg" type=3D"image">
     <map:parameter name=3D"height" value=3D"{2}"/>
  </map:read>
</map:match>

and by default (in directory2book.xsl) get-href is

<xsl:template name=3D"get-href">
   <xsl:param name=3D"corename"/>
   <xsl:value-of select=3D"concat($corename, '.', $served-extension)"/>
</xsl:template>

which link items with something like filename.html

> Sorting by XPath is a good idea, but ordering still doesn't seem flexible
> enough for ordinary sites.  Perhaps we need another transformer that sets
> a <meta name=3D"order"> field based on some clever algorithm:
>
> <map:generate src=3D"content/xdocs/{1}" type=3D"xpathdirectory"/>
> <map:transform type=3D"sorter"/>
> <map:transform src=3D"resources/stylesheets/directory2book.xsl"/>
>

That would be nice. I didn't like the fact to use a non standard xslt=20
extension to achieve this sorting flexibility in my stylesheet, but it was =
a=20
good preliminary that fullfill my needs.

> Then pages could have some metadata used by the sorting algorithm:
>
> <meta name=3D"group">GettingStarted</meta>
>
> <meta name=3D"comes-after">index.html</meta>
>
> <meta name=3D"comes-before">primer.html</meta>
>

Yeah ! much more flexibility like this ! Thus you can already achieve quite=
=20
the same behavior with the actual sorting mechanism and without the hassle =
of=20
programming a constraints resolution engine. Use directory hierachie a=20
relaxed numbering scheme (like sysV init filenames):

directory: GettingStarted
file1
<meta name=3D"menu-order">S5</meta>

index.xml
<meta name=3D"menu-order">S0</meta>

primer.xml
<meta name=3D"menu-order">S20</meta>

and do your sorting with

<map:transform src=3D"resources/stylesheets/documentdirectory2book.xsl">
   <map:parameter name=3D"sort-select"=20
value=3D"dir:xpath/meta[@name=3D'menu-order']"/>
</map:transform>

PS: What did the pathutils.xsl do in resources/skins/common/xslt/html=20
directory ? Shouldn't it be placed in resources/stylesheets ?

>
> --Jeff

--Boundary-00=_KAhg/oB9gKMqpI9
Content-Type: text/xml;
  charset="iso-8859-1";
  name="directory2book.xsl"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment;
	filename="directory2book.xsl"

<?xml version="1.0"?>

<!-- Converts the output of the DirectoryGenerator to Forrest's book.xml
format.  Typically this would be used to define a book.xml pipeline for a
specific page.  Eg, in menu.xmap, define the DirectoryGenerator:

<map:generators default="file">
  <map:generator name="directory" src="org.apache.cocoon.generation.DirectoryGenerator" />
</map:generators>

And then define the book.xml matcher for a directory that you want to
automatically generate a menu for (here wiki/):

<map:match pattern="wiki/**book-*">
  <map:generate type="directory" src="content/xdocs/wiki/{1}">
    <map:parameter name="dateFormat" value="yyyy-MM-dd hh:mm" />
    <map:parameter name="depth" value="5" />
    <map:parameter name="exclude" value="[.][^x[^m][^l]|~$|^my-images$" />
  </map:generate>
  <map:transform src="resources/stylesheets/directory2book.xsl" />
  <map:serialize type="xml"/>
</map:match>


-->

<xsl:stylesheet exclude-result-prefixes="dir" version="1.0"
    xmlns:dir="http://apache.org/cocoon/directory/2.0" xmlns:dyn="http://exslt.org/dynamic" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
    <xsl:import href="substring-last.xsl"/>
    <xsl:output doctype-public="-//APACHE//DTD Cocoon Documentation Book V1.0//EN" doctype-system="book-cocoon-v10.dtd"/>

    <xsl:param name="served-extension" select="'html'"/>
    <xsl:param name="sort-order" select="'ascending'"/>
    <xsl:param name="sort-case-order" select="'upper-first'"/>
    <xsl:param name="sort-select" select="'.'"/>

    <xsl:template match="/">
        <book copyright="" software="" title="">
            <xsl:apply-templates/>
        </book>
    </xsl:template>

    <xsl:template match="dir:directory">
        <menu label="{translate(@name,'-_',' ')}">
            <xsl:apply-templates select="dir:file">
                <xsl:sort case-order="{$sort-case-order}" order="{$sort-order}" select="dyn:evaluate($sort-select)"/>
            </xsl:apply-templates>
        </menu>
        <xsl:apply-templates select="dir:directory [descendant::dir:file]"/>
    </xsl:template>

    <xsl:template match="dir:file">
        <!-- name without extension -->
        <xsl:variable name="corename">
            <xsl:call-template name="substring-before-last">
                <xsl:with-param name="input" select="@name"/>
                <xsl:with-param name="substr" select="'.'"/>
            </xsl:call-template>
        </xsl:variable>
        <!-- indirection to allow get-label overriding -->
        <xsl:variable name="label">
            <xsl:call-template name="get-label">
                <xsl:with-param name="corename" select="$corename"/>
            </xsl:call-template>
        </xsl:variable>
        <!-- empty label means side menu item inexistence -->
        <xsl:if test="$label != ''">
            <menu-item label="{$label}">
                <xsl:attribute name="href">
                    <xsl:variable name="path"/>
                    <xsl:for-each select="ancestor::dir:directory [not (position()=last())]">
                        <xsl:variable name="path" select="concat($path, @name, '/')"/>
                        <xsl:value-of select="$path"/>
                    </xsl:for-each>
                    <!-- indirection to allow get-href overriding -->
                    <xsl:call-template name="get-href">
                        <xsl:with-param name="corename" select="$corename"/>
                    </xsl:call-template>
                </xsl:attribute>
            </menu-item>
        </xsl:if>
    </xsl:template>

    <!-- override theses to your needs -->
    <xsl:template name="get-label">
        <xsl:param name="corename"/>
        <xsl:value-of select="translate($corename,'-_',' ')"/>
    </xsl:template>

    <xsl:template name="get-href">
        <xsl:param name="corename"/>
        <xsl:value-of select="concat($corename, '.', $served-extension)"/>
    </xsl:template>
</xsl:stylesheet>

--Boundary-00=_KAhg/oB9gKMqpI9--