Forum OpenACS Improvement Proposals (TIPs): Re: TIP #54 (Proposed) Add an adp tag to handle documenting and commenting adp files.

Collapse
2: Re: TIP #54 (Proposed) Add an adp tag to handle documenting and commenting adp files. (response to 1)
Posted by Randy O'Meara on 03/13/04 07:19 AM
<%
# This may be the type of
# comment mechanism you are
# looking for...

# The user does not see it
%>

Collapse
3: Re: TIP #54 (Proposed) Add an adp tag to handle documenting and commenting adp files. (response to 2)
Posted by Benjamin Bytheway on 03/13/04 07:40 AM
That is one option. However, as I understand it, the best practices recommendations for the project are to not use <% %> and <tcl></tcl> in adp templates if at all possible.

Another option would be, as I mentioned in the proposal, to do something like:

<if 0>
# Here are some comments
# that will be stripped
# before the compiled template
# is sent to the user
</if>

Again, this works, but I think a more generalized commenting mechanism would be beneficial. If this is ultimately rejected by the OCT, your option is probably what I'll use instead.