Name

comment — comment (disable) parts of Interchange or HTML code

ATTRIBUTES

Attribute Pos. Req. Default Description
interpolate     0 interpolate input?
reparse     1 interpolate output?
hide     0 Hide the tag return value?

DESCRIPTION

The tag comments parts of ITL or HTML code. Content enclosed in the [comment] block will not be processed in any way, and will be stripped out of the final data sent to the clients.

You can use comment sections to provide code commentary, or effectively disable parts of code.

Interchange's [comment] tag is often preferred over HTML comments (<!--...--> blocks), because unlike [comment] blocks, HTML comments do get passed through to the clients.

BEHAVIOR

This tag does not appear to be affected by, or affect, the rest of Interchange.

EXAMPLES

Example: Using comment

[comment]
  Have no fear, for this is just one comment area!
[/comment]

Example: Disabling ITL code

This [nitems] tag below will never execute:

[comment]
  You have [nitems] items in your cart.
[/comment]

NOTES

[comment] blocks can be nested.

AVAILABILITY

comment is available in Interchange versions:

4.6.0-5.7.0 (git-head)

SOURCE

Interchange 5.7.0:

Source: code/SystemTag/comment.coretag
Lines: 18


# Copyright 2005-2007 Interchange Development Group and others
# 
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.  See the LICENSE file for details.
# 
# $Id: comment.coretag,v 1.2 2007-03-30 23:40:49 pajamian Exp $

# This tag exists to strip out any [comment]...[/comment] blocks
# that weren't caught by &Vend::Interpolate::vars_and_comments,
# e.g. in reparsed output from [perl] blocks

UserTag comment Version $Revision: 1.2 $
UserTag comment hasEndTag
UserTag comment Routine <<EOR
sub { '' }
EOR

AUTHORS

Interchange Development Group

SEE ALSO

debug(7ic)

DocBook! Interchange!