Index: openacs-4/packages/acs-content-repository/www/doc/api/item.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-content-repository/www/doc/api/item.adp,v
diff -u -r1.2.2.8 -r1.2.2.9
--- openacs-4/packages/acs-content-repository/www/doc/api/item.adp	1 Dec 2015 11:17:40 -0000	1.2.2.8
+++ openacs-4/packages/acs-content-repository/www/doc/api/item.adp	9 Jun 2016 08:44:49 -0000	1.2.2.9
@@ -27,12 +27,11 @@
 See also: content_revision, content_folder
 <p> </p>
 <h3><a name="api">API</a></h3>
-<ul><li>
-<font size="+1">Function:</font>
-content_item.get_content_type</li></ul>
+<ul>
+<li>
+<font size="+1">Function:</font> content_item.get_content_type
 <p>Retrieve the content type of this item. Only objects of this
-type may be used as revisions for the item.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+type may be used as revisions for the item.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -45,12 +44,10 @@
 ) return cr_items.content_type%TYPE;
 
 </tt></pre></td></tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font> content_item.get_context</li></ul>
-<p>Retrieve the parent of the given item</p>
-<table cellpadding="3" cellspacing="0" border="0">
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.get_context
+<p>Retrieve the parent of the given item</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -63,15 +60,13 @@
 ) return acs_objects.context_id%TYPE;
 
 </tt></pre></td></tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font> content_item.get_id</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.get_id
 <p>Takes in a path, such as "/tv/programs/star_trek/episode_203"
 and returns the id of the item with this path. Note: URLs are
 abstract (no extensions are allowed in content item names and
-extensions are stripped when looking up content items)</p>
-<table cellpadding="3" cellspacing="0" border="0">
+extensions are stripped when looking up content items)</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -93,14 +88,12 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>content_item.get_path</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
+</table><p> </p>
+</li><li>
 <font size="+1">Function:</font>
-content_item.get_latest_revision</li></ul>
+content_item.get_latest_revision
 <p>Retrieves the id of the latest revision for the item (as opposed
-to the live revision)</p>
-<table cellpadding="3" cellspacing="0" border="0">
+to the live revision)</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -116,17 +109,13 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>content_item.get_live_revision</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font>
-content_item.get_live_revision</li></ul>
-<p>Retrieves the id of the live revision for the item</p>
-<p>Note that this function does nothing else besides retrieving the
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.get_live_revision
+<p>Retrieves the id of the live revision for the item</p><p>Note that this function does nothing else besides retrieving the
 value of the column <code>cr_items.live_revision</code>. It is thus
 more efficient in many cases to join against <code>cr_items</code>
-and retrieve the value directly.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+and retrieve the value directly.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Returns:</th><td align="left">The id of the live revision for this item, or null
 if no live revision exists</td>
@@ -141,13 +130,10 @@
 <th align="left" valign="top">See Also:</th><td>content_item.set_live_revision,
 content_item.get_latest_revision</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font>
-content_item.get_parent_folder</li></ul>
-<p>Get the parent folder.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.get_parent_folder
+<p>Get the parent folder.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Michael Pih</td>
 </tr><tr>
@@ -161,13 +147,11 @@
 ) return cr_folders.folder_id%TYPE;
 
 </tt></pre></td></tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font> content_item.get_path</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.get_path
 <p>Retrieves the full path to an item, in the form of
-"/tv/programs/star_trek/episode_203"</p>
-<table cellpadding="3" cellspacing="0" border="0">
+"/tv/programs/star_trek/episode_203"</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -188,13 +172,10 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>content_item.get_id, content_item.write_to_file</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font>
-content_item.get_publish_date</li></ul>
-<p>Retrieves the publish date for the item</p>
-<table cellpadding="3" cellspacing="0" border="0">
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.get_publish_date
+<p>Retrieves the publish date for the item</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -217,13 +198,11 @@
 <th align="left" valign="top">See Also:</th><td>content_item.get_live_revision,
 content_item.get_latest_revision,</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
+</table><p> </p>
+</li><li>
 <font size="+1">Function:</font>
-content_item.get_revision_count</li></ul>
-<p>Return the total count of revisions for this item</p>
-<table cellpadding="3" cellspacing="0" border="0">
+content_item.get_revision_count
+<p>Return the total count of revisions for this item</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -238,25 +217,21 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>content_revision.new</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font>
-content_item.get_root_folder</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.get_root_folder
 <table cellpadding="3" cellspacing="0" border="0">
 <tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><i>Not yet documented</i></td></tr><tr><th align="left" colspan="2">Declaration:</th></tr><tr align="left"><td colspan="2" align="left"><pre><tt>
 function get_root_folder return cr_folders.folder_id%TYPE;
 
 </tt></pre></td></tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font> content_item.get_template</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.get_template
 <p>Retrieves the template which should be used to render this item.
 If no template is registered to specifically render the item in the
 given context, the default template for the item's type is
