Index: openacs-4/packages/acs-templating/www/doc/TclDocs/content.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/TclDocs/content.adp,v diff -u -r1.2.2.1 -r1.2.2.2 --- openacs-4/packages/acs-templating/www/doc/TclDocs/content.adp 25 Aug 2015 18:02:11 -0000 1.2.2.1 +++ openacs-4/packages/acs-templating/www/doc/TclDocs/content.adp 9 Jun 2016 13:03:12 -0000 1.2.2.2 @@ -14,14 +14,14 @@

Method Detail

* indicates required

-Public Methods: +Public Methods:
content::add_attribute_element
Add a form element (possibly a compound widget) to an ATS form object. for entering or editing an attribute value.
-Parameters: +Parameters:
form_name* @@ -52,7 +52,7 @@
Add form elements to an ATS form object for all attributes of a content type.
-Parameters: +Parameters:
form_name* @@ -70,7 +70,7 @@ queried
-
Returns:
The list of attributes that were added.
+
Returns:
The list of attributes that were added.
@@ -79,7 +79,7 @@
Create a basic new revision using the content_revision PL/SQL API.
-Parameters: +Parameters:
item_id* @@ -94,7 +94,7 @@
-
Options:
+
Options:
@@ -115,15 +115,15 @@ element. If the elements do not exist, or if there are no valid relation tags, this proc does nothing.
-Parameters:
description
+Parameters:
form_name* The name of the form
-
Options:
+
Options:
section -none If present, creates a new form section +none If present, creates a new form section for the element.
label{Child relation tag} The label for the @@ -137,7 +137,7 @@
content::add_content
Update the BLOB column of a revision with content submitted in a form
-Parameters: +Parameters:
@@ -149,7 +149,7 @@
revision_id* The object ID of the revision to be updated.
content::add_content_element
Adds a content input element to an ATS form object.
-Parameters: +Parameters:
form_name* @@ -171,7 +171,7 @@ row into the attribute input view for the appropriate content type. Inserts the contents of a file into the content column of the cr_revisions table for the revision as well.
-Parameters: +Parameters:
form_name* @@ -195,7 +195,7 @@ the form does not already exist, creates the form object and sets its enctype to multipart/form-data to allow for text entries greater than 4000 characters.
-
Options:
+
Options:
@@ -227,7 +227,7 @@
form_nameThe name of the ATS form object. Defaults to { new_item} .
content::copy_content
Update the BLOB column of one revision with the content of another revision
-Parameters: +Parameters:
revision_id_src* @@ -247,7 +247,7 @@
content::get_attribute_enum_values
Returns a list of { pretty_name enum_value } for an attribute of datatype enumeration.
-Parameters: +Parameters:
@@ -303,7 +303,7 @@ creates the form object and sets its enctype to multipart/form-data to allow for text entries greater than 4000 characters.
-
Options:
attribute_id* The primary key of the attribute as in the @@ -260,7 +260,7 @@
content::get_latest_revision
Get the ID of the latest revision for the specified content item.
-Parameters: +Parameters:
@@ -277,7 +277,7 @@
Create a new item, including the initial revision, based on a valid form submission.
-Parameters:
item_id* The ID of the content item.
+Parameters:
form_name* @@ -291,7 +291,7 @@ to upload for the initial revision.
-
See Also:
add_revision -
+
See Also:
add_revision -
+
Options:
@@ -337,25 +337,25 @@
Make sure that name is unique for the folder
-Parameters:
form_nameThe name of the ATS form object. Defaults to { new_item} .
+Parameters:
form_name* The name of the form (containing name and parent_id)
-
Returns:
0 if there are items with the same name, 1 otherwise
+
Returns:
0 if there are items with the same name, 1 otherwise

-Private Methods:
+Private Methods:

@@ -390,7 +390,7 @@
Prepare the insert statement into the attribute input view for a new revision (see the content repository documentation for details about the view).
-Parameters:
content::add_revision_dml
Perform the DML to insert a revision into the appropriate input view.
-Parameters: +Parameters:
statement* @@ -380,7 +380,7 @@ cr_revisions
-
See Also:
add_revision -
+
See Also:
add_revision -
+Parameters:
content_type* @@ -420,7 +420,7 @@
content::get_attribute_params
Query for parameters associated with a particular attribute
-Parameters: +Parameters:
content_type* @@ -440,7 +440,7 @@
content::get_attributes
Returns columns from the acs_attributes table for all attributes associated with a content type.
-Parameters: +Parameters:
content_type* @@ -461,7 +461,7 @@
Gets the content input method most appropriate for an content type, based on the MIME types that are registered for that content type.
-Parameters: +Parameters:
content_type* The content type for which an input method is @@ -476,7 +476,7 @@ insert or update statement, using a bind variable for the actual value and wrapping it in a conversion function where appropriate.
-Parameters: +Parameters:
name* @@ -495,12 +495,12 @@
content::get_type_attribute_params
Query for attribute form metadata
-Parameters: +Parameters:
args* Any number of object types
-
Returns:
A list of attribute parameters nested by object_type, +
Returns:
A list of attribute parameters nested by object_type, attribute_name and the is_html flag. For attributes with no parameters, there is a single entry with is_html as null.
@@ -510,7 +510,7 @@
content::get_type_info
Return specified columns from the acs_object_types table.
-Parameters: +Parameters:
object_type* @@ -534,7 +534,7 @@
content::get_widget_param_value
Utility procedure to return the value of a widget parameter
-Parameters: +Parameters:
array_ref* @@ -559,13 +559,13 @@ file is text, then ensures that is in UTF-8. Does nothing if the uploaded file is in binary format.
-Parameters: +Parameters:
form_name* The name of the form object in which content was submitted.
-
Returns:
The path of the temporary file containing the content, or an +
Returns:
The path of the temporary file containing the content, or an empty string if the form does not include a content element or the value of the element is null.
@@ -575,7 +575,7 @@
content::set_attribute_values
Set the default values for attribute elements in ATS form object based on a previous revision
-Parameters: +Parameters:
form_name* @@ -604,7 +604,7 @@
content::set_content_value
Set the default value for the content text area in an ATS form object based on a previous revision
-Parameters: +Parameters:
form_name* @@ -624,7 +624,7 @@
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.
-Parameters: +Parameters:
@@ -636,7 +636,7 @@
s* The string to write to the file.
content::update_content_from_file
Update the BLOB column of a revision with the contents of a file
-Parameters: +Parameters:
revision_id* @@ -656,7 +656,7 @@
Inserts content into the database from an uploaded file. Does automatic mime_type updating Parses text/html content and removes tags
-Parameters: +Parameters:
db*