| 1 |
<!-- $Id$ --> |
<!-- $Id: taxonomy_sifter.help,v 1.1.4.4 2008/11/15 14:12:35 tbarregren Exp $ --> |
| 2 |
<p><a href="http://drupal.org/project/taxonomy_sifter">Taxonomy Sifter</a> is a Drupal module that provides a block with terms which <em>any</em> or <em>all</em> selected must apply to a node for it to be listed when viewing a taxonomy term page, e.g. <code>taxonomy/term/...</code> The vocabularies used in the block is configurable.</p><!--break--> |
<p><a href="http://drupal.org/project/taxonomy_sifter">Taxonomy Sifter</a> is a Drupal module that provides a block with terms which <em>any</em> or <em>all</em> selected must apply to a node for it to be listed when viewing a taxonomy term page, e.g. <code>taxonomy/term/...</code> The vocabularies used in the block is configurable.</p><!--break--> |
| 3 |
<p>Taxonomy Sifter is developed by <a href="/user/16678">Thomas Barregren</a> at <a href="http://drupal.org/node/131670">imBridge</a> and <a href="http://drupal.org/user/101412">Nancy Wichmann</a>. The initial development was sponsored by <a href="http://www.sspa.se/">SSPA Sweden</a>. |
<p>Taxonomy Sifter is developed by <a href="/user/16678">Thomas Barregren</a> at <a href="http://drupal.org/node/131670">imBridge</a> and <a href="http://drupal.org/user/101412">Nancy Wichmann</a>. The initial development was sponsored by <a href="http://www.sspa.se/">SSPA Sweden</a>. |
| 4 |
<h2>Background</h2> |
<h3 id="background">Background</h2> |
| 5 |
<p>Given the path <code>taxonomy/term/...</code>, where <code>...</code> is the identity number of a taxonomy term, Drupal responds by dynamically building a page with teasers of nodes with the given term applied to them. Often, more than just one term is applied to a node. By combining several terms with either the OR operator (<code>+</code>) or the AND operator (<code>,</code>) the returned teasers will correspond to nodes with <em>any</em> or <em>all</em>, respectively, of the terms applied. For further explanation, see the <a href="http://drupal.org/node/22273">handbook</a>.</p> |
<p>Given the path <code>taxonomy/term/...</code>, where <code>...</code> is the identity number of a taxonomy term, Drupal responds by dynamically building a page with teasers of nodes with the given term applied to them. Often, more than just one term is applied to a node. By combining several terms with either the OR operator (<code>+</code>) or the AND operator (<code>,</code>) the returned teasers will correspond to nodes with <em>any</em> or <em>all</em>, respectively, of the terms applied. For a further explanation of the taxonomy navigation, see the <a href="http://drupal.org/node/22273">handbook</a>.</p> |
| 6 |
<p>There are several modules that leverage this feature by providing a block with a user friendly interface for combining the terms. Some examples are <a href="http://drupal.org/project/refine_by_taxo">Refine by taxonomy</a>, <a href="http://drupal.org/project/taxonomy_filter">Taxonomy Filter</a> and <a href="http://drupal.org/project/ubrowser">uBrowser</a>. These modules works as filters which can be refined step-by-step. But, once the taxonomy term page is left, for instance by viewing a node sorted out by the filter, the filter is reset. That is often the desired behaviour. But if the purpose of the filter is to provide a short-list of nodes to be reviewed, it can be very frustrating to reapply the refinement over and over again.</p> |
<p>There are several modules that leverage this feature by providing a block with a user friendly interface for combining the terms. Some examples are <a href="http://drupal.org/project/refine_by_taxo">Refine by taxonomy</a>, <a href="http://drupal.org/project/taxonomy_filter">Taxonomy Filter</a>, and <a href="http://drupal.org/project/ubrowser">uBrowser</a>. These modules works as filters which can be refined step-by-step. But, once the taxonomy term page is left, for instance by viewing a node sorted out by the filter, the filter is reset. That is often the desired behavior. But if the purpose of the filter is to provide a short-list of nodes to be reviewed, it can be very frustrating to reapply the refinement over and over again.</p> |
| 7 |
<p>To this end Taxonomy Sifter provides a block where the user can select terms that automatically will be combined with the terms in every request of the form <code>taxonomy/term/...</code> The selected terms are combined with the same operator already used in the request. If no operator is used, that is a single term is given, the sifter use the operator given in the module's settings. The vocabularies of the terms presented in the sifter block is also configurable.</p> |
<p>To this end Taxonomy Sifter provides a block where the user can select terms that automatically will be combined with the terms in every request of the form <code>taxonomy/term/...</code> The selected terms are combined with the same operator already used in the request. If no operator is used, that is a single term is given, the sifter use the operator given in the module's settings. The vocabularies of the terms presented in the sifter block is also configurable.</p> |
| 8 |
<h2>Configuration</h2> |
<h3 id="configuration">Configuration</h3> |
| 9 |
<p>Configure Taxonomy Sifter as follows:</p> |
<p>Configure Taxonomy Sifter as follows:</p> |
| 10 |
<ol> |
<ol> |
| 11 |
<li>On <a href="/admin/settings/taxonomy_sifter">admin/settings/taxonomy_sifter</a>, select vocabularies that should be available in the Taxonomy Sifter block.</li> |
<li>Go to <a href="/admin/user/access#module-taxonomy_sifter">admin/user/access</a>.</li> |
| 12 |
<li>On <a href="/admin/settings/taxonomy_sifter">admin/settings/taxonomy_sifter</a>, select the default term filter. When a taxonomy term page or feed is requested, the given terms are combined with those selected in the Taxonomy Sifter block. If more than one term is given in the request, the combination is done with the operator used in the request. If only one term is given, the operator selected here is used.</li> |
<li>In the <em>taxonomy_sifter module</em> section, grant the <em>administer taxonomy sifter</em> permission to roles of which users should be able to administer the Taxonomy Sifter block.</li> |
| 13 |
<li>On <a href="/admin/access">admin/access</a>, select the roles that will be allowed to view the sifter block, and also the roles that will allowed to administer the settings.</li> |
<li>In the <em>taxonomy_sifter module</em> section, grant the <em>view sifter block</em> permission to roles of which users should be able to use the Taxonomy Sifter block.</li> |
| 14 |
<li>Go to <a href="/admin/block">admin/block</a> and enable the sifter block.</li> |
<li>Go to <a href="/admin/build/block">admin/build/block</a>, and click on the <a href="admin/build/block/configure/taxonomy_sifter/0">configure link</a> for the Taxonomy Sifter block.</li> |
| 15 |
|
<li>In the <em>Taxonomy Sifter Settings</em>, select one or more vocabularies.</li> |
| 16 |
|
<li>In the <em>Taxonomy Sifter Settings</em>, select the operator (<code>,</code>/<code>+</code>) to use to combine terms if no one is used in the URL.</li> |
| 17 |
|
<li>In the <em>Page specific visibility settings</em>, choose the alternative <em>Show on only the listed pages</em> and put <code>taxonomy/term/*</code> in the <em>Pages</em> text area.</li> |
| 18 |
|
<li>Press the <em>Save block</em> button.</li> |
| 19 |
|
<li>Enable the Taxonomy Sifter block by choosing a region.</li> |
| 20 |
</ol> |
</ol> |
| 21 |
|
<h3 id="usage">Usage</h3> |
| 22 |
|
<p>The Taxonomy Sifter block appears on taxonomy term(s) listing pages.</p> |
| 23 |
|
<p>To combine the terms in a request for <code>taxonomy/term/...</code> with terms in sifter block, select the terms in question in the sift block and press the <em>Sift</em> button at the end of te block.</p> |
| 24 |
|
<p>If the URL contains more than one term, the terms in the URL and the term(s) selected in the Taxonomy Sifter block are combined with the operator (<code>,</code>/<code>+</code>) used in the URL.</p> |
| 25 |
|
<p>If the URL contains a single term, the term in the URL and the term(s) selected in the Taxonomy Sifter block are combined with the Taxonomy Sifter default operator configured as described above.</p> |
| 26 |
|
<p>To restore the default behavior of <code>taxonomy/term/...</code>, press the <em>Reset</em> button at the end of the block.</p> |