You are here

README.txt in Taxonomy Facets 7

Same filename and directory in other branches
  1. 7.3 README.txt
  2. 7.2 README.txt
TAXONOMY FACETS
--------------------


TAXO FACETED NAVIGATION module - Faceted search with clean url's.

CONTENT:

* INTRO
* INSTALLATION
* CONFIGURATION
* HOW TO USE


IMPORTANT: this module will not work with default URL alias patterns for 
Taxonomies, see "Configure URL alias patterns" section below

==========================================================================
                                         INTRO
==========================================================================

Progresive content filtering, with clean url's, using taxonomies as facets.

Ideal for eCommerce carts, real estate / properyies sites, classified ads, or other sites with multiple categories, where users need to filter content progressively by applying filters from one or more categories.

Category Landing Pages

Taxonomy terms are used as Facets to help users filter content progressively. Similar to the way it is done on most of today’s eCommerce sites, like Amazon. This module is all about SEO, so as the user applies different filters the clean URL's are preserved with each filter change. For example, if the user applies these three filters: Computer Monitors, Samsung and LCD, then the URL will look something like:

http://sitename.com/products/computer-monitors/samsung/lcd

When the user then changes the filters to Computer Monitors, HP and LCD, the URL will change to:

http://sitename.com/products/computer-monitors/HP/lcd

Filters can be applied in various permutations, so producing a clean URL for each unique filter combination will allow search engines to index a huge amount of landing pages.

Node pages

When a user arrives on the “node body page”, like the product page, the full URL path will be preserved.

http://sitename.com/products/computer-monitors/HP/lcd/Monitor-123-AB

If a user finds the same product (node) with different filter permutations this will be reflected in the URL:

http://sitename.com/products/multimedia/displays/HP/Monitor-123-AB

Futhermore, if a user arrives on the product page via a direct URL, say directly from a Google search, the filters from the URL will be applied automatically and menu items expanded and highlighted accordingly.

For example, if a user arrives on the site via this URL:

http://sitename.com/products/computer-monitors/HP/lcd/Monitor-123-AB

The menu tree / facets will look something like

Computer hardware
--Monitors (highlighted)
--Peripherals
--Hard discs
--Workstations

Brand
--Sony
--HP (highlighted)
--Dell
--Apple

TYPE
--LCD (highlighted)
--Plasma

But if they arrive on the same product page via a different URL, say:

http://sitename.com/products/multimedia/displays/HP/Monitor-123-AB

The menu tree / facets will now look something like

Stores
--Multimedia (highlighted)
--Books
--House appliance

Product type
--displays (highlighted)
--gaming
--handheld

Brand
--Sony
--HP (highlighted)
--Dell
--Apple

This module produces "menus" on the fly, i.e. no need for rebuilding menus or indexing as the menu items are not Drupal menu items but just items in the block. This is useful for sites where taxonomies may change frequently.

Filters / facets blocks are cached for better performance.


==========================================================================
                                INSTALLATION
==========================================================================

1) Place this module directory in your "modules" folder (this will usually be
   "sites/all/modules/"). Don't install your module in Drupal core's "modules"
   folder, since that will cause problems and is bad practice in general. If
   "sites/all/modules" doesn't exist yet, just create it.

2) Enable the Taxonomy Faceted navigation module in Drupal at:
   administration -> site configuration -> modules (admin/build/modules)
   The Drupal core taxonomy module is required.
   
 3) IMPORTANT: this module will not work with default URL alias patterns for 
 Taxonomies, see "Configure URL alias patterns" section below


==========================================================================
                            CONFIGURATION
==========================================================================

Set Permissions
------------------
Go to Permissions page: admin/people/permissions
Find permision: "View taxonomy facets" and select for appropriate 
roles, i.e select ANONYMOUS USER role.

* Expose taxonomy as Faceted Filters / Navigation blocks
------------------------
Go to Blocks admin page:
Administration » Structure » Blocks
and create Taxo Faceterd block by clicking on "Add taxofaceted block" link.
Select desired taxonomy in the Taxonomy drop down field.

You can oweride the default block title (which is Taxonomy name) by
filing the title filed of the block.

Save block.	

The block will appear in the "Disabled" section on the blocks page.
and the blocks name will be prefixed by "Taxo Faceted Filter:", say
"Taxo Faceted Filter: Monitors".

Select region you want your block to apper in, i.e "Sidebar first".

Save blocks.

* Set first argument
--------------------
Go to admin section: 
Configuration >> SEARCH AND METADATA >> Taxo Faceted Navigation 
( admin/config/search/tax_faceted_nav )
Setting up of the first argument in the url is necessary for the working of 
this module. 
For example, if this is an ecommerce site the argument could be store, so URL 
would look something like http://yoursite.com/store/hardware/monitors. 
Can not be null. 

