api_page_documentation_mode_p (public)

 api_page_documentation_mode_p

Defined in packages/acs-tcl/tcl/tcl-documentation-procs.tcl

Determines whether the thread is in "gathering documentation" or "executing the page" mode.

Returns:

true if the thread is in "gathering documentation" mode, or false otherwise.

See Also:

• doc_set_page_documentation_mode

Testcases:

package_normalize_path, xowiki_test_cases, link_tests, slot_interactions, path_resolve

Source code:

    if { [info exists ::ad_conn(api_page_documentation_mode_p)] } {
        return $::ad_conn(api_page_documentation_mode_p)
    }
    return 0

XQL Not present:

Generic, PostgreSQL, Oracle