Made to Order Software Corporation Logo

MO Glossary: mo_glossary.admin.inc File Reference

Forms to administer the mo_glossary setup. More...

Functions

 _mo_glossary_settings_form ($format)
 MO Glossary filter settings form.
 get_tag_options ()
 Get the array of supported tags.
 _mo_glossary_taxonomy_form (&$form)
 Add a few fields in the taxonomy vocabulary form.
 _mo_glossary_terms_form (&$form)
 Return the form while editing terms.

Detailed Description

Implementation of the MO Glossary module administration functions.

This includes the setup function for Input filters and the terms form alteration.

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.


Function Documentation

_mo_glossary_settings_form ( format)

This function is called when the user edits the configuration options of the Input filter using the MO Glossary module.

Parameters:
[in]$formatThe format being configured
Returns:
A form array used by the Input format configuration screen

Referenced by mo_glossary_filter().

_mo_glossary_taxonomy_form ( &$  form)

This function adds settings in the taxonomy that the user can tweak to change the default behavior of the glossary terms.

Parameters:
[in,out]$formThe form that will be modified

References get_tag_options().

Referenced by mo_glossary_form_taxonomy_form_vocabulary_alter().

_mo_glossary_terms_form ( &$  form)

This function adds a few boxes to the Terms form in order for the user to be able to define how to handle the term with the MO Glossary filter.

Parameters:
[in,out]$formThe form we want to alter

References get_tag_options().

Referenced by mo_glossary_form_taxonomy_form_term_alter().

get_tag_options ( )

This function returns the array of tags that this module supports. Any one of those tags can be used for any one term. The user can defined a default in the Taxonomy form so it is easier to manage especially in case of a Site Index or similar tag definition.

Returns:
The list of tags as a select '#options' array.

Referenced by _mo_glossary_taxonomy_form(), and _mo_glossary_terms_form().

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