mod/glossary/formats/README.txt

   1 $Id$
   2
   3 GLOSSARY FORMAT PLUGINS
   4 -----------------------
   5
   6 Starting with Moodle 1.4, the glossary module supports a plugin
   7 architecture to create your own formats. This plugin system allows
   8 you to "invent" your own presentations for your glossary data. :-)
   9
  10 To facilitate the creation process a TEMPLATE format has been created.
  11 You should use it as the base for your own modifications (this requires
  12 some basic PHP skills). The template includes all the available data.
  13
  14 Please, follow these STEPS:
  15
  16 1.-Think of an English word (or short phrase) to define your format.
  17    For further reference in this document, we call it "THENAME".
  18 2.-Duplicate the TEMPLATE directory (under mod/glossary/formats/TEMPLATE).
  19 3.-Rename it to THENAME
  20 4.-Go into the THENAME directory and rename the TEMPLATE_format.php file
  21    to THENAME_format.php
  22 5.-Edit the THENAME_format.php file. Change every ocurrence of TEMPLATE to
  23    THENAME.
  24 6.-Login into Moodle. Go to any glossary in your site.
  25 7.-Edit (configure) your glossary. In the Format popup you'll see a new
  26    entry. It will be showed as "displayformatTHENAME". Select it and view
  27    your glossary.
  28 8.-Edit the THENAME_format.php. Make your format modifications and reload your
  29    web page to see them in your glossary. This file has been commented to make
  30    things easier to understand (further suggestions welcome!)
  31 9.-If you want to translate your THENAME format name to some nice name to
  32    be showed in the Format popup, simply, edit your lang/XX/glossary.php
  33    file (where XX is your language) and create a new displayformatTHENAME
  34    string.
  35 10.-Enjoy!! (and don't forget to send your amazing glossary formats to
  36    the Glossary forum on http://moodle.org. They will be welcome!! ;-)
  37
  38 To talk about Glossary formats, go to:
  39     http://moodle.org/mod/forum/view.php?id=742
  40
  41 Eloy (stronk7)
  42 08/02/2004 (MM/DD/YYYY) :-D