Set a data source in the calling frame with folder URL and label Useful for generating a context bar. This function returns a hard-coded name for the root level. One should use for path generation for items the appropriate API, such as e.g. content::item::get_virtual_path

Parameters:

varname (optional, defaults to "folders")

See Also:

• content::item::get_virtual_path

Testcases:

No testcase defined.

Delete an external link.

Switches:

-extlink_id (required)

The object id of the link to delete

See Also:

• content::extlink::delete

Testcases:

No testcase defined.

Edit an existing external link. The parameters are required because it is assumed that the caller will be pulling the existing values out of the database before editing them.

Switches:

-extlink_id (required)

Optional pre-assigned object_id for the link

-url (required)

The URL of the external resource

-label (required)

Label for the extlink (defaults to the URL)

-description (required)

An extended description of the link (defaults to NULL)

See Also:

• content::extlink::edit

Testcases:

No testcase defined.

Returns the name of an extlink

Switches:

-item_id (required)

The object id of the item to check.

See Also:

• content::extlink::name

Testcases:

No testcase defined.

Returns true if the given item is an external link.

Switches:

-item_id (required)

The object id of the item to check.

See Also:

• content::extlink::is_extlink

Testcases:

No testcase defined.

Create a new external link.

Switches:

-extlink_id (optional)

Optional pre-assigned object_id for the link

-url (required)

The URL of the external resource

-parent_id (required)

The folder that will contain this extlink

-name (optional)

Name to assign the object (defaults to "link extlink_id")

-label (optional)

Label for the extlink (defaults to the URL)

-description (optional)

An extended description of the link (defaults to NULL)

-package_id (optional)

Package Id of the package that created the link

See Also:

• content::extlink::new

Testcases:

No testcase defined.

Provides data source for search interface. Used to access content items after search. DEPRECATED: does not comply with OpenACS naming convention

Parameters:

object_id (required)

See Also:

• content_search::datasource

Testcases:

No testcase defined.

Provides a URL for linking to content items which show up in a search result set. DEPRECATED: does not comply with OpenACS naming convention

Parameters:

object_id (required)

See Also:

• content_search::url

Testcases:

No testcase defined.

Delete an external link.

Switches:

-symlink_id (required)

The object id of the link to delete

See Also:

• content::symlink::delete

Testcases:

No testcase defined.

Edit an existing internal link. The parameters are required because it is assumed that the caller will be pulling the existing values out of the database before editing them.

Switches:

-symlink_id (required)

Optional pre-assigned object_id for the link

-target_id (required)

The target item_id of the link

-label (required)

Label for the symlink (defaults to the target_id item title)

Testcases:

No testcase defined.

Create a new internal link.

Switches:

-symlink_id (optional)

Optional pre-assigned object_id for the link

-target_id (required)

The item_id of the target of the link

-parent_id (required)

The folder that will contain this symlink

-name (optional)

Name to assign the object (defaults to the name of the target item)

-label (optional)

Label for the symlink (defaults to the URL)

-package_id (optional)

Package Id of the package that created the link

See Also:

• content::symlink::new

Testcases:

No testcase defined.

Switches:

-item_id (required)

item_id of content_symlink item to resolve

Returns:

item_id of symlink target

See Also:

• content::symlink::resolve

Testcases:

No testcase defined.

Switches:

-item_id (required)

item_id of symlink

Returns:

content_type of target item

See Also:

• content::symlink::resolve_content_type

Testcases:

No testcase defined.

Returns the name of an symlink

Switches:

-item_id (required)

The object id of the item to check.

Testcases:

No testcase defined.

Returns true if the given item is a symlink

Switches:

-item_id (required)

The object id of the item to check.

See Also:

• content::symlink::is_symlink

Testcases:

No testcase defined.

Delete a keyword.

Switches:

-keyword_id (required)

Author:

Peter Marklund

See Also:

• content::keyword::delete

Testcases:

No testcase defined.

Returns the ids of the keywords having the given parent_id. Returns an empty list if there are no children.

Switches:

-parent_id (optional)

Author:

Peter Marklund

See Also:

• content::keyword::get_children

Testcases:

No testcase defined.

Get the keyword with the given heading under the given parent. Returns the empty string if none exists.

Switches:

-parent_id (required)

-heading (required)

See Also:

• content::keyword::get_keyword_id

Testcases:

No testcase defined.

Returns a flat options list of the keywords with the given parent_id.

Switches:

-parent_id (optional)

See Also:

