Generates hidden input tags for all values in a form submission. Typically used to create a confirmation page following an initial submission. DEPRECATED: this proc has been superseded by export_vars, which also offers additional features.

Returns:

A string containing hidden input tags for inclusion in a form.

See Also:

• export_vars

Testcases:

No testcase defined.

Reach back into the tag stack for the last enclosing instance of a tag. Typically used where the usage of a tag depends on its context, such as the "group" tag within a "multiple" tag. Deprecated, use:

    set tag [template::enclosing_tag <tag-type>]
    set attribute [template::tag_attribute tag <attribute>]
    

Parameters:

tag (required)

The name of the enclosing tag to look for.

See Also:

• template::enclosing_tag
• template::tag_attribute

Testcases:

No testcase defined.

Get the template directory The body is doublequoted, so it is interpreted when this file is read

See Also:

• template::resource_path

Testcases:

No testcase defined.

Parameters:

statement_name (required)

Standard db_api statement name used to hook into query dispatcher

sql (required)

Query to use when processing this command

body (required)

Code body to be execute for each result row of the returned query

See Also:

• db_foreach

Testcases:

No testcase defined.

Expires an existing cookie.

Parameters:

name (required)

domain (optional)

See Also:

• ad_get_cookie

Testcases:

No testcase defined.

a proc used for debugging, just prints out a value to the error log

Parameters:

ref (required)

See Also:

• use simple "ns_log ...." instead

Testcases:

No testcase defined.

Retrieve the value of a cookie and return it Return the default if no such cookie exists

Parameters:

name (required)

default_value (optional)

See Also:

• ad_get_cookie

Testcases:

No testcase defined.

Retrieve a stored parameter, or "" if no such parameter If section/key are present, read the parameter from the specified section.key in the INI file, and cache them under the given name

Parameters:

name (required)

section (optional)

key (optional)

Testcases:

No testcase defined.

Converts an array to an option list DEPRECATED: this proc can be replaced by simple tcl idioms

Parameters:

array_ref (optional, defaults to "opts")

The name of the array in the calling frame containing option-value pairs. Defaults to "opts".

Returns:

A list of option-value pairs suitable for appending to a command.

See Also:

• plain tcl

Testcases:

No testcase defined.

runs a block of code foreach row in a multirow. Using "template::multirow foreach" is recommended over this routine.

Parameters:

name (required)

the name of the multirow over which the block of code is iterated

code_text (required)

the block of code in the for loop; this block can reference any of the columns belonging to the multirow specified; with the multirow named "fake_multirow" containing columns named "spanky" and "foobar",to set the column spanky to the value of column foobar use:
set fake_multirow.spanky @fake_multirow.foobar@

note: this block of code is evaluated in the same scope as the .tcl page that uses this procedure

Author:

simon

See Also:

• template::multirow

Testcases:

No testcase defined.

capitalizes the first letter of a string

Parameters:

string_ref (required)

Returns:

returns formatted string (UNFINISHED. FIXME.)

See Also:

• use "string totitle ..."

Testcases:

No testcase defined.

Quote possible HTML tags in the contents of the html parameter.

Parameters:

html (required)

See Also:

• ns_quotehtml

Testcases:

No testcase defined.

uses ns_library to find the server root, may not always be accurate because it essentially asks for the Tcl library path and strips off the last /tcl directory.

See Also:

• use $::acs::rootdir instead

Testcases:

No testcase defined.

Create a cookie with specified parameters. The expiration state may be persistent, session, or a number of minutes from the current time.

Parameters:

expire_state (required)

name (required)

value (required)

domain (optional)

See Also:

• ad_set_cookie

Testcases:

No testcase defined.

Set a stored parameter

Parameters:

name (required)

value (required)

Testcases:

No testcase defined.

Turns an ns_set into a key-value list, excluding any number of specified keys. Useful for turning the contents on an ns_set into a form that may be cached or manipulated as a native Tcl data structure. DEPRECATED: this proc can be replaced with trivial ns_set and plain tcl idioms

Parameters:

set (required)

A reference to an ns_set.

Returns:

A list in the form { key value key value key value ... }

See Also:

• ns_set

Testcases:

No testcase defined.

Declare local variables for set values DEPRECATED: this proc can be replaced with trivial ns_set and plain tcl idioms

Parameters:

set (required)

A reference to an ns_set.

See Also:

• ns_set

Testcases:

No testcase defined.

Parameters:

string (required)

indices (required)

See Also:

• use "string range instead"

Testcases:

No testcase defined.

Convert a Tcl list to a SQL list, for use with the "in" statement. Uses double single quotes to escape single quotes in values. DEPRECATED: NaviServer now provides a native API ns_dbquotelist for this; a tcl-implemented fallback for older NaviServer versions exists in current OpenACS code.

Parameters:

lst (required)

See Also:

• ns_dbquotelist

Testcases:

No testcase defined.

Implements the richtext widget, which offers rich text editing options. If the acs-templating.UseHtmlAreaForRichtextP parameter is set to true (1), this will use the htmlArea WYSIWYG editor widget. Otherwise, it will use a normal textarea, with a drop-down to select a format. The available formats are:

• Enhanced text = Allows HTML, but automatically inserts line and paragraph breaks.
• Plain text = Automatically inserts line and paragraph breaks, and quotes all HTML-specific characters, such as less-than, greater-than, etc.
• Fixed-width text = Same as plain text, but conserves spacing; useful for tabular data.
• HTML = normal HTML.

Parameters:

element_reference (required)

tag_attributes (required)

See Also:

• template::widget::richtext

Testcases:

No testcase defined.