You are here

Home » API reference » Lexicon 6

README.txt in Lexicon 6

Same filename and directory in other branches
  1. 7 README.txt
Non-displayable characters.

File

README.txt
View source 
  1. 

  2. Lexicon

  3. http://www.drupal.org/project/lexicon

  4. =====================================

  5. 

  6. 

  7. DESCRIPTION

  8. -----------

  9. A lexicon is a stock of terms used in a particular profession, subject or style; a vocabulary. 

  10. The Lexicon module generates one or more Lexicon pages based on terms in taxonomies and optionally 

  11. marks and links them in the content.

  12. 

  13. The Lexicon module is a fork of the Glossary module (http://www.drupal.org/project/glossary) that 

  14. was changed to suit the needs of a project for the Dutch government and later ported to Drupal 7.

  15. The main reason for the changes is compliancy with the web guidelines of the Dutch government

  16. (http://www.webguidelines.nl).

  17. 

  18. 

  19. DIFFERENCES BETWEEN LEXICON AND GLOSSARY MODULE

  20. -----------------------------------------------

  21. The main differences with the Glossary module are that the Lexicon module:

  22. 

  23. * Produces output that is valid W3C XHTML 1.0 Strict.

  24. * Enables showing lists of terms without marking the terms in content (this is still an option).

  25.   You can choose which vocabularies act as Lexicons and you don’t bind them to input filters.

  26. * Has configurable paths and titles for each Lexicon.

  27. * Optionally inserts a “go to top” link for each section on the Lexicon page.

  28. * Optionally “scrolls” to internal links on the Lexicon page.

  29. * Lexicon is also available for Drupal 7

  30. * From the 7.x-1.4 version and up the Lexicon module uses template files instead of theme functions 

  31.   for output rendering

  32. 

  33. 

  34. DRUPAL 6 VERSUS DRUPAL 7 VERSION

  35. --------------------------------

  36. Shortly after Drupal 7.0 was released the Drupal 7 version of the Lexicon module was developed.

  37. From that moment new features only go into the Drupal 7 version unless there is lot of demand for a 

  38. feature to be backported to the Drupal 6 version.

  39. 

  40. Related terms and synonyms for terms have been stripped out of the Taxonomy module in Drupal 7 and 

  41. the functionality should now be created using Fields. The Drupal 7 version of the Lexicon module lets 

  42. the administrator configure which fields of a vocabulary are used as fields for related terms, 

  43. synonyms and/or term images.

  44. 

  45. Two-way relations of terms is not implemented (yet).

  46. 

  47. Development of this module is sponsored by Sogeti Netherlands (http://sogeti.doethetmetdrupal.nl).

  48. 

  49. 

  50. REQUIREMENTS

  51. ------------

  52. Drupal 7.x

  53. Taxonomy

  54. Fields

  55. 

  56. 

  57. INSTALLING

  58. ----------

  59. 1. To install the module copy the 'lexicon' folder to your sites/all/modules directory.

  60. 

  61. 2. Go to admin/build/modules. Enable the Lexicon module.

  62. Read more about installing modules at http://drupal.org/node/70151

  63. 

  64. 

  65. CONFIGURING AND USING

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

  67. 1. Create a taxonomy vocabulary for each Lexicon.

  68. 2. Go to admin/settings/lexicon.

  69. 3. Select the created taxonomy vocabularies you want to use as Lexicons.

  70. 4. Set the desired behavior of the Lexicon module and save the configuration.

  71. 5. Configure the alphabar and save the configuration.

  72. 6. Optionally set the paths and titles of the Lexicons and save the configuration.

  73. 7. Optionally configure fields for synonyms, related terms and term images.

  74. 8. Optionally put the suggested menu-items in the right menu and activate them.

  75. 9. Enable the Lexicon filter on the appropriate text formats.

  76. 

  77. Have fun!