Revising Documentation (not as off-topic as one might think)

[John Lianoglou <jo...@arachnedesign.net>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hey folks,

I know there's a whole mailing list dedicated to the documentation, but 
I've tried posting there in the past, and it doesn't seem very 
productive, as it winds up being a sea of Wiki update notifications...

This is *important*, tho.   :)

I was wondering if someone could direct me to the right person to 
contact for this matter... or, if indeed that "right person" might be 
following this list.

I have found an error in the documentation regarding the behavior of 
the Source Writing Transformer: the docs state that the Source Writing 
Transformer does NOT honor prefixes and namespaces, when in fact it 
(now?) does!

I've taken it upon myself to classify this issue as *important* because 
this error is provides information that is exactly *opposite* to the 
actual behavior.

Based on the information printed on the docs, I spent a couple hours 
and concocted a hack to overcome this documentented shortcoming, only 
to realize that it wasn't necessary at all. I'm confident that a 
revision could save a number of people some valuable time in the future 
:)



jL



John Lianoglou | Vice President | ARACHNEdesign
http://www.arachnedesign.net
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.3 (Darwin)

iD8DBQFAW+V22mjmCyerauURAkM0AKDHMCedDYMkbqPpIbZ5aKEY0s/yFgCfRI0x
SIGztvbuEpaUj3dRZq7Oyrw=
=Hzh6
-----END PGP SIGNATURE-----


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@cocoon.apache.org
For additional commands, e-mail: users-help@cocoon.apache.org

Re: Revising Documentation (not as off-topic as one might think)

[Geoff Howard <co...@leverageweb.com>]

John Lianoglou wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> 
> Hey folks,
> 
> I know there's a whole mailing list dedicated to the documentation, but 
> I've tried posting there in the past, and it doesn't seem very 
> productive, as it winds up being a sea of Wiki update notifications...

In fact, we've decided to use the docs list only for those update notifications.

...

> I've taken it upon myself to classify this issue as *important* because 
> this error is provides information that is exactly *opposite* to the 
> actual behavior.
> 
> Based on the information printed on the docs, I spent a couple hours and 
> concocted a hack to overcome this documentented shortcoming, only to 
> realize that it wasn't necessary at all. I'm confident that a revision 
> could save a number of people some valuable time in the future :)

Documentation issues are handled through bugzilla same as coding issues.  Can 
you enter a bug there for this, and even supply a diff -u patch if you're 
willing and able?  See the contributing page at the cocoon site for more info.

Thanks,

Geoff

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@cocoon.apache.org
For additional commands, e-mail: users-help@cocoon.apache.org