Adds JavaScript code to an event handler in the body tag. Several JavaScript code blocks may be assigned to each handler by subsequent calls to template::add_body_handler.

If your script may only be added once you may supply an identifier. Subsequent calls to template::add_body_handler with the same identifier will replace your script rather than appending to it.

event may be one of:

• onload
• onunload
• onclick
• ondblclick
• onmousedown
• onmouseup
• onmouseover
• onmousemove
• onmouseout
• onkeypress
• onkeydown
• onkeyup

Switches:

-event

(required)

the event during which the supplied script should be executed

-script

(required)

the JavaScript code to execute

-identifier

(defaults to "anonymous") (optional)

a name, if supplied, used to ensure this JavaScript code is only added to the handler once

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

Testcases:

templates_and_scripts

Add a script to the start of the body section of the document to be returned to the users client. You must supply either src or script.

Switches:

-async

(boolean) (optional)

whether execution of the script should be executed asynchronously as soon as it is available

-charset

(optional)

the charset attribute of the script tag, i.e. the character set of the script if it differs from the main document

-crossorigin

(optional)

Enumerated attribute to indicate whether CORS (Cross-Origin Resource Sharing) should be used

-defer

(boolean) (optional)

whether execution of the script should be deferred until after the page has been loaded

-integrity

(optional)

provide hash values for W3C Subresource Integrity recommendation

-script

(optional)

the inline script for the body of the script tag. This parameter will be ignored if a value has been supplied for src

-src

(optional)

the src attribute of the script tag, i.e. the source url of the script

-type

(defaults to "text/javascript") (optional)

the type attribute of the script tag, e.g. 'text/javascript'

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

Testcases:

templates_and_scripts, xowiki_test_cases

Register an event handler for confirmation dialogs for elements either with a specified ID, CSS class, a formfield targeted by form id and field name or a CSS selector.

Switches:

-event

(defaults to "click") (optional)

register confirm handler for this type of event

-message

(defaults to "Are you sure?") (optional)

Message to be displayed in the confirmation dialog. If the message looks like a message key (starting and ending with a hash sign) it is treated as a message key

-CSSclass

(defaults to "acs-confirm") (optional)

register confirm handler for this CSS class

-id

(optional)

register confirm handler for this HTML ID

-selector

(optional)

register confirm handler for elements identified by this CSS selector. When a CSS selector contains double and single quotes, we won't add any of those around the selector automatically. Instead, the user must specify them explicitly, for instance like this: ... -selector {'[name="o\'hara"]'}. If the selector does not contain any single or double quotes, we can let the user omit them, as for the case of a simple tag name selector: ... -selector "li". Quotes can also be omitted if the selector contains only one kind of them, like ... -selector {[data-property='value']} or ... -selector {[data-property="value"]}

-formfield

(optional)

register confirm handler for this formfield, specified in a list of two elements in the form { form_id field_name }

Author:

Gustaf Neumann

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

Testcases:

templates_and_scripts

Register an event handler for elements. The affected elements can be specified in different ways, which will be checked in the following order of precedence: id, formfield, selector and CSSclass. Normally one needs to provide only one kind of specification.

Switches:

-event

(defaults to "click") (optional)

register handler for this type of event

-CSSclass

(defaults to "acs-listen") (optional)

register handler for this CSS class

-id

(optional)

register handler for this HTML ID

-formfield

(optional)

register handler for this formfield, specified in a list of two elements in the form { form_id field_name }

-selector

(optional)

register handler for elements identified by this CSS selector. When a CSS selector contains double and single quotes, we won't add any of those around the selector automatically. Instead, the user must specify them explicitly, for instance like this: ... -selector {'[name="o\'hara"]'}. If the selector does not contain any single or double quotes, we can let the user omit them, as for the case of a simple tag name selector: ... -selector "li". Quotes can also be omitted if the selector contains only one kind of them, like ... -selector {[data-property='value']} or ... -selector {[data-property="value"]}

-usecapture

(boolean) (defaults to "false") (optional)

indicating whether event will be dispatched to the registered listener before being dispatched to any EventTarget beneath it in the DOM tree.

-preventdefault

(boolean) (defaults to "true") (optional)

this option can the used prevent default click handling

-script

(required)

Author:

Gustaf Neumann

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

Testcases:

templates_and_scripts

Add a footer include to the end of the document body. This function is used by site wide services to add functionality to the end 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

(defaults to "outer") (optional)

whether the footer 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_header

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

Testcases:

No testcase defined.

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

(defaults to "outer") (optional)

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.

Register an event handler which will trigger a complete page refresh when we land on this page by accessing the browser's history (back and forward buttons). This is useful e.g. for those pages where some push interaction is happening and retrieving the page from the browser history would display it in an inconsistent state.

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

Testcases:

