- Publicity: Public Only All
richtext-procs.tcl
Xinha integration with the richtext widget of acs-templating. This script defines the following two procs: ::richtext-xinha::initialize_widget ::richtext-xinha::render_widgets
- Location:
- packages/richtext-xinha/tcl/richtext-procs.tcl
- Created:
- 1 Jan 2016
- Author:
- Gustaf Neumann
- CVS Identification:
$Id: richtext-procs.tcl,v 1.4.2.9 2024/08/17 17:07:30 gustafn Exp $
Procedures in this file
- richtext::xinha::add_editor (public)
- richtext::xinha::download (private)
- richtext::xinha::initialize_widget (public)
- richtext::xinha::render_widgets (public)
- richtext::xinha::resource_info (public)
Detailed information
richtext::xinha::add_editor (public)
richtext::xinha::add_editor [ -conf conf ] [ -version version ] \
[ -order order ]Add the necessary JavaScript and other files to the current page. The naming is modeled after "add_script", "add_css", ... but is intended to care about everything necessary, including the content security policies. Similar naming conventions should be used for other editors as well. This function can be as well used from other packages, such e.g. from the xowiki form-fields, which provide a much higher customization.
- Switches:
- -conf (optional)
- -version (optional)
- -order (optional, defaults to
"10")- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
richtext::xinha::download (private)
richtext::xinha::download [ -version version ]
Download the Xinha package in the specified version and put it into a directory structure similar to the CDN structure to allow installation of multiple versions. When the local structure is available, it will be used by initialize_widget. Notice, that for this automated download, the "unzip" program must be installed and $::acs::rootdir/packages/www must be writable by the web server.
- Switches:
- -version (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
richtext::xinha::initialize_widget (public)
richtext::xinha::initialize_widget [ -form_id form_id ] \
[ -text_id text_id ] [ -options options ]Initialize an Xinha richtext editor widget.
- Switches:
- -form_id (optional)
- -text_id (optional)
- -options (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
richtext::xinha::render_widgets (public)
richtext::xinha::render_widgets
Render the xinha rich-text widgets. This function is created at a time when all rich-text widgets of this page are already initialized. The function is controlled via the global variable ::acs_blank_master(xinha)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
richtext::xinha::resource_info (public)
richtext::xinha::resource_info [ -version version ]
Get information about available version(s) of Xinha, either from the local filesystem, or from CDN.
- Switches:
- -version (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