-returned.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+returned.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -279,15 +254,13 @@
 <th align="left" valign="top">See Also:</th><td>content_type.register_template,
 content_item.register_template,</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font> content_item.get_title</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.get_title
 <p>Retrieves the title for the item, using either the latest or the
 live revision. If the specified item is in fact a folder, return
 the folder's label. In addition, this function will automatically
-resolve symlinks.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+resolve symlinks.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -309,14 +282,11 @@
 <th align="left" valign="top">See Also:</th><td>content_item.get_live_revision,
 content_item.get_latest_revision, content_symlink.resolve</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font>
-content_item.get_virtual_path</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.get_virtual_path
 <p>Retrieves the virtual path to an item, in the form of
-"/tv/programs/star_trek/episode_203"</p>
-<table cellpadding="3" cellspacing="0" border="0">
+"/tv/programs/star_trek/episode_203"</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Michael Pih</td>
 </tr><tr>
@@ -338,15 +308,12 @@
 <th align="left" valign="top">See Also:</th><td>content_item.get_id, content_item.write_to_file,
 content_item.get_path</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font>
-content_item.is_index_page</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.is_index_page
 <p>Determine if the item is an index page for the specified folder.
 The item is an index page for the folder if it exists in the folder
-and its item name is "index".</p>
-<table cellpadding="3" cellspacing="0" border="0">
+and its item name is "index".</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -367,17 +334,14 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>content_folder.get_index_page</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font>
-content_item.is_publishable</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.is_publishable
 <p>Determines if an item is publishable. Publishable items must
 meet the following criteria: 1) for each child type, the item has n
 children, min_n &lt; n &lt; max_n 2) for each relation type, the
 item has n relations, min_n &lt; n &lt; max_n 3) any
-'publishing_wf' workflows are finished</p>
-<table cellpadding="3" cellspacing="0" border="0">
+'publishing_wf' workflows are finished</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Michael Pih</td>
 </tr><tr>
@@ -391,13 +355,11 @@
 ) return char;
 
 </tt></pre></td></tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font> content_item.is_subclass</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.is_subclass
 <p>Determines if one type is a subclass of another. A class is
-always a subclass of itself.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+always a subclass of itself.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -418,16 +380,13 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>acs_object_type.create_type</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font>
-content_item.is_valid_child</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.is_valid_child
 <p>Determines if an item would be a valid child of another item by
 checking if the parent allows children of the would-be child's
 content type and if the parent already has n_max children of that
-content type.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+content type.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Michael Pih</td>
 </tr><tr>
@@ -446,14 +405,12 @@
 ) return char;
 
 </tt></pre></td></tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font> content_item.new</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.new
 <p>Creates a new content item. If the <tt>data</tt>, <tt>title</tt>
 or <tt>text</tt> parameters are specified, also creates a revision
-for the item.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+for the item.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr>
@@ -539,10 +496,9 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>acs_object.new</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Function:</font> content_item.relate</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Function:</font> content_item.relate
 <table cellpadding="3" cellspacing="0" border="0">
 <tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><i>Not yet documented</i></td></tr><tr><th align="left" colspan="2">Declaration:</th></tr><tr align="left"><td colspan="2" align="left"><pre><tt>
 function relate (
@@ -554,15 +510,13 @@
 ) return cr_item_rels.rel_id%TYPE;
 
 </tt></pre></td></tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Procedure:</font> content_item.copy</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Procedure:</font> content_item.copy
 <p>Copies the item to a new location, creating an identical item
 with no revisions or associated workflow. If the target folder does
 not exist, or if the folder already contains an item with the same
-name as the given item, an error will be thrown.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+name as the given item, an error will be thrown.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><blockquote><table border="0" cellpadding="0" cellspacing="1">
@@ -580,14 +534,12 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>content_item.new, content_folder.new, content_item.move</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Procedure:</font> content_item.delete</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Procedure:</font> content_item.delete
 <p>Deletes the specified content item, along with any revisions,
 symlinks, workflows, and template relations for the item. Use with
-caution - this operation cannot be undone.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+caution - this operation cannot be undone.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><blockquote><table border="0" cellpadding="0" cellspacing="1"><tr>
@@ -600,14 +552,12 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>acs_object.delete</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Procedure:</font> content_item.move</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Procedure:</font> content_item.move
 <p>Move the specified item to a different folder. If the target
 folder does not exist, or if the folder already contains an item