templates_and_scripts

Switches:

-async

(boolean) (optional)

whether execution of the script should be executed asynchronously as soon as it is available

-charset

(optional)

the charset attribute of the script tag, i.e. the character set of the script if it differs from the main document

-crossorigin

(optional)

Enumerated attribute to indicate whether CORS (Cross-Origin Resource Sharing) should be used

-defer

(boolean) (optional)

whether execution of the script should be deferred until after the page has been loaded

-integrity

(optional)

provide hash values for W3C Subresource Integrity recommendation

-order

(defaults to "0") (optional)

specify inclusion order

-script

(optional)

the inline script for the body of the script tag. This parameter will be ignored if a value has been supplied for src

-section

(defaults to "head") (optional)

section, where script is added ("head" or "body")

-src

(optional)

the src attribute of the script tag, i.e. the source url of the script

-type

(defaults to "text/javascript") (optional)

the type attribute of the script tag, e.g. 'text/javascript'

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

Testcases:

No testcase defined.

Collect the body scripts via an easy to call function, hiding the template used for the implementation.

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

Testcases:

templates_and_scripts

Get body event handlers specified with template::add_body_handler. The proc clears the global variable ::template::body_handlers after having processed its content.

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

Testcases:

templates_and_scripts

Get footers as a chunk of html suitable for insertion into blank-master.adp Called only from blank-master.tcl

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

Testcases:

No testcase defined.

Get headers as a chunk of html suitable for insertion into blank-master.adp Called only from blank-master.tcl

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

Testcases:

No testcase defined.

Add a link tag with relation type 'stylesheet' or 'alternate stylesheet', and type 'text/css' to the head section of the document to be returned to the users client. A given target stylesheet may only be added once; subsequent calls to add_css will replace the existing entry. This function is a wrapper around template::head::add_link.

Switches:

-alternate

(boolean) (optional)

sets the rel attribute of the link tag defining to 'alternate stylesheet' if set, sets it to 'stylesheet' otherwise

-crossorigin

(optional)

Enumerated attribute to indicate whether CORS (Cross-Origin Resource Sharing) should be used

-href

(required)

the href attribute of the link tag, e.g. the target stylesheet

-integrity

(optional)

provide hash values for W3C Subresource Integrity recommendation

-lang

(optional)

the lang attribute of the link tag specifying the language of its attributes if they differ from the document language

-media

(defaults to "all") (optional)

the media attribute of the link tag describing which display media this link is relevant to. This may be a comma separated list of values, e.g. 'screen,print,braille'

-order

(defaults to "0") (optional)

-title

(optional)

the title attribute of the link tag describing the target of this link

See Also:

• template::head::add_link

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

Testcases:

xowiki_test_cases

Add a script of type 'text/javascript' to the head section of the document to be returned to the users client. This function is a wrapper around template::head::add_script. You must supply either src or script.

Switches:

-async

(boolean) (optional)

whether execution of the script should be executed asynchronously as soon as it is available

-charset

(optional)

the charset attribute of the script tag, i.e. the character set of the script if it differs from the main document

-crossorigin

(optional)

Enumerated attribute to indicate whether CORS (Cross-Origin Resource Sharing) should be used

-defer

(boolean) (optional)

whether execution of the script should be deferred until after the page has been loaded

-integrity

(optional)

provide hash values for W3C Subresource Integrity recommendation

-order

(defaults to "0") (optional)

specify inclusion order

-script

(optional)

the inline script for the body of the script tag. This parameter will be ignored if a value has been supplied for src

-src

(optional)

the src attribute of the script tag, i.e. the source url of the script

See Also:

• template::head::add_script

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

Testcases:

No testcase defined.

Add a link tag to the head section of the document to be returned to the users client. A given target document may only be added once for a specified relation; subsequent calls to add_link will replace the existing entry.

Switches:

-crossorigin

(optional)

Enumerated attribute to indicate whether CORS (Cross-Origin Resource Sharing) should be used

-href

(required)

the href attribute of the link tag, e.g. the target document of the link

-integrity

(optional)

provide hash values for W3C Subresource Integrity recommendation

-lang

(optional)

the lang attribute of the link tag specifying the language of its attributes if they differ from the document language

-media

(optional)

the media attribute of the link tag describing which display media this link is relevant to. This may be a comma

-order

(defaults to "0") (optional)

specify inclusion order

-rel

(required)

the rel attribute of the link tag defining the relationship of the linked document to the current one, e.g. 'stylesheet'

-title

(optional)

the title attribute of the link tag describing the target of this link

-type

(optional)

the type attribute of the link tag, e.g. 'text/css' separated list of values, e.g. 'screen,print,braille'

See Also:

• template::head::flush_link

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

Testcases:

No testcase defined.

