You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cocoon.apache.org by David Crossley <cr...@indexgeo.com.au> on 2001/10/11 10:03:56 UTC

[Patch] xdocs/tutorial.xml

The attached patch to tutorial.xml does this ...

- Replaces every mention of "Cocoon" with "@docname@".
(Note that there are also some other xdocs that do not yet use
the replacement tag.)

- Adds a paragraph to the introduction to explain that the
screenshots come from the "tutorial" webapp, which they
can build themselves.

cheers, David Crossley

AW: [Patch] xdocs/tutorial.xml

Posted by Carsten Ziegeler <cz...@sundn.de>.
> Stefano Mazzocchi wrote:
> 
> David Crossley wrote:
> > 
> > The attached patch to tutorial.xml does this ...
> > 
> > - Replaces every mention of "Cocoon" with "@docname@".
> > (Note that there are also some other xdocs that do not yet use
> > the replacement tag.)
> 
> David, thanks for the patch.
> 
> As a side note, can't we change that @docname@ to something more useful?
> 
Yes, we could do this, but I think we should remove it again. See below.

> And, BTW, can you tell me *why* we have Cocoon written as a token
> expansion? Do you guys plan to use the same documentation for another
> project when you fork it? :)
> 
No, at the time this was introduced, we were not exactly sure what the 
name is we should use. Would it be simply "Cocoon" or "Apache Cocoon"
or "Cocoon2" or "Cocoon 2" or "Apache Cocoon 2" ....
I think we agreed by the time to "Apache Cocoon 2", but as we were not
that happy with it, we used the tokens instead, so that we could simply
change the name very quickly.
As you suggested last week, we should remove the version number, so
it should be called "Apache Cocoon". 

Looking at it, I it might be a little bit ugly with this. So, the best
way would be to revert the changes and replace the token with the real
name in all documents (Renaming @docname@ with "Apache Cocoon" in fact).

Whereever we need the version information there are the other tokens
@version@ etc.

Carsten


> I understand the need for versioning, but not all instances of Cocoon
> should have a version associated with it, or am I wrong?
> 
> I'm a pain, I know, but gosh, sometimes it seems we use features just
> because they are there.
> 
> Bah, a little puzzled.
> 
> Stefano.
> 
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
> For additional commands, email: cocoon-dev-help@xml.apache.org
> 

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


Re: [Patch] xdocs/tutorial.xml

Posted by Stefano Mazzocchi <st...@apache.org>.
David Crossley wrote:
> 
> The attached patch to tutorial.xml does this ...
> 
> - Replaces every mention of "Cocoon" with "@docname@".
> (Note that there are also some other xdocs that do not yet use
> the replacement tag.)

David, thanks for the patch.

As a side note, can't we change that @docname@ to something more useful?

And, BTW, can you tell me *why* we have Cocoon written as a token
expansion? Do you guys plan to use the same documentation for another
project when you fork it? :)

I understand the need for versioning, but not all instances of Cocoon
should have a version associated with it, or am I wrong?

I'm a pain, I know, but gosh, sometimes it seems we use features just
because they are there.

Bah, a little puzzled.

Stefano.



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


AW: [Patch] xdocs/tutorial.xml

Posted by Carsten Ziegeler <cz...@sundn.de>.
Thanks David!

It's applied.

Carsten

> -----Ursprüngliche Nachricht-----
> Von: David Crossley [mailto:crossley@indexgeo.com.au]
> Gesendet: Donnerstag, 11. Oktober 2001 10:04
> An: cocoon-dev@xml.apache.org
> Betreff: [Patch] xdocs/tutorial.xml
>
>
> The attached patch to tutorial.xml does this ...
>
> - Replaces every mention of "Cocoon" with "@docname@".
> (Note that there are also some other xdocs that do not yet use
> the replacement tag.)
>
> - Adds a paragraph to the introduction to explain that the
> screenshots come from the "tutorial" webapp, which they
> can build themselves.
>
> cheers, David Crossley
>


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