- Publicity: Public Only All
spellcheck-procs.tcl
Spell-check library for OpenACS templating system.
- Location:
- packages/acs-templating/tcl/spellcheck-procs.tcl
- Created:
- 2003-09-21
- Author:
- Ola Hansson <ola@polyxena.net>
- CVS Identification:
$Id: spellcheck-procs.tcl,v 1.30 2024/09/11 06:15:48 gustafn Exp $
Procedures in this file
- template::data::transform::spellcheck (public)
- template::util::spellcheck (public)
- template::util::spellcheck::get_element_formtext (public)
- template::util::spellcheck::get_sorted_list_with_unique_elements (public)
- template::util::spellcheck::merge_text (public)
- template::util::spellcheck::spellcheck_properties (public)
Detailed information
template::data::transform::spellcheck (public)
template::data::transform::spellcheck -element_ref element_ref \ -values values
Transform submitted and previously validated input into a spellcheck datastructure.
- Switches:
- -element_ref (required)
- Reference variable to the form element.
- -values (required)
- The set of values for that element.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
template::util::spellcheck (public)
template::util::spellcheck command [ args... ]
Dispatch procedure for the spellcheck object
- Parameters:
- command (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
template::util::spellcheck::get_element_formtext (public)
template::util::spellcheck::get_element_formtext -text text [ -html ] \ -var_to_spellcheck var_to_spellcheck [ -language language ] \ -error_num_ref error_num_ref [ -no_abort ] \ -formtext_to_display_ref formtext_to_display_ref \ [ -just_the_errwords_ref just_the_errwords_ref ]
- Switches:
- -text (required)
- The string to check for spelling errors.
- -html (optional, boolean, defaults to
"0"
)- -var_to_spellcheck (required)
- The name of the text input type or textarea that holds this text (e.g., "email_body")
- -language (optional)
- -error_num_ref (required)
- -no_abort (optional, boolean, defaults to
"0"
)- -formtext_to_display_ref (required)
- -just_the_errwords_ref (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- spellcheck__get_element_formtext
template::util::spellcheck::get_sorted_list_with_unique_elements (public)
template::util::spellcheck::get_sorted_list_with_unique_elements \ -the_list the_list
Converts a list of possibly duplicate elements (words) into a sorted list where no duplicates exist.
- Switches:
- -the_list (required)
- The list of possibly duplicate elements.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
template::util::spellcheck::merge_text (public)
template::util::spellcheck::merge_text element_id
Returns the merged (possibly corrected) text or the empty string if it is not time to merge.
- Parameters:
- element_id (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
template::util::spellcheck::spellcheck_properties (public)
template::util::spellcheck::spellcheck_properties \ -element_ref element_ref
Returns a list of spellcheck properties in array setable format.
- Switches:
- -element_ref (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- spellcheck__spellcheck_properties