[jira] Updated: (VELOCITY-576) Move the section about converting to strings

2007-12-13 Thread Spencer Davis (JIRA)

 [ 
https://issues.apache.org/jira/browse/VELOCITY-576?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Spencer Davis updated VELOCITY-576:
---

Summary: Move the section about converting to strings  (was: Move the 
section about strings being converted)

> Move the section about converting to strings
> 
>
> Key: VELOCITY-576
> URL: https://issues.apache.org/jira/browse/VELOCITY-576
> Project: Velocity
>  Issue Type: Improvement
>  Components: Documentation
>Reporter: Spencer Davis
>Priority: Minor
>
> In the References section of the User Guide it says:
> Everything coming to and from a reference is treated as a String object. If 
> there is an object that 
> represents $foo (such as an Integer object), then Velocity will call its 
> .toString() method to resolve 
> the object into a String.
> This would make more sense if it was at the end of the section on references 
> so that the different
> types of objects are introduced before this is.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Updated: (VELOCITY-576) Move the section about strings being converted

2007-12-13 Thread Spencer Davis (JIRA)

 [ 
https://issues.apache.org/jira/browse/VELOCITY-576?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Spencer Davis updated VELOCITY-576:
---

Summary: Move the section about strings being converted  (was: he section 
about all variables being converted to strings should )

> Move the section about strings being converted
> --
>
> Key: VELOCITY-576
> URL: https://issues.apache.org/jira/browse/VELOCITY-576
> Project: Velocity
>  Issue Type: Improvement
>  Components: Documentation
>Reporter: Spencer Davis
>Priority: Minor
>
> In the References section of the User Guide it says:
> Everything coming to and from a reference is treated as a String object. If 
> there is an object that 
> represents $foo (such as an Integer object), then Velocity will call its 
> .toString() method to resolve 
> the object into a String.
> This would make more sense if it was at the end of the section on references 
> so that the different
> types of objects are introduced before this is.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Created: (VELOCITY-576) he section about all variables being converted to strings should

2007-12-11 Thread Spencer Davis (JIRA)
he section about all variables being converted to strings should 
-

 Key: VELOCITY-576
 URL: https://issues.apache.org/jira/browse/VELOCITY-576
 Project: Velocity
  Issue Type: Improvement
  Components: Documentation
Reporter: Spencer Davis
Priority: Minor


In the References section of the User Guide it says:

Everything coming to and from a reference is treated as a String object. If 
there is an object that 
represents $foo (such as an Integer object), then Velocity will call its 
.toString() method to resolve 
the object into a String.

This would make more sense if it was at the end of the section on references so 
that the different
types of objects are introduced before this is.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Updated: (VELOCITY-572) Need to make escaping examples more clear

2007-12-11 Thread Spencer Davis (JIRA)

 [ 
https://issues.apache.org/jira/browse/VELOCITY-572?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Spencer Davis updated VELOCITY-572:
---

Description: 
In the User Guide, the examples for escaping could be changed to make it easier 
to understand
for newcomers. It would be better if there was an example showing how to escape 
(with one 
backslash) and then move on to the more complicated examples.

  was:
The examples for escaping could be changed to make it easier to understand for 
newcomers. 
It would be better if there was an example showing how to escape (with one 
backslash) and
then move on to the more complicated examples.


> Need to make escaping examples more clear
> -
>
> Key: VELOCITY-572
> URL: https://issues.apache.org/jira/browse/VELOCITY-572
> Project: Velocity
>  Issue Type: Improvement
>  Components: Documentation
>Reporter: Spencer Davis
>
> In the User Guide, the examples for escaping could be changed to make it 
> easier to understand
> for newcomers. It would be better if there was an example showing how to 
> escape (with one 
> backslash) and then move on to the more complicated examples.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Updated: (VELOCITY-572) Need to make escaping examples more clear

2007-12-11 Thread Spencer Davis (JIRA)

 [ 
https://issues.apache.org/jira/browse/VELOCITY-572?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Spencer Davis updated VELOCITY-572:
---

Comment: was deleted

> Need to make escaping examples more clear
> -
>
> Key: VELOCITY-572
> URL: https://issues.apache.org/jira/browse/VELOCITY-572
> Project: Velocity
>  Issue Type: Improvement
>  Components: Documentation
>Reporter: Spencer Davis
>
> The examples for escaping could be changed to make it easier to understand 
> for newcomers. 
> It would be better if there was an example showing how to escape (with one 
> backslash) and
> then move on to the more complicated examples.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Created: (VELOCITY-575) Shorthand Notation should be called regular notation

2007-12-11 Thread Spencer Davis (JIRA)
Shorthand Notation should be called regular notation


 Key: VELOCITY-575
 URL: https://issues.apache.org/jira/browse/VELOCITY-575
 Project: Velocity
  Issue Type: Improvement
  Components: Documentation
Reporter: Spencer Davis
Priority: Minor


In the User Guide, it shows the "shorthand" notation for references but does not
mention any other notation until the section about formal notation. In the VTL
Reference, it calls the same notation "regular" notation. The User Guide should
be changed so that it is consistent with the reference. This also prevents 
confusion
 about calling it shorthand without mentioning any other notations until much 
later on.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Created: (VELOCITY-574) VTL Comment Blocks description is not clear

2007-12-11 Thread Spencer Davis (JIRA)
VTL Comment Blocks description is not clear
---

 Key: VELOCITY-574
 URL: https://issues.apache.org/jira/browse/VELOCITY-574
 Project: Velocity
  Issue Type: Improvement
  Components: Documentation
Reporter: Spencer Davis
Priority: Minor


The User Guide says: 

There is a third type of comment, the VTL comment block, which may be used to 
store
such information as the document author and versioning information:
#**
This is a VTL comment block and
may be used to store such information
as the document author and versioning
information:
@author
@version 5
*#

The description only says that it can be used to store the information but not 
why you
would want to store the information or how it could be used. Also, the examples 
should
either show more of how it is used or there should be an explanation of how to 
use them.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Updated: (VELOCITY-574) VTL Comment Blocks description is not clear

2007-12-11 Thread Spencer Davis (JIRA)

 [ 
https://issues.apache.org/jira/browse/VELOCITY-574?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Spencer Davis updated VELOCITY-574:
---

Description: 
The User Guide says: 

There is a third type of comment, the VTL comment block, which may be used to 
store
such information as the document author and versioning information:
#**
This is a VTL comment block and
may be used to store such information
as the document author and versioning
information:
@author
@version 5
*#

The description only says that it can be used to store the information but not 
why you
would want to store the information or how it could be used. Also, the examples 
should
either show more of how it is used or there should be an explanation of how to 
use 
@author and @version.

  was:
The User Guide says: 

There is a third type of comment, the VTL comment block, which may be used to 
store
such information as the document author and versioning information:
#**
This is a VTL comment block and
may be used to store such information
as the document author and versioning
information:
@author
@version 5
*#

The description only says that it can be used to store the information but not 
why you
would want to store the information or how it could be used. Also, the examples 
should
either show more of how it is used or there should be an explanation of how to 
use them.


> VTL Comment Blocks description is not clear
> ---
>
> Key: VELOCITY-574
> URL: https://issues.apache.org/jira/browse/VELOCITY-574
> Project: Velocity
>  Issue Type: Improvement
>  Components: Documentation
>Reporter: Spencer Davis
>Priority: Minor
>
> The User Guide says: 
> There is a third type of comment, the VTL comment block, which may be used to 
> store
> such information as the document author and versioning information:
> #**
> This is a VTL comment block and
> may be used to store such information
> as the document author and versioning
> information:
> @author
> @version 5
> *#
> The description only says that it can be used to store the information but 
> not why you
> would want to store the information or how it could be used. Also, the 
> examples should
> either show more of how it is used or there should be an explanation of how 
> to use 
> @author and @version.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Created: (VELOCITY-573) Combine the two sections about escaping

2007-12-11 Thread Spencer Davis (JIRA)
Combine the two sections about escaping
---

 Key: VELOCITY-573
 URL: https://issues.apache.org/jira/browse/VELOCITY-573
 Project: Velocity
  Issue Type: Improvement
  Components: Documentation
Reporter: Spencer Davis


It would make more sense to just have one section of the User Guide about 
escaping. The two 
sections, "Escaping Valid VTL References" and "Escaping VTL Directives" should 
be combined
into one section where the "Escaping VTL Directives" section is now.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Commented: (VELOCITY-572) Need to make escaping examples more clear

2007-12-11 Thread Spencer Davis (JIRA)

[ 
https://issues.apache.org/jira/browse/VELOCITY-572?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12550752
 ] 

Spencer Davis commented on VELOCITY-572:


I forgot to mention, this is in the User Guide.

> Need to make escaping examples more clear
> -
>
> Key: VELOCITY-572
> URL: https://issues.apache.org/jira/browse/VELOCITY-572
> Project: Velocity
>  Issue Type: Improvement
>  Components: Documentation
>Reporter: Spencer Davis
>
> The examples for escaping could be changed to make it easier to understand 
> for newcomers. 
> It would be better if there was an example showing how to escape (with one 
> backslash) and
> then move on to the more complicated examples.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Created: (VELOCITY-572) Need to make escaping examples more clear

2007-12-11 Thread Spencer Davis (JIRA)
Need to make escaping examples more clear
-

 Key: VELOCITY-572
 URL: https://issues.apache.org/jira/browse/VELOCITY-572
 Project: Velocity
  Issue Type: Improvement
  Components: Documentation
Reporter: Spencer Davis


The examples for escaping could be changed to make it easier to understand for 
newcomers. 
It would be better if there was an example showing how to escape (with one 
backslash) and
then move on to the more complicated examples.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Updated: (VELTOOLS-84) Create .jar dependency documentation as has been done with Velocity project

2007-12-10 Thread Spencer Davis (JIRA)

 [ 
https://issues.apache.org/jira/browse/VELTOOLS-84?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Spencer Davis updated VELTOOLS-84:
--

Attachment: velocitytoolsdependencies.xml

I have attached the finished documentation.

> Create .jar dependency documentation as has been done with Velocity project
> ---
>
> Key: VELTOOLS-84
> URL: https://issues.apache.org/jira/browse/VELTOOLS-84
> Project: Velocity Tools
>  Issue Type: Task
>  Components: Documentation
>Reporter: Peter Locke
> Fix For: 2.0
>
> Attachments: DEPENDENCY_NOTES.txt, velocitytoolsdependencies.xml
>
>
> There are great pages for the velocity engine (links below), something 
> similar would be very handy for the tools subproject for integration into 
> larger applications.  Nathan requested a Jira so it does not get forgotten, 
> and here it is.
> http://velocity.apache.org/engine/devel/jar-dependencies.html
> http://velocity.apache.org/engine/devel/dependencies.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Issue Comment Edited: (VELOCITY-571) Create a glossary of significant terms and abbreviations

2007-12-09 Thread Spencer Davis (JIRA)

[ 
https://issues.apache.org/jira/browse/VELOCITY-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12549856
 ] 

spencerdavis edited comment on VELOCITY-571 at 12/9/07 11:30 AM:
--

I posted the finished glossary

  was (Author: spencerdavis):
This is the finished glossary.
  
> Create a glossary of significant terms and abbreviations
> 
>
> Key: VELOCITY-571
> URL: https://issues.apache.org/jira/browse/VELOCITY-571
> Project: Velocity
>  Issue Type: Task
>Reporter: Spencer Davis
>Priority: Minor
> Attachments: velocityglossary.html
>
>
> Like most long-lived communities, the Velocity project has over the years 
> developed specific meanings for more broadly used terms. We also have 
> developed a number of sub-projects whose names are not always explanatory of 
> their function. Gather a list of significant terms, names and acronyms used 
> throughout the Velocity documentation and create an alphabetized glossary 
> listing both them with their Velocity-specific definition. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Created: (VELOCITY-571) Create a glossary of significant terms and abbreviations

2007-12-09 Thread Spencer Davis (JIRA)
Create a glossary of significant terms and abbreviations


 Key: VELOCITY-571
 URL: https://issues.apache.org/jira/browse/VELOCITY-571
 Project: Velocity
  Issue Type: Task
Reporter: Spencer Davis
Priority: Minor
 Attachments: velocityglossary.html

Like most long-lived communities, the Velocity project has over the years 
developed specific meanings for more broadly used terms. We also have developed 
a number of sub-projects whose names are not always explanatory of their 
function. Gather a list of significant terms, names and acronyms used 
throughout the Velocity documentation and create an alphabetized glossary 
listing both them with their Velocity-specific definition. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



[jira] Updated: (VELOCITY-571) Create a glossary of significant terms and abbreviations

2007-12-09 Thread Spencer Davis (JIRA)

 [ 
https://issues.apache.org/jira/browse/VELOCITY-571?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Spencer Davis updated VELOCITY-571:
---

Attachment: velocityglossary.html

This is the finished glossary.

> Create a glossary of significant terms and abbreviations
> 
>
> Key: VELOCITY-571
> URL: https://issues.apache.org/jira/browse/VELOCITY-571
> Project: Velocity
>  Issue Type: Task
>Reporter: Spencer Davis
>Priority: Minor
> Attachments: velocityglossary.html
>
>
> Like most long-lived communities, the Velocity project has over the years 
> developed specific meanings for more broadly used terms. We also have 
> developed a number of sub-projects whose names are not always explanatory of 
> their function. Gather a list of significant terms, names and acronyms used 
> throughout the Velocity documentation and create an alphabetized glossary 
> listing both them with their Velocity-specific definition. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]