From 8d2b1238b4d8ebd57848fde665b7f93c3a03cd90 Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Thu, 29 May 2003 09:15:00 +0000 Subject: - Michael Frankowski's excellent help text improvements! --- modules/taxonomy.module | 73 ++++++++++--------------------------------------- 1 file changed, 14 insertions(+), 59 deletions(-) (limited to 'modules/taxonomy.module') diff --git a/modules/taxonomy.module b/modules/taxonomy.module index 70da7475c..3396ab624 100644 --- a/modules/taxonomy.module +++ b/modules/taxonomy.module @@ -28,8 +28,8 @@ function taxonomy_perm() { function taxonomy_link($type, $node = NULL) { if ($type == "admin" && user_access("administer taxonomy")) { - $help["taxonomy"] = "The taxonomy module allows you to classify posts into categories and subcategories; it allows 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)."; - $help["vocabulary"] = "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.org's or Kuro5hin.org's sections. For more complex implementations, you might create a hierarchical list of categories."; + $help["taxonomy"] = t("The taxonomy module allows you to classify content into categories and subcategories; it allows 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). To delete a term choose \"edit term\". To delete a vocabulary, and all its terms, choose \"edit vocabulary\"."); + $help["vocabulary"] = t("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 type (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.org's or Kuro5hin.org's sections. For more complex implementations, you might create a hierarchical list of categories."); menu("admin/taxonomy", "taxonomy", "taxonomy_admin", $help["taxonomy"], 3); menu("admin/taxonomy/add/vocabulary", "create new vocabulary", "taxonomy_admin", $help["vocabulary"]); @@ -797,62 +797,17 @@ 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: food

-

Dairy
- --Milk
- Drink
- --Alchohol
- --Pop
- --Milk
- Meat
- --Beef
- --Chicken
- --Lamb
- Spices
- --Sugar

-

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.

- -

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

- Background

Taxonomy is the science of classification, acording to a predetermined system, where the results are used for analysis, discussion, or information retreival. In Drupal the taxonomy.module allows you to define a taxonomy which is then used to classify the Drupal nodes. The module can create classification that can include multiple lists of categories (controlled vocabularies), as well as thesauri (controlled vocabularies that indicated the relationships of terms) and taxonomies (controlled vocabularies where relationships arehierarchical). For more details about classification types and insight into the development of the taxonomy.module, see this drupal.org discussion.

"; + $output .= "

An example taxonomy: food

Dairy
--Milk
Drink
--Alchohol
--Pop
--Milk
Meat
--Beef
--Chicken
--Lamb
Spices
--Sugar

"; + $output .= "

Notes

"; + $output .= "

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 Food taxonomy shown above.

"; + $output .= "

Setting up a vocabulary

When setting up a controlled vocabulary, if you select the hierarchy option, you will be defining a taxonomy or a thesaurus. If you select the related terms option, you are allowing the definition of related terms, think see also, 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.

"; + $output .= "

When setting up a controlled vocabulary you are asked for:

"; + $output .= "

Adding terms to a vocabulary

Once done defining the vocabulary, you have to add terms to it to make it useful. The options you see when adding a term to a vocabulary will depend on what you selected for related terms, hierarchy and multiple select. These options are:

"; + $output .= "

"; + $output .= "

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 Taxonomy URL. For example, ". l("taxonomy/page/or/1,2","taxonomy/pages/or/1,2") .". Taxonomy URLs always contain one or more term IDs (tid) at the end of the URL (a.k.a the querystring). You may learn the term ID for a given term by hovering over that term in the ". l("taxonomy overview", "admin/taxonomy") ." page and noting the number at the end or the URL. To build a Taxonomy URL start with \"taxonomy/page\". Now add the querystring parameter, either or, which chooses nodes tagged with any of the given term IDs, or and, which chooses nodes tagged with all of the given Term IDs. Thus or is less specific than and. Finally add a comma seperated list of term IDs.

"; + $output .= "

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 ". l("node/feed/or/1,2","node/feed/or/1,2") .". Built like a Taxonomy URL, ". l("see above", "admin/taxonomy/help#taxonomyURL") ." it starts with \"node/feed\", then has the querystring parameter, and finally the Term IDs.

"; + return t($output); } ?> -- cgit v1.2.3