form-procs.tcl

Reusable forms in the forums package

Location:
packages/forums/tcl/form-procs.tcl
Created:
2003-11-12
Author:
lee@thaum.net

Procedures in this file

Detailed information

forums::form::forum (public)

 forums::form::forum [ -prefix prefix ] form_name

Constructs the elements of a form for creating/editing a forum

Switches:
-prefix (optional)
Parameters:
form_name (required)

Testcases:
web_forum_new, web_forum_view, web_forum_edit, web_forums_message_and_reply

forums::form::forward_message (public)

 forums::form::forward_message [ -prefix prefix ] form_name

adds form elements to form_name to allow the user to enter the details of a message they want to forward by email

Switches:
-prefix (optional)
Parameters:
form_name (required)

Testcases:
No testcase defined.

forums::form::message (public)

 forums::form::message [ -optional ] [ -prefix prefix ] form_name

adds form elements to form_name which represent the data held in a forum message

Switches:
-optional (optional, boolean)
-prefix (optional)
Parameters:
form_name (required)

Testcases:
web_forums_message_and_reply

forums::form::post_message (public)

 forums::form::post_message [ -optional ] \
    [ -show_anonymous_p show_anonymous_p ] \
    [ -show_attachments_p show_attachments_p ] [ -prefix prefix ] \
    form_name

adds form elements to a form for the default post message form

Switches:
-optional (optional, boolean)
-show_anonymous_p (optional, defaults to "1")
-show_attachments_p (optional, defaults to "1")
-prefix (optional)
Parameters:
form_name (required)

Testcases:
No testcase defined.

forums::form::search (public)

 forums::form::search [ -prefix prefix ] form_name

Constructs the elements of a form for searching for a term optionally in a particular forum

Switches:
-prefix (optional)
Parameters:
form_name (required)

Testcases:
web_forum_view, web_forum_edit, web_forums_message_and_reply
[ show source ]