* !!! IMPORTANT: Configure URL alias patterns (if Pathauto module is installed)
----------------------------------------
Go to: 
Administration > Configuration > Search and metadata > URL aliases >Patterns
In the TAXONOMY TERM PATHS section configure term patterns, change it to 
single argument, for example change default pattern: 
[term:vocabulary]/[term:name] to [term:name]. 
You can use [term:vocabulary]-[term:name] or similar, the key is to NOT have 
any / character in the pattern, as this module expects a single argument for 
each filter.

If you already have taxonomy term aliases generated with a different pattern update them:
* Delete aliases for taxonomy terms.
* Bulk update taxonomy term paths.

* Configure other options
--------------------------
Go to admin section: 
Configuration >> SEARCH AND METADATA >> Taxo Faceted Navigation 
( admin/config/search/tax_faceted_nav )
Configure as desired


==========================================================================
                              HOW TO USE
==========================================================================

If you do not have any taxonomies in your system create some. Add them them as 
taxonmy facets block, by going to blocks page 
Administration » Structure » Blocks and click on +Add taxofacet block

For example create a vocabulary Catalog, 
create some terms in this vocabulary, for example:

Catalog
   Monitors
     LCD
     TFT
   Laptops
   Workstations
 
 Create another 2 vocabularies
 
 Brand
   Sony
   HP
   Acer
   
 Price range
  less than $100
  $100 - $200
  $200 - $500
  $500 - $1000
  $1000 +
  
Set URL aliases. Either install Pathauto module and generate URL aliases or set
 aliases manually. 
This module will not work without URL aliases
   
Add some nodes in to your CMS and tag them with appropriate taxonomies: Lets 
say you have Product content type. Add 3 fields to the product content type. 
Field type is Term Reference. 
Add fields Catalog, Brand and Price range, of type Term Reference, and select 
appropriate Vocabularies respectively.

Create some Products and associate with appropriate terms. For Example add 
Product node Sony
LCD monitor that costs $400 and associate it with:
 Product-LCD
 Brand-Sony
 Price range - ($200 - $500)
 

File

