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 Insert Taxonomy VTN (look under the "Input filters" package.)

Then go to admin/settings/filters to add your new filter to your existing formats. On websites where taxonomies are 100% public, the filter is safe for any user. If you somehow protect some taxonomies, know that the filter will let users access anyone of them. In Drupal, there is no access restrictions to Taxonomies by default.

: Back to Summary

Inserting Taxonomy VTN chunks

This module is a filter. It is found under the Input filters in the module installation and then under each Input format.

Once selected in a format, a new entry will appear under your text area with the tag definition:

[taxonomy_vtn:<path> <param>*]

The path is composed of 3 numbers:

The vocabulary identifier
The parent of the terms to be displayed
The maximum depth to be displayed

By default, the parent is assumed to be 0 and the depth to not be limited.

The parameters define the different capabilities of the Taxonomy VTN available to this filter. The following is a complete list of all the parameters available:

check-omit, ignore-omit

: Ask the system to check (not check) the omit list as defined in that taxonomy settings.

include-terms=<term-id>/<term-id>/...

: Show only the terms listed in that parameter. By default, display all the terms of the vocabulary or the included terms as defined in the taxonomy settings.

title-mode=<mode>

: Defines how the vocabulary title is to be displayed. The following modes are accepted:

: * none -- hide the title

: * inline -- display the title in an <h3> tag

: * title -- display the title in the Browser title bar

show-empty-terms, hide-empty-terms

: Show (hide) empty terms (i.e. terms that do not reference any nodes will be hidden.)

: This option requires the module to count the number of nodes linked with each term.

show-index, hide-index

: Show (hide) the letters before each set of terms.

show-count-nodes, hide-count-nodes

: Show (hide) the number of nodes attached to each term.

show-edit-link, hide-edit-link

: Show (hide) the edit link next to each term. Only administrators with the right permissions to edit a term will see that link.

show-voc-desc, hide-voc-desc

: Show (hide) the vocabulary description.

show-term-desc, hide-term-desc

: Show (hide) the term descriptions.

show-synonyms, hide-synonyms

: Show (hide) the term synonyms.

count-group-terms

: Define the number of letters to create a group of terms. This is the number of letters taken from each term. And each term is grouped by that set of letters.

: Valid values are 1, 2 and 3. The default is 1.

count-column-terms

: Define the number of columns to display the terms.

: Valid values are 1, 2 and 3. The default is 2.

term-goto

: The destination of the link of each term. The possible values are:

: * no_links -- do not create a link on the terms

: * nodes -- show a list of nodes (default)

: * taxonomy_term -- the list of term as defined by the Core taxonomy module

: * taxonomy_term_all -- all the terms as defined by the Core taxonomy module

: * taxonomy_view -- a view using path taxonomy_view/<vid>/<tid>

show-show-hide-description, hide-show-hide-description

: Show (hide) the Show/Hide Description link used to show and hide the term descriptions.

show-related, hide-related

: Show (hide) the related terms.

show-quick-index, hide-quick-index

: Show (hide) the quick index of letters at the top of the table.

break-quick-index, nobreak-quick-index

: Show the quick index on two lines (break) or a single line (nobreak).

show-statistics, hide-statistics

: Show (hide) statistics at the bottom of the total number of terms, nodes, etc.

content

: Show the current selection. This can be used to show the same list of terms with different options. Note that the path cannot be changed between calls to 'content.' However, you could use the include-terms option to display different terms with different options.

: This option is not required. If no content option was specified, then the content is automatically added. If one content is specified, then the automatic add is not applied. This means that if you have options defined after your last content, they are ignored.

more=<label>

: Create a more link that sends the users to the complete index of that vocabulary (i.e. taxonomy_vtn/voc/<vocabulary identifier>)

: The label is optional and defaults to "See more..."

link=<label>

: Display a link as defined by the path. The label is optional and defaults to the name of the vocabulary.

description

: Display the vocabulary description.

collapsible, collapsed

: Put the result in a collapsible or collapsed fieldset.

: Back to Summary

Errors generated by this module

When the syntax of the tag (i.e. [taxonomy_vtn:<path> ...]) has an error, then the tag is left alone in your page (i.e. nothing gets transformed.)

The tag can include a set of parameters. If a parameter is not understood, it is printed in red in the output of the filter. This way, you can immediately see what is wrong in your tag specification.

: Back to Summary

Changes between versions

* Version 1.4

Fixed the "terms-goto" in the documentation with "term-goto" as it was supposed to be. Just in case, added support for both in the code so it is backward compatible.

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

on Tue Jul 5 20:08:26 2011