Return-Path: 
 <dev-return-16323-apmail-forrest-dev-archive=forrest.apache.org@forrest.apache.org>
Delivered-To: apmail-forrest-dev-archive@www.apache.org
Received: (qmail 51327 invoked from network); 23 May 2005 20:32:16 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
  by minotaur.apache.org with SMTP; 23 May 2005 20:32:16 -0000
Received: (qmail 55728 invoked by uid 500); 23 May 2005 20:32:16 -0000
Delivered-To: apmail-forrest-dev-archive@forrest.apache.org
Received: (qmail 55644 invoked by uid 500); 23 May 2005 20:32:15 -0000
Mailing-List: contact dev-help@forrest.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:dev-help@forrest.apache.org>
list-unsubscribe: <mailto:dev-unsubscribe@forrest.apache.org>
List-Post: <mailto:dev@forrest.apache.org>
Reply-To: dev@forrest.apache.org
List-Id: <dev.forrest.apache.org>
Delivered-To: mailing list dev@forrest.apache.org
Received: (qmail 55630 invoked by uid 500); 23 May 2005 20:32:15 -0000
Delivered-To: apmail-xml-forrest-dev@xml.apache.org
Received: (qmail 55620 invoked by uid 99); 23 May 2005 20:32:15 -0000
X-ASF-Spam-Status: No, hits=0.0 required=10.0
	tests=
X-Spam-Check-By: apache.org
Received-SPF: neutral (hermes.apache.org: local policy)
Received: from ns3.wkwyw.net (HELO ns3.wkwyw.net) (217.199.181.91)
  by apache.org (qpsmtpd/0.28) with SMTP; Mon, 23 May 2005 13:32:13 -0700
Received: (qmail 21973 invoked from network); 23 May 2005 20:32:16 -0000
Received: from 82-69-78-226.dsl.in-addr.zen.co.uk (HELO ?192.168.0.4?)
 (82.69.78.226)
  by ns3.wkwyw.net with SMTP; 23 May 2005 20:32:16 -0000
Message-ID: <42923DC6.2090405@apache.org>
Date: Mon, 23 May 2005 21:32:06 +0100
From: Ross Gardler <rgardler@apache.org>
User-Agent: Mozilla Thunderbird 1.0 (Windows/20041206)
X-Accept-Language: en-us, en
MIME-Version: 1.0
To: forrest-dev@xml.apache.org
Subject: Self documenting sitemaps
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: quoted-printable
X-Virus-Checked: Checked
X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N

This snippet from a mail on Cocoon Dev will be interesting to those=20
wishing to improve our sitemap documentation.

-------- Original Message --------
From: Bertrand Delacretaz <bdelacretaz@apache.org>
Subject: Re: [PlanetCocoon] 4 new ideas to discuss on Planet Cocoon
Date: Mon, 23 May 2005 20:44:06 +0200
To: dev@cocoon.apache.org

Le 23 mai 05, =E0 20:33, Sebastien Arbogast a =E9crit :
> ...finally it appears
> it's not as interesting as I thought at the beginning because current
> samples are code only whereas we think code-illustrated documentation
> is what we need most...

Sure. Note that I just applied a patch to both the 2.1 branch and the
trunk, which allows you to add annotation to sitemaps, like:

<map:match pattern=3D"news.pdf">
    <n:explain>Get news in XML from server</n:explain>
    <map:generate src=3D"http://newsserver/somestuff.xml"/>

    <n:explain>Convert to xsl-fo</n:explain>
    <map:transform src=3D"news-to-fo.xsl"/>

    <n:explain>
      And let <a href=3D"http://xml.apache.org/fop">FOP</a> generate PDF
    </n:explain>
    <map:serialize type=3D"fo2pdf"/>
</map:match>

This could be very useful to create self-describing samples.

There's also stuff in the tour block that could be reused to extract
code excerpts from sitemaps, xml and text files.

-Bertrand