MO Tag: Main Page
MO Tag Documentation
1.4
Summary
Introduction to the MO Tag module
The MO Tag module was created by Made to Order Software Corporation.
The module is used to replace tags with the content of a taxonomy term description. For instance, to enter the version of a software, you can use [mo_tag software_version] instead of the version itself. That way, whenever you do an upgrade, the website pages all get updated at once without you having to edit every single page! Instead, you edit the 'software_version' term.
Note that those tags can be recursive (i.e. tag A references tag B that references tag C, etc.)
- Back to Summary
Requirements
MO Tag requires the Taxonomy module from Drupal Core.
It has no other requirements.
- Back to Summary
Installation
In order to install this module in Drupal:
- 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 Tag
This is it for the installation itself. Once install, though, you need to do some additional setup to get going:
- Taxonomy
Once installed, go to your taxonomies (admin/content/taxonomy). There you will see a new taxonomy named MO Tag. You may create others if you want. This is the default used by the system.
Edit the taxonomy and add one or more term. Make sure to enter a description since that is what will be added to your pages.
- WARNING: Do not use a term which name start with "no " or is the reserved keyword "off". You won't be able to access those.
- Input format
The module offers a new filter. In order to make use of the MO Tag module, it is important to add that new filter to your input format. (please, check the Potential security issues below for additional information in that regard.)
Go to your Input formats administration screen (admin/settings/filters). Click on the format where you want to add the MO Tag filter. Select the filter and click Save. Go back to that same format and click the Settings tab. Now you have the fieldsets of different filters, including the MO Tag filter. The settings form let you choose the taxonomy to use (MO Tag by default.)
If no taxonomies are available, then an error is displayed and a link gives you access to the taxonomy. (Watch out, if you click on the link you will lose your changes if any.)
- Terms
When a term becomes obsolete, you can go and edit it and mark it as disabled (uncheck the Enable checkbox.)
Creating a term that is automatically inserted is as easy. The terms settings is used for that purpose. As you mark a term as being automatically inserted, you, at the same time, define where the tag will be inserted (top, bottom or after a given paragraph.)
- Back to Summary
Potential security issues
This module gives a user access to all the descriptions of a taxonomy. It is wise to not just let all users access a taxonomy if it is private! To do so, make sure the users who don't have the right to see the content of the taxonomy do not have access to the Input formats that offer MO Tag on that private taxonomy.
- Back to Summary
Errors generated by this module.
The module generates errors when no taxonomy is available.
The module also handles recursivity (since an mo_tag can reference another mo_tag!) It will always prevent infinite loops causing an error to appear in place of the tag and to generate a Drupal error. We have the Drupal error because it helps the administrators to know there is a problem even if they don't themselves visit that page.
- Back to Summary
Copyright (c) 2009-2011 Made to Order Software Corp.
http://www.m2osw.com/mo_tag 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
on Sat Mar 12 16:25:23 2011