Tag Plugin v1.0.0

Tag plugin enables you to put “tags” to your content and make it easier for you and visitors to classify content using the tags. This allows you to implement a 'Tag Cloud' to highlight content on your site.

Requirements

  • glFusion v1.2.0 or newer

Installation

The Tag Plugin uses the glFusion automated plugin installer. Simply upload the distribtuion using the glFusion plugin installer located in the Plugin Administration page.

Upgrading

The upgrade process is identical to the installation process, simply upload the distribution from the Plugin Administration page.

Usage

When you are create content and want to associate tags with the content, enter

  [tag:your_favorite_tag]

in the editor. You can use multiple tags like this:

  [tag:glFusion plugins]

Each tag must be separated by a space. If you would like to register words as one tag, such as “Zend Framework”, you should enter “Zend_Framework”. By default, tags are case-insensitive. For example, the tag “glfusion” will be identified with “glfusion” or “GLFUSION”.

If you want to ban certain tags, you can do so in the admin control panel. Bad words are also case-insensitive.

If you would like to display “tag clouds” in your site block, just create a PHP block with the function name being phpblock_tag_cloud. This block is create automatically during the plugin installation.

The appearance of tag clouds are controlled with templates (in <glfusion>/plugins/tag/templates/) and Cascading Style Sheet (as <public_html>/tag/tag.css).

In case <public_html>/layout/your_theme/tag.css exists, this will be preferred over <public_html>/tag/tag.css.

If you would like to display a menu based on tags in your site block, just create a PHP block with the function name being phpblock_tag_menu. You can edit menu items in the admin control panel. This block is created automatically during the plugin installation.

The Tag Plugin supports all glFusion plugins, so you can include the tag auto tag in just about any type of content, including; Stories, Forum Posts, Media Gallery descriptions, DokuWiki pages, evList events, etc.

Configuration

You can control certain features of the Tag Plugin by modifying the following configuration options. The configuration options are set using the glFusion Online Configuration system: Command & Control → Configuration → Tag Plugin

Option Description
Default name for Tag Cloud Block The default name of tag block which will be created during the installation. If you disable/enable the tag plugin, this block named will also be disabled/enabled automatically.
Tag Name Tag name to be used in items (articles), like '[tag:foo]'. You might prefer a shorter name like '[t:foo]'.
Max length of tag in bytes Max length of a tag in bytes. Should not be longer than 255.
Tag case-sensitive If this is true, the tag “glFusion” will NOT be identified with the tag “glfusion”. When you change this option, you should re-install tag plugin.
Allow stemming words If this is true, each tag consisting only of alphabets will be stemmed. For example, tag “realize” will be stemmed into “real”, thus tag “realize” will be identified with tag “real”. WARNING: The stemming feature is still not perfect. For example, 'Firefox' is stemmed into 'Firefoxi'. So, I don't recommend you set tag_stemming to true for the time being (and forever, maybe).
Use list of bad words Whether to use a list of bad words. If a tag is regarded as bad, it will be replaced with badword_replace automatically.
String to be used as spacer in Tag Cloud A string to be used as a spacer in displaying tag clouds
Max number of tags in Tag Cloud Max number of tags to be displayed in tag clouds in public_html/tag/index.php
Max Number of tgas in Tag Cloud Block Max number of tags to be displayed in tag clouds in side block
Threshold of Tag Levels Thresholds of frequency of each tag cloud level. All tag clouds are classified in 10 levels (level 0..level 9). Those tags whose number is equal to or smaller than $_TAG_CONF['tag_cloud_threshold'][X] belong to level X. Each level corresponds to its own class in CSS (Cascading Style Sheet), so you can display in different styles tags according to their levels.
Replace an underscore with a space Whether to replace an underscore included in tag texts with a space when a tag is displayed.
Max number of keywords The number of key words to be included in <meta name=“keywords” content=“foo,bar”> tag. If the number is 0, the meta tag won't be included.
Publish tags as template vars If this is set to true, tags will NOT be displayed where they should be in the article, but will be published as template vars ({tag_label} and {tag_part}) which can be used in 'storytext.thtml', 'featuredstorytext.thtml', and 'archivestorytext.thtml'. If this is set to false, tags will be displayed in the article.
Default name for Tag Menu Block
String to be used as an indenter in Tag Menu A string to indent an item of tag menu
Display number of items in Tag Menu Whether to add the number of items to each tag menu item.
Display glFusion Blocks Select which glFusion navigation blocks to display when viewing the tag list page.

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

 
Logged in as: Guest (Guest)
tag/start.txt · Last modified: 2010/05/22 21:32 by Guest
 
Except where otherwise noted, content on this wiki is licensed under the following license:GNU Free Documentation License 1.2