From d859a37ff74cea8ae1121cf3528af57e4946058d Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Sun, 9 Jun 2002 14:16:35 +0000 Subject: - Documentation updates: made it more consistent with the rest of Drupal. --- modules/taxonomy.module | 123 ++++++++++++++---------------------------------- 1 file changed, 36 insertions(+), 87 deletions(-) (limited to 'modules/taxonomy.module') diff --git a/modules/taxonomy.module b/modules/taxonomy.module index 2bc895b1a..0d4b3e27b 100644 --- a/modules/taxonomy.module +++ b/modules/taxonomy.module @@ -213,7 +213,7 @@ function taxonomy_del_term($tid) { function taxonomy_overview() { global $tree; - $output .= "

vocabularies overview

"; + $output .= "

Vocabularies overview

"; $output .= "\n"; $output .= " \n"; @@ -619,19 +619,12 @@ function taxonomy_admin() { function taxonomy_help() { ?> -

Background

- Classifying nodes allows for the organization of content into categories and - subcategories of description. These categories can be used to organize and retrieve - similarly described content. Drupal's taxonomy.module is an extremely flexible - classification system that allows for multiple lists of categories for classification - (controlled vocabularies) and offers the possibility of creating thesauri (controlled - vocabularies that indicate the relationship of terms) and taxonomies (controlled - vocabularies where relationships are indicated hierarchically). For details about -classification -types and insight into the development of taxonomy.module, see this -drupal.org discussion.
-

An Example Taxonomy - Foods

-

Dairy
+ +

Background

+

Classifying nodes allows for the organization of content into categories and subcategories of description. These categories can be used to organize and retrieve similarly described content. Drupal's taxonomy.module is an extremely flexible classification system that allows for multiple lists of categories for classification (controlled vocabularies) and offers the possibility of creating thesauri (controlled vocabularies that indicate the relationship of terms) and taxonomies (controlled vocabularies where relationships are indicated hierarchically). For details about classification types and insight into the development of taxonomy.module, see this drupal.org discussion.

+ +

An example taxonomy: food

+

Dairy
--Milk
Drink
--Alchohol
@@ -643,90 +636,46 @@ types and insight into the development of taxonomy.module, see this --Lamb
Spices
--Sugar

-

Notes

- -

+

Notes

+ +

Vocabularies

- When you create a controlled vocabulary you are creating a set of terms to use - for describing content (known as descriptors in indexing lingo). Drupal allows - you to describe each node of content (blog, story, etc.) - using one or many of these terms. For simple implementations, you might - create a set of categories without subcategories, similar to Slashdot's "Sections". - For more complex implementations, you might create a hierarchical list of categories - such as the example Food taxonomy above. +

When you create a controlled vocabulary you are creating a set of terms to use for describing content (known as descriptors in indexing lingo). Drupal allows you to describe each node of content (blog, story, etc.) using one or many of these terms. For simple implementations, you might create a set of categories without subcategories, similar to Slashdot's sections. For more complex implementations, you might create a hierarchical list of categories such as the example Food taxonomy above.

Setting up a vocabulary

-

When you set up a controlled vocabulary, you will be asked to enter some descriptive -data and define the attributes of this vocabulary. For example, if you select -the Hierarchy option, you will be defining a taxonomy or a thesaurus. If -you select Related Terms option, you are allowing the definition of related -terms as in a thesaurus. Selecting Multiple Select will allow you to describe -a node using more than one term. That node will then appear in each term's page, -thus increasing the chance that a user will find it.

- Vocabulary name
- Required. The name for this vocabulary. Example: Dairy.
+

When you set up a controlled vocabulary, you will be asked to enter some descriptive data and define the attributes of this vocabulary. For example, if you select the hierarchy option, you will be defining a taxonomy or a thesaurus. If you select related terms option, you are allowing the definition of related terms as in a thesaurus. Selecting multiple select will allow you to describe a node using more than one term. That node will then appear in each term's page, thus increasing the chance that a user will find it.

+ + Vocabulary name
Required. The name for this vocabulary. Example: Dairy.

- Description
- Optional. Description of the vocabulary, can be used by modules and feeds.
+ Description
Optional. Description of the vocabulary, can be used by modules and feeds.

- Types
- Required. The list of node types you want to associate this vocabulary - with. Some available types are: blog, book, forum, page, story.
+ Types
Required. The list of node types you want to associate this vocabulary with. Some available types are: blog, book, forum, page, story.

- Related Terms
- Allows relationships between terms within this vocabulary. Think of these as - See also references.
+ Related terms
Allows relationships between terms within this vocabulary. Think of these as see also-references.

- Hierarchy
- Allows a tree-like taxonomy, as in our Foods example above
+ Hierarchy
Allows a tree-like taxonomy, as in our Foods example above

- Multiple Select
-Allows nodes to be described using more than one term. Nodes may then appear on -multiple taxonomy pages.
+ Multiple select
Allows nodes to be described using more than one term. Nodes may then appear on multiple taxonomy pages.
+

Adding terms to a vocabulary

-The options you see when adding a term to a vocabulary will depend on what you -selected for Related Terms, Hierarchy and Multiple Select -when you created the corrosponding vocabulary.
-
-Term name
- Required. The name for this term. Example: Milk
+

The options you see when adding a term to a vocabulary will depend on what you selected for related terms, hierarchy and multiple select when you created the corrosponding vocabulary.

+ + Term name
Required. The name for this term. Example: Milk

-Description
-Optional. Description of the term that may be used by modules and RSS feeds. -This is synonymous with a 'Scope note'.
+ Description
Optional. Description of the term that may be used by modules and RSS feeds. This is synonymous with a 'scope note'.

-Parent
- Required. Select the term under which this term is a subset -- the branch of the hierarchy - that this term belongs under. This is also known as the "Broader term" indicator - used in thesauri.
+ Parent
Required. Select the term under which this term is a subset -- the branch of the hierarchy that this term belongs under. This is also known as the "Broader term" indicator used in thesauri.

-Synonyms
- Optional. Enter synonyms for this term, one synonym per line. Synonyms can be used for - variant spellings, acronyms, and other terms that have the same meaning as the - added term, but which are not explicitly listed in this thesaurus (i.e. unauthorized - terms).
- -

Displaying Nodes Organized by Term(s)

-

In order to view the nodes associated with a term or a collection of terms, you - should browse to a properly formed URL. For example, see - "node", "or" => "1,2"), "module"); ?>"> "node", "or" => "1,2"), "module"); ?>. - Taxonomy URLs always contain a termID or list of termIDs at the end of the URL (aka querystring). - You may learn the termID for a given term by hovering over that term in the "taxonomy")) ?> page in the Admin and noting the number after the querystring parameter called tid. - If you wish to see nodes from a collection of termIDs, separate each termID with a comma. - Also, the name of the querystring parameter may be or or and. - or shows nodes which appear in any of the termIDs while and shows nodes in all the specified termIDs. - Thus, or is less specific than and. -

