Index: openacs-4/packages/acs-content-repository/www/doc/api/keyword.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-content-repository/www/doc/api/keyword.adp,v diff -u -r1.2 -r1.3 --- openacs-4/packages/acs-content-repository/www/doc/api/keyword.adp 27 Oct 2014 16:39:14 -0000 1.2 +++ openacs-4/packages/acs-content-repository/www/doc/api/keyword.adp 7 Aug 2017 23:47:47 -0000 1.3 @@ -1,55 +1,69 @@ -{/doc/acs-content-repository {Content Repository}} {Package: content_keyword} +{/doc/acs-content-repository {ACS Content Repository}} {Package: content_keyword} Package: content_keyword - - -

content_keyword

-Content Repository : -content_keyword

content_keyword

+Content Repository : +content_keyword

Overview
Related Objects
API

Overview

Keyword cassify a content_item. For example: If you have some +

Overview

Keyword cassify a content_item. For example: If you have some press releases about dogs. You might want assigning the Keyword dog -to every single content_item.

Related Objects

+to every single content_item.

Related Objects

+ See also: content_item -

API

+

+
API
+
- Function: -content_keyword.get_description
Retrieves the description of the content keyword
+content_keyword.get_description +
Retrieves the description of the content keyword
Author: Karl Goldstein
Returns: The description for the specified keyword
Parameters:
-
keyword_id: The keyword id
Declaration:
+
Declaration:
```
 function get_description (
   keyword_id  in cr_keywords.keyword_id%TYPE
 ) return varchar2;
 
-
```
+ See Also:content_keyword.get_heading, content_keyword.set_description -
- -Function: -content_keyword.get_heading
Retrieves the heading of the content keyword
+

+
+Function: content_keyword.get_heading +
Retrieves the heading of the content keyword
Author: Karl Goldstein
Returns: The heading for the specified keyword
Parameters:
-
keyword_id: The keyword id
Declaration:
+
Declaration:
```
 function get_heading (
   keyword_id  in cr_keywords.keyword_id%TYPE
 ) return varchar2;
 
-
```
+ See Also:content_keyword.set_heading, content_keyword.get_description -
- -Function: content_keyword.get_path
Retreives a path to the keyword/subject category, with the most +

+
+Function: content_keyword.get_path +
Retrieves a path to the keyword/subject category, with the most general category at the root of the path
@@ -58,22 +72,23 @@ keyword exists
Author: Karl Goldstein
Parameters:
-
keyword_id: The keyword id
Declaration:
+
Declaration:
```
 function get_path (
   keyword_id in cr_keywords.keyword_id%TYPE
 ) return varchar2;
 
-
```
+ See Also:content_keyword.new -
- -Function: -content_keyword.is_assigned
Determines if the keyword is assigned to the item
+

+

+Function: content_keyword.is_assigned +

Determines if the keyword is assigned to the item

- +

Author: Karl Goldstein

Returns: 't' if the keyword may be matched to an item, 'f' -otherwise Returns: 't' if the keyword may be matched to an +item, 'f' otherwise

Parameters:

@@ -84,46 +99,54 @@ of the following values:

-none: Not recursive. Look for an exact match.
-up: Recursive from specific to general. A search for -"attack dogs" will also match "dogs", "animals", "mammals", +none: Not recursive. Look for an exact +match.
+up: Recursive from specific to general. A +search for "attack dogs" will also match +"dogs", "animals", "mammals", etc.
-down: Recursive from general to specific. A search for -"mammals" will also match "dogs", "attack dogs", "cats", "siamese +down: Recursive from general to specific. A +search for "mammals" will also match "dogs", +"attack dogs", "cats", "siamese cats", etc.

-

item_id: The item id

Declaration:


 function is_assigned (
   item_id      in cr_items.item_id%TYPE,
   keyword_id   in cr_keywords.keyword_id%TYPE,
   recurse      in varchar2 default 'none'
 ) return varchar2;
 
-

+ See Also:content_keyword.item_assign -

-Function: content_keyword.is_leaf

Determines if the keyword has no sub-keywords associated with +

+Function: content_keyword.is_leaf +

Determines if the keyword has no sub-keywords associated with it

- +

Author: Karl Goldstein

Returns: 't' if the keyword has no descendants, 'f' -otherwise Returns: 't' if the keyword has no descendants, +'f' otherwise

Parameters:

-
keyword_id: The keyword id

Declaration:


 function is_leaf (
   keyword_id  in cr_keywords.keyword_id%TYPE
 ) return varchar2;
 
-

+ See Also:content_keyword.new -

-Function: content_keyword.new

Creates a new keyword (also known as "subject category").

+Function: content_keyword.new +

Creates a new keyword (also known as "subject +category").

@@ -139,20 +162,20 @@ - + - - - -

