You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by Jose Alberto Fernandez <JF...@viquity.com> on 2000/12/12 22:36:23 UTC

RE: cvs commit: jakarta-velocity/xdocs vtl-reference-guide.xml te xen.xml install.xml

> From: Geir Magnusson Jr. [mailto:geirm@optonline.net]
> 
> 
> Christoph Reck wrote:
> > 
> > jcastura@locus.apache.org wrote:
> > > I'd like each directive to have an identical format.
> > 
> > Then we should normalize the position of the brakets, e.g.
> > we should use:
> >   #set( $value = $foo + 1 )
> > as-well-as:
> >   #if( condition )...#else...#end
> > and:
> >   #macro( vmname arg1 arg2 )
> > to match:
> >   #vmname( arg1 arg2 )
> > Note that I'm recommending to glue the bracket to the directive
> > and place spaces after the openingand before the closing bracket.
> 
> +1
>  

Why? I see no need for the "(" be together with the directive name.
I see no need for such rigid grammar, I do not see the current grammar to
be ambiguous or anything else. Why does this smplify explaining the
directives?

Jose Alberto


Re: cvs commit: jakarta-velocity/xdocs vtl-reference-guide.xml texen.xml install.xml

Posted by "Geir Magnusson Jr." <ge...@optonline.net>.
Jose Alberto Fernandez wrote:
> 
> > From: Geir Magnusson Jr. [mailto:geirm@optonline.net]
> >
> >
> > Christoph Reck wrote:
> > >
> > > jcastura@locus.apache.org wrote:
> > > > I'd like each directive to have an identical format.
> > >
> > > Then we should normalize the position of the brakets, e.g.
> > > we should use:
> > >   #set( $value = $foo + 1 )
> > > as-well-as:
> > >   #if( condition )...#else...#end
> > > and:
> > >   #macro( vmname arg1 arg2 )
> > > to match:
> > >   #vmname( arg1 arg2 )
> > > Note that I'm recommending to glue the bracket to the directive
> > > and place spaces after the openingand before the closing bracket.
> >
> > +1
> >
> 
> Why? I see no need for the "(" be together with the directive name.
> I see no need for such rigid grammar, I do not see the current grammar to
> be ambiguous or anything else. Why does this smplify explaining the
> directives?

Dude.  It's just the docs

> Jose Alberto

-- 
Geir Magnusson Jr.                               geirm@optonline.com
Velocity : it's not just a good idea. It should be the law.
http://jakarta.apache.org/velocity

Re: cvs commit: jakarta-velocity/xdocs vtl-reference-guide.xml texen.xml install.xml

Posted by "Geir Magnusson Jr." <ge...@optonline.net>.
Daniel Rall wrote:
> 
> "Geir Magnusson Jr." <ge...@optonline.net> writes:
> 
> > Jon Stevens wrote:
> > >
> > > on 12/12/2000 1:36 PM, "Jose  Alberto Fernandez" <JF...@viquity.com>
> > > wrote:
> > >
> > > > Why? I see no need for the "(" be together with the directive name.
> > > > I see no need for such rigid grammar, I do not see the current grammar to
> > > > be ambiguous or anything else. Why does this smplify explaining the
> > > > directives?
> > > >
> > > > Jose Alberto
> > >
> > > I agree.
> > >
> > > #foo (
> > > #foo     (
> > > #foo(
> > >
> > > should all work.
> >
> > The do all work. We are talking about documentation...
> >
> > For the documentation, which was the original post of this thread, a
> > single consistant style might be nice and easier to read.
> 
> I agree with you, but there should be a note saying that variations
> are in fact functional.  :)

Maybe we could have random amounts of spaces inserted at render time in
the directive examples in the docs on the site :)

(And they are functional...)

geir

-- 
Geir Magnusson Jr.                               geirm@optonline.com
Velocity : it's not just a good idea. It should be the law.
http://jakarta.apache.org/velocity

Re: cvs commit: jakarta-velocity/xdocs vtl-reference-guide.xml texen.xml install.xml

Posted by Christoph Reck <Ch...@dlr.de>.
I mean't a consistent documentation giving the hint of a recommended
coding style.

