Index: openacs-4/packages/acs-templating/www/doc/TclDocs/item.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/TclDocs/item.html,v diff -u -r1.2 -r1.3 --- openacs-4/packages/acs-templating/www/doc/TclDocs/item.html 27 Oct 2014 16:40:17 -0000 1.2 +++ openacs-4/packages/acs-templating/www/doc/TclDocs/item.html 7 Aug 2017 23:48:02 -0000 1.3 @@ -62,13 +62,13 @@

Method Detail

-

+

* indicates required

-Public Methods:
-
+Public Methods:
+ @@ -79,19 +79,19 @@
- Parameters: + Parameters:
item::content_is_null
- -
revision_id + revision_id * + The revision id
-
Returns: +
Returns:
1 if the content is null, 0 otherwise @@ -101,7 +101,7 @@

-
+ @@ -112,27 +112,27 @@
- Parameters: + Parameters:
item::content_methods_by_type
- -
content_type + content_type * + The content type
-
Returns: +
Returns:
A Tcl list of all possible content methods -
Options: +
Options: - - + @@ -144,7 +144,7 @@
get_labels +
get_labels Return not just a list of types, but a list of name-value pairs, as in the -options ATS switch for form widgets

-
+ @@ -155,23 +155,23 @@
- Parameters: + Parameters:
item::get_best_revision
- -
item_id + item_id * + The item id
-
Returns: +
Returns:
The best revision id for the item, or an empty string if no revisions exist -
See Also: +
See Also:
proc - item::get_item_from_revision
item::get_live_revision
@@ -180,30 +180,30 @@

-
+
item::get_content_type
-Retrieves the content type of tyhe item. If the item does not exist, returns an empty string. +Retrieves the content type of the item. If the item does not exist, returns an empty string.
- Parameters: + Parameters: - -
item_id + item_id * + The item id
-
Returns: +
Returns:
The content type of the item, or an empty string if no such item exists @@ -213,7 +213,7 @@

-
+ @@ -224,40 +224,40 @@
- Parameters: + Parameters:
item::get_extended_url
- -
item_id + item_id * + The item id
-
Returns: +
Returns:
The relative URL of the item with the appropriate file extension or an empty string on failure -
Options: +
Options: - - + - - +
template_extension +
template_extension Signifies that the file extension should be retrieved using the mime_type of the template assigned to the item, not from the item itself. The live revision of the template is used. If there is no template which could be used to render the item, or if the template has no live revision, the extension defaults to { .html}
revision_id +
revision_id - default the live revision; + 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: +
See Also:
proc - item::get_mime_info
item::get_template_id
item::get_url
@@ -266,7 +266,7 @@

-
+ @@ -277,30 +277,30 @@
- Parameters: + Parameters:
item::get_id
- - -
url + url * + The URL
root_folder + root_folder - default The Sitemap; + default The Sitemap; The ID of the root folder to use for resolving the URL
-
Returns: +
Returns:
The item ID of the item at that URL, or the empty string on failure -
See Also: +
See Also:
proc - item::get_url
@@ -309,7 +309,7 @@

-
+ @@ -320,23 +320,23 @@
- Parameters: + Parameters:
item::get_item_from_revision
- -
revision_id + revision_id * + The revision id
-
Returns: +
Returns:
The item_id of the item to which this revision belongs -
See Also: +
See Also:
proc - item::get_best_revision
item::get_live_revision
@@ -345,7 +345,7 @@

-
+ @@ -356,23 +356,23 @@
- Parameters: + Parameters:
item::get_live_revision
- -
item_id + item_id * + The item id
-
Returns: +
Returns:
The live revision id for the item, or an empty string if no live revision exists -
See Also: +
See Also:
proc - item::get_best_revision
item::get_item_from_revision
@@ -381,7 +381,7 @@

-
+ @@ -392,26 +392,26 @@
- Parameters: + Parameters:
item::get_mime_info
- - -
revision_id + revision_id * + The revision id
datasource_ref + datasource_ref - default mime_info; + 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: +
See Also:
proc - item::get_extended_url
@@ -420,34 +420,34 @@

-
+
item::get_publish_status
-Get the publish status of the item. The publish status will be one of the following:
  • production - The item is still in production. The workflow (if any) is not finished, and the item has no live revision.
  • ready - The item is ready for publishing
  • live - The item has been published
  • expired - The item has been published in the past, but its publication has expired
+Get the publish status of the item. The publish status will be one of the following:
  • production - The item is still in production. The workflow (if any) is not finished, and the item has no live revision.
  • ready - The item is ready for publishing
  • live - The item has been published
  • expired - The item has been published in the past, but its publication has expired
- Parameters: + Parameters: - -
item_id + item_id * + The item id
-
Returns: +
Returns:
The publish status of the item, or the empty string on failure -
See Also: +
See Also:
proc - item::is_publishable
@@ -456,7 +456,7 @@

-
+ @@ -467,35 +467,35 @@
- Parameters: + Parameters:
item::get_revision_content
- -
revision_id + revision_id * + The revision whose attributes are to be retrieved
-
Returns: +
Returns:
1 on success (and create a content array in the calling frame), 0 on failure -
Options: +
Options: - - +
item_id +
item_id - default auto-generated; + default auto-generated; The item_id of the corresponding item.
-
See Also: +
See Also:
proc - item::get_content_type
item::get_mime_info
@@ -504,7 +504,7 @@

-
+ @@ -515,30 +515,30 @@
- Parameters: + Parameters:
item::get_template_id
- - -
item_id + item_id * + The item id
context + context - default 'public'; + default 'public'; The context in which the template will be used.
-
Returns: +
Returns:
The template_id of the template which can be used to render the item, or an empty string on failure -
See Also: +
See Also:
proc - item::get_template_url
@@ -547,7 +547,7 @@

-
+ @@ -558,30 +558,30 @@
- Parameters: + Parameters:
item::get_template_url
- - -
item_id + item_id * + The item id
context + context - default 'public'; + default 'public'; The context in which the template will be used.
-
Returns: +
Returns:
The template_id of the template which can be used to render the item, or an empty string on failure -
See Also: +
See Also:
proc - item::get_template_id
@@ -590,7 +590,7 @@

-
+ @@ -601,23 +601,23 @@
- Parameters: + Parameters:
item::get_title
- -
item_id + item_id * + The item id
-
Returns: +
Returns:
The title of the item -
See Also: +
See Also:
proc - item::get_best_revision
@@ -626,7 +626,7 @@

-
+ @@ -637,23 +637,23 @@
- Parameters: + Parameters:
item::get_url
- -
item_id + item_id * + The item id
-
Returns: +
Returns:
The relative URL to the item, or an empty string on failure -
See Also: +
See Also:
proc - item::get_extended_url
@@ -662,7 +662,7 @@

-
+ @@ -673,19 +673,19 @@
- Parameters: + Parameters:
item::is_publishable
- -
item_id + item_id * + The item id
-
Returns: +
Returns:
1 if the item is publishable, 0 otherwise @@ -701,7 +701,7 @@ -

+

* indicates required