template::add_header (public)

 template::add_header [ -direction direction ] [ -src src ] \
    [ -params params ] [ -html html ]

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

Add a header include to the beginning of the document body. This function is used by site-wide services to add functionality to the beginning of a page. Examples include the developer support toolbar, acs-lang translation interface and the acs-templating WYSIWYG editor textarea place holder. If you are not implementing a site-wide service, you should not be using this function to add content to your page. You must supply either src or html.

Switches:

-direction (optional, defaults to "outer")

whether the header should be added as the outer most page content or the inner most

-src (optional)

the path to the include

-params (optional)

a list of name, value pairs to pass as parameter to the include

-html (optional)

literal html to include in the page. This parameter will be ignored if a values has been supplied for src.

See Also:

• template::add_footer

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

Testcases:

No testcase defined.

Source code:

    variable ::template::headers

    if {$src eq ""} {
        if {$html eq ""} {
            error "You must supply either -src or -html."
        }
        set values [list literal $html ""]
    } else {
        set values [list include $src $params]
    }

    if {[info exists headers]} {
      switch -- $direction {
        outer {set headers [linsert $headers 0 $values]}
        inner {lappend headers $values}
        default {error "unknown direction $direction"}
      }
    } else {
      set headers [list $values]
    }

XQL Not present:

Generic, PostgreSQL, Oracle