Differences

This shows you the differences between two versions of the page.

--- g2:choosing [2011/01/12 09:17] – [Rationale for G2 specificities] fgm
+++ g2:choosing [2011/02/22 07:25] – fgm
@@ Line 1: / Line 1: @@
 Back to [[g2:start|G2 main]]
+====== Choosing a glossary-type module ======
+None of the glossary modules is intended as a plug-in replacement for the original glossary module already available with drupal since its humble beginnings. Each of the alternatives was designed for slightly different needs, and this page is here to help you choose which module you should probably be using, or if you should really write your own. Lexicon evolved from glossary to accomodate yet another set of requirements, and glossify started with needs similar to glossary, but evolved to a much more diverse set of features; only those relevant to glossaries should be listed here.
+Left-to-right order by date of creation. Empty cells means info not yet available. Please contribute !
+TODO: import "features discussion" from the [[g2/choosing_next|2008 glossary comparison table]], which updated the very obsolete http://drupal.org/node/266511, currently unavailable for edit except to members of the Drupal doc team due to the Full HTML format, but has now become partly obsolete itself. The 2008 chart is now imported.
+TODO: document the new [[http://drupal.org/project/atrium_glossary|Atrium Glossary]].
-====== Choosing a glossary-type module ======
+^ Feature                           ^  Glossary          ^  G2                          ^  Glossify   ^ Lexicon ^  G2 Refactoring       ^  Atrium Glossary  ^
+^ Drupal-related                    ^                    ^                              ^             ^         ^                       ^  ^
-G2 is not intended as a direct replacement for the glossary module already available with drupal for quite some time now. It was designed for slightly different needs, and this page is here to help you choose which module you should probably be using, or if you should really write your own. Lexicon has been evolved from glossary to accomodate yet another set of requirements, and glossify started with needs similar to glossary, but evolved to a much more diverse set of features; only those relevant to glossaries should be listed here.
+| Drupal 7.x                        |  No                |  Yes                         |  No(t yet)  |  Yes    |  Yes                  |  No   |
+| Drupal 6.x                        |  Yes               |  Yes                         |  Yes        |  Yes    |  No                   |  Yes  |
-^ Feature                           ^  Glossary          ^  G2                          ^  Glossify  ^ Lexicon ^  Refactoring          ^
+| Drupal 5.x                        |  Yes               |  Yes                         |  Yes        |  No     |  No                   |  No   |
-^ Drupal-related                    ^                    ^                              ^            ^         ^                       ^
+| Drupal 4.7.x                      |  Yes               |  Yes                         |  No         |  No     |  No                   |  No   |
-| Drupal 7.x                        |  No                |  No(t yet)                   |  No(t yet) |  Yes    |  Yes                  |
+| Drupal 4.6.x                      |  Yes               |  No                          |  No         |  No     |  No                   |  No   |
-| Drupal 6.x                        |  Yes               |  Yes                         |  Yes       |  Yes    |  No                   |
+| Earlier Drupal versions           |  Yes               |  No                          |  No         |  No     |  No                   |  No   |
-| Drupal 5.x                        |  Yes               |  Yes                         |  Yes       |  No     |  No                   |
+| AJAX                              |  No                |  Some autocompletion         |             |         |                       |
-| Drupal 4.7.x                      |  Yes               |  Yes                         |  No        |  No     |  No                   |
+| Storage                           |  terms             |  nodes, 1 content type       |  nodes (types ?) |    |  any entity           |
-| Drupal 4.6.x                      |  Yes               |  No                          |  No        |  No     |  No                   |
+| Revision support                  |  No                |  core                        |  core       |         |                       |
-| AJAX                              |  No                |  Some autocompletion         |            |         |                       |
+| Simpletest                        |  No                |  A few                       |             |         |  Yes                  |
-| Storage                           |  terms             |  nodes, single content type  |            |         |  any entity           |
+^ Services provided                 ^                    ^                              ^             ^         ^                       ^
-^ Services provided                 ^                    ^                              ^            ^         ^                       ^
+| multiple glossaries on one site   |  Yes               |  No                          |  No         |         |  Yes                  |
-| multiple glossaries on one site   |  Yes               |  No                          |            |         |  Yes                  |
+| RSS feeds on entries              |  core              |  No                          |  core (?)   |         |                       |
-| RSS feeds on entries              |  core              |  No                          |            |         |                       |
+| RSS feeds on additional vocabularies |  No             |  core                        |  core       |         |  core                 |
-| RSS feeds on additional vocabularies |  No             |  core                        |            |         |  core                 |
+| classify entries                  |  No                |  core taxonomy               |  core taxonomy  |     |  core fields          |
-| classify entries                  |  No                |  core taxonomy               |            |         |  core fields          |
+| commenting on entries             |  No                |  core                        |  core       |         |  core, only on node storage  |
-| commenting on entries             |  No                |  core                        |            |         |  core, only on node storage  |
+| private editorial information     |  No                |  Builtin                     |  Use CCK    |         |  core fields          |
-| private editorial information     |  No                |  Yes                         |            |         |  core fields          |
+| alphabar maintenance              |  automatic         |  manual                      |             |         |  defaults + override  |
-| alphabar maintenance              |  automatic         |  manual                      |            |         |                       |
+| remote glossaries                 |  No                |  Yes, limited                |             |         |  Yes                  |
-| content filtering, automatic      |  Yes               |  No                          |            |         |  Yes                  |
+| steganographic content protection |                    |  No                          |             |         |  Yes                  |
-| content filtering, explicit       |  No                |  Yes, dfn element            |            |         |  Yes, custom element  |
+| RDF information                   |                    |  No                       |   |   |  [[http://drupal.org/node/1029544|Yes]]  |
-| feature blocks                    |  No                |  alphabar \\ latest \\ top \\ random \\ word of the day  |
+^ i18n                              ^                    ^                              ^             ^         ^                       ^
-| remote glossaries                 |  No                |  Yes, limited                |            |         |  Yes                  |
+| Translation template supplied     |  Yes               |  Yes                         |             |         |                       |
-| Security                          |  core              |  core \\ XML-RPC access control \\ XML-RPC throttling  | | | |
+| Multilingual blocks               |                    |  No                          |             |         |                       |
-^ 3rd party integration             ^                    ^                              ^            ^         ^                       ^
+| Translatable content              |  Use i18nterms     |  Use i18ncontent             |  Use i18ncontent  |   |                       |
-| [[http://wiki.audean.com/g2/wishlist|Quality Agent]] |  No  |  No                     |            |         |  Yes                  |
+^ Feature blocks                    ^                    ^                              ^             ^         ^                       ^
-| Views: basic                      |  core              |  core + specific             |            |         |  core + specific      |
+| Alphabar                          |  No                |  Yes                         |  Use Views  |         |  Default View         |
-| Views: default views              |  No                |  No                          |            |         |  Yes                  |
+| Daily                             |  Yes               |  Yes                         |  Use Views  |         |  Default View         |
-| [[http://wiki.audean.com/g2/wishlist|Wikipedia]]  |  No  |  No                        |            |         |  Yes, with i18n       |
+| Latest                            |  No                |  Yes                         |  Use Views  |         |  Default View         |
-| [[http://wiki.audean.com/g2/wishlist|Zeitgeist]] |  No  |  No                         |            |         |  Yes                  |
+| Random                            |  Yes               |  Yes                         |  Use Views  |         |  Default View         |
-^ Performance                       ^                    ^                              ^            ^         ^                       ^
+| Search glossary                   |  Yes               |  No                          |  No         |         |  Yes                  |
-| memory needs/number of entries    |  proportional      |  constant                    |            |         |                       |
+^ Content filtering                 ^                    ^                              ^             ^         ^                       ^
-| speed on small glossaries         |  faster            |  slower                      |            |         |                       |
+| Input, automatic                  |  Yes               |  No                          |  No         |         |  Yes                  |
-| speed on large glossaries         |  slower with size  |  remains constant            |            |         |                       |
+| Input, automatic, stop list       |  Single language   |  No                          |  No         |         |  i18n support         |
-^ Themeing                          ^                    ^                              ^            ^         ^                       ^
+| Input, explicit                   |  No                |  Yes, dfn element            |  No         |         |  Yes, custom element  |
-| - search form                     |  Yes               |  core                        |            |         |                       |
+| Output, automatic                 |  No                |  No                          |  Yes        |         |                       |
-| - node overview                   |  Yes               |  core                        |            |         |                       |
+| auto "title" on links             |  No                |  No                          |             |         |  Teaser / Disambiguation        |
-| - definition fields               |  n.a.              |  Yes                         |            |         |  core fields          |
+| Disambiguation pages              |  n.a.              |  Yes, limited                |             |         |  default + override   |
-| - each feature block              |  n.a.              |  Yes                         |            |         |                       |
+| Disambiguation targeting in links |  n.a.              |  No                          |             |         |  Yes, on explicit     |
-| Implementation                    |  Templates         |  Theme functions             |            |         |  Templates            |
+^ 3rd party integration             ^                    ^                              ^             ^         ^                       ^
-^ Developer features                ^                    ^                              ^            ^         ^                       ^
+| [[http://wiki.audean.com/g2/wishlist|Quality Agent]] |  No  |  No                     |             |         |  Yes                  |
-| XML-RPC API                       |  No                |  alphabar \\ latest \\ top \\ random \\ word of the day  |
+| Views: basic                      |  core              |  core + specific             |             |         |  core + specific      |
-| UI module separate from Data API  |  No                |  No                          |            |         |  Yes                  |
+| Views: default views              |  No                |  No                          |             |         |  Yes                  |
+| [[http://wiki.audean.com/g2/wishlist|Wikipedia]]  |  No  |  No                        |             |         |  Yes, with i18n       |
+| [[http://wiki.audean.com/g2/wishlist|Zeitgeist]] |  No  |  No                         |             |         |  Yes                  |
+^ Performance                       ^                    ^                              ^             ^         ^                       ^
+| memory needs/number of entries    |  O(n)              |  O(1)                        |  O(n) (?)   |         |                       |
+| speed on small glossaries         |  faster            |  slower                      |  slower     |         |                       |
+| speed on large glossaries         |  slower with size  |  remains constant            |  slower with size  |  |                       |
+^ Themeing                          ^                    ^                              ^             ^         ^                       ^
+| - home page                       |                    |  core                        |             |         |                       |
+| - search form                     |  Yes               |  core                        |  core       |         |                       |
+| - node overview                   |  Yes               |  core                        |  core       |         |                       |
+| - definition fields               |  n.a.              |  Yes                         |  Use CCK    |         |  core fields          |
+| - each feature block              |  n.a.              |  Yes                         |  Use Views  |         |                       |
+| Specific class on glossary links  |                    |  Yes                         |  Yes        |         |                       |
+| Implementation                    |  Templates         |  Theme functions             |             |         |  Templates            |
+^ Developer features                ^                    ^                              ^             ^         ^                       ^
+| XML-RPC API                       |  No                |  alphabar \\ latest \\ top \\ random \\ word of the day  |  No  |   |        |
+| Web services security             |  n.a.              |  IP-based access control \\ throttling  |  n.a.  |   |                       |
+| UI module separate from Data API  |  No                |  No                          |             |         |  Yes                  |
-Obviously, in all cases, a "No" actually means: "roll your own
-", as in all Open Source software.
+Obviously, in all cases, a "No" actually means: "roll your own", as in all Open Source software.
+====== Documentation ======
-===== Drupal 4.x to 6: Rationale for G2 specificities  =====
+  * Glossary
+    * [[http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/glossary/README.txt?view=markup|README]]
+    * [[http://drupal.org/node/196880|Handbook]]
+  * G2
+    * [[http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/g2/README.txt?view=markup|README]]
+    * [[http://wiki.audean.com/g2/start|Wiki]]
+  * Glossify
+    * [[http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/glossify/README.TXT?view=markup&pathrev=DRUPAL-6--1|README]]
-  * Optimization for large glossaries: this is the need expressed by OSInet, which funded development, to support its 5000+ term glossary of computing, for which glossary.module, even when coupled with flexinode to bind blob content to terms, is not really efficient enough.
-  * Single glossary: multiple glossaries were not necessary to OSInet, which funded development
-  * Explicit linking to terms with dfn elements:
-    * limits system workload
-    * allows invisible marking of entries made of other entries. Think: XML-RPC, points to XML and to RPC with glossary.module and various wiki filters, but can point to 'XML-RPC' with G2. Wrapping XML-RPC in quotes is necessary to allow linking to this entry in glossary, but the quotes remain visible, degrading the UI.
-    * allows redactor-level choice of
-      * whether to link to an entry: glossary always links if the term matches, which is not always meaningful ("and" can be present in a glossary and you don't want "and" to be linked from in all nodes on the site).
-      * where to link to an entry: glossary allows only a predefined set of positions (first, last or all matches)
-  * nodes vs terms: this is the most salient difference.
-    * Using custom nodes (g2_entry in g2.module) allows large definitions, with the complete drupal feature set for nodes,
-    * Using terms (glossary.module) allows definitions to be bound to custom nodes instead of being nodes on their own
-  * Alphabar maintenance: large glossaries will most of the time use all available initials, so the processing cost of maintaining it is not justifiable