• content::keyword::get_options_flat

Testcases:

No testcase defined.

Assign one or more keywords to a content_item.

Switches:

-item_id (required)

-keyword_id (required)

A list of keywords to assign.

-singular (optional, boolean)

If singular is specified, then any keywords with the same parent_id as this keyword_id will first be unassigned.

Returns:

the supplied item_id for convenience.

See Also:

• content::keyword::item_assign

Testcases:

No testcase defined.

Returns a list of all keywords assigned to the given cr_item. If parent_id is supplied, only keywords that are children of parent_id are listed.

Switches:

-item_id (required)

-parent_id (optional)

See Also:

• content::keyword::item_get_assigned

Testcases:

No testcase defined.

Unassign a single keyword from a content item. Returns the supplied item_id for convenience.

Switches:

-keyword_id (required)

-item_id (required)

See Also:

• content::keyword::item_unassign

Testcases:

No testcase defined.

Unassign all the keywords attached to a content item that are children of keyword parent_id.

Switches:

-item_id (required)

-parent_id (required)

Returns:

the supplied item_id for convenience.

See Also:

• content::keyword::item_unassign_children

Testcases:

No testcase defined.

Create a new keyword

Switches:

-heading (required)

-description (optional)

-parent_id (optional)

-keyword_id (optional)

-object_type (optional, defaults to "content_keyword")

-package_id (optional)

See Also:

• content::keyword::new

Testcases:

No testcase defined.

Update a keyword heading

Switches:

-keyword_id (required)

-heading (required)

See Also:

• content::keyword::set_heading

Testcases:

No testcase defined.

Deprecated. See content::folder::delete instead. Delete a content folder. If the folder to delete has children content items referencing it via acs_objects.context_id then this proc will fail.

Switches:

-folder_id (required)

Author:

Peter Marklund

See Also:

• content::folder::delete

Testcases:

No testcase defined.

Provides data source for search interface. Used to access content items after search. DEPRECATED: does not comply with OpenACS naming convention

Parameters:

object_id (required)

See Also:

• image_search::datasource

Testcases:

No testcase defined.

Provides a URL for linking to content items which show up in a search result set. DEPRECATED: does not comply with OpenACS naming convention

Parameters:

object_id (required)

See Also:

• image_search::url

Testcases:

No testcase defined.

Parameters:

revision_id (required)

The revision id

Returns:

1 if the content is null, 0 otherwise

See Also:

• content::item::content_is_null

Testcases:

No testcase defined.

Parameters:

content_type (required)

The content type

Options:

-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

Returns:

A Tcl list of all possible content methods

See Also:

• content::item::content_methods_by_type

Testcases:

No testcase defined.

Copy the given item.

Switches:

-item_id (required)

The content item to copy

-target_folder_id (required)

The folder which will hold the new copy

See Also:

• content::item::copy

Testcases:

No testcase defined.

Delete a content item from the database. If the content item to delete has children content items referencing its parent via acs_objects.context_id then this proc will fail.

Switches:

-item_id (required)

Author:

Peter Marklund

See Also:

• content::item::delete

Testcases:

No testcase defined.

Get information about a content item.

Switches:

-item_id (required)

The id of the item to get info for

-array (required)

The name of the array to populate with values. The keys are: ITEM_ID, PARENT_ID, NAME, LOCALE, LIVE_REVISION, LATEST_REVISION, PUBLISH_STATUS, CONTENT_TYPE, STORAGE_TYPE, STORAGE_AREA_KEY, ARCHIVE_DATE, PACKAGE_ID

Author:

Peter Marklund

See Also:

• content::item::get

Testcases:

No testcase defined.

Parameters:

item_id (required)

The item id

Returns:

The best revision id for the item, or an empty string if no revisions exist

See Also:

• content::item::get_live_revision
• content::item::get_latest_revision
• content::item::get_best_revision

Testcases:

No testcase defined.

Switches:

-revision_id (optional)

The revision whose attributes are to be retrieved

-array (required)

-item_id (optional)

Options:

-item_id

The item_id of the corresponding item. You can provide this as an optimization. If you don't provide revision_id, you must provide item_id, and the item must have a live revision.

Returns:

1 on success (and set the array in the calling frame), 0 on failure

See Also:

• content::item::get_content

Testcases:

No testcase defined.

Parameters:

item_id (required)

The item id

Returns:

The content type of the item, or an empty string if no such item exists

See Also:

• content::item::get_content_type

Testcases:

No testcase defined.