README.txt
View source
  1. TAXONOMY FACETS
  2. --------------------
  3. TAXO FACETED NAVIGATION module - Faceted search with clean url's.
  4. CONTENT:
  5. * INTRO
  6. * INSTALLATION
  7. * CONFIGURATION
  8. * HOW TO USE
  9. IMPORTANT: this module will not work with default URL alias patterns for
  10. Taxonomies, see "Configure URL alias patterns" section below
  11. ==========================================================================
  12. INTRO
  13. ==========================================================================
  14. Progresive content filtering, with clean url's, using taxonomies as facets.
  15. Ideal for eCommerce carts, real estate / properyies sites, classified ads, or other sites with multiple categories, where users need to filter content progressively by applying filters from one or more categories.
  16. Category Landing Pages
  17. Taxonomy terms are used as Facets to help users filter content progressively. Similar to the way it is done on most of today’s eCommerce sites, like Amazon. This module is all about SEO, so as the user applies different filters the clean URL's are preserved with each filter change. For example, if the user applies these three filters: Computer Monitors, Samsung and LCD, then the URL will look something like:
  18. http://sitename.com/products/computer-monitors/samsung/lcd
  19. When the user then changes the filters to Computer Monitors, HP and LCD, the URL will change to:
  20. http://sitename.com/products/computer-monitors/HP/lcd
  21. Filters can be applied in various permutations, so producing a clean URL for each unique filter combination will allow search engines to index a huge amount of landing pages.
  22. Node pages
  23. When a user arrives on the “node body page”, like the product page, the full URL path will be preserved.
  24. http://sitename.com/products/computer-monitors/HP/lcd/Monitor-123-AB
  25. If a user finds the same product (node) with different filter permutations this will be reflected in the URL:
  26. http://sitename.com/products/multimedia/displays/HP/Monitor-123-AB
  27. Futhermore, if a user arrives on the product page via a direct URL, say directly from a Google search, the filters from the URL will be applied automatically and menu items expanded and highlighted accordingly.
  28. For example, if a user arrives on the site via this URL:
  29. http://sitename.com/products/computer-monitors/HP/lcd/Monitor-123-AB
  30. The menu tree / facets will look something like
  31. Computer hardware
  32. --Monitors (highlighted)
  33. --Peripherals
  34. --Hard discs
  35. --Workstations
  36. Brand
  37. --Sony
  38. --HP (highlighted)
  39. --Dell
  40. --Apple
  41. TYPE
  42. --LCD (highlighted)
  43. --Plasma
  44. But if they arrive on the same product page via a different URL, say:
  45. http://sitename.com/products/multimedia/displays/HP/Monitor-123-AB
  46. The menu tree / facets will now look something like
  47. Stores
  48. --Multimedia (highlighted)
  49. --Books
  50. --House appliance
  51. Product type
  52. --displays (highlighted)
  53. --gaming
  54. --handheld
  55. Brand
  56. --Sony
  57. --HP (highlighted)
  58. --Dell
  59. --Apple
  60. This module produces "menus" on the fly, i.e. no need for rebuilding menus or indexing as the menu items are not Drupal menu items but just items in the block. This is useful for sites where taxonomies may change frequently.
  61. Filters / facets blocks are cached for better performance.
  62. ==========================================================================
  63. INSTALLATION
  64. ==========================================================================
  65. 1) Place this module directory in your "modules" folder (this will usually be
  66. "sites/all/modules/"). Don't install your module in Drupal core's "modules"
  67. folder, since that will cause problems and is bad practice in general. If
  68. "sites/all/modules" doesn't exist yet, just create it.
  69. 2) Enable the Taxonomy Faceted navigation module in Drupal at:
  70. administration -> site configuration -> modules (admin/build/modules)
  71. The Drupal core taxonomy module is required.
  72. 3) IMPORTANT: this module will not work with default URL alias patterns for
  73. Taxonomies, see "Configure URL alias patterns" section below
  74. ==========================================================================
  75. CONFIGURATION
  76. ==========================================================================
  77. Set Permissions
  78. ------------------
  79. Go to Permissions page: admin/people/permissions
  80. Find permision: "View taxonomy facets" and select for appropriate
  81. roles, i.e select ANONYMOUS USER role.
  82. * Expose taxonomy as Faceted Filters / Navigation blocks
  83. ------------------------
  84. Go to Blocks admin page:
  85. Administration » Structure » Blocks
  86. and create Taxo Faceterd block by clicking on "Add taxofaceted block" link.
  87. Select desired taxonomy in the Taxonomy drop down field.
  88. You can oweride the default block title (which is Taxonomy name) by
  89. filing the title filed of the block.
  90. Save block.
  91. The block will appear in the "Disabled" section on the blocks page.
  92. and the blocks name will be prefixed by "Taxo Faceted Filter:", say
  93. "Taxo Faceted Filter: Monitors".
  94. Select region you want your block to apper in, i.e "Sidebar first".
  95. Save blocks.
  96. * Set first argument
  97. --------------------
  98. Go to admin section:
  99. Configuration >> SEARCH AND METADATA >> Taxo Faceted Navigation
  100. ( admin/config/search/tax_faceted_nav )
  101. Setting up of the first argument in the url is necessary for the working of
  102. this module.
  103. For example, if this is an ecommerce site the argument could be store, so URL
  104. would look something like http://yoursite.com/store/hardware/monitors.
  105. Can not be null.
  106. * !!! IMPORTANT: Configure URL alias patterns (if Pathauto module is installed)
  107. ----------------------------------------
  108. Go to:
  109. Administration > Configuration > Search and metadata > URL aliases >Patterns
  110. In the TAXONOMY TERM PATHS section configure term patterns, change it to
  111. single argument, for example change default pattern:
  112. [term:vocabulary]/[term:name] to [term:name].
  113. You can use [term:vocabulary]-[term:name] or similar, the key is to NOT have
  114. any / character in the pattern, as this module expects a single argument for
  115. each filter.
  116. If you already have taxonomy term aliases generated with a different pattern update them:
  117. * Delete aliases for taxonomy terms.
  118. * Bulk update taxonomy term paths.
  119. * Configure other options
  120. --------------------------
  121. Go to admin section:
  122. Configuration >> SEARCH AND METADATA >> Taxo Faceted Navigation
  123. ( admin/config/search/tax_faceted_nav )
  124. Configure as desired
  125. ==========================================================================
  126. HOW TO USE
  127. ==========================================================================
  128. If you do not have any taxonomies in your system create some. Add them them as
  129. taxonmy facets block, by going to blocks page
  130. Administration » Structure » Blocks and click on +Add taxofacet block
  131. For example create a vocabulary Catalog,
  132. create some terms in this vocabulary, for example:
  133. Catalog
  134. Monitors
  135. LCD
  136. TFT
  137. Laptops
  138. Workstations
  139. Create another 2 vocabularies
  140. Brand
  141. Sony
  142. HP
  143. Acer
  144. Price range
  145. less than $100
  146. $100 - $200
  147. $200 - $500
  148. $500 - $1000
  149. $1000 +
  150. Set URL aliases. Either install Pathauto module and generate URL aliases or set
  151. aliases manually.
  152. This module will not work without URL aliases
  153. Add some nodes in to your CMS and tag them with appropriate taxonomies: Lets
  154. say you have Product content type. Add 3 fields to the product content type.
  155. Field type is Term Reference.
  156. Add fields Catalog, Brand and Price range, of type Term Reference, and select
  157. appropriate Vocabularies respectively.
  158. Create some Products and associate with appropriate terms. For Example add
  159. Product node Sony
  160. LCD monitor that costs $400 and associate it with:
  161. Product-LCD
  162. Brand-Sony
  163. Price range - ($200 - $500)