modules/g2/README.txt

=============================================================================
Glossary2 (G2)
-----------------------------------------------------------------------------
$Id: README.txt,v 1.6 2007/05/20 15:40:34 fgm Exp $
=============================================================================

G2 is a glossary management module written for Drupal.

It is not intended as a direct replacement for glossary.module
which has been already available with drupal for quite some time now,
but as an alternative for sites needing a glossary for a large number of entries,
or a different feature set.

Unlike glossary.module, it uses nodes for its definitions, and does not
automatically link terms in other nodes to their entries in G2, but relies on
<dfn> markup in definitions, and can link to terms in multi-byte character sets
and terms containing special characters like slashes or ampersands without
specific markup.

Its development to this date has been entirely sponsored by OSInet.fr

A word of warning: due to G2 targeting high-volume glossaries and including
its own APIs and features, the code is heavier than glossary.module: the base
version source for G2 is more than twice the volume of the base version
source for glossary.module. It may be too heavy for sites on very limited
hosting plans or unable to use clean URLs. On the other hand, it handles
glossaries with thousands of nodes without slowing or increasing its memory
requirements significantly.

Project page on Drupal.org:
        http://drupal.org/project/g2
Documentation wiki (contributions welcome)
        http://wiki.audean.com/g2/start
Sample implementation (over 5000 terms, localized to french)
        http://www.riff.org/glossaire

==== PREREQUISITES ====

  * Drupal 6.0 pre-beta
  * MySQL 4.1.x, configured for UTF-8 encoding (collating: utf8_general_ci)
  * PHP 5.1

==== VERSION WARNINGS ====

As of 2007-08-19:
- sites not configured with clean URLs are no longer taken into account
- the module is only maintained/evolved for the DRUPAL-4-7 and
  DRUPAL-6--1 branches.
- A 5.0 version will not be considered unless someone writes the
  port or sponsors it (shouldn't cost much).

==== NOTICE ====

The statistics displayed on the "entries starting by initial ..." page
at URL <drupal>/g2/initial/<some initial segment> mention :

"Displaying 0 entries starting by ... from a total number of ... entries.

It must be understood that this "total number" is actually the total number
a user without administrative permissions can see, that is, published entries.
The "published" epithete is not used because site visitors are not expected
to be aware of the publishing process.
1	=============================================================================
2	Glossary2 (G2)
3	-----------------------------------------------------------------------------
4	$Id: README.txt,v 1.6 2007/05/20 15:40:34 fgm Exp $
5	=============================================================================
6
7	G2 is a glossary management module written for Drupal.
8
9	It is not intended as a direct replacement for glossary.module
10	which has been already available with drupal for quite some time now,
11	but as an alternative for sites needing a glossary for a large number of entries,
12	or a different feature set.
13
14	Unlike glossary.module, it uses nodes for its definitions, and does not
15	automatically link terms in other nodes to their entries in G2, but relies on
16	<dfn> markup in definitions, and can link to terms in multi-byte character sets
17	and terms containing special characters like slashes or ampersands without
18	specific markup.
19
20	Its development to this date has been entirely sponsored by OSInet.fr
21
22	A word of warning: due to G2 targeting high-volume glossaries and including
23	its own APIs and features, the code is heavier than glossary.module: the base
24	version source for G2 is more than twice the volume of the base version
25	source for glossary.module. It may be too heavy for sites on very limited
26	hosting plans or unable to use clean URLs. On the other hand, it handles
27	glossaries with thousands of nodes without slowing or increasing its memory
28	requirements significantly.
29
30	Project page on Drupal.org:
31	http://drupal.org/project/g2
32	Documentation wiki (contributions welcome)
33	http://wiki.audean.com/g2/start
34	Sample implementation (over 5000 terms, localized to french)
35	http://www.riff.org/glossaire
36
37	==== PREREQUISITES ====
38
39	* Drupal 6.0 pre-beta
40	* MySQL 4.1.x, configured for UTF-8 encoding (collating: utf8_general_ci)
41	* PHP 5.1
42
43	==== VERSION WARNINGS ====
44
45	As of 2007-08-19:
46	- sites not configured with clean URLs are no longer taken into account
47	- the module is only maintained/evolved for the DRUPAL-4-7 and
48	DRUPAL-6--1 branches.
49	- A 5.0 version will not be considered unless someone writes the
50	port or sponsors it (shouldn't cost much).
51
52	==== NOTICE ====
53
54	The statistics displayed on the "entries starting by initial ..." page
55	at URL <drupal>/g2/initial/<some initial segment> mention :
56
57	"Displaying 0 entries starting by ... from a total number of ... entries.
58
59	It must be understood that this "total number" is actually the total number
60	a user without administrative permissions can see, that is, published entries.
61	The "published" epithete is not used because site visitors are not expected
62	to be aware of the publishing process.