Author:	Karl Goldstein
keyword_id:		The id of the new keyword. A new id will be allocated if this parameter is null
object_type:		The type for the new keyword, defaults to 'content_keyword'. -This parameter may be used by subclasses of -`content_keyword` to initialize the superclass.	object_type:	The type for the new keyword, defaults to +'content_keyword'. This parameter may be used by subclasses +of `content_keyword` to initialize the superclass.
creation_date:		As in `acs_object.new` +	creation_date:	As in `acs_object.new`
creation_ip:		As in `acs_object.new` +	creation_ip:	As in `acs_object.new`
creation_user:		As in `acs_object.new` +	creation_user:	As in `acs_object.new`

Declaration:


+Declaration:
 function new (
   heading       in cr_keywords.heading%TYPE,
   description   in cr_keywords.description%TYPE default null,
@@ -166,29 +189,32 @@
   object_type   in acs_object_types.object_type%TYPE default 'content_keyword'
 ) return cr_keywords.keyword_id%TYPE;
 
-
+

See Also:acs_object.new, content_item.new, content_keyword.item_assign, content_keyword.delete -

-Procedure: content_keyword.delete

Deletes the specified keyword, which must be a leaf. Unassigns +

+Procedure: content_keyword.delete +
Deletes the specified keyword, which must be a leaf. Unassigns the keyword from all content items. Use with caution - this operation cannot be undone.
Author: Karl Goldstein
Parameters:
-
keyword_id: The id of the keyword to be deleted
Declaration:
+
Declaration:
```
 procedure delete (
   keyword_id  in cr_keywords.keyword_id%TYPE
 );
 
-
```
+ See Also:acs_object.delete, content_keyword.item_unassign -
- -Procedure: -content_keyword.item_assign
Assigns this keyword to a content item, creating a relationship +

+

+Procedure: content_keyword.item_assign +

Assigns this keyword to a content item, creating a relationship between them

@@ -198,13 +224,13 @@ - + - + - + -

Author:	Karl Goldstein
keyword_id:		The keyword to be assigned
context_id:		As in `acs_rel.new`, deprecated	context_id:	As in `acs_rel.new`, deprecated
creation_ip:		As in `acs_rel.new`, deprecated	creation_ip:	As in `acs_rel.new`, deprecated
creation_user:		As in `acs_rel.new`, deprecated	creation_user:	As in `acs_rel.new`, deprecated

Declaration:


+Declaration:
 procedure item_assign (
   item_id       in cr_items.item_id%TYPE,
   keyword_id    in cr_keywords.keyword_id%TYPE,
@@ -213,12 +239,13 @@
   creation_ip   in acs_objects.creation_ip%TYPE default null
 );
 
-
+

See Also:acs_rel.new, content_keyword.item_unassign -

-Procedure: -content_keyword.item_unassign

Unassigns this keyword to a content item, removing a +

+Procedure: content_keyword.item_unassign +
Unassigns this keyword to a content item, removing a relationship between them
@@ -228,18 +255,20 @@ -

Author: Karl Goldstein
keyword_id: The keyword to be unassigned
Declaration:
```
+Declaration:
 procedure item_unassign (
   item_id     in cr_items.item_id%TYPE,
   keyword_id  in cr_keywords.keyword_id%TYPE
 );
 
-
+
```
See Also:acs_rel.delete, content_keyword.item_assign -
- +
  
  +
- Procedure: -content_keyword.set_description
Sets a new description for the keyword
+content_keyword.set_description +
Sets a new description for the keyword
Author: Karl Goldstein
Parameters:
@@ -248,19 +277,20 @@ -
description: The new description
Declaration:
+
Declaration:
```
 procedure set_description (
   keyword_id  in cr_keywords.keyword_id%TYPE,
   description in cr_keywords.description%TYPE
 );
 
-
```
+ See Also:content_keyword.set_heading, content_keyword.get_description -
- -Procedure: -content_keyword.set_heading
Sets a new heading for the keyword
+

+
+Procedure: content_keyword.set_heading +
Sets a new heading for the keyword
Author: Karl Goldstein
Parameters:
@@ -269,17 +299,20 @@ -
heading: The new heading
Declaration:
+
Declaration:
```
 procedure set_heading (
   keyword_id  in cr_keywords.keyword_id%TYPE,
   heading     in cr_keywords.heading%TYPE
 );
 
-
```
+ See Also:content_keyword.get_heading, content_keyword.set_description -

-Last Modified: $Id: keyword.html,v 1.1.1.1 2001/03/13 22:59:26 ben -Exp $ - + +

Author:	Karl Goldstein
keyword_id:		The keyword to be unassigned

+ +Last Modified: $‌Id: keyword.html,v 1.1.1.1.30.3 2017/04/21 14:53:08 +gustafn Exp $