-with the same name as the given item, an error will be thrown.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+with the same name as the given item, an error will be thrown.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><blockquote><table border="0" cellpadding="0" cellspacing="1">
@@ -625,13 +575,11 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>content_item.new, content_folder.new, content_item.copy</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
+</table><p> </p>
+</li><li>
 <font size="+1">Procedure:</font>
-content_item.register_template</li></ul>
-<p>Registers a template which will be used to render this item.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+content_item.register_template
+<p>Registers a template which will be used to render this item.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><blockquote><table border="0" cellpadding="0" cellspacing="1">
@@ -654,13 +602,11 @@
 <th align="left" valign="top">See Also:</th><td>content_type.register_template,
 content_item.unregister_template, content_item.get_template</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Procedure:</font> content_item.edit_name</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Procedure:</font> content_item.edit_name
 <p>Renames the item. If an item with the specified name already
-exists under this item's parent, an error is thrown</p>
-<table cellpadding="3" cellspacing="0" border="0">
+exists under this item's parent, an error is thrown</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><blockquote><table border="0" cellpadding="0" cellspacing="1">
@@ -678,13 +624,11 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>content_item.new</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
+</table><p> </p>
+</li><li>
 <font size="+1">Procedure:</font>
-content_item.set_live_revision</li></ul>
-<p>Make the specified revision the live revision for the item</p>
-<table cellpadding="3" cellspacing="0" border="0">
+content_item.set_live_revision
+<p>Make the specified revision the live revision for the item</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><blockquote><table border="0" cellpadding="0" cellspacing="1"><tr>
@@ -699,15 +643,13 @@
 </tt></pre></td></tr><tr>
 <th align="left" valign="top">See Also:</th><td>content_item.get_live_revision</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
+</table><p> </p>
+</li><li>
 <font size="+1">Procedure:</font>
-content_item.set_release_period</li></ul>
+content_item.set_release_period
 <p>Sets the release period for the item. This information may be
 used by applications to update the publishing status of items at
-periodic intervals.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+periodic intervals.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><blockquote><table border="0" cellpadding="0" cellspacing="1">
@@ -726,14 +668,12 @@
 );
 
 </tt></pre></td></tr>
-</table>
-<p> </p>
-<ul><li>
+</table><p> </p>
+</li><li>
 <font size="+1">Procedure:</font>
-content_item.unregister_template</li></ul>
+content_item.unregister_template
 <p>Unregisters a template which will be used to render this
-item.</p>
-<table cellpadding="3" cellspacing="0" border="0">
+item.</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><blockquote><table border="0" cellpadding="0" cellspacing="1">
@@ -756,11 +696,10 @@
 <th align="left" valign="top">See Also:</th><td>content_type.register_template, content_item.register_template,
 content_item.get_template</td>
 </tr>
-</table>
-<p> </p>
-<ul><li>
+</table><p> </p>
+</li><li>
 <font size="+1">Procedure:</font>
-content_item.unset_live_revision</li></ul>
+content_item.unset_live_revision
 <table cellpadding="3" cellspacing="0" border="0">
 <tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><i>Not yet documented</i></td></tr><tr><th align="left" colspan="2">Declaration:</th></tr><tr align="left"><td colspan="2" align="left"><pre><tt>
 procedure unset_live_revision (
@@ -772,14 +711,11 @@
 );
 
 </tt></pre></td></tr>
-</table>
-<p> </p>
-<ul><li>
-<font size="+1">Procedure:</font>
-content_item.write_to_file</li></ul>
+</table><p> </p>
+</li><li>
+<font size="+1">Procedure:</font> content_item.write_to_file
 <p>Writes the content of the live revision of this item to a file,
-creating all the neccessary directories in the process</p>
-<table cellpadding="3" cellspacing="0" border="0">
+creating all the neccessary directories in the process</p><table cellpadding="3" cellspacing="0" border="0">
 <tr>
 <th align="left">Author:</th><td align="left">Karl Goldstein</td>
 </tr><tr><th align="left" colspan="2">Parameters:</th></tr><tr><td></td></tr><tr><td align="left" colspan="2"><blockquote><table border="0" cellpadding="0" cellspacing="1">
@@ -799,6 +735,9 @@
 <th align="left" valign="top">See Also:</th><td>content_item.get_path</td>
 </tr>
 </table>
+</li>
+</ul>
 <p> </p>
 
-Last Modified: $&zwnj;Id: item.html,v 1.3 2004/06/01 22:54:18 donb Exp $
+Last Modified: $&zwnj;Id: item.html,v 1.3.18.1 2016/06/09 08:21:01
+gustafn Exp $