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

Method Detail

* indicates required

-Public Methods: +Public Methods:
item::content_is_null
Determines if the content for the revision is null (not mereley zero-length)
-Parameters: +Parameters:
revision_id* The revision id
-
Returns:
1 if the content is null, 0 otherwise
+
Returns:
1 if the content is null, 0 otherwise
@@ -44,12 +44,12 @@ type registered to it. In the future, a more sophisticated mechanism will be implemented.
-Parameters: +Parameters:
content_type* The content type
-
Returns:
A Tcl list of all possible content methods
Options:
+
Returns:
A Tcl list of all possible content methods
Options:
@@ -63,13 +63,13 @@ no live revision exists, attempts to retrieve the latest revision. If the item has no revisions, returns an empty string.
-Parameters:
get_labelsReturn not just a list of types, but a list of name-value pairs, as in the -options ATS switch for form widgets
+Parameters:
item_id* The item id
-
Returns:
The best revision id for the item, or an empty string if no -revisions exist
See Also:
proc - item::get_item_from_revision
item::get_live_revision
+
Returns:
The best revision id for the item, or an empty string if no +revisions exist
See Also:
proc - item::get_item_from_revision
item::get_live_revision
@@ -79,12 +79,12 @@
Retrieves the content type of tyhe item. If the item does not exist, returns an empty string.
-Parameters: +Parameters:
item_id* The item id
-
Returns:
The content type of the item, or an empty string if no such +
Returns:
The content type of the item, or an empty string if no such item exists
@@ -95,13 +95,13 @@ extension based on the item's mime_type (Example: { /foo/bar/baz.html} ).
-Parameters: +Parameters:
item_id* The item id
-
Returns:
The relative URL of the item with the appropriate file -extension or an empty string on failure
Options:
+
Returns:
The relative URL of the item with the appropriate file +extension or an empty string on failure
Options:
-
template_extensionSignifies that the file extension should be retrieved using the mime_type of the template assigned to the item, @@ -111,12 +111,12 @@ defaults to { .html}
revision_id -default the live revision; Specifies the +default the live revision; Specifies the revision_id which will be used to retrieve the item's mime_type. This option is ignored if the -template_extension option is specified.
See Also:
proc - item::get_mime_info
item::get_template_id
item::get_url
+
See Also:
proc - item::get_mime_info
item::get_template_id
item::get_url
@@ -126,19 +126,19 @@
Looks up the URL and gets the item id at that URL, if any.
-Parameters: +Parameters:
url* The URL
root_folder -default The Sitemap; The ID of the root +default The Sitemap; The ID of the root folder to use for resolving the URL
-
Returns:
The item ID of the item at that URL, or the empty string on -failure
See Also:
proc - item::get_url
+
Returns:
The item ID of the item at that URL, or the empty string on +failure
See Also:
proc - item::get_url
@@ -148,12 +148,12 @@
Gets the item_id of the item to which the revision belongs.
-Parameters: +Parameters:
revision_id* The revision id
-
Returns:
The item_id of the item to which this revision belongs
See Also:
proc - item::get_best_revision
item::get_live_revision
+
Returns:
The item_id of the item to which this revision belongs
See Also:
proc - item::get_best_revision
item::get_live_revision
@@ -163,13 +163,13 @@
Retrieves the live revision for the item. If the item has no live revision, returns an empty string.
-Parameters: +Parameters:
item_id* The item id
-
Returns:
The live revision id for the item, or an empty string if no -live revision exists
See Also:
proc - item::get_best_revision
item::get_item_from_revision
+
Returns:
The live revision id for the item, or an empty string if no +live revision exists
See Also:
proc - item::get_best_revision
item::get_item_from_revision
@@ -181,20 +181,20 @@ If the revision does not exist, does not create the datasource.
-Parameters: +Parameters:
revision_id* The revision id
datasource_ref -default mime_info; The name of the +default mime_info; The name of the datasource to be created. The datasource will have two columns, mime_type and file_extension. return 1 (one) if the revision exists, 0 (zero) otherwise.
-
See Also:
proc - item::get_extended_url
+
See Also:
proc - item::get_extended_url
@@ -215,13 +215,13 @@
-Parameters: +Parameters:
item_id* The item id
-
Returns:
The publish status of the item, or the empty string on -failure
See Also:
proc - item::is_publishable
+
Returns:
The publish status of the item, or the empty string on +failure
See Also:
proc - item::is_publishable
@@ -236,18 +236,18 @@ the revision has a textual mime-type.

-Parameters: +Parameters:
revision_id* The revision whose attributes are to be retrieved
-
Returns:
1 on success (and create a content array in the calling frame), -0 on failure
Options:
+
Returns:
1 on success (and create a content array in the calling frame), +0 on failure
Options:
-
item_id -defaultauto-generated; The item_id +defaultauto-generated; The item_id of the corresponding item.
See Also:
proc - item::get_content_type
item::get_mime_info
+
See Also:
proc - item::get_content_type
item::get_mime_info
@@ -260,19 +260,19 @@ default template registered to the item's content_type. Returns an empty string on failure.
-Parameters: +Parameters:
item_id* The item id
context -default 'public'; The context in which the +default 'public'; The context in which the template will be used.
-
Returns:
The template_id of the template which can be used to render the -item, or an empty string on failure
See Also:
proc - item::get_template_url
+
Returns:
The template_id of the template which can be used to render the +item, or an empty string on failure
See Also:
proc - item::get_template_url
@@ -283,19 +283,19 @@ used to render the item. The URL is relative to the TemplateRoot as it is specified in the ini file.
-Parameters: +Parameters:
item_id* The item id
context -default 'public'; The context in which the +default 'public'; The context in which the template will be used.
-
Returns:
The template_id of the template which can be used to render the -item, or an empty string on failure
See Also:
proc - item::get_template_id
+
Returns:
The template_id of the template which can be used to render the +item, or an empty string on failure
See Also:
proc - item::get_template_id
@@ -306,12 +306,12 @@ item exists, use the live revision. Otherwise, use the latest revision.
-Parameters: +Parameters:
item_id* The item id
-
Returns:
The title of the item
See Also:
proc - item::get_best_revision
+
Returns:
The title of the item
See Also:
proc - item::get_best_revision
@@ -322,13 +322,13 @@ relative to the page root, and has no extension (Example: { /foo/bar/baz} ).
-Parameters: +Parameters:
item_id* The item id
-
Returns:
The relative URL to the item, or an empty string on -failure
See Also:
proc - item::get_extended_url
+
Returns:
The relative URL to the item, or an empty string on +failure
See Also:
proc - item::get_extended_url
@@ -343,12 +343,12 @@
-Parameters: +Parameters:
item_id* The item id
-
Returns:
1 if the item is publishable, 0 otherwise
+
Returns:
1 if the item is publishable, 0 otherwise