Made to Order Software Corporation Logo

MO Glossary: Main Page

Summary

Introduction to the MO Glossary module
Requirements
Installation
Security with this module.
Errors generated by this module.
Changes between versions
Copyright (c) 2009-2012 Made to Order Software Corp.

Introduction to the MO Glossary module

The MO Glossary module was created by Made to Order Software Corporation.

Back to Summary

Requirements

MO Glossary depends on the Taxonomy module since it is used to transform terms in your pages, terms that are defined in one or more taxonomies.

Back to Summary

Installation

In order to install this module:

  • Extract the tarball under sites/all/modules
  • On your server, feel free to delete the doc sub-folder (it is safe since it is just and only static HTML)
  • Go to admin/build/modules and select MO Glossary

Once the module was installed, you need to change the default settings to your liking and then attach the glossary taxonomies to your Input formats.

The main feature in the MO Glossary is an advanced input filter which checks your pages for terms that are defined in your taxonomy. For that reason, it is important for you to attach the MO Glossary filters to your input formats. Each filter can be used to replace terms in a different taxonomy and you have 5 available.

MO Glossary adds settings to the taxonomy and terms. Most of those settings are documented inline for your convenience. Terms can be checked off meaning that they will be ignored by the MO Glossary module. This can be useful if you use the same taxonomy for multiple purposes and some of the terms should not get defined in your pages.

Terms are defined in an MO Glossary taxonomy to be used as a definition or a link to another page. Each term can link to a different page, or the same page with a different anchor, or the default term page as defined by the Drupal Core taxonomy or the Taxonomy VTN module.

Back to Summary

Security with this module.

The MO Glossary module does not do anything that would otherwise be considered unsecure. However, it may generate links to pages that are not accessible by all users. This will be caught by Drupal when the user attempts to access those pages, but that means you'll get many 403 errors.

If you consider some of your taxonomies as secret, then be very careful to turn off the MO Glossary feature from those taxonomies.

By default, the MO Glossary input filter transforms terms by wrapping them inside an <abbr> tag with a title attribute. The title attribute is the term short definition if available, the long definition (i.e. description) if the short definition is not available. No link is generated.

It is a good idea to use the Taxonomy VTN module along the MO Glossary module if you want your users to read your definitions in a dictionary like environment.

Back to Summary

Errors generated by this module.

The module does not really generate errors. You may misuse the module and display things you would prefer to keep private, and a few other fun things, but it is not otherwise generating errors.

Back to Summary

Changes between versions

  • Version 1.6

* Increased the length of the anchor URL to 255 characters

  • Version 1.5

* Very much enhanced the use of anchors in the MO Glossary feature * Link to the term * Link to the VTN term * Link to a page * Link to a page #<term> * Offer multiple (5) input filters so we can make use of different link schemes and taxonomies * Updated the license

  • Version 1.4

* Added this documentation.

Back to Summary

Copyright (c) 2009-2012 Made to Order Software Corp.

http://www.m2osw.com/mo_glossary contact@m2osw.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Back to Summary
Documentation generated by Doxygen on Sat Mar 24 2012 23:03:00