Index: openacs-4/packages/acs-content-repository/tcl/publish-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-content-repository/tcl/publish-procs.tcl,v
diff -u -r1.3 -r1.4
--- openacs-4/packages/acs-content-repository/tcl/publish-procs.tcl 13 Aug 2002 04:21:33 -0000 1.3
+++ openacs-4/packages/acs-content-repository/tcl/publish-procs.tcl 16 Sep 2002 10:56:15 -0000 1.4
@@ -26,9 +26,9 @@
The id of the revision to use. If missing, live
revision will most likely be used
- @see proc publish::pop_id
- @see proc publish::get_main_item_id
- @see proc publish::get_main_revision_id
+ @see publish::pop_id
+ @see publish::get_main_item_id
+ @see publish::get_main_revision_id
} {
variable item_id_stack
@@ -82,9 +82,9 @@
@return The popped item id, or the empty string if the string is
already empty
- @see proc publish::push_id
- @see proc publish::get_main_item_id
- @see proc publish::get_main_revision_id
+ @see publish::push_id
+ @see publish::get_main_item_id
+ @see publish::get_main_revision_id
} {
variable item_id_stack
@@ -182,7 +182,7 @@
template, or "" if no template exists or the -no_merge
flag was specified
- @see proc publish::handle::image
+ @see publish::handle::image
} {
@@ -240,7 +240,7 @@
@return An HTML string in format "name=value name=value ..."
- @see proc publish::set_to_pairs
+ @see publish::set_to_pairs
} {
set extra_html ""
@@ -272,8 +272,8 @@
@return The HTML for the include tag
- @see proc item::item_url
- @see proc publish::html_args
+ @see item::get_url
+ @see publish::html_args
} {
@@ -362,7 +362,7 @@
@return The rendered HTML, or the empty string on failure
- @see proc publish::handle_item
+ @see publish::handle_item
} {
#set ::content::item_id $item_id
@@ -487,7 +487,7 @@
@return The name of the proc which should be used to handle the mime-type,
or an empty string on failure.
- @see proc publish::handle_item
+ @see publish::handle_item
} {
set mime_pair [split $mime_type "/"]
@@ -517,9 +517,9 @@
@return the main item id
- @see proc publish::pop_id
- @see proc publish::push_id
- @see proc publish::get_main_revision_id
+ @see publish::pop_id
+ @see publish::push_id
+ @see publish::get_main_revision_id
} {
@@ -541,9 +541,9 @@
@return the main item id
- @see proc publish::pop_id
- @see proc publish::push_id
- @see proc publish::get_main_item_id
+ @see publish::pop_id
+ @see publish::push_id
+ @see publish::get_main_item_id
} {
@@ -594,9 +594,9 @@
@return The rendered HTML for the item, or an empty string on failure
- @see proc publish::handle_binary_file
- @see proc publish::handle::text
- @see proc publish::handle::image
+ @see publish::handle_binary_file
+ @see publish::handle::text
+ @see publish::handle::image
} {
@@ -729,8 +729,8 @@
@return The rendered HTML for the child item
- @see proc publish::merge_with_template
- @see proc publish::handle_item
+ @see publish::merge_with_template
+ @see publish::handle_item
} {
@@ -803,7 +803,7 @@
@param relation_type Either child or relation
@param params The ns_set id for extra HTML parameters
- @see proc publish::render_subitem
+ @see publish::render_subitem
} {
@@ -843,7 +843,7 @@
Use this root path instead of the paths specified in the INI
file
- @see proc publish::get_publish_roots
+ @see publish::get_publish_roots
} {
if { ![template::util::is_nil root_path] } {
@@ -876,8 +876,8 @@
@param url Relative URL of the file to write
@param revision_id Write the blob for this revision
- @see proc publish::get_publish_roots
- @see proc publish::write_multiple_files
+ @see publish::get_publish_roots
+ @see publish::write_multiple_files
} {
foreach_publish_path $url {
@@ -909,9 +909,9 @@
@param url Relative URL of the file to write
@param text A string of text to be written to the URL
- @see proc template::util::write_file
- @see proc publish::get_publish_roots
- @see proc publish::write_multiple_blobs
+ @see template::util::write_file
+ @see publish::get_publish_roots
+ @see publish::write_multiple_blobs
} {
ns_log Notice "WRITE_MULTIPLE_FILES: root_path = $root_path"
@@ -955,8 +955,8 @@
@return The relative URL of the file that was written, or an empty
string on failure
- @see proc content::get_content_value
- @see proc publish::get_publish_roots
+ @see content::get_content_value
+ @see publish::get_publish_roots
} {
Index: openacs-4/packages/acs-templating/tcl/doc-tcl-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/tcl/doc-tcl-procs.tcl,v
diff -u -r1.6 -r1.7
--- openacs-4/packages/acs-templating/tcl/doc-tcl-procs.tcl 13 Sep 2002 11:24:19 -0000 1.6
+++ openacs-4/packages/acs-templating/tcl/doc-tcl-procs.tcl 16 Sep 2002 10:56:13 -0000 1.7
@@ -79,9 +79,9 @@
of the text marker, returns a zero-element list
@see namespace doc
- @see proc doc::parse_file
- @see proc doc::parse_namespace doc.html#doc::parse_namespace
- @see proc doc::util::text_divider
+ @see doc::parse_file
+ @see doc::parse_namespace
+ @see doc::util::text_divider
} {
set indices_list [list]
@@ -108,7 +108,7 @@
@param text name of string variable (not the string value itself)
@param marker the string indicating text division
- @see proc doc::util::find_marker_indices
+ @see doc::util::find_marker_indices
} {
upvar $text_ref text
@@ -581,9 +581,8 @@
ad_proc -private doc::parse_tcl_library { dir_list } {
takes the absolute path of the tcl library directory and parses through it
- @see proc doc::parse_file doc.html#doc::parse_file
- @see namespace util util.html
- @see proc template::util::comment_text_normalize util.html#template::util::comment_text_normalize
+ @see doc::parse_file
+ @see template::util::comment_text_normalize
@return a long lists of lists of lists, each list element contains
Index: openacs-4/packages/acs-templating/tcl/element-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/tcl/element-procs.tcl,v
diff -u -r1.7 -r1.8
--- openacs-4/packages/acs-templating/tcl/element-procs.tcl 14 Sep 2002 18:13:47 -0000 1.7
+++ openacs-4/packages/acs-templating/tcl/element-procs.tcl 16 Sep 2002 10:56:13 -0000 1.8
@@ -136,7 +136,7 @@
@param form_id The identifier of the form containing the element.
@param element_id The unique identifier of the element.
- @see create
+ @see template::element::create
} {
get_reference
@@ -170,7 +170,7 @@
@param element_id The unique identifier of the element.
@return The current value of the element.
- @see get_values
+ @see template::element::get_values
} {
get_reference
@@ -191,7 +191,7 @@
@param element_id The unique identifier of the element.
@return A list of current values for the element.
- @see get_value
+ @see template::element::get_value
} {
get_reference
@@ -207,7 +207,8 @@
@param property The property to be retreived
@return The value of the property, or "" if the property does not exist
- @see set_properties
+
+ @see template::element::set_properties
} {
get_reference
Index: openacs-4/packages/acs-templating/tcl/request-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/tcl/request-procs.tcl,v
diff -u -r1.3 -r1.4
--- openacs-4/packages/acs-templating/tcl/request-procs.tcl 1 Sep 2002 02:24:57 -0000 1.3
+++ openacs-4/packages/acs-templating/tcl/request-procs.tcl 16 Sep 2002 10:56:13 -0000 1.4
@@ -78,7 +78,7 @@
to 1 or 0, and message is to be displayed to the user
when the validation step fails.
- @see element::create
+ @see template::element::create
} {
set level [template::adp_level]
eval template::element::create request $name $args
Index: openacs-4/packages/cms/tcl/content-method-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/cms/tcl/content-method-procs.tcl,v
diff -u -r1.7 -r1.8
--- openacs-4/packages/cms/tcl/content-method-procs.tcl 15 Aug 2002 03:39:34 -0000 1.7
+++ openacs-4/packages/cms/tcl/content-method-procs.tcl 16 Sep 2002 10:56:14 -0000 1.8
@@ -8,10 +8,8 @@
namespace eval content_method {}
-ad_proc content_method::get_content_methods { content_type args } {
+ad_proc -public content_method::get_content_methods { content_type args } {
- @public get_content_methods
-
Returns a list of content_methods that are associated with
a content type, first checking for a default method, then for registered
content methods, and then for all content methods
@@ -23,9 +21,10 @@
a list of label-value pairs of associated content methods.
@return A list of content methods or a list of label-value pairs of
content methods if the "-get_labels" option is specified
- @see {content_method::get_content_method_options,
- content_method::text_entry_filter_sql }
+ @see content_method::get_content_method_options
+ @see content_method::text_entry_filter_sql
+
} {
template::util::get_opts $args
@@ -59,20 +58,19 @@
}
-ad_proc content_method::get_content_method_options { content_type } {
+ad_proc -private content_method::get_content_method_options { content_type } {
- @private get_content_method_options
-
Returns a list of label, content_method pairs that are associated with
a content type, first checking for a default method, then for registered
content methods, and then for all content methods
@author Michael Pih
@param content_type The content type
@return A list of label, value pairs of content methods
- @see {content_method::get_content_methods,
- content_method::text_entry_filter_sql }
+ @see content_method::get_content_methods
+ @see content_method::text_entry_filter_sql
+
} {
set text_entry_filter [text_entry_filter_sql $content_type]
@@ -96,14 +94,13 @@
}
-ad_proc content_method::text_entry_filter_sql { content_type } {
+ad_proc -private content_method::text_entry_filter_sql { content_type } {
- @private text_entry_filter_sql
-
Generate a SQL stub that filters out the text_entry content method
@author Michael Pih
- @param content_type
+ @param content_type mime type
+
@return SQL stub that possibly filters out the text_entry content method
} {
@@ -122,10 +119,8 @@
-ad_proc content_method::flush_content_methods_cache { {content_type ""} } {
+ad_proc -public content_method::flush_content_methods_cache { {content_type ""} } {
- @public flush_content_method_cache
-
Flushes the cache for content_method_types for a given content type. If no
content type is specified, the entire content_method_types cache is
flushed
Index: openacs-4/packages/cms/tcl/form-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/cms/tcl/form-procs.tcl,v
diff -u -r1.18 -r1.19
--- openacs-4/packages/cms/tcl/form-procs.tcl 15 Aug 2002 03:39:34 -0000 1.18
+++ openacs-4/packages/cms/tcl/form-procs.tcl 16 Sep 2002 10:56:14 -0000 1.19
@@ -616,7 +616,6 @@
ad_proc -public content::new_item { form_name { storage_type text } { tmpfile "" } } {
- @public new_item
Create a new item, including the initial revision, based on a valid
form submission.
@@ -631,7 +630,7 @@
@param tmpfile Name of the temporary file containing the content to
upload for the initial revision.
- @see add_revision
+ @see content::add_revision
} {
@@ -687,8 +686,6 @@
ad_proc -public content::add_revision { form_name { tmpfile "" } } {
- @public add_revision
-
Create a new revision for an existing item based on a valid form
submission. Queries for attribute names and inserts a row into the
attribute input view for the appropriate content type. Inserts the
@@ -738,11 +735,10 @@
}
-ad_proc -public content::attribute_insert_statement {
+ad_proc -private content::attribute_insert_statement {
+
content_type table_name bind_vars form_name } {
- @private attribute_insert_statement
-
Prepare the insert statement into the attribute input view for a new
revision (see the content repository documentation for details about
the view).
@@ -807,8 +803,6 @@
ad_proc -private content::add_revision_dml { statement bind_vars tmpfile filename } {
- @private add_revision_dml
-
Perform the DML to insert a revision into the appropriate input view.
@param statement The DML for the insert statement, specifying a bind
@@ -822,7 +816,7 @@
@param filename The client-side name of the file containing the body of
the revision to upload into the content BLOB column of cr_revisions
- @see add_revision
+ @see content::add_revision
} {
@@ -926,8 +920,6 @@
ad_proc -private content::get_sql_value { name datatype } {
- @private get_sql_value
-
Return the sql statement for a column value in an insert or update
statement, using a bind variable for the actual value and wrapping it
in a conversion function where appropriate.
@@ -951,8 +943,6 @@
ad_proc -private content::prepare_content_file { form_name } {
- @private prepare_content_file
-
Looks for an element named "content" in a form and prepares a
temporarily file in UTF-8 for uploading to the content repository.
Checks for a query variable named "content.tmpfile" to distinguish
@@ -1001,8 +991,6 @@
ad_proc -private content::string_to_file { s } {
- @private string_to_file
-
Write a string in UTF-8 encoding to of temp file so it can be
uploaded into a BLOB (which is blind to character encodings).
Returns the name of the temp file.
@@ -1038,8 +1026,6 @@
ad_proc -public content::new_item_form { args } {
- @public new_item_form
-
Adds elements to an ATS form object for creating an item and its
initial revision. If the form does not already exist, creates the
form object and sets its enctype to multipart/form-data to allow for
@@ -1123,8 +1109,6 @@
ad_proc -public content::add_revision_form { args } {
- @public add_revision_form
-
Adds elements to an ATS form object for adding a revision to an
existing item. If the item already exists, element values default a
previous revision (the latest one by default). If the form does not
@@ -1213,8 +1197,6 @@
ad_proc -public content::add_attribute_elements { form_name content_type \
{ revision_id "" } } {
- @public add_attribute_elements
-
Add form elements to an ATS form object for all attributes of a
content type.
@@ -1276,8 +1258,6 @@
ad_proc -public content::add_attribute_element {
form_name content_type attribute { attribute_data "" } } {
- @public add_attribute_element
-
Add a form element (possibly a compound widget) to an ATS form object.
for entering or editing an attribute value.
@@ -1359,8 +1339,6 @@
ad_proc -public content::add_content_element {
form_name content_method { section_name "Content" } } {
- @public add_content_element
-
Adds a content input element to an ATS form object.
@param form_name The name of the form to which the object should be
@@ -1413,8 +1391,6 @@
ad_proc content::add_child_relation_element { form_name args } {
- @public add_child_relation_element
-
Add a select box listing all valid child relation tags.
The form must contain a parent_id element and a content_type element.
If the elements do not exist, or if there are no valid relation tags,
@@ -1489,8 +1465,6 @@
array_ref {content_type content_revision}
} {
- @private get_widget_param_value
-
Utility procedure to return the value of a widget parameter
@param array_ref The name of an array in the calling frame
@@ -1547,8 +1521,6 @@
ad_proc -private content::get_type_attribute_params { args } {
- @private get_type_attribute_params
-
Query for attribute form metadata
@param args Any number of object types
@@ -1581,8 +1553,6 @@
ad_proc -private content::get_attribute_params { content_type attribute_name } {
- @private get_attribute_params
-
Query for parameters associated with a particular attribute
@param content_type The content type keyword to which this attribute
@@ -1612,8 +1582,6 @@
ad_proc -private content::set_attribute_values { form_name content_type revision_id \
attributes } {
- @private set_attribute_values
-
Set the default values for attribute elements in ATS form object
based on a previous revision
@@ -1675,8 +1643,6 @@
ad_proc -private content::set_content_value { form_name revision_id } {
- @private set_content_value
-
Set the default value for the content text area in an ATS form object
based on a previous revision
@@ -1694,8 +1660,6 @@
ad_proc -private content::get_default_content_method { content_type } {
- @private get_default_content_method
-
Gets the content input method most appropriate for an content type,
based on the MIME types that are registered for that content type.
@@ -1721,8 +1685,6 @@
ad_proc -private content::get_type_info { object_type ref args } {
- @private get_type_info
-
Return specified columns from the acs_object_types table.
@param object_type Object type key for which info is required.
@@ -1747,8 +1709,6 @@
ad_proc -public content::get_object_id {} {
- @public get_object_id
-
Grab an object ID for creating a new ACS object.
} {
@@ -1759,8 +1719,6 @@
ad_proc -private content::get_attributes { content_type args } {
- @private get_attributes
-
Returns columns from the acs_attributes table for all attributes
associated with a content type.
@@ -1792,8 +1750,6 @@
ad_proc -public content::get_attribute_enum_values { attribute_id } {
- @public get_attribute_enum_values
-
Returns a list of { pretty_name enum_value } for an attribute of
datatype enumeration.
@@ -1809,8 +1765,6 @@
ad_proc -public content::get_latest_revision { item_id } {
- @public get_latest_revision
-
Get the ID of the latest revision for the specified content item.
@param item_id The ID of the content item.
@@ -1825,8 +1779,6 @@
ad_proc -public content::add_basic_revision { item_id revision_id title args } {
- @public add_basic_revision
-
Create a basic new revision using the content_revision PL/SQL API.
@param item_id
@@ -1876,8 +1828,6 @@
ad_proc -private content::update_content_from_file { revision_id tmpfile } {
- @private update_content_from_file
-
Update the BLOB column of a revision with the contents of a file
@param revision_id The object ID of the revision to update.
@@ -1928,8 +1878,6 @@
ad_proc -public content::copy_content { revision_id_src revision_id_dest } {
- @public copy_latest_content
-
Update the BLOB column of one revision with the content of another revision
@param revision_id_src The object ID of the revision with the content to be
@@ -1964,8 +1912,6 @@
ad_proc -public content::add_content { form_name revision_id } {
- @public add_content
-
Update the BLOB column of a revision with content submitted in a form
@param revision_id The object ID of the revision to be updated.
@@ -1990,8 +1936,6 @@
ad_proc -public content::validate_name { form_name } {
- @public validate_name
-
Make sure that name is unique for the folder
@param form_name The name of the form (containing name and parent_id)
Index: openacs-4/packages/cms/tcl/publish-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/cms/tcl/publish-procs.tcl,v
diff -u -r1.9 -r1.10
--- openacs-4/packages/cms/tcl/publish-procs.tcl 15 Aug 2002 03:39:34 -0000 1.9
+++ openacs-4/packages/cms/tcl/publish-procs.tcl 16 Sep 2002 10:56:14 -0000 1.10
@@ -36,8 +36,8 @@
@return The page root
- @see proc publish::get_template_root
- @see proc publish::get_publish_roots
+ @see publish::get_template_root
+ @see publish::get_publish_roots
} {
@@ -65,8 +65,8 @@
@return A list of all the publish roots
- @see proc publish::get_template_root
- @see proc publish::get_page_root
+ @see publish::get_template_root
+ @see publish::get_page_root
} {
@@ -104,7 +104,8 @@
@return The template root
- @see proc content::get_template_root, proc publish::get_page_root
+ @see content::get_template_root
+ @see publish::get_page_root
} {
return [content::get_template_root]
@@ -148,9 +149,9 @@
@param url Relative URL of the file to write
- @see proc publish::get_publish_roots
- @see proc publish::write_multiple_files
- @see proc publish::write_multiple_blobs
+ @see publish::get_publish_roots
+ @see publish::write_multiple_files
+ @see publish::write_multiple_blobs
} {
foreach_publish_path $url {
@@ -173,9 +174,9 @@
@option root_path {default All paths in the PublishPaths parameter}
Write the content to this path only.
- @see proc item::get_extended_url
- @see proc publish::get_publish_paths
- @see proc publish::handle_item
+ @see item::get_extended_url
+ @see publish::get_publish_roots
+ @see publish::handle_item
} {
@@ -216,7 +217,7 @@
@option root_path {default All paths in the PublishPaths parameter}
Write the content to this path only.
- @see proc publish::publish_revision
+ @see publish::publish_revision
} {
@@ -292,8 +293,8 @@
@param revision_id {default The live revision}
The revision id to be used when publishing the item to the filesystem.
- @see proc publish::publish_revision
- @see proc publish::unpublish_item
+ @see publish::publish_revision
+ @see publish::unpublish_item
} {
@@ -353,7 +354,7 @@
Scheduled proc which keeps the publish status updated
- @see proc publish::schedule_status_sweep
+ @see publish::schedule_status_sweep
} {
@@ -408,9 +409,9 @@
StatusSweepInterval parameter in the server's INI file is used
(if it exists).
- @see proc publish::set_publish_status
- @see proc publish::unschedule_status_sweep
- @see proc publish::track_publish_status
+ @see publish::set_publish_status
+ @see publish::unschedule_status_sweep
+ @see publish::track_publish_status
} {
@@ -432,7 +433,7 @@
Unschedule the proc which keeps track of the publish status.
- @see proc publish::schedule_status_sweep
+ @see publish::schedule_status_sweep
} {