'\"
'\" Generated from file 'substify' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2006 Wojciech Kocjan <wojciech.kocjan@dq.pl>
'\"
.so man.macros
.TH "substify" n 0.1  "Text expander for later use in subst command"
.BS
.SH NAME
substify \- Text expander for later use in subst command
.SH SYNOPSIS
package require \fBTcl  8.4\fR
.sp
package require \fBsubstify::substify  ?1.0?\fR
.sp
\fBsubstify::substify\fR \fIstring\fR \fIbeginstr\fR \fIendstr\fR
.sp
.BE
.SH DESCRIPTION
This package allows parsing templates that include
Tcl code embedded inside non-Tcl information.
.PP
The behavior is similar to textutil::expander, but the purpose
is that it is converted once and can then be passed to \fBsubst\fR
multiple times.
.SH COMMAND
.TP
\fBsubstify::substify\fR \fIstring\fR \fIbeginstr\fR \fIendstr\fR
Converts a string so that it can be passed to subst.
It escapes the string outside commands and passes the commands
so that the parsing is similar to PHP or ASP/ADP parsers.
The behavior is similar to textutil::expander, but the purpose
is that it is converted once and can then be passed to \fBsubst\fR
multiple times.
Parameter \fIstring\fR is the string to be parsed.
\fIBeginstr\fR is the string that begins a command.
\fIEndstr\fR is the string that ends a command.
.SH EXAMPLES
.nf

# small substify example
package require substify

puts [subst [substify::substify {1 + 1 = <%expr {1+1}%>.
Platform is <%=$tcl_platform(platform)%>.} "<%" "%>"]]
1 + 1 = 2.
Platform is windows.

.fi
.SH "SEE ALSO"
substify_browser, substify_configgui
.SH KEYWORDS
log, substify
.SH COPYRIGHT
.nf
Copyright (c) 2006 Wojciech Kocjan <wojciech.kocjan@dq.pl>

.fi