• Publicity: Public Only All

richtext-procs.tcl

CKEditor 4 integration with the richtext widget of acs-templating. This script defines the following public procs: ::richtext-ckeditor4::initialize_widget ::richtext-ckeditor4::render_widgets ::richtext::ckeditor4::resource_info ::richtext::ckeditor4::add_editor

Location:
packages/richtext-ckeditor4/tcl/richtext-procs.tcl
Created:
1 Jan 2016
Author:
Gustaf Neumann
CVS Identification:
$Id: richtext-procs.tcl,v 1.14.2.33 2024/07/30 10:25:45 gustafn Exp $

Procedures in this file

Detailed information

richtext::ckeditor4::add_editor (public)

 richtext::ckeditor4::add_editor [ -ck_package ck_package ] \
    [ -version version ] [ -adapters adapters ] [ -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:
-ck_package (optional)
-version (optional)
-adapters (optional)
-order (optional, defaults to "10")

Partial Call Graph (max 5 caller/called nodes):
%3 richtext::ckeditor4::initialize_widget richtext::ckeditor4::initialize_widget (public) richtext::ckeditor4::add_editor richtext::ckeditor4::add_editor richtext::ckeditor4::initialize_widget->richtext::ckeditor4::add_editor richtext::ckeditor4::resource_info richtext::ckeditor4::resource_info (public) richtext::ckeditor4::add_editor->richtext::ckeditor4::resource_info security::csp::require security::csp::require (public) richtext::ckeditor4::add_editor->security::csp::require template::head::add_javascript template::head::add_javascript (public) richtext::ckeditor4::add_editor->template::head::add_javascript

Testcases:
No testcase defined.

richtext::ckeditor4::initialize_widget (public)

 richtext::ckeditor4::initialize_widget [ -form_id form_id ] \
    [ -text_id text_id ] [ -options options ]

Initialize an CKEditor 4 richtext editor widget.

Switches:
-form_id (optional)
-text_id (optional)
-options (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_package_id_from_key apm_package_id_from_key (public) export_vars export_vars (public) lang::conn::language lang::conn::language (public) parameter::get parameter::get (public) richtext::ckeditor4::add_editor richtext::ckeditor4::add_editor (public) richtext::ckeditor4::initialize_widget richtext::ckeditor4::initialize_widget richtext::ckeditor4::initialize_widget->apm_package_id_from_key richtext::ckeditor4::initialize_widget->export_vars richtext::ckeditor4::initialize_widget->lang::conn::language richtext::ckeditor4::initialize_widget->parameter::get richtext::ckeditor4::initialize_widget->richtext::ckeditor4::add_editor

Testcases:
No testcase defined.

richtext::ckeditor4::render_widgets (public)

 richtext::ckeditor4::render_widgets

Render the ckeditor4 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 variables ::acs_blank_master(ckeditor4) ::acs_blank_master__htmlareas

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

Testcases:
No testcase defined.

richtext::ckeditor4::resource_info (public)

 richtext::ckeditor4::resource_info [ -ck_package ck_package ] \
    [ -version version ]

Get information about available version(s) of CKEditor, either from the local filesystem, or from CDN.

Switches:
-ck_package (optional)
-version (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 packages/richtext-ckeditor4/www/sitewide-admin/index.tcl packages/richtext-ckeditor4/ www/sitewide-admin/index.tcl richtext::ckeditor4::resource_info richtext::ckeditor4::resource_info packages/richtext-ckeditor4/www/sitewide-admin/index.tcl->richtext::ckeditor4::resource_info richtext::ckeditor4::add_editor richtext::ckeditor4::add_editor (public) richtext::ckeditor4::add_editor->richtext::ckeditor4::resource_info richtext::ckeditor4::download richtext::ckeditor4::download (private) richtext::ckeditor4::download->richtext::ckeditor4::resource_info acs_package_root_dir acs_package_root_dir (public) richtext::ckeditor4::resource_info->acs_package_root_dir parameter::get_global_value parameter::get_global_value (public) richtext::ckeditor4::resource_info->parameter::get_global_value

Testcases:
No testcase defined.
[ show source ]