Mailing-List: contact dev-help@forrest.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@forrest.apache.org
Received-SPF: neutral (asf.osuosl.org: local policy)
Message-ID: <43418AA1.6010603@apache.org>
Date: Mon, 03 Oct 2005 20:46:41 +0100
From: Ross Gardler <rgardler@apache.org>
User-Agent: Mozilla Thunderbird 1.0 (Windows/20041206)
MIME-Version: 1.0
To: dev@forrest.apache.org
Subject: documenting sitemaps (was Re: Fixing a Howto)
References: <918019854.20051001115614@soethe.net>
 <433F04CE.7060903@apache.org> <709799954.20051002233737@soethe.net>
 <43405E6A.2000303@apache.org> <604654225.20051003094432@soethe.net>
In-Reply-To: <604654225.20051003094432@soethe.net>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit

Ferdinand Soethe wrote:
> Ross Gardler wrote:

...

[concerning the refdoc project in Cocoon]

>>>And once that documentation is added, that would be easy enough to
>>>read w/o having to extract it into html-documents. So I'd consider
>>>that stuff nice to have but nothing to put much effort into.
> 
> 
>>Fair enough. Thanks.
> 
> 
> That said I'm very much in favour of adding documentation there (the
> documentation of the html-pipeline should really be the only extensive
> document of that kind) and will do so where I come across useful
> pieces of info.

As you know I'm visiting all sitemaps at the moment, and will do so 
again in the near future as I clean them up (actually, I'm thinking of 
starting from the very beginning again, rebuilding as defined in our TR 
- but that's a whole different story).

Anyway, the point is. If you can point me at a document describing how 
to write this embedded documentation, or provide some examples of the 
kind of thing you want to see, or write a how-to on it (whichever is 
appropriate), then I will do my best to add comments as I go through.

Ross