- -

RSS Feeds

-

Every term, or collection of terms, provides an RSS feed to which interested - users may subscribe. The URL format for an sample RSS feed is - "node", "op" => "feed", "or" => "1,2"), "module"); ?>"> "node", "op" => "feed", "or" => "1,2"), "module"); ?>.

- Synonyms
Optional. Enter synonyms for this term, one synonym per line. Synonyms can be used for variant spellings, acronyms, and other terms that have the same meaning as the added term, but which are not explicitly listed in this thesaurus (i.e. unauthorized terms).
+ +

Displaying nodes organized by term(s)

+

In order to view the nodes associated with a term or a collection of terms, you should browse to a properly formed URL. For example, see "node", "or" => "1,2"), "module"); ?>"> "node", "or" => "1,2"), "module"); ?>. Taxonomy URLs always contain a term ID or list of term IDs at the end of the URL (aka querystring). You may learn the term ID for a given term by hovering over that term in the "taxonomy")) ?> page in the Admin and noting the number after the querystring parameter called tid. If you wish to see nodes from a collection of term IDs, separate each term ID with a comma. Also, the name of the querystring parameter may be or or and: or shows nodes which appear in any of the term IDs while and shows nodes in all the specified term IDs. Thus, or is less specific than and.

+ +

RSS feeds

+

Every term, or collection of terms, provides an RSS feed to which interested users may subscribe. The URL format for an sample RSS feed is "node", "op" => "feed", "or" => "1,2"), "module"); ?>"> "node", "op" => "feed", "or" => "1,2"), "module"); ?>.

+ -- cgit v1.2.3
namenode typesoperations