> > > #foo (
> > > #foo     (
> > > #foo(
> > >
> > > should all work.
> >
> > The do all work. We are talking about documentation...
> >
> > For the documentation, which was the original post of this thread, a
> > single consistant style might be nice and easier to read.
> 
> I agree with you, but there should be a note saying that variations
> are in fact functional.  :)

+1 Sure, the doc should contain a hint that any spaces between the 
directive and opening paren are optional (but beware - were not
speaking whitespaces! - '\n' is not allowed!).


P.S. I forgot to state that the velocimacro declaration example int
the doc is buggy:
  #macro( vmname arg1 arg2 )
should be:
  #macro( vmname $arg1 $arg2 )
to be compatible with the #set declaration...


:) Christoph

Re: cvs commit: jakarta-velocity/xdocs vtl-reference-guide.xml texen.xml install.xml

Posted by Daniel Rall <dl...@finemaltcoding.com>.
"Geir Magnusson Jr." <ge...@optonline.net> writes:

> Jon Stevens wrote:
> > 
> > on 12/12/2000 1:36 PM, "Jose  Alberto Fernandez" <JF...@viquity.com>
> > wrote:
> > 
> > > Why? I see no need for the "(" be together with the directive name.
> > > I see no need for such rigid grammar, I do not see the current grammar to
> > > be ambiguous or anything else. Why does this smplify explaining the
> > > directives?
> > >
> > > Jose Alberto
> > 
> > I agree.
> > 
> > #foo (
> > #foo     (
> > #foo(
> > 
> > should all work.
> 
> The do all work. We are talking about documentation...
> 
> For the documentation, which was the original post of this thread, a
> single consistant style might be nice and easier to read.

I agree with you, but there should be a note saying that variations
are in fact functional.  :)

Daniel

Re: cvs commit: jakarta-velocity/xdocs vtl-reference-guide.xml texen.xml install.xml

Posted by "Geir Magnusson Jr." <ge...@optonline.net>.
Jon Stevens wrote:
> 
> on 12/12/2000 1:36 PM, "Jose  Alberto Fernandez" <JF...@viquity.com>
> wrote:
> 
> > Why? I see no need for the "(" be together with the directive name.
> > I see no need for such rigid grammar, I do not see the current grammar to
> > be ambiguous or anything else. Why does this smplify explaining the
> > directives?
> >
> > Jose Alberto
> 
> I agree.
> 
> #foo (
> #foo     (
> #foo(
> 
> should all work.

The do all work. We are talking about documentation...

For the documentation, which was the original post of this thread, a
single consistant style might be nice and easier to read.

geir


-- 
Geir Magnusson Jr.                               geirm@optonline.com
Velocity : it's not just a good idea. It should be the law.
http://jakarta.apache.org/velocity

Re: cvs commit: jakarta-velocity/xdocs vtl-reference-guide.xml te xen.xml install.xml

Posted by Daniel Rall <dl...@finemaltcoding.com>.
Jon Stevens <jo...@latchkey.com> writes:

> on 12/12/2000 1:36 PM, "Jose  Alberto Fernandez" <JF...@viquity.com>
> wrote:
> 
> > Why? I see no need for the "(" be together with the directive name.
> > I see no need for such rigid grammar, I do not see the current grammar to
> > be ambiguous or anything else. Why does this smplify explaining the
> > directives?
> > 
> > Jose Alberto
> 
> I agree.
> 
> #foo (
> #foo     (
> #foo(
> 
> should all work.

If we really need those blasted parens, all those examples should work
flawlessly.

Daniel

Re: cvs commit: jakarta-velocity/xdocs vtl-reference-guide.xml te xen.xml install.xml

Posted by Jon Stevens <jo...@latchkey.com>.
on 12/12/2000 1:36 PM, "Jose  Alberto Fernandez" <JF...@viquity.com>
wrote:

> Why? I see no need for the "(" be together with the directive name.
> I see no need for such rigid grammar, I do not see the current grammar to
> be ambiguous or anything else. Why does this smplify explaining the
> directives?
> 
> Jose Alberto

I agree.

#foo (
#foo     (
#foo(

should all work.

-jon

-- 
Honk if you love peace and quiet.