• Publicity: Public Only All

richtext-procs.tcl

Integrate Markdown with the OpenACS richtext widget.

Location:
packages/richtext-markdown/tcl/richtext-procs.tcl
Created:
18 Nov 2026
Author:
Gustaf Neumann

Procedures in this file

Detailed information

richtext::markdown::add_editor (public)

 richtext::markdown::add_editor -text_id text_id -contents contents \
    [ -format format ] [ -format_field ] [ -repeat_template ] \
    [ -image_upload_url image_upload_url ]

Enhance a textarea with the Markdown editor and submit rendered HTML.

Switches:
-text_id (required)
the textarea ID
-contents (required)
the original textarea content before browser normalization
-format (optional, defaults to "text/html")
MIME type of the original content
-format_field (optional, boolean, defaults to "true")
whether the form has a companion MIME type field
-repeat_template (optional, boolean)
whether the textarea is a disabled repeat template
-image_upload_url (optional)
optional same-origin endpoint for pasted image blobs

Partial Call Graph (max 5 caller/called nodes):
richtext::markdown::initialize_widget richtext::markdown::initialize_widget (public) richtext::markdown::add_editor richtext::markdown::add_editor richtext::markdown::initialize_widget->richtext::markdown::add_editor _ _ (public) richtext::markdown::add_editor->_ ad_html_text_convert ad_html_text_convert (public) richtext::markdown::add_editor->ad_html_text_convert lang::message::lookup lang::message::lookup (public) richtext::markdown::add_editor->lang::message::lookup security::csrf::new security::csrf::new (public) richtext::markdown::add_editor->security::csrf::new template::head::add_javascript template::head::add_javascript (public) richtext::markdown::add_editor->template::head::add_javascript

Testcases:
No testcase defined.

richtext::markdown::initialize_widget (public)

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

Attach the Markdown editor to an OpenACS richtext textarea.

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

Partial Call Graph (max 5 caller/called nodes):
richtext::markdown::add_editor richtext::markdown::add_editor (public) template::element::get_property template::element::get_property (public) template::util::richtext::formats template::util::richtext::formats (public) template::util::richtext::get_property template::util::richtext::get_property (public) richtext::markdown::initialize_widget richtext::markdown::initialize_widget richtext::markdown::initialize_widget->richtext::markdown::add_editor richtext::markdown::initialize_widget->template::element::get_property richtext::markdown::initialize_widget->template::util::richtext::formats richtext::markdown::initialize_widget->template::util::richtext::get_property

Testcases:
No testcase defined.

richtext::markdown::render_widgets (public)

 richtext::markdown::render_widgets

Provide one theme-rendered toolbar template for all Markdown widgets on the page.

Partial Call Graph (max 5 caller/called nodes):
template::add_footer template::add_footer (public) richtext::markdown::render_widgets richtext::markdown::render_widgets richtext::markdown::render_widgets->template::add_footer

Testcases:
No testcase defined.
[ show source ]