Handle richtext transformations using a standardized naming convention.

Parameters:

value (required)

Testcases:

No testcase defined.

Transform the previously-validated submitted data into a two-element list as defined by the richtext datatype.

Parameters:

element_ref (required)

Reference variable to the form element

Returns:

Two-element list defined by the richtext datatype

Testcases:

No testcase defined.

Validate richtext after form submission.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if the submitted data is valid, false (0) if not

Testcases:

No testcase defined.

Dispatch procedure for the richtext object

Parameters:

command (required)

Testcases:

No testcase defined.

Create a new richtext value with some predefined value Basically, create and set the richtext value

Parameters:

type (required)

value (optional)

Testcases:

No testcase defined.

Create a richtext widget

Parameters:

contents (optional)

The text content of the widget

format (optional)

How that text is formatted (text, html, etc)

Returns:

Two-element list of the joined parameters

Testcases:

No testcase defined.

Returns a formatting option list

Testcases:

No testcase defined.

Returns a list of valid richtext formats

Testcases:

No testcase defined.

Get a property of the richtext datatype. Valid properties are:

Parameters:

what (required)

the name of the property. Must be one of:

• contents (synonyms content, text) - returns the actual contents of the textarea field
• format (synonym mime_type) - returns the mimetype, e.g. 'text/plain'
• html_value - returns the content converted to html format, regardless of the format the content is actually in. In case it is already text/html no conversion will be applied.

richtext_list (required)

a richtext datatype value, usually created with ad_form.

Testcases:

No testcase defined.

Return tag name for the markup; normally a "textarea", but some editors might use e.g. a "div". If the function is defined for the editor, call it.

Switches:

-options (optional)

Testcases:

No testcase defined.

Initialize a single text input (textarea with the id "text_id" part of a form with "form_id") for the specified richtext editor via a richtext-editor plugin (e.g. ckeditor4, tinymce, or xinha)

Switches:

-form_id (optional)

ID of the form containing the textarea

-text_id (optional)

ID of the textarea

-editor (optional)

Editor, which should be used. Will default to that specified in acs-templating RichTextEditor parameter when not specified.

-options (optional)

Options passed in from the widget spec

Returns:

On success, this function returns a dict with success 1

Testcases:

No testcase defined.

Make an rich-text editor known to the templating system.

Parameters:

editor (required)

Editor to be registered

Returns:

List of editors registered so far

Testcases:

No testcase defined.

Render all rich-text editors with their widget specific code. Every editor might have multiple instances on the page, which are accessible to "render_widgets" via the global variable acs_blank_master__htmlareas. This function can be used to perform a single (customization) operation relevant for multiple widgets.

Testcases:

No testcase defined.

Check, whether this editor package is installed.

Switches:

-editor (optional)

Testcases:

No testcase defined.

Set a property of the richtext datatype.

Parameters:

what (required)

One of

• contents (synonyms content, text)
• format (synonym mime_type)

richtext_list (required)

the richtext list to modify

value (required)

the new value

Returns:

the modified list

Testcases:

No testcase defined.

Implements the richtext widget, which offers rich text editing options. This version integrates support for the xinha and tinymce editors out of the box, but other richtext editors can be used including and configuring them in your custom template. If the acs-templating.UseHtmlAreaForRichtextP parameter is set to true (1), this will use the WYSIWYG editor widget set in the acs-templating.RichTextEditor parameter. Otherwise, it will use a normal textarea, with a drop-down to select a format. The available formats are:

• Enhanced text = Allows HTML, but automatically inserts line and paragraph breaks.
• Plain text = Automatically inserts line and paragraph breaks, and quotes all HTML-specific characters, such as less-than, greater-than, etc.
• Fixed-width text = Same as plain text, but conserves spacing; useful for tabular data.
• HTML = normal HTML.

You can also parameterize the richtext widget with a 'htmlarea_p' attribute, which can be true or false, and which will override the parameter setting.

The richtext widget can be extended with several plugins, which are OpenACS packages named richtex-EDITOR. Plugins are available e.g. for xinha, tinymce and ckeditor4. When the plugins are installed, one can use e.g. xinha by specifying 'editor xinha' in the options of the widget spec. The following options for xinha may be specified:

• editor: xinha
• height: height of the xinha widget (e.g. 350px)
• width: width of the xinha widget (e.g. 500px)
• plugins: Tcl list of plugins to be used in xinha. There is a special plugin for the oacs file selector available, called OacsFs. If no options are specified, the following plugins will be loaded: GetHtml CharacterMap ContextMenu FullScreen ListType TableOperations EditTag LangMarks Abbreviation

These options are used by the OacsFs plugin

• folder_id: the folder from which files should be taken for the file selector. Can be used alternative with fs_package_id, whatever more handy in the application.
• fs_package_id: the package id of the file_storage package from which files should be taken for the file selector. Can be used alternative with folder_id, whatever more handy in the application. If nothing is specified, the globally mounted file-store is used.
• file_types: SQL match pattern for selecting certain types of files (e.g. pdf files). The match pattern is applied on the MIME type of the field. E.g. a value of %text/% allows any kind of text files to be selected, while %pdf% could be used for pdf-files. If nothing is specified, all file-types are presented.
• javascript: provide JavaScript code to configure the xinha widget and its plugins. The configure object is called xinha_config.

Example to use xinha with only a few controls:

    {options {editor xinha plugins {OacsFs} height 350px javascript {
        xinha_config.toolbar = [
                                ['popupeditor', 'bold','italic','createlink','insertimage','separator'],
                                ['killword','removeformat'] ];
    }}}
    

Example for the use of the xinha widget with options:

    text:richtext(richtext),nospell,optional
    {label Content}
    {options {editor xinha plugins OacsFs height 350px file_types %pdf%}}
    {html {rows 15 cols 50 style {width: 100%}}}
    

Caveat: the three adp-files needed for the OpenACS file selector (insert-image, insert-ilink and file-selector) are currently part of the xowiki package, since acs-templating is per default not mounted. This is hopefully only a temporal situation and we find a better place.

Example for the use of the tinymce widget with options:

    text:richtext(richtext),nospell,optional
    {label Biography}
    {options {theme simple plugins "oacsimage,oacslink,style"}}
    {html {rows 15 cols 50 style {width: 100%}}}
    

See TinyMCE documentation for a full list of available options

Caveat: the scripts needed for the oacsimage and oacslink plugins require acs-templating to be mounted. This is a temporary situation until we find a better way to handle plugins.

Example for the use of a custom editor widget:

    text:richtext(richtext),nospell,optional
    {label Biography}
    {options {editor custom ...custom configuration...}}
    {html {rows 15 cols 50 style {width: 100%}}}
    

If provided with a WYSIWYG editor different than 'xinha' or 'tinymce', system will just collect formfield ids and supplied options for the richtext field and will provide them as-is to the blank-master environment. When using a custom editor, functional meaning of the options is totally up to the user.

Note that the richtext editors interact with blank-master.tcl and blank-master.adp.

Derived from the htmlarea richtext widget for htmlarea by lars@pinds.com
modified for RTE http://www.kevinroth.com/ by davis@xarg.net
xinha and ckeditor4 support by gustaf.neumann@wu-wien.ac.at
tinymce support by oct@openacs.org

Parameters:

element_reference (required)

tag_attributes (required)

Testcases:

No testcase defined.