modules/glossary/README.txt

; $Id$
Glossary helps newbies understand the jargon which always crops up when
specialists talk about a topic. Doctors discuss CBC and EKG and CCs.
Web developers keep talking about CSS, P2P, XSLT, etc. This is all
intimidating for newbies. 

The glossary module uses a filter that scans posts for glossary terms 
(including synonyms). The glossary indicator is inserted after every
found term, or the term itself is turned into an indicator depending
on the site settings. By hovering over the indicator, users may learn
the definition of that term. Clicking the indicator leads the user to
that term presented within the whole glossary or directly to the
detailed description of the term, if available.

The glossary uses Drupal's built in taxonomy feature, so you can organize
your terms in a Drupal vocabulary. This allows you to create hierarchical
structures, synonyms and relations. Glossary terms are represented with
the taxonomy terms in the glossary vocabulary. Descriptions are used to
provide a short explanation of the terms. You can attach nodes to the
terms to provide detailed explanation on the keywords.

The Glossary module will call the Taxonomy Image module, if it's enabled,
to allow you to display an image for each term in the glossary.

If you use Firefox, you may want to install the "Longer Titles" add-on
in order to see the entire definition.

Installation
------------

1. Copy this whole folder to rhe appropriate modules/ directory, as usual.
   Drupal should automatically detect the module. Enable the module on
   the modules' administration page.

2. Glossary terms are managed as vocabularies within the taxonomy.module.
   To get started with glossary, create a new vocabulary on the
   taxonomy administration page. The vocabulary need not be associated
   with any modules, though you can attach detailed description to terms
   by adding nodes to the terms, so it might be a good idea to associate
   the vocabulary with the "story" module. Add a few terms to the vocabulary.
   The term title should be the glossary entry, the description should be
   the explanation of that term. You can make use of the hierarchy,
   synonym, and related terms features. These features impact the display
   of the glossary when viewed in an overview.

3. Next, you have to set up the module and the input formats you want to use.
   This is done on the Glossary settings page at Administer >> Site configuration
   >> Glossary. First select the appropriate "General" settings and save them.
   Then select the tabs corresponding to any "input formats" you will allow to 
   be used on your site (probably at least "Filtered HTML"). You may have
   different settings for each input format, but consider that carefully. You
   will be able to choose between superscript, icon, or acronym inclusion for
   each term.
   
4. If you want a search box on your glossary page, enable the block on admin/block page.


Advanced Usage
---------

You can create a dedicated glossary for some pages of your site. To do so, create a new
vocabulary and put the special terms in it. Then create a new input format and add the
glossary filter to it. Then configure glossary filter in that format to look at the new
vocabulary. Finally, affiliate the special pages with this input format and you will get the
desired behavior.

You may also set up a "dictionary" that looks just like the glossary page, but is not 
associated with a vocabulary.

Authors
-------
Additional improvements and fixes by Nancy Wichmann
More improvements by Moshe Weitzman aagin. And so it goes around ...
More improvements by Frodo Looijaard <drupal [at] frodo.looijaard.name>
Many improvements by Gabor Hojtsy <goba [at] php.net>
Modified extensively by Al Maw <drupal-glossary [at] almaw.com>.
Originally written by Moshe Weitzman <weitzman [at] tejasa.com>. Much help from killes.
1	; $Id$
2	Glossary helps newbies understand the jargon which always crops up when
3	specialists talk about a topic. Doctors discuss CBC and EKG and CCs.
4	Web developers keep talking about CSS, P2P, XSLT, etc. This is all
5	intimidating for newbies.
6
7	The glossary module uses a filter that scans posts for glossary terms
8	(including synonyms). The glossary indicator is inserted after every
9	found term, or the term itself is turned into an indicator depending
10	on the site settings. By hovering over the indicator, users may learn
11	the definition of that term. Clicking the indicator leads the user to
12	that term presented within the whole glossary or directly to the
13	detailed description of the term, if available.
14
15	The glossary uses Drupal's built in taxonomy feature, so you can organize
16	your terms in a Drupal vocabulary. This allows you to create hierarchical
17	structures, synonyms and relations. Glossary terms are represented with
18	the taxonomy terms in the glossary vocabulary. Descriptions are used to
19	provide a short explanation of the terms. You can attach nodes to the
20	terms to provide detailed explanation on the keywords.
21
22	The Glossary module will call the Taxonomy Image module, if it's enabled,
23	to allow you to display an image for each term in the glossary.
24
25	If you use Firefox, you may want to install the "Longer Titles" add-on
26	in order to see the entire definition.
27
28	Installation
29	------------
30
31	1. Copy this whole folder to rhe appropriate modules/ directory, as usual.
32	Drupal should automatically detect the module. Enable the module on
33	the modules' administration page.
34
35	2. Glossary terms are managed as vocabularies within the taxonomy.module.
36	To get started with glossary, create a new vocabulary on the
37	taxonomy administration page. The vocabulary need not be associated
38	with any modules, though you can attach detailed description to terms
39	by adding nodes to the terms, so it might be a good idea to associate
40	the vocabulary with the "story" module. Add a few terms to the vocabulary.
41	The term title should be the glossary entry, the description should be
42	the explanation of that term. You can make use of the hierarchy,
43	synonym, and related terms features. These features impact the display
44	of the glossary when viewed in an overview.
45
46	3. Next, you have to set up the module and the input formats you want to use.
47	This is done on the Glossary settings page at Administer >> Site configuration
48	>> Glossary. First select the appropriate "General" settings and save them.
49	Then select the tabs corresponding to any "input formats" you will allow to
50	be used on your site (probably at least "Filtered HTML"). You may have
51	different settings for each input format, but consider that carefully. You
52	will be able to choose between superscript, icon, or acronym inclusion for
53	each term.
54
55	4. If you want a search box on your glossary page, enable the block on admin/block page.
56
57
58	Advanced Usage
59	---------
60
61	You can create a dedicated glossary for some pages of your site. To do so, create a new
62	vocabulary and put the special terms in it. Then create a new input format and add the
63	glossary filter to it. Then configure glossary filter in that format to look at the new
64	vocabulary. Finally, affiliate the special pages with this input format and you will get the
65	desired behavior.
66
67	You may also set up a "dictionary" that looks just like the glossary page, but is not
68	associated with a vocabulary.
69
70	Authors
71	-------
72	Additional improvements and fixes by Nancy Wichmann
73	More improvements by Moshe Weitzman aagin. And so it goes around ...
74	More improvements by Frodo Looijaard <drupal [at] frodo.looijaard.name>
75	Many improvements by Gabor Hojtsy <goba [at] php.net>
76	Modified extensively by Al Maw <drupal-glossary [at] almaw.com>.
77	Originally written by Moshe Weitzman <weitzman [at] tejasa.com>. Much help from killes.