Add a meta tag to the head section of the document to be returned to the users client. A meta tag with a given name or http-equiv may only be added once; subsequent calls to add_meta will replace the existing entry. You must supply either name or http_equiv.

Switches:

-http_equiv

(optional)

the http-equiv attribute of the meta tag, i.e. the HTTP header which this metadata is equivalent to e.g. 'content-type'

-name

(optional)

the name attribute of the meta tag, i.e. the metadata identifier

-scheme

(optional)

the scheme attribute of the meta tag defining which metadata scheme should be used to interpret the metadata, e.g. 'DC' for Dublin Core (http://dublincore.org/)

-content

(optional)

the content attribute of the meta tag, i.e. the metadata value

-lang

(optional)

the lang attribute of the meta tag specifying the language of its attributes if they differ from the document language

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

Testcases:

xowiki_test_cases

Add a script to the head section of the document to be returned to the users client. A script library in an external file may only be included once; subsequent calls to add_script will replace the existing entry. Anonymous script blocks will be added without checking for duplicates; the caller must ensure that anonymous script blocks are not inadvertently added multiple times. You must supply either src or script.

Switches:

-async

(boolean) (optional)

whether execution of the script should be executed asynchronously as soon as it is available

-charset

(optional)

the charset attribute of the script tag, i.e. the character set of the script if it differs from the main document

-crossorigin

(optional)

Enumerated attribute to indicate whether CORS (Cross-Origin Resource Sharing) should be used

-defer

(boolean) (optional)

whether execution of the script should be deferred until after the page has been loaded

-integrity

(optional)

provide hash values for W3C Subresource Integrity recommendation

-order

(defaults to "0") (optional)

specify inclusion order

-script

(optional)

the inline script for the body of the script tag. This parameter will be ignored if a value has been supplied for src

-src

(optional)

the src attribute of the script tag, i.e. the source url of the script

-type

(defaults to "text/javascript") (optional)

the type attribute of the script tag, e.g. 'text/javascript'

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

Testcases:

No testcase defined.

Add an embedded css style declaration

Switches:

-style

(required)

CSS content to be included in the style tag

-title

(optional)

the title attribute of the link tag describing the target of this link

-lang

(optional)

the lang attribute of the link tag specifying the language of its attributes if they differ from the document language

-media

(optional)

the media attribute of the link tag describing which display media this link is relevant to. This may be a comma separated list of values, e.g. 'screen,print,braille'

-type

(defaults to "text/css") (optional)

the type attribute of the link tag, e.g. 'text/css'

Author:

Dave Bauer <dave@thedesignexperience.org>

Created:

2007-11-30

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

Testcases:

No testcase defined.

Return a boolean value indicating, whether we can resolve the URN.

Parameters:

resource

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

Testcases:

urn_api

Flush a link tag, which was previously set in the head section via template::head::add_link

Switches:

-href

(required)

the href attribute of the link tag, e.g. the target document of the link. A glob pattern similar link in "string match" can be provided.

-rel

(required)

the rel attribute of the link tag defining the relationship of the linked document to the current one, e.g. 'stylesheet'

Author:

Gustaf Neumann

Created:

2018-03-09

See Also:

• template::head::add_link

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

Testcases:

head_includes

Flush a script tag, which was previously set in the head section via template::add_script. One can delete multiple entries by providing a glob pattern.

Switches:

-src

(required)

src attribute of the script tag, i.e. the source url of the script. A glob pattern similar link in "string match" can be provided.

Author:

Gustaf Neumann

Created:

2018-03-09

See Also:

• template::head::add_script

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

Testcases:

head_includes

Define, that a compound resource (container) contains multiple parts. Container and parts are typically URLs, which are referred to by a "href" attribute or by link or a "src" attribute of a script.

Switches:

-container

(required)

compound resource

-parts

(required)

list of resources, which are included in a compound resource (container).

Author:

Gustaf Neumann

Created:

2018-03-09

See Also:

• template::head::add_link
• template::head::add_script
• template::head::included_p

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

Testcases:

head_includes

Register a URN for a resource. These URNs provide a single place for e.g. updating references to external resources when switching between a CDN and a local resource, or when a resource should be updated. We could consider a dns-prefetch for CDN requests. When the url-check is performed at register time, the performance for processing the url can be neglected.

Switches:

-urn

(required)

-resource

(required)

-csp_list

(optional)

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

Testcases:

urn_api

Set the specified CSS property in the DOM tree of the browser for elements for the specified class or query selector. This function should be used sparely in special situations, where CSS modification other approaches might be too complex.

Switches:

-class

(optional)

CSS class for which properties is set

-querySelector

(optional)

CSS querySelector via the javascript function querySelectorAll

-property

(required)

CSS property

-value

(required)

value for the CSS property

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

Testcases:

No testcase defined.