Index: openacs-4/packages/xotcl-core/tcl/generic-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/xotcl-core/tcl/generic-procs.tcl,v
diff -u -r1.97.2.3 -r1.97.2.4
--- openacs-4/packages/xotcl-core/tcl/generic-procs.tcl 7 Dec 2015 16:58:07 -0000 1.97.2.3
+++ openacs-4/packages/xotcl-core/tcl/generic-procs.tcl 31 Dec 2015 13:13:51 -0000 1.97.2.4
@@ -25,29 +25,24 @@
{submit_link "."}
{action "[::xo::cc url]"}
} -ad_doc {
-
Class for the simplified generation of forms. This class was designed
+
This class was designed
together with the content repository class
- ::xo::db::CrClass,
- but it can be used also with different classes. The only requirement is the
- presence of an 'item_id' form field.
-
-
+ ::xo::db::CrClass
+ for the generation of HTML forms, but it can be used also with different classes.
+ The only hard requirement is the presence of an 'item_id' form field.
For generic acs_objects, 'item_id' will correspond to 'object_id' column in 'acs_objects'
table. For content repository items, 'item_id' will be the column by the same name in
cr_revisions/cr_items.
-
-
- - fields: form elements as described in ad_form.
-
- data: data object (e.g. instance if CrItem)
-
- package_id: package_id of the object. Will default to data's 'package_id' variable
-
- folder_id: associated folder id. Will default to data's 'parent_id' variable.
- If 'parent_id' is missing too, package's 'folder_id' will be used.
-
- name: of this form, used for naming the template,
- defaults to the object name
-
- add_page_title: page title when adding content items
-
- edit_page_title: page title when editing content items
-
- with_categories: display form with categories (default false)
-
- submit_link: link for page after submit
+
+ @param add_page_title page title when adding content items
+ @param edit_page_title page title when editing content items
+ @param data data object (e.g. instance if CrItem)
+ @param folder_id associated folder id. Will default to data's 'parent_id' variable.
+ If 'parent_id' is missing too, package's 'folder_id' will be used.
+ @param name name of the form, used for naming the template, defaults to the object name
+ @param package_id package_id of the object. Will default to data's 'package_id' variable
+ @param submit_link link for page after submit
+ @param with_categories display form with categories (default false)
}