Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

- Documentation updates: made it more consistent with the rest of Drupal.

4.0.x
Dries Buytaert 2002-06-09 14:16:35 +00:00
parent 300e524368
commit d859a37ff7
2 changed files with 74 additions and 176 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

125
modules/taxonomy.module
View File

@ -213,7 +213,7 @@ function taxonomy_del_term($tid) {
function taxonomy_overview() {
global $tree;
$output .= "<h3>vocabularies overview</h3>";
$output .= "<h3>Vocabularies overview</h3>";
$output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">\n";
$output .= " <tr><th>name</th><th>node types</th><th>operations</th></tr>\n";
@ -619,19 +619,12 @@ function taxonomy_admin() {
function taxonomy_help() {
?>
<h3>Background</h3>
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 <i>taxonomy.module</i> 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
<a href="http://www.eleganthack.com/archives/002165.html#002165">classification
types</a> and insight into the development of <i>taxonomy.module</i>, see this
<a href="http://www.drupal.org/node.php?id=55">drupal.org discussion</a>.<br />
<h3>An Example Taxonomy - Foods</h3>
<p>Dairy <br />
<h3>Background</h3>
<p>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 <i>taxonomy.module</i> 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 <a href="http://www.eleganthack.com/archives/002165.html#002165">classification types</a> and insight into the development of <i>taxonomy.module</i>, see this <a href="http://www.drupal.org/node.php?id=55">drupal.org discussion</a>.</p>
<h3>An example taxonomy: food</h3>
<p>Dairy <br />
--Milk <br />
Drink <br />
--Alchohol <br />
@ -643,90 +636,46 @@ types</a> and insight into the development of <i>taxonomy.module</i>, see this
--Lamb <br />
Spices <br />
--Sugar</p>
<p><b>Notes</b></p>
<ul>
<li>The term <i>Milk</i> appears within both <i>Dairy</i> and <i>Drink</i>.
This is an example of <i>Multiple Parents</i> for a term.</li>
<li>The order of siblings (e.g. <i>Beef</i>, <i>Chicken</i>, <i>Lamb</i>) in
the taxonomy may be controlled with the <i>Weight</i> parameter. </li>
</ul>
<h4></h4>
<p><b>Notes</b></p>
<ul>
<li>The term <i>Milk</i> appears within both <i>Dairy</i> and <i>Drink</i>. This is an example of <i>nmultiple parents</i> for a term.</li>
<li>The order of siblings (e.g. <i>Beef</i>, <i>Chicken</i>, <i>Lamb</i>) in the taxonomy may be controlled with the <i>weight</i> parameter. </li>
</ul>
<h3>Vocabularies</h3>
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 <a href="http://www.slashdot.com">Slashdot's</a> "Sections".
For more complex implementations, you might create a hierarchical list of categories
such as the example <i>Food</i> taxonomy above.
<p>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 <a href="http://www.slashdot.com/">Slashdot's</a> sections. For more complex implementations, you might create a hierarchical list of categories such as the example <i>Food</i> taxonomy above.</p>
<h4>Setting up a vocabulary</h4>
<p>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 <i>Hierarchy </i>option, you will be defining a taxonomy or a thesaurus. If
you select <i>Related Terms</i> option, you are allowing the definition of related
terms as in a thesaurus. Selecting <i>Multiple Select</i> 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.</p>
<i>Vocabulary name</i><br />
Required. The name for this vocabulary. Example: <i>Dairy</i>.<br />
<p>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 <i>hierarchy</i> option, you will be defining a taxonomy or a thesaurus. If you select <i>related terms</i> option, you are allowing the definition of related terms as in a thesaurus. Selecting <i>multiple select</i> 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.</p>
<i>Vocabulary name</i><br />Required. The name for this vocabulary. Example: <i>Dairy</i>.<br />
<br />
<i>Description</i><br />
Optional. Description of the vocabulary, can be used by modules and feeds.<br />
<i>Description</i><br />Optional. Description of the vocabulary, can be used by modules and feeds.<br />
<br />
<i>Types</i><br />
Required. The list of node types you want to associate this vocabulary
with. Some available types are: blog, book, forum, page, story.<br />
<i>Types</i><br />Required. The list of node types you want to associate this vocabulary with. Some available types are: blog, book, forum, page, story.<br />
<br />
<i><a name="relatedterms"></a>Related Terms</i><br />
Allows relationships between terms within this vocabulary. Think of these as
<i>See also</i> references.<br />
<i><a name="relatedterms"></a>Related terms</i><br />Allows relationships between terms within this vocabulary. Think of these as <i>see also</i>-references.<br />
<br />
<i><a name="hierarchy"></a>Hierarchy</i><br />
Allows a tree-like taxonomy, as in our <i>Foods</i> example above<br />
<i><a name="hierarchy"></a>Hierarchy</i><br />Allows a tree-like taxonomy, as in our <i>Foods</i> example above<br />
<br />
<i>Multiple Select</i><br />
Allows nodes to be described using more than one term. Nodes may then appear on
multiple taxonomy pages.<br />
<i>Multiple select</i><br />Allows nodes to be described using more than one term. Nodes may then appear on multiple taxonomy pages.<br />
<h4>Adding terms to a vocabulary</h4>
The options you see when adding a term to a vocabulary will depend on what you
selected for <i>Related Terms</i>, <i>Hierarchy </i>and <i>Multiple Select</i>
when you created the corrosponding vocabulary.<br />
<br />
<i>Term name</i><br />
Required. The name for this term. Example: <i>Milk</i><br />
<br />
<i>Description</i><br />
Optional. Description of the term that may be used by modules and RSS feeds.
This is synonymous with a 'Scope note'.<br />
<br />
<i><a name="parent"></a>Parent</i><br />
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.<br />
<br />
<i><a name="synonyms"></a>Synonyms</i><br />
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. <i>unauthorized
terms</i>).<br />
<p>The options you see when adding a term to a vocabulary will depend on what you selected for <i>related terms</i>, <i>hierarchy </i>and <i>multiple select</i> when you created the corrosponding vocabulary.</p>
<h3>Displaying Nodes Organized by Term(s)</h3>
<p>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
<a href="<?php print path_uri().drupal_url(array("mod" => "node", "or" => "1,2"), "module"); ?>"><?php print path_uri().drupal_url(array("mod" => "node", "or" => "1,2"), "module"); ?></a>.
Taxonomy URLs always contain a termID or list of termIDs at the end of the URL (aka <i>querystring</i>).
You may learn the termID for a given term by hovering over that term in the <? echo la("Taxonomy Overview", array("mod" => "taxonomy")) ?> page in the Admin and noting the number after the querystring parameter called <i>tid</i>.
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 <i>or</i> or <i>and</i>.
<i>or</i> shows nodes which appear in <b>any</b> of the termIDs while <i>and</i> shows nodes in <b>all</b> the specified termIDs.
Thus, <i>or</i> is less specific than <i>and</i>.
</p>
<i>Term name</i><br />Required. The name for this term. Example: <i>Milk</i><br />
<br />
<i>Description</i><br />Optional. Description of the term that may be used by modules and RSS feeds. This is synonymous with a 'scope note'.<br />
<br />
<i><a name="parent"></a>Parent</i><br />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.<br />
<br />
<i><a name="synonyms"></a>Synonyms</i><br />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. <i>unauthorized terms</i>).<br />
<h3>RSS Feeds</h3>
<p>Every term, or collection of terms, provides an <a href="http://backend.userland.com/stories/rss091">RSS</a> feed to which interested
users may subscribe. The URL format for an sample RSS feed is
<a href="<?php print path_uri().drupal_url(array("mod" => "node", "op" => "feed", "or" => "1,2"), "module"); ?>"><?php print path_uri().drupal_url(array("mod" => "node", "op" => "feed", "or" => "1,2"), "module"); ?></a>.</p>
<?php
<h3>Displaying nodes organized by term(s)</h3>
<p>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 <a href="<?php print path_uri().drupal_url(array("mod" => "node", "or" => "1,2"), "module"); ?>"><?php print path_uri().drupal_url(array("mod" => "node", "or" => "1,2"), "module"); ?></a>. Taxonomy URLs always contain a term ID or list of term IDs at the end of the URL (aka <i>querystring</i>). You may learn the term ID for a given term by hovering over that term in the <? echo la("taxonomy overview", array("mod" => "taxonomy")) ?> page in the Admin and noting the number after the querystring parameter called <i>tid</i>. 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 <i>or</i> or <i>and</i>: <i>or</i> shows nodes which appear in <b>any</b> of the term IDs while <i>and</i> shows nodes in <b>all</b> the specified term IDs. Thus, <i>or</i> is less specific than <i>and</i>.</p>
<h3>RSS feeds</h3>
<p>Every term, or collection of terms, provides an <a href="http://backend.userland.com/stories/rss091">RSS</a> feed to which interested users may subscribe. The URL format for an sample RSS feed is <a href="<?php print path_uri().drupal_url(array("mod" => "node", "op" => "feed", "or" => "1,2"), "module"); ?>"><?php print path_uri().drupal_url(array("mod" => "node", "op" => "feed", "or" => "1,2"), "module"); ?></a>.</p>
<?php
}
?>

125
modules/taxonomy/taxonomy.module
View File

@ -213,7 +213,7 @@ function taxonomy_del_term($tid) {
function taxonomy_overview() {
global $tree;
$output .= "<h3>vocabularies overview</h3>";
$output .= "<h3>Vocabularies overview</h3>";
$output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">\n";
$output .= " <tr><th>name</th><th>node types</th><th>operations</th></tr>\n";
@ -619,19 +619,12 @@ function taxonomy_admin() {
function taxonomy_help() {
?>
<h3>Background</h3>
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 <i>taxonomy.module</i> 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
<a href="http://www.eleganthack.com/archives/002165.html#002165">classification
types</a> and insight into the development of <i>taxonomy.module</i>, see this
<a href="http://www.drupal.org/node.php?id=55">drupal.org discussion</a>.<br />
<h3>An Example Taxonomy - Foods</h3>
<p>Dairy <br />
<h3>Background</h3>
<p>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 <i>taxonomy.module</i> 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 <a href="http://www.eleganthack.com/archives/002165.html#002165">classification types</a> and insight into the development of <i>taxonomy.module</i>, see this <a href="http://www.drupal.org/node.php?id=55">drupal.org discussion</a>.</p>
<h3>An example taxonomy: food</h3>
<p>Dairy <br />
--Milk <br />
Drink <br />
--Alchohol <br />
@ -643,90 +636,46 @@ types</a> and insight into the development of <i>taxonomy.module</i>, see this
--Lamb <br />
Spices <br />
--Sugar</p>
<p><b>Notes</b></p>
<ul>
<li>The term <i>Milk</i> appears within both <i>Dairy</i> and <i>Drink</i>.
This is an example of <i>Multiple Parents</i> for a term.</li>
<li>The order of siblings (e.g. <i>Beef</i>, <i>Chicken</i>, <i>Lamb</i>) in
the taxonomy may be controlled with the <i>Weight</i> parameter. </li>
</ul>
<h4></h4>
<p><b>Notes</b></p>
<ul>
<li>The term <i>Milk</i> appears within both <i>Dairy</i> and <i>Drink</i>. This is an example of <i>nmultiple parents</i> for a term.</li>
<li>The order of siblings (e.g. <i>Beef</i>, <i>Chicken</i>, <i>Lamb</i>) in the taxonomy may be controlled with the <i>weight</i> parameter. </li>
</ul>
<h3>Vocabularies</h3>
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 <a href="http://www.slashdot.com">Slashdot's</a> "Sections".
For more complex implementations, you might create a hierarchical list of categories
such as the example <i>Food</i> taxonomy above.
<p>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 <a href="http://www.slashdot.com/">Slashdot's</a> sections. For more complex implementations, you might create a hierarchical list of categories such as the example <i>Food</i> taxonomy above.</p>
<h4>Setting up a vocabulary</h4>
<p>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 <i>Hierarchy </i>option, you will be defining a taxonomy or a thesaurus. If
you select <i>Related Terms</i> option, you are allowing the definition of related
terms as in a thesaurus. Selecting <i>Multiple Select</i> 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.</p>
<i>Vocabulary name</i><br />
Required. The name for this vocabulary. Example: <i>Dairy</i>.<br />
<p>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 <i>hierarchy</i> option, you will be defining a taxonomy or a thesaurus. If you select <i>related terms</i> option, you are allowing the definition of related terms as in a thesaurus. Selecting <i>multiple select</i> 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.</p>
<i>Vocabulary name</i><br />Required. The name for this vocabulary. Example: <i>Dairy</i>.<br />
<br />
<i>Description</i><br />
Optional. Description of the vocabulary, can be used by modules and feeds.<br />
<i>Description</i><br />Optional. Description of the vocabulary, can be used by modules and feeds.<br />
<br />
<i>Types</i><br />
Required. The list of node types you want to associate this vocabulary
with. Some available types are: blog, book, forum, page, story.<br />
<i>Types</i><br />Required. The list of node types you want to associate this vocabulary with. Some available types are: blog, book, forum, page, story.<br />
<br />
<i><a name="relatedterms"></a>Related Terms</i><br />
Allows relationships between terms within this vocabulary. Think of these as
<i>See also</i> references.<br />
<i><a name="relatedterms"></a>Related terms</i><br />Allows relationships between terms within this vocabulary. Think of these as <i>see also</i>-references.<br />
<br />
<i><a name="hierarchy"></a>Hierarchy</i><br />
Allows a tree-like taxonomy, as in our <i>Foods</i> example above<br />
<i><a name="hierarchy"></a>Hierarchy</i><br />Allows a tree-like taxonomy, as in our <i>Foods</i> example above<br />
<br />
<i>Multiple Select</i><br />
Allows nodes to be described using more than one term. Nodes may then appear on
multiple taxonomy pages.<br />
<i>Multiple select</i><br />Allows nodes to be described using more than one term. Nodes may then appear on multiple taxonomy pages.<br />
<h4>Adding terms to a vocabulary</h4>
The options you see when adding a term to a vocabulary will depend on what you
selected for <i>Related Terms</i>, <i>Hierarchy </i>and <i>Multiple Select</i>
when you created the corrosponding vocabulary.<br />
<br />
<i>Term name</i><br />
Required. The name for this term. Example: <i>Milk</i><br />
<br />
<i>Description</i><br />
Optional. Description of the term that may be used by modules and RSS feeds.
This is synonymous with a 'Scope note'.<br />
<br />
<i><a name="parent"></a>Parent</i><br />
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.<br />
<br />
<i><a name="synonyms"></a>Synonyms</i><br />
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. <i>unauthorized
terms</i>).<br />
<p>The options you see when adding a term to a vocabulary will depend on what you selected for <i>related terms</i>, <i>hierarchy </i>and <i>multiple select</i> when you created the corrosponding vocabulary.</p>
<h3>Displaying Nodes Organized by Term(s)</h3>
<p>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
<a href="<?php print path_uri().drupal_url(array("mod" => "node", "or" => "1,2"), "module"); ?>"><?php print path_uri().drupal_url(array("mod" => "node", "or" => "1,2"), "module"); ?></a>.
Taxonomy URLs always contain a termID or list of termIDs at the end of the URL (aka <i>querystring</i>).
You may learn the termID for a given term by hovering over that term in the <? echo la("Taxonomy Overview", array("mod" => "taxonomy")) ?> page in the Admin and noting the number after the querystring parameter called <i>tid</i>.
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 <i>or</i> or <i>and</i>.
<i>or</i> shows nodes which appear in <b>any</b> of the termIDs while <i>and</i> shows nodes in <b>all</b> the specified termIDs.
Thus, <i>or</i> is less specific than <i>and</i>.
</p>
<i>Term name</i><br />Required. The name for this term. Example: <i>Milk</i><br />
<br />
<i>Description</i><br />Optional. Description of the term that may be used by modules and RSS feeds. This is synonymous with a 'scope note'.<br />
<br />
<i><a name="parent"></a>Parent</i><br />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.<br />
<br />
<i><a name="synonyms"></a>Synonyms</i><br />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. <i>unauthorized terms</i>).<br />
<h3>RSS Feeds</h3>
<p>Every term, or collection of terms, provides an <a href="http://backend.userland.com/stories/rss091">RSS</a> feed to which interested
users may subscribe. The URL format for an sample RSS feed is
<a href="<?php print path_uri().drupal_url(array("mod" => "node", "op" => "feed", "or" => "1,2"), "module"); ?>"><?php print path_uri().drupal_url(array("mod" => "node", "op" => "feed", "or" => "1,2"), "module"); ?></a>.</p>
<?php
<h3>Displaying nodes organized by term(s)</h3>
<p>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 <a href="<?php print path_uri().drupal_url(array("mod" => "node", "or" => "1,2"), "module"); ?>"><?php print path_uri().drupal_url(array("mod" => "node", "or" => "1,2"), "module"); ?></a>. Taxonomy URLs always contain a term ID or list of term IDs at the end of the URL (aka <i>querystring</i>). You may learn the term ID for a given term by hovering over that term in the <? echo la("taxonomy overview", array("mod" => "taxonomy")) ?> page in the Admin and noting the number after the querystring parameter called <i>tid</i>. 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 <i>or</i> or <i>and</i>: <i>or</i> shows nodes which appear in <b>any</b> of the term IDs while <i>and</i> shows nodes in <b>all</b> the specified term IDs. Thus, <i>or</i> is less specific than <i>and</i>.</p>
<h3>RSS feeds</h3>
<p>Every term, or collection of terms, provides an <a href="http://backend.userland.com/stories/rss091">RSS</a> feed to which interested users may subscribe. The URL format for an sample RSS feed is <a href="<?php print path_uri().drupal_url(array("mod" => "node", "op" => "feed", "or" => "1,2"), "module"); ?>"><?php print path_uri().drupal_url(array("mod" => "node", "op" => "feed", "or" => "1,2"), "module"); ?></a>.</p>
<?php
}
?>