Return the value of a single element (attribute) of a content item.

Switches:

-item_id (required)

The id of the item to get element value for

-element (required)

The name (column name) of the element. See item::get for valid element names.

See Also:

• content::item::get

Testcases:

No testcase defined.

Retrieves the relative URL of the item with a file extension based on the item's mime_type (Example: "/foo/bar/baz.html").

Parameters:

item_id (required)

The item id

Options:

-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

{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.

Returns:

The relative URL of the item with the appropriate file extension or an empty string on failure

See Also:

• proc item::get_url
• proc item::get_mime_info
• proc item::get_template_id

Testcases:

No testcase defined.

Parameters:

url (required)

The URL

root_folder (optional)

{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
• content::item::get_id

Testcases:

No testcase defined.

Parameters:

revision_id (required)

The revision id

Returns:

The item_id of the item to which this revision belongs

See Also:

• content::item::get_live_revision
• content::revision::item_id

Testcases:

No testcase defined.

Retrieves the latest revision for the item. If the item has no live revision, returns an empty string.

Parameters:

item_id (required)

The item id

Returns:

The latest revision id for the item, or an empty string if no revisions exist

See Also:

• content::item::get_live_revision
• content::item::get_latest_revision
• content::item::get_best_revision

Testcases:

No testcase defined.

Parameters:

item_id (required)

The item id

Returns:

The live revision id for the item, or an empty string if no live revision exists

See Also:

• item::get_best_revision
• content::revision::item_id
• content::item::get_live_revision

Testcases:

No testcase defined.

Parameters:

revision_id (required)

The revision id

datasource_ref (optional, defaults to "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:

• proc content::item::get

Testcases:

No testcase defined.

Parameters:

item_id (required)

The item id

Returns:

The publish status of the item, or the empty string on failure

See Also:

• proc item::is_publishable

Testcases:

No testcase defined.

Parameters:

revision_id (required)

The revision whose attributes are to be retrieved

Options:

-item_id

{default auto-generated} The item_id of the corresponding item.

Returns:

1 on success (and create a content array in the calling frame), 0 on failure

See Also:

• content::item::get_revision_content

Testcases:

No testcase defined.

Parameters:

item_id (required)

The item id

context (optional, defaults to "public")

{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
• content::item::get_template

Testcases:

No testcase defined.

Parameters:

item_id (required)

The item id

context (optional, defaults to "public")

{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
• content::item::get_path

Testcases:

No testcase defined.

Parameters:

item_id (required)

The item id

Returns:

The title of the item

See Also:

• item::get_best_revision
• content::item::get_title

Testcases:

No testcase defined.

Returns the content type of the specified item, or empty string if the item_id is invalid

Parameters:

item_id (required)

See Also:

• content::item::get_content_type

Testcases:

No testcase defined.

Switches:

-root_folder_id (optional, defaults to "null")

Starts path resolution from this folder. Defaults to the root of the sitemap (when null).

Parameters:

item_id (required)

The item id

Returns:

The relative URL to the item, or an empty string on failure

See Also:

• proc item::get_extended_url
• content::item::get_virtual_path

Testcases:

No testcase defined.

Determine if the item is publishable. The item is publishable only if:

• All child relations, as well as item relations, are satisfied (according to min_n and max_n)
• The workflow (if any) for the item is finished

Parameters:

item_id (required)

The item id

Returns:

1 if the item is publishable, 0 otherwise

See Also:

• content::item::is_publishable

Testcases:

No testcase defined.

Publish a content item. Updates the live_revision and publish_date attributes, and sets publish_status to live.

Switches:

-item_id (required)

The id of the content item

-revision_id (optional)

The id of the revision to publish. Defaults to the latest revision.

Author:

Peter Marklund

See Also:

• content::item::publish

Testcases:

No testcase defined.

Unpublish a content item.

Switches:

-item_id (required)

The id of the content item

-publish_status (optional, defaults to "production")

The publish_status to put the item in after unpublishing it.

Author:

Peter Marklund

See Also:

• content::item::unpublish

Testcases:

No testcase defined.

Provides data source for search interface. Used to access content items after search. DEPRECATED: does not comply with OpenACS naming convention

Parameters:

object_id (required)

See Also:

• template_search::datasource

Testcases:

No testcase defined.

Provides a URL for linking to content items which show up in a search result set. DEPRECATED: does not comply with OpenACS naming convention

Parameters:

object_id (required)

See Also:

• template_search::url

Testcases:

No testcase defined.