You are here

Home » API reference » Context Keywords 6

README.txt in Context Keywords 6

Same filename and directory in other branches
  1. 7 README.txt
CONTENTS OF THIS FILE
---------------------
* Introduction
* Requirements
* Installation
* Configuration
* Tips & Tricks
* Debugging


INTRODUCTION
------------
Current Maintainer: mikegfx <mikegfx@gmail.com>

Context Keywords is a add-on for the Context module that allows Contexts to be 
triggered by the keywords a user searched upon landing on your site.  The keywords 
are stored throughout the session allowing the condition to be activated until 
the session is ended.


Requirements
------------
- Drupal 6.x

- Context 3.0 or higher


Installation
------------
1. Copy the entire context_keywords directory the Drupal sites/[all]/modules
   directory

2. Login as an administrator. Enable the module in the "Administer" -> "Site
   Building" -> "Modules"

3. Create a new context at admin/build/context and select 'Keywords'
   to test it out.


Configuration
------------
- Seperate phrases by line.

- Use  *  as a wildcard.

- Use  ~  to exclude one or more keywords.

- Use <default> to trigger a context if no other contexts with keywords are active.


Tips & Tricks
------------
- If you are try to match a short word/acronym and concerned that it may appear within another word, 
  you can use multiple lines like such to verify a space:
  
  key
  * key
  key *
  * key *
  
  NOTE: I may look to refine this in the future.


Debugging
------------
You may test the context using a 'keywords' URL argument in one of two ways.

1. Terms seperated by a + symbol:

http://yoursite.com/?keywords=keyword1+keyword2

2. Search engine results URL(Example by searching 'Drupal' with Bing)
http://yoursite.com/?keywords=http://www.bing.com/search?q=drupal&go=&form=QBLH&qs=n&sk=&sc=8-1

NOTE: Debugging will not work correctly with Google's Live Search URL.

File

README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

  3. ---------------------

  4. * Introduction

  5. * Requirements

  6. * Installation

  7. * Configuration

  8. * Tips & Tricks

  9. * Debugging

  10. 

  11. 

  12. INTRODUCTION

  13. ------------

  14. Current Maintainer: mikegfx 

  15. 

  16. Context Keywords is a add-on for the Context module that allows Contexts to be 

  17. triggered by the keywords a user searched upon landing on your site.  The keywords 

  18. are stored throughout the session allowing the condition to be activated until 

  19. the session is ended.

  20. 

  21. 

  22. Requirements

  23. ------------

  24. - Drupal 6.x

  25. 

  26. - Context 3.0 or higher

  27. 

  28. 

  29. Installation

  30. ------------

  31. 1. Copy the entire context_keywords directory the Drupal sites/[all]/modules

  32.    directory

  33. 

  34. 2. Login as an administrator. Enable the module in the "Administer" -> "Site

  35.    Building" -> "Modules"

  36. 

  37. 3. Create a new context at admin/build/context and select 'Keywords'

  38.    to test it out.

  39. 

  40. 

  41. Configuration

  42. ------------

  43. - Seperate phrases by line.

  44. 

  45. - Use  *  as a wildcard.

  46. 

  47. - Use  ~  to exclude one or more keywords.

  48. 

  49. - Use  to trigger a context if no other contexts with keywords are active.

  50. 

  51. 

  52. Tips & Tricks

  53. ------------

  54. - If you are try to match a short word/acronym and concerned that it may appear within another word, 

  55.   you can use multiple lines like such to verify a space:

  56.   

  57.   key

  58.   * key

  59.   key *

  60.   * key *

  61.   

  62.   NOTE: I may look to refine this in the future.

  63. 

  64. 

  65. Debugging

  66. ------------

  67. You may test the context using a 'keywords' URL argument in one of two ways.

  68. 

  69. 1. Terms seperated by a + symbol:

  70. 

  71. http://yoursite.com/?keywords=keyword1+keyword2

  72. 

  73. 2. Search engine results URL(Example by searching 'Drupal' with Bing)

  74. http://yoursite.com/?keywords=http://www.bing.com/search?q=drupal&go=&form=QBLH&qs=n&sk=&sc=8-1

  75. 

  76. NOTE: Debugging will not work correctly with Google's Live Search URL.

  77. 

  78. 

  79.