MO Insert Taxonomy VTN: mo_insert_taxonomy_vtn.module File Reference
mo_insert_taxonomy_vtn.module File Reference
Definition of the MO Insert Taxonomy VTN filter. More...
Enumerations | |
| enum | MO_INSERT_TAXONOMY_VTN_VERSION |
Define the version of the MO Insert Taxonomy VTN module. More... | |
Functions | |
| mo_insert_taxonomy_vtn_help ($section) | |
| Display different help messages. | |
| mo_insert_taxonomy_vtn_filter ($op, $delta=0, $format=-1, $text= '') | |
| Define the filter itself. | |
| mo_insert_taxonomy_vtn_filter_tips ($delta, $format, $long=FALSE) | |
| Return tips on how to use the filter. | |
Detailed Description
The MO Insert Taxonomy VTN filter module transforms tags of the form [mo_taxonomy_vtn <name>] into the corresponding content of the taxonomy VTN.
You can view this as a way to include a view, a node or a block in one another.
Installation
In order to install this module, extract the files under sites/all/modules
Go to your Drupal website under admin/build/modules and select the module. You will find it under the package named Input filters. Once selected, hit save.
Now go to your site configuration menu and click on Input filters. Select the formats that should include the MO Insert Taxonomy VTN filter.
Rearrange the order of the filters as required. The MO Insert Taxonomy VTN is likely to fit anywhere.
Copyright (c) 2009-2011 Made to Order Software Corp.
http://www.m2osw.com/mo_insert_taxonomy_vtn 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.
Enumeration Type Documentation
This variable defines the version of the MO Insert Taxonomy VTN module. This will always be the same as the version defined in Drupal (throught the .info file.)
Function Documentation
| mo_insert_taxonomy_vtn_filter | ( | $ | op, | |
| $ | delta = 0, |
|||
| $ | format = -1, |
|||
| $ | text = '' | |||
| ) |
This function reacts to the filter operation ($op) as follow:
o list
Returns the list of filters. We have one at this time.
o description
Returns a brief description of the filter.
o no cache
We prevent the cache from being used. We may later offer a flag so each user can select what best fit their need. However, each time a node is added, each time the counter appearing in the list is increased. With cache you would not see that effect.
o prepare
Tweak the text being filtered which in our case means do nothing.
o process
This function processes the text and replaces the tags with the content of the Taxonomy VTN (unless the path is wrong.)
- Parameters:
-
[in] $op The filter operation such as list or description [in] $delta The filter being called (always 0 at this time) [in] $format The format using this filter [in] $text The text being filtered
- Returns:
- Mixed: depends on the operation.
| mo_insert_taxonomy_vtn_filter_tips | ( | $ | delta, | |
| $ | format, | |||
| $ | long = FALSE | |||
| ) |
This function is used by the system to retrieve the tips on how to use the filter.
- Parameters:
-
[in] $delta Expected to be 0 [in] $format The format where the filter is currently being used [in] $long Whether the short (false) or long (true) tips are returned
- Returns:
- A string with the filter tips.
| mo_insert_taxonomy_vtn_help | ( | $ | section | ) |
Implementation of hook_help().
- Parameters:
-
[in] $section The section that requestes a help message.
- Returns:
- A string with the help.
on Tue Jul 5 20:08:26 2011