template::adp_include (public)

 template::adp_include [ -uplevel uplevel ] src varlist

Defined in packages/acs-templating/tcl/parse-procs.tcl

return the output of a Tcl/ADP pair as a string. adp_level is set to the calling procedure so that pass by reference works. and example of using this is in the search indexer for various content types:

    bookshelf::book::get -book_id $book_id -array bookdata
    set body [template::adp_include /packages/bookshelf/lib/one-book  [list &book "bookdata" base $base style feed]]
    

The [list &book "bookdata" ...] tells adp_include to pass the book array by reference to the adp include, where it is referred to via @book.field@.

Switches:

-uplevel

(defaults to "1") (optional)

how far up the stack should the adp_level be set to (default is the calling procedures level)

Parameters:

src - should be the path to the Tcl/ADP pair relative to the server root, as with the src attribute to the include tag.
varlist - a list of {key value key value ... } varlist can also be &var foo for things passed by reference (arrays and multirows)

Returns:

the string generated by the Tcl/ADP pair.

Author:

Jeff Davis davis@xarg.net

Created:

2004-06-02

See Also:

• template::adp_parse

Partial Call Graph (max 5 caller/called nodes):

Testcases:

page_contracts, templates_and_scripts