ns_adp_include - Parse an ADP file and return its output
This command includes an ADP file in some other ADP file. ADP files can be nested by including each other up to the maximum of 256 levels deep.
This command is only applicable while parsing an ADP file. Use ns_adp_parse to parse ADPs from outside the context of an ADP.
Includes the content of an ADP file, including the text blocks and any output generated by script blocks in the current output buffer. The execution occurs in a new call frame with private local variables similar to a Tcl procedure. The filename can be absolute or will be considered relative to the current ADP working directory which is the directory of the previously included file.
The optional -cache argument specifies the time to cache the results of execution. All output generated by any scripts and included ADP files are saved for subsequent requests unless an included ADP file has a -nocache option. The use of -cache and -nocache can be used to increase performance of ADP files used to generated a mix of personalized, non-cacheable, content and shared content which changes more slowly. Under high load, the performance improvement can be substantial, especially in cases where the cached content is the result of accessing a slow databases or web services.
The option -tcl can be used to wrap the .tcl file given by filename on the fly by an ADP page.
The optional arguments are passed to the included adp page, and can be accessed there by the ns_adp_argc, ns_adp_argv, and ns_adp_bind_args functions.
### ### Example: ADP file "a.adp" includes ADP file "b.adp" ### # In a.adp: begin of a.adp<br> <% ns_adp_include b.adp %> end of a.adp<br> # In b.adp: begin of b.adp<br> ...<br> <% ns_adp_puts "Hello, world!" %><br> ...<br> end of b.adp<br>
# Including ADP file a.adp:
begin of a.adp<br>
<% ns_adp_include b.adp 1 2 3%>
end of a.adp<br>
# Included ADP file b.adp:
begin of b.adp<br>
...<br>
<% ns_adp_puts "Arguments: [ns_adp_argv]" %><br>
<%
ns_adp_bind_args x y z
ns_adp_puts "x=$x y=$y z=$z" ;# => {1 2 3}
%>
...<br>
end of b.adp<br>