Index: openacs-4/contrib/misc/db-cache-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/misc/db-cache-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/misc/db-cache-procs.tcl 21 Feb 2003 17:33:07 -0000 1.1 +++ openacs-4/contrib/misc/db-cache-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -96,7 +96,7 @@ return $result } -proc_doc db_list_of_lists { +ad_proc db_list_of_lists { -cache:boolean {-cache_pool db_cache_pool} statement_name Index: openacs-4/contrib/obsolete-packages/library/tcl/km-00-defs-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-00-defs-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/km-00-defs-procs.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-00-defs-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -280,7 +280,7 @@ } } -proc_doc km_question_attributes {question_id_list} { +ad_proc km_question_attributes {question_id_list} { Returns the question_id, abstract_data_type, pretty_name as triples for each question_id in the list. @@ -564,7 +564,7 @@ return $result } -proc_doc km_get_child_questions {composite_id} { +ad_proc km_get_child_questions {composite_id} { Returns a list of child question_ids for this composite question. } { set sql "select question_id from sn_question_object_type_map @@ -573,7 +573,7 @@ return $result } -proc_doc km_get_answer_options {question_id} { +ad_proc km_get_answer_options {question_id} { Returns the list of key-value-sort_key tuples of answer options for this question_id, assuming that this question is actually @@ -588,7 +588,7 @@ return $result } -proc_doc km_answer_option {option_id} { +ad_proc km_answer_option {option_id} { Returns an the pretty name of an answer option. } { set sql "select answer_option from sn_answer_options where option_id = :option_id" @@ -607,7 +607,7 @@ # ******************** Input checking ******************** -proc_doc km_sort_form { key_value_tuples } { +ad_proc km_sort_form { key_value_tuples } { Sorts form vars into a list of tuples of keys and value_lists. Date variables are assembled to make one value. Note that even if one key has only one value associated with it that this value will be represented as a single element list. } { @@ -657,7 +657,7 @@ return $sorted_tuples } -proc_doc km_filter_valid_keys { key_value_list} { +ad_proc km_filter_valid_keys { key_value_list} { Returns the tuple if it is valid- i.e. it has an integer key value. } { set filtered_tuples [list] @@ -667,7 +667,7 @@ return $filtered_tuples } -proc_doc km_filter_other_category_keys { key_value_list} { +ad_proc km_filter_other_category_keys { key_value_list} { Returns the tuple if it is originating from extra input field for category 'Other' } { set filtered_tuples [list] @@ -680,7 +680,7 @@ return $filtered_tuples } -proc_doc km_required_questions {object_id} { +ad_proc km_required_questions {object_id} { Returns a list of required (or mandatory) questions for this object. } { set context_id [ad_conn package_id] @@ -734,7 +734,7 @@ return $result } -proc_doc km_answered_p { abstract_data_type answer } { +ad_proc km_answered_p { abstract_data_type answer } { Determines on the basis of the abstract_data_type if this question has been answered or is empty. } { switch $abstract_data_type { @@ -908,7 +908,7 @@ } } -proc_doc km_upload_exists_p { object_id question_id } { +ad_proc km_upload_exists_p { object_id question_id } { Looks if a file has been uploaded for this object_id and question_id } { set client_filename [db_string km_upload_exists_p " @@ -933,7 +933,7 @@ return $result } -proc_doc km_type_has_data_type_p { object_type_id data_type } { +ad_proc km_type_has_data_type_p { object_type_id data_type } { Determines if an object type has a column of the given abstract datatype. } { return [db_string km_type_has_data_type_p " @@ -947,15 +947,15 @@ # ******************** Date Procs ******************** -proc_doc month_list {} { +ad_proc month_list {} { Returns a list of months, the second row holds the corresponding 2 digit values. } { set months [list Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec] set values [list 01 02 03 04 05 06 07 08 09 10 11 12] return [list $months $values] } -proc_doc km_default_date {question_id} { +ad_proc km_default_date {question_id} { Calculates a default date based on the question_id } { set default_value [db_string km_default_date_1 " @@ -1056,7 +1056,7 @@ # ******************** Navigation ******************** -proc_doc generate_path_id {} { +ad_proc generate_path_id {} { Generates a random number to uniquely define this excursion state in the knowledge management library. @@ -1120,7 +1120,7 @@ return $path_id } -proc_doc get_path_return_url {path_id} { +ad_proc get_path_return_url {path_id} { Returns the destination of a path if it's a valid path, otherwise it returns an empty string. @@ -1181,13 +1181,13 @@ return $result } -proc_doc get_path_action {path_id} { +ad_proc get_path_action {path_id} { Returns the path's action as a plain value. } { return [snd [get_path_values $path_id]] } -proc_doc get_last_path {path_id} { +ad_proc get_last_path {path_id} { If this was an excursion launched within another excursion then we want to return the path_id of that excursion. @@ -1199,7 +1199,7 @@ return $last_path_id } -proc_doc path_valid_p {path_id} { +ad_proc path_valid_p {path_id} { Checks if the given path (still) exists. } { if [empty_string_p $path_id] { return 0 } @@ -1211,7 +1211,7 @@ return $result } -proc_doc value_from_tuples {key_values key} { +ad_proc value_from_tuples {key_values key} { Given a list of key/value tuples, returns the value associated with the given key. Index: openacs-4/contrib/obsolete-packages/library/tcl/km-access-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-access-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/km-access-procs.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-access-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -303,7 +303,7 @@ return $result } -proc_doc km_object_type_private_p {object_type_id} { +ad_proc km_object_type_private_p {object_type_id} { Checks if an object type is not visible to the public. } { set context_id [ad_conn package_id] Index: openacs-4/contrib/obsolete-packages/library/tcl/km-admin-lib-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-admin-lib-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/km-admin-lib-procs.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-admin-lib-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -64,14 +64,14 @@ return $list_to_return } -proc_doc km_new_acs_object_id {} { +ad_proc km_new_acs_object_id {} { Returns a new acs_object_id } { set result [db_string km_new_acs_object_id "select acs_object_id_seq.nextval from dual"] return $result } -proc_doc km_sort_key_list { object_type_id } { +ad_proc km_sort_key_list { object_type_id } { Returns a list of sort_keys available for this object_type (sort_keys are offered as increments of 10 and should *NEVER* be @@ -118,7 +118,7 @@ } } -proc_doc km_pretty_adt { abstract_data_type } { +ad_proc km_pretty_adt { abstract_data_type } { Returns the pretty abstract data type } { switch $abstract_data_type { @@ -140,7 +140,7 @@ } -proc_doc km_pretty_tag { presentation_type } { +ad_proc km_pretty_tag { presentation_type } { Returns the pretty tag name } { switch $presentation_type { Index: openacs-4/contrib/obsolete-packages/library/tcl/km-branch-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-branch-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/km-branch-procs.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-branch-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -62,7 +62,7 @@ return $result } -proc_doc km_default_branch { root_branch_id } { +ad_proc km_default_branch { root_branch_id } { Returns the default branch of a branch node. } { set default_branch [db_string km_default_branch " @@ -76,7 +76,7 @@ return $default_branch } -proc_doc km_branch_parent { question_id object_type_id } { +ad_proc km_branch_parent { question_id object_type_id } { Returns the parent_question_id of this question iff this is a branch. } { set result [db_string km_branch_parent " @@ -89,7 +89,7 @@ return $result } -proc_doc km_composite_parent { question_id object_type_id } { +ad_proc km_composite_parent { question_id object_type_id } { Returns the parent_question_id of this question if this is a composite child. } { set result [db_string km_composite_parent " @@ -104,7 +104,7 @@ return $result } -proc_doc km_get_root_branch { question_id object_type_id} { +ad_proc km_get_root_branch { question_id object_type_id} { Returns the id of the root question of this branch. } { set result [db_string km_get_root_branch " @@ -117,7 +117,7 @@ return $result } -proc_doc km_root_branch_p { question_id } { +ad_proc km_root_branch_p { question_id } { Returns true if this question is a root of a branch (at any level) } { return [db_string km_root_branch_p { @@ -128,7 +128,7 @@ }] } -proc_doc km_composite_child_p { question_id object_type_id } { +ad_proc km_composite_child_p { question_id object_type_id } { Returns 1 if this question is the child of a composite question, 0 otherwise. Included here because the distinction between branches and composite children is slight. } { @@ -142,7 +142,7 @@ return 0 } -proc_doc km_active_branch_path { root_question_id object_id object_type_id } { +ad_proc km_active_branch_path { root_question_id object_id object_type_id } { Returns the sequence of questions after this root branch question that are part of the active branch path for this object. @@ -186,7 +186,7 @@ } } -proc_doc km_active_path_p { question_id object_id object_type_id } { +ad_proc km_active_path_p { question_id object_id object_type_id } { Returns 1 if this question is on an active branch path or is not on a branch at all. Returns 0 if this question is not on a central branch path (i.e. it is decoupled Index: openacs-4/contrib/obsolete-packages/library/tcl/km-browse-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-browse-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/km-browse-procs.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-browse-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -5,7 +5,7 @@ # # $Id$ -proc_doc km_ancestors_context_list {ancestors {category_id ""} {pre_url ""}} { +ad_proc km_ancestors_context_list {ancestors {category_id ""} {pre_url ""}} { Get a list of links to the parent objects, plus a link to the root parent's object type. @@ -46,7 +46,7 @@ return $result } -proc_doc km_sort_by_bar { sort_by child_type_p } { +ad_proc km_sort_by_bar { sort_by child_type_p } { Sort: Object name | Modification date } { set sort_by_list {{name "name"} {last_modified "modification date"}} @@ -67,7 +67,7 @@ return "\[ [join [concat $sort_text] " | "] \]" } -proc_doc km_category_display_limit {} { +ad_proc km_category_display_limit {} { If the object list contains more than this many objects, no categorization will be shown. Index: openacs-4/contrib/obsolete-packages/library/tcl/km-categories-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-categories-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/km-categories-procs.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-categories-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -97,7 +97,7 @@ return $i } -proc_doc km_get_child_categories {question_id} { +ad_proc km_get_child_categories {question_id} { Returns all the categories associated with the given question as a list of tuples holding the category_id and the indented @@ -118,7 +118,7 @@ return $result } -proc_doc km_get_node_id {question_id} { +ad_proc km_get_node_id {question_id} { Returns the node_id for this question_id or an empty string. @@ -128,7 +128,7 @@ return $result } -proc_doc km_categorize_object { question_id object_id category_ids } { +ad_proc km_categorize_object { question_id object_id category_ids } { Inserts a row into the sw_object_category_map which maps each object to a list of categories. @@ -553,7 +553,7 @@ and question_state <> 'invisible')" } -proc_doc km_node_question { object_type_id node_id } { +ad_proc km_node_question { object_type_id node_id } { Given an object type and a top-level node ID, determine which question this category belongs to. @@ -649,7 +649,7 @@ Sort: [km_sort_by_bar $sort_by $child_type_p]" } -proc_doc km_object_view_bar_top_level { show short_title all_title } { +ad_proc km_object_view_bar_top_level { show short_title all_title } { View: Just category descriptions | All objects } { set show_list [list [list short $short_title] [list all $all_title]] @@ -668,7 +668,7 @@ return "\[ [join $show_bar " | "] \]" } -proc_doc km_ownership_bar { current_pool } { +ad_proc km_ownership_bar { current_pool } { Filter: My objects | My objects & co-owner | All } { return [ad_choice_bar \ @@ -678,7 +678,7 @@ $current_pool] } -proc_doc km_archive_bar { current_archive } { +ad_proc km_archive_bar { current_archive } { Filter: Live Objects | Archived Objects } { return [ad_choice_bar \ @@ -688,7 +688,7 @@ $current_archive] } -proc_doc km_age_bar { current_age } { +ad_proc km_age_bar { current_age } { Filter: 3 6 12 24 months | All } { proc mk_link { default parms } { @@ -805,7 +805,7 @@ } -proc_doc ad_category_parentage_list {category_id {known_parent_id ""}} { +ad_proc ad_category_parentage_list {category_id {known_parent_id ""}} { Returns a list of lists, where each sublist is one line of parentage up from the specified category to the hierarchy root. In Index: openacs-4/contrib/obsolete-packages/library/tcl/km-display-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-display-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/km-display-procs.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-display-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -5,15 +5,15 @@ # $Id$ # ********** Display procs for questions of various abstract data types- No Form ********** -proc_doc km_display_category_value {category_value_list} { +ad_proc km_display_category_value {category_value_list} { Formats a list of category_id and category value tuples for simple display. } { set category_names [snd [transpose $category_value_list]] set formatted_values [join $category_names ", "] return $formatted_values } -proc_doc km_display_other_category_value {category_value_list object_id question_id} { +ad_proc km_display_other_category_value {category_value_list object_id question_id} { Formats a list of category_id and category value tuples for simple display. } { set other_value [snd [fst [km_get_object_content -question_ids [list $question_id] $object_id]]] @@ -29,7 +29,7 @@ return $formatted_values } -proc_doc km_display_options {answer_option_list} { +ad_proc km_display_options {answer_option_list} { Displays tuples in an option list for simple display. } { return [join [snd [transpose $answer_option_list]] ", "] @@ -67,7 +67,7 @@ } } -proc_doc km8_button_panel {question_id object_id object_type_id} { +ad_proc km8_button_panel {question_id object_id object_type_id} { This proc returns the submit button-panel. @@ -148,7 +148,7 @@ } # ********** Basic Display Procs ********** -proc_doc km_count_object_view { user_id object_id } { +ad_proc km_count_object_view { user_id object_id } { Record an object view. } { if {![km_original_author_p $user_id $object_id]} { @@ -183,7 +183,7 @@ } } -proc_doc km_get_access_count { object_id } { +ad_proc km_get_access_count { object_id } { } { return [db_string access_count { select nvl(sum(access_count),0) @@ -192,7 +192,7 @@ }] } -proc_doc km_get_access_count_month { object_id } { +ad_proc km_get_access_count_month { object_id } { } { return [db_string access_count_month { select nvl(sum(access_count),0) @@ -203,7 +203,7 @@ } -proc_doc km_object_access_toolbar {object_id {category_id ""}} { +ad_proc km_object_access_toolbar {object_id {category_id ""}} { Toolbar: [Private] Make public | Access Control | Delete Object } { set user_id [ad_conn user_id] @@ -319,7 +319,7 @@ return [join $result " | "] } -proc_doc km_shorten_question { question } { +ad_proc km_shorten_question { question } { Shortens a question up to the question mark in the question. } { set line_end [string first ? $question] @@ -333,7 +333,7 @@ #-------------------------------------------------------- -proc_doc util_trim_string_with_hrefs { string_to_trim { final_length 200 } } { +ad_proc util_trim_string_with_hrefs { string_to_trim { final_length 200 } } { Will return the trimmed string without cutting off an href before the tag. } { @@ -365,7 +365,7 @@ } -proc_doc util_make_href_and_mailto_links { text } { +ad_proc util_make_href_and_mailto_links { text } { Changes http:// and https:// to links and email formats to mailto's } { # (bd) if there are any A HREF or IMG SRCs this guy know how to use them @@ -411,7 +411,7 @@ return [string trimleft $text] } -proc_doc util_make_href_and_mailto_links_and_convert_to_html { text {html_p 0} } { +ad_proc util_make_href_and_mailto_links_and_convert_to_html { text {html_p 0} } { util_make_href_and_mailto_links interferes badly with util_convert_to_html. That's why I had to write a special procedure that does both things correctly. @@ -469,11 +469,11 @@ return [string trimleft $text] } -proc_doc library_icon_height {} "Returns the height for an object icon" { +ad_proc library_icon_height {} "Returns the height for an object icon" { return "50" } -proc_doc library_icon_width {} "Returns the width for an object icon" { +ad_proc library_icon_width {} "Returns the width for an object icon" { return "50" } Index: openacs-4/contrib/obsolete-packages/library/tcl/km-feedback-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-feedback-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/km-feedback-procs.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-feedback-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -7,7 +7,7 @@ # # ported by dirk@arsdigita.com in July 2001 -proc_doc km_check_comment_id { user_id comment_id } { +ad_proc km_check_comment_id { user_id comment_id } { Checks if the user may edit the comment. If not, 0 is returned. If he has edit permission, the associated object_id is returned. Index: openacs-4/contrib/obsolete-packages/library/tcl/km-links-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-links-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/km-links-procs.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-links-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -6,7 +6,7 @@ # # $Id$ -proc_doc km_linked_object_types { object_type_id } { +ad_proc km_linked_object_types { object_type_id } { Returns an array in the form: object_type_id, pretty_type, pretty_plural, graphic for all object_types that are linkable with this object_type. @@ -192,7 +192,7 @@ return $result } -proc_doc km8_get_to_links { {-only_unarchived_p 0} object_id question_id } { +ad_proc km8_get_to_links { {-only_unarchived_p 0} object_id question_id } { } { set current_user_id [ad_conn user_id] @@ -240,7 +240,7 @@ return [map fst $result] } -proc_doc sn_people_responsible {user_id object_id} { +ad_proc sn_people_responsible {user_id object_id} { Returns a list of triples:user_id, full name, email of people responsible for this xchange_task project. @@ -717,7 +717,7 @@ } } -proc_doc km_get_object_ancestors { object_id } { +ad_proc km_get_object_ancestors { object_id } { Returns a list of ids of the parent of this object, the parent of the parent of this object, etc. Will do this for normal links if @@ -734,7 +734,7 @@ return $result } -proc_doc km_get_descendents { object_id } { +ad_proc km_get_descendents { object_id } { Almost identical to the ancestor proc. } { set result [db_list_of_lists km_get_descendents " @@ -794,7 +794,7 @@ return $result } -proc_doc km_get_child_objects { +ad_proc km_get_child_objects { {-only_unarchived_p 0} object_id question_id } { Returns an array containing the object_ids of the child objects @@ -821,7 +821,7 @@ order by :order_by}]] } -proc_doc km_get_nephew_objects { +ad_proc km_get_nephew_objects { {-only_unarchived_p 0} object_id question_id } { Returns an array containing the object_ids of the nephew objects @@ -917,7 +917,7 @@ return $nephew_questions_without_public_nephews } -proc_doc km_link_question_attributes { question_id } { +ad_proc km_link_question_attributes { question_id } { Returns the object_type_attributes for this object_link question. } { set context_id [ad_conn package_id] Index: openacs-4/contrib/obsolete-packages/library/tcl/km-object-data-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-object-data-procs.tcl,v diff -u -N -r1.2 -r1.3 --- openacs-4/contrib/obsolete-packages/library/tcl/km-object-data-procs.tcl 1 Mar 2005 00:01:14 -0000 1.2 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-object-data-procs.tcl 13 Feb 2009 20:40:39 -0000 1.3 @@ -6,7 +6,7 @@ # ********** Procs that get data from an object ********** -proc_doc km_object_exists_p {object_id} "Returns 1 if this object exists in the library" { +ad_proc km_object_exists_p {object_id} "Returns 1 if this object exists in the library" { if [empty_string_p [km_get_object_type $object_id]] { return 0 } else { @@ -378,7 +378,7 @@ return $result } -proc_doc km_get_object_answers { object_id question_id } { +ad_proc km_get_object_answers { object_id question_id } { Returns the option_ids, pretty_names as tuples that answer this question for this object. } { set sql "select a.option_id, a.answer_option @@ -392,7 +392,7 @@ # ********** Saving data ********** -proc_doc km_create_object { object_type_id user_id } { +ad_proc km_create_object { object_type_id user_id } { Creates a new knowledge object as a row in sn_objects. Note that the object is first considered completed when all required questions @@ -418,7 +418,7 @@ } -proc_doc km_save_object_data { object_id user_id key_values } { +ad_proc km_save_object_data { object_id user_id key_values } { Takes object data in as a list of keys value tuples and saves it in the database according to its abstract data type. } { @@ -668,7 +668,7 @@ } } -proc_doc km_map_object_answers { question_id object_id option_ids } { +ad_proc km_map_object_answers { question_id object_id option_ids } { Maps any number of answer_options to a } { db_dml km_map_object_answers_1 "delete from sn_object_option_map where object_id=:object_id @@ -690,7 +690,7 @@ } -proc_doc km_delete_object_data { object_id question_id } { +ad_proc km_delete_object_data { object_id question_id } { Removes the answer for a question. (Used for read-only questions.) } { set abstract_data_type [db_string km_delete_object_data_1 " @@ -718,7 +718,7 @@ # ********** Filters/Validators ********** -proc_doc km_filter_content_questions {question_ids abstract_data_types} { +ad_proc km_filter_content_questions {question_ids abstract_data_types} { Returns a list of question_ids that are actually a row in sn_content. } { set questions [zip $question_ids $abstract_data_types] @@ -733,15 +733,15 @@ return $filtered_questions } -proc_doc integer_p {number} "returns 1 if this is an integer" { +ad_proc integer_p {number} "returns 1 if this is an integer" { if [regexp {[^0-9]} $number] { return 0 } else { return 1 } } -proc_doc filter_integers {char_list} { +ad_proc filter_integers {char_list} { returns a filtered list of characters in the list that are integers } { set result [list] @@ -751,7 +751,7 @@ return $result } -proc_doc date_p {date} "returns 1 if this is a date" { +ad_proc date_p {date} "returns 1 if this is a date" { set result [catch {db_0or1row date_p "select to_date('$date') from dual"}] if {$result} { return 0 @@ -760,7 +760,7 @@ } } -proc_doc km_break_date {date} { +ad_proc km_break_date {date} { Breaks an Oracle date in the form YYYY-MM-DD up into a list YYYY MM DD } { if {![regexp {([0-9]*)-.*} $date match YYYY]} { return ""} @@ -770,7 +770,7 @@ return [list $YYYY $MM $DD] } -proc_doc empty_date_p {date} "returns 1 if this is an empty date in the form xx--" { +ad_proc empty_date_p {date} "returns 1 if this is an empty date in the form xx--" { if [regexp {.+-.+-.+} $date] {return 0} return 1 Index: openacs-4/contrib/obsolete-packages/library/tcl/km-users-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/km-users-procs.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/km-users-procs.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/km-users-procs.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -6,7 +6,7 @@ # # $Id$ -proc_doc km_workspace_toolbar {object_id {category_id ""} {child_p 0}} { +ad_proc km_workspace_toolbar {object_id {category_id ""} {child_p 0}} { Show a toolbar to allow the user to add an object to his workspace or list of alerts, or send it to a colleague. @@ -51,7 +51,7 @@ return [join $result " | "] } -proc_doc km_list_user_searches {user_id} { +ad_proc km_list_user_searches {user_id} { Returns a list of the searches the user has done in the past. Each row looks like this: name url_params @@ -65,7 +65,7 @@ return $result } -proc_doc km_user_info {user_id} { +ad_proc km_user_info {user_id} { Given an user_id, returns a list with full name, email, affiliation, work phone, country Index: openacs-4/contrib/obsolete-packages/library/tcl/library-init.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/library/tcl/library-init.tcl,v diff -u -N -r1.1 -r1.2 --- openacs-4/contrib/obsolete-packages/library/tcl/library-init.tcl 2 Jul 2003 12:19:41 -0000 1.1 +++ openacs-4/contrib/obsolete-packages/library/tcl/library-init.tcl 13 Feb 2009 20:40:39 -0000 1.2 @@ -2,7 +2,7 @@ # # $Id$ -proc_doc excursion_timeout {} { +ad_proc excursion_timeout {} { Returns the amount of time in hours that an excursion exists before being timed out. Index: openacs-4/contrib/obsolete-packages/photo-album-lite/tcl/photo-album-lite-init.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/photo-album-lite/tcl/photo-album-lite-init.tcl,v diff -u -N -r1.2 -r1.3 --- openacs-4/contrib/obsolete-packages/photo-album-lite/tcl/photo-album-lite-init.tcl 10 Sep 2002 22:23:13 -0000 1.2 +++ openacs-4/contrib/obsolete-packages/photo-album-lite/tcl/photo-album-lite-init.tcl 13 Feb 2009 20:40:39 -0000 1.3 @@ -68,7 +68,7 @@ return $second_subdir } -proc_doc pl_delete_photo photo_id { +ad_proc pl_delete_photo photo_id {
     # Deletes a photo.  First, flag the table row as deleted,
     # then nuke the associated files.
@@ -101,7 +101,7 @@
     }
 }
 
-proc_doc pl_delete_folder folder_id {
+ad_proc pl_delete_folder folder_id {
     
     # Deletes a folder and all of its contents.
     
Index: openacs-4/contrib/obsolete-packages/ticket-tracker-lite/tcl/ticket-tracker-lite-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/ticket-tracker-lite/tcl/ticket-tracker-lite-procs.tcl,v diff -u -N -r1.5 -r1.6 --- openacs-4/contrib/obsolete-packages/ticket-tracker-lite/tcl/ticket-tracker-lite-procs.tcl 1 Mar 2005 00:01:16 -0000 1.5 +++ openacs-4/contrib/obsolete-packages/ticket-tracker-lite/tcl/ticket-tracker-lite-procs.tcl 13 Feb 2009 20:40:39 -0000 1.6 @@ -51,7 +51,7 @@ } } -proc_doc ttl_paragraph_wrap {paragraph max_line_length} { +ad_proc ttl_paragraph_wrap {paragraph max_line_length} {
     # 
     # Converts a parargraph with long lines into a paragraph with lines
@@ -204,7 +204,7 @@
     return $navbar_list
 }
 
-proc_doc ttl_pref_choices {var_name args} {
+ad_proc ttl_pref_choices {var_name args} {
     
     #
     
Index: openacs-4/contrib/obsolete-packages/wap/tcl/0-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/wap/tcl/0-procs.tcl,v diff -u -N -r1.2 -r1.3 --- openacs-4/contrib/obsolete-packages/wap/tcl/0-procs.tcl 10 Sep 2002 22:23:28 -0000 1.2 +++ openacs-4/contrib/obsolete-packages/wap/tcl/0-procs.tcl 13 Feb 2009 20:40:39 -0000 1.3 @@ -19,7 +19,7 @@ } -proc_doc wap_set_content_type {} { +ad_proc wap_set_content_type {} { Sets the content-type to text/vnd.wml.wap is request comes from WAP device. } { if { [wap_user_agent_p] } { Index: openacs-4/contrib/obsolete-packages/wap/tcl/wap-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/contrib/obsolete-packages/wap/tcl/wap-procs.tcl,v diff -u -N -r1.4 -r1.5 --- openacs-4/contrib/obsolete-packages/wap/tcl/wap-procs.tcl 30 Sep 2003 12:10:01 -0000 1.4 +++ openacs-4/contrib/obsolete-packages/wap/tcl/wap-procs.tcl 13 Feb 2009 20:40:39 -0000 1.5 @@ -7,7 +7,7 @@ @cvs-id $Id$ } -proc_doc wap_user_agent_p {} "Returns 1 if User-Agent matches a list of known WAP user agents. Returns 0 if no header is supplied." { +ad_proc wap_user_agent_p {} "Returns 1 if User-Agent matches a list of known WAP user agents. Returns 0 if no header is supplied." { # Get the user agent for the request. set agent [ns_set iget [ad_conn headers] User-Agent] @@ -19,7 +19,7 @@ return [util_memoize "wap_db_user_agent_p {$agent}" [ad_parameter WapUADbRefresh wap 3600]] } -proc_doc wap_db_user_agent_p {agent} "Returns 1 if agent matches a list of known WAP user agents allowed." { +ad_proc wap_db_user_agent_p {agent} "Returns 1 if agent matches a list of known WAP user agents allowed." { set compare_length [ad_parameter WapUAStringCompareLength wap 4] set wapUA_p [db_string "GetWAPAgentCount" "select count(*) as wapUA_p @@ -36,7 +36,7 @@ } } -proc_doc wap_add_user_agent { name creation_comment active_p } { +ad_proc wap_add_user_agent { name creation_comment active_p } { tcl wrapper for plsql function to add a WAP user agent. } { set user_id [ad_conn user_id] @@ -53,7 +53,7 @@ return } -proc_doc wap_modify_user_agent { user_agent_id name creation_comment active_p } { +ad_proc wap_modify_user_agent { user_agent_id name creation_comment active_p } { tcl wrapper for plsql function that modifies a WAP user agent. } { db_dml "modify_user_agent" "begin @@ -63,7 +63,7 @@ return } -proc_doc wap_delete_user_agent { user_agent_id } { +ad_proc wap_delete_user_agent { user_agent_id } { tcl wrapper for deleting WAP user agent } { db_dml "delete_user_agent" "begin @@ -73,7 +73,7 @@ return } -proc_doc wap_header {{no_cache_p "f"}} "Returns headers for WAP devices. Return no cache hearders if no_cache_p is t. " { +ad_proc wap_header {{no_cache_p "f"}} "Returns headers for WAP devices. Return no cache hearders if no_cache_p is t. " { if { $no_cache_p == "t" } { set headders [ad_conn outputheaders] ns_set put $headers "Cache-Control" "no-cache, must-revalidate" @@ -105,7 +105,7 @@ } } -proc_doc wml_logout_link {} { +ad_proc wml_logout_link {} { Generate a logout link for a wml browser. } { set return_wml " @@ -115,7 +115,7 @@ return $return_wml } -proc_doc export_wml_form_vars args { +ad_proc export_wml_form_vars args { Generate wml segments that export these form variables to the next card/url. } { Index: openacs-4/packages/simple-survey/tcl/survsimp-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/simple-survey/tcl/survsimp-procs.tcl,v diff -u -N -r1.5 -r1.6 --- openacs-4/packages/simple-survey/tcl/survsimp-procs.tcl 10 Sep 2002 22:23:22 -0000 1.5 +++ openacs-4/packages/simple-survey/tcl/survsimp-procs.tcl 13 Feb 2009 20:40:39 -0000 1.6 @@ -13,7 +13,7 @@ } -proc_doc survsimp_question_display { question_id {edit_previous_response_p "f"} } "Returns a string of HTML to display for a question, suitable for embedding in a form. The form variable is of the form \"response_to_question.\$question_id" { +ad_proc survsimp_question_display { question_id {edit_previous_response_p "f"} } "Returns a string of HTML to display for a question, suitable for embedding in a form. The form variable is of the form \"response_to_question.\$question_id" { set element_name "response_to_question.$question_id" db_1row survsimp_question_properties " @@ -207,7 +207,7 @@ return $html } -proc_doc util_show_plain_text { text_to_display } "allows plain text (e.g. text entered through forms) to look good on screen without using tags; preserves newlines, angle brackets, etc." { +ad_proc util_show_plain_text { text_to_display } "allows plain text (e.g. text entered through forms) to look good on screen without using tags; preserves newlines, angle brackets, etc." { regsub -all "\\&" $text_to_display "\\&" good_text regsub -all "\>" $good_text "\\>" good_text regsub -all "\<" $good_text "\\<" good_text @@ -217,7 +217,7 @@ return $good_text } -proc_doc survsimp_answer_summary_display {response_id {html_p 1} {category_id_list ""}} "Returns a string with the questions and answers. If html_p =t, the format will be html. Otherwise, it will be text. If a list of category_ids is provided, the questions will be limited to that set of categories." { +ad_proc survsimp_answer_summary_display {response_id {html_p 1} {category_id_list ""}} "Returns a string with the questions and answers. If html_p =t, the format will be html. Otherwise, it will be text. If a list of category_ids is provided, the questions will be limited to that set of categories." { set return_string "" set question_id_previous "" @@ -339,7 +339,7 @@ return "$return_string" } -proc_doc survsimp_survey_admin_check { user_id survey_id } { Returns 1 if user is allowed to administer a survey or is a site administrator, 0 otherwise. } { +ad_proc survsimp_survey_admin_check { user_id survey_id } { Returns 1 if user is allowed to administer a survey or is a site administrator, 0 otherwise. } { if { ![ad_permission_p -user_id $user_id $survey_id "admin"] && [db_string survsimp_creator_p " select creation_user from survsimp_surveys @@ -350,7 +350,7 @@ } # For site administrator new stuff page. -proc_doc ad_survsimp_new_stuff { since_when only_from_new_users_p purpose } "Produces a report of the new surveys created for the site administrator." { +ad_proc ad_survsimp_new_stuff { since_when only_from_new_users_p purpose } "Produces a report of the new surveys created for the site administrator." { if { $purpose != "site_admin" } { return "" } @@ -383,15 +383,15 @@ lappend ad_new_stuff_module_list [list "Surveys" ad_survsimp_new_stuff] } -proc_doc survsimp_survey_short_name_to_id {short_name} "Returns the id of the survey +ad_proc survsimp_survey_short_name_to_id {short_name} "Returns the id of the survey given the short name" { set survey_id [db_string survsimp_id_from_shortname "select survey_id from survsimp_surveys where lower(short_name) = lower(:short_name)" -default ""] return $survey_id } -proc_doc survsimp_survey_get_response_id {survey_id user_id} "Returns the id of the user's most recent response to a survey" { +ad_proc survsimp_survey_get_response_id {survey_id user_id} "Returns the id of the user's most recent response to a survey" { set response_id [ db_string get_response_id { select response_id @@ -409,7 +409,7 @@ return $response_id } -proc_doc survsimp_survey_get_score {survey_id user_id} "Returns the score of the user's most recent response to a survey" { +ad_proc survsimp_survey_get_score {survey_id user_id} "Returns the score of the user's most recent response to a survey" { set response_id [ survsimp_survey_get_response_id $survey_id $user_id ] @@ -430,7 +430,7 @@ return $score } -proc_doc survsimp_get_response_date {survey_id user_id} "Returns the date of the user's most recent response to a survey" { +ad_proc survsimp_get_response_date {survey_id user_id} "Returns the date of the user's most recent response to a survey" { set response_id [ survsimp_survey_get_response_id $survey_id $user_id ] @@ -466,7 +466,7 @@ return $return_html } -proc_doc survsimp_bt_mergepiece {htmlpiece values} { +ad_proc survsimp_bt_mergepiece {htmlpiece values} { HTMLPIECE is a form usually; VALUES is an ns_set NEW VERSION DONE BY BEN ADIDA (ben@mit.edu) Index: openacs-4/packages/version-control/tcl/version-control-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/version-control/tcl/version-control-procs.tcl,v diff -u -N -r1.5 -r1.6 --- openacs-4/packages/version-control/tcl/version-control-procs.tcl 13 Nov 2003 12:24:18 -0000 1.5 +++ openacs-4/packages/version-control/tcl/version-control-procs.tcl 13 Feb 2009 20:40:39 -0000 1.6 @@ -52,7 +52,7 @@ # $Id$ # ----------------------------------------------------------------------------- -proc_doc vc_path_relative { path } { +ad_proc vc_path_relative { path } { Returns the component of path relative to [acs_root_dir]. If path does not begin with [acs_root_dir] it is returned @@ -101,7 +101,7 @@ return $repository } -proc_doc vc_fetch_root { { path "" } } { +ad_proc vc_fetch_root { { path "" } } { Fetches the CVSROOT associated with path. If path is not specified, looks under acs_root_dir. This is always overridden by the CVSROOT @@ -131,7 +131,7 @@ # Fetches the status report for a file -proc_doc vc_fetch_status { path } { +ad_proc vc_fetch_status { path } { Returns the CVS status report for a file, caching it based on mtime if it exists. @@ -165,7 +165,7 @@ return $status } -proc_doc vc_fetch_log { path } { +ad_proc vc_fetch_log { path } { Fetches the change log for a file @@ -201,7 +201,7 @@ # Fetches the summary report for a file -proc_doc vc_fetch_summary { path } { +ad_proc vc_fetch_summary { path } { Returns the CVS summary report for a file, caching it based on mtime. @@ -234,7 +234,7 @@ return $summary } -proc_doc vc_fetch_date { path } { +ad_proc vc_fetch_date { path } { Returns the commit time for a file, or the empty string if no version control information is available. @@ -243,7 +243,7 @@ return [lindex [split [vc_fetch_summary $path] "/"] 3] } -proc_doc vc_fetch_revision { path } { +ad_proc vc_fetch_revision { path } { Returns the revision number for a file, or the empty string if no version control information is available. @@ -317,7 +317,7 @@ # Wrappers for various CVS commands # ----------------------------------------------------------------------------- -proc_doc vc_exec { cmd } { +ad_proc vc_exec { cmd } { Wrapper for exec that sets up the correct environment for CVS and starts execution from [acs_root_dir]. @@ -331,7 +331,7 @@ } } -proc_doc vc_add { path } { +ad_proc vc_add { path } { Add a file or a directory to the repository. @@ -344,7 +344,7 @@ } } -proc_doc vc_commit { path message } { +ad_proc vc_commit { path message } { Commit a change to the repository, along with a log message. @@ -363,7 +363,7 @@ } } -proc_doc vc_remove { path } { +ad_proc vc_remove { path } { Remove a file from the repository. @@ -386,23 +386,23 @@ } } -proc_doc vc_status { path } { +ad_proc vc_status { path } { Returns the output of CVS status. } { return [vc_fetch_status $path] } -proc_doc vc_log { path } { +ad_proc vc_log { path } { Returns the output of CVS log. } { return [vc_fetch_log $path] } -proc_doc vc_update { path } { +ad_proc vc_update { path } { Updates the specified file/directory @@ -417,7 +417,7 @@ } } -proc_doc vc_checkout { module path } { +ad_proc vc_checkout { module path } { Checks out a copy of the specified module to a given destination. @@ -431,7 +431,7 @@ } } -proc_doc vc_path_to_module { path } { +ad_proc vc_path_to_module { path } { Converts a path name to the correct CVS module name associated with that file. @@ -454,7 +454,7 @@ # Initialize file properties -proc_doc vc_file_props_init { path } { +ad_proc vc_file_props_init { path } { Initialize vc_file_props for $path. Index: openacs-4/packages/wp-slim/tcl/wp-slim-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/wp-slim/tcl/wp-slim-procs.tcl,v diff -u -N -r1.4 -r1.5 --- openacs-4/packages/wp-slim/tcl/wp-slim-procs.tcl 15 Jun 2005 18:03:36 -0000 1.4 +++ openacs-4/packages/wp-slim/tcl/wp-slim-procs.tcl 13 Feb 2009 20:40:39 -0000 1.5 @@ -26,7 +26,7 @@ } -proc_doc wp_check_style_authorization { style_id user_id } { Verifies that the user owns this style. } { +ad_proc wp_check_style_authorization { style_id user_id } { Verifies that the user owns this style. } { set owner [db_string wp_style_owner_select { *SQL* } -default "not_found"] if { $owner == "not_found" } { set err "Error"