Install/Uninstall instruction for the Geeklog tag plugin

Plugin Name	Tag plugin
Version	0.3.2
Author	mystral-kk - geeklog AT mystral-kk DOT net
License	GPL

ABSTRACT

Tag plugin enables you to put "tags" to your articles and make it easier for you and visitors to classify articles using the tags.

INSTALL

In the following descriptions

<geeklog_dir> is the directory where the system config.php file resides
<public_html> is the directory where the lib-common.php file resides
<admin> is the directory where the administration files reside (usually, under <public_html>)

Back up your Geeklog Database. The tag plugin adds tables to your Geeklog database. You can do this with the built in admin backup facility.
Uncompress the tag plugin archive while in the <geeklog_dir>/plugins directory. The archive will create a directory called tag in the plugins directory.
Create the public_html and admin directories. Under your html directory (usually <public_html>) create a directory called tag. Under your <admin>/plugins/ directory create a directory called tag.
Change to your <geeklog_dir>/plugins/tag/ directory. Copy the files in the admin directory to the <admin>/plugins/tag/ directory your created in step 3. Copy the files and directories in the public_html directory to the <public_html>/tag/ directory your created in step 3.
Edit the config.php in the tag directory and confirm the table prefix and anonymous access settings and other display settings. The default is to use the geeklog table prefix and not allow anonymous access.
Log in to your Geeklog as a root user and run install.php in your <admin>/plugins/tag/ directory. The install page will tell you if the install was successful or not. If not, examine Geeklog system errorlog for possible problems. The tag plugin should now be installed and functioning. Clicking on the tag Icon will take you to the admin page.
Set up security. On install only the root users have access to tag administration and Viewing. You can delegate control for either of these functions through the user and group editors.

UNINSTALL

Run the install.php page in your <admin>/plugins/tag directory. This will remove all the data from your database.
Delete the three plugin directories created in the install process: <geeklog-dir>/plugins/tag/, <public_html>/tag/ and <admin>/plugins/tag/

USAGE

When you are writing an article and want to put tags to it, just enter [tag:your_favorite_tag]in the article. You can use multiple tags like this:[tag:Geeklog 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 "Geeklog" will be identified with "geeklog" or "GEEKLOG".

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.
NOTE: Since version 0.2.0, a tag cloud block will be created automatically during installation.
The apperance of tag clouds are controlled with templates (in <geeklog>/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.
(Version-0.3.0 or later) 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.
NOTE: Since version 0.3.0, a tag menu block will be created automatically during installation.

Configurations by modifying <geeklog>/plugins/tag/config.php

You can change some behavior of tag plugin by modifying the above file. Available options are:

[Options]
Var name	Default Value	Description
$_TAG_CONF['default_block_name']	'tag_cloud_block'	The default name of tag block which will be created during the installation. If you use Geeklog-1.4.1 or later and disable/enable the tag plugin, the block named $_TAG_CONF['default_block_name'] will also be disabled/enabled automatically.
$_TAG_CONF['tag_name']	tag	Tag name to be used in items (articles), like '[tag:foo]'. You might prefer a shorter name like '[t:foo]'.
$_TAG_CONF['max_tag_len']	60	Max length of a tag in bytes. Should not be longer than 255.
$_TAG_CONF['tag_case_sensitive']	false	If this is true, the tag "Geeklog" will NOT be identified with the tag "geeklog". When you change this option, you should re-install tag plugin.
$_TAG_CONF['tag_stemming']	false	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 identidied 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_CONF['tag_stemming'] to true for the time being (and forever, maybe).
$_TAG_CONF['tag_check_badword']	true	Whether to use a list of bad words. If a tag is regarded as bad, it will be replaced with $LANG_TAG['badword_replace'] automatically.
$_TAG_CONF['tag_cloud_spacer']	(2 spaces)	A string to be used as a spacer in displaying tag clouds
$_TAG_CONF['max_tag_cloud']	30	Max number of tags to be displayed in tag clouds in public_html/tag/index.php
$_TAG_CONF['max_tag_cloud_in_block']	20	Max number of tags to be displayed in tag clouds in side block
$_TAG_CONF['tag_cloud_threshold'][X]	$_TAG_CONF['tag_cloud_threshold'][0] = 1 $_TAG_CONF['tag_cloud_threshold'][1] = 2 $_TAG_CONF['tag_cloud_threshold'][2] = 3 $_TAG_CONF['tag_cloud_threshold'][3] = 4 $_TAG_CONF['tag_cloud_threshold'][4] = 5 $_TAG_CONF['tag_cloud_threshold'][5] = 6 $_TAG_CONF['tag_cloud_threshold'][6] = 7 $_TAG_CONF['tag_cloud_threshold'][7] = 8 $_TAG_CONF['tag_cloud_threshold'][8] = 9	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.
$_TAG_CONF['replace_underscore']	false	Whether to replace an underscore included in tag texts with a space when a tag is displayed.
$_TAG_CONF['num_keywords']	0	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.
$_TAG_CONF['publish_as_template_vars']	false	If this is set to true, tags will NOT be displayed where they should be in the artcile, 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. This feature is valid for Geeklog-1.4.1 or later.
$_TAG_CONF['menu_indenter']		A string to indent an item of tag menu
$_TAG_CONF['add_num_items_to_menu']	false	Whether to add the number of items to each tag menu item. @note This feature could be a costly operation.

REVISION HISTORY

Version	Date	Description
0.3.2	2008-02-28	Fixed to better delete non-existent tags from database. Fixed to handle 'XHTML' constant properly when <meta name="keywords" content="foo,bar"> is published. Fixed to better handle underscores when $_TAG_CONF['replace_underscore'] is true.
0.3.1	2008-01-23	Fixed an error which happens when upgrading from version 0.2.0 to 0.3.0. New! Added an option to show the number of items next to tag menu items.
0.3.0	2008-01-22	New! Added a menu based on tags (experimental). New! Added an option to replace an underscore ('_') included in tag texts with a space. New! Added an option to publish most frequent tags in the <meta name="keywords" content="foo,bar"> tag in the head. New! Added an option to publish tags as template vars. See the above for detail.
0.2.0	2008-01-14	Fixed broken links to stories in tag clouds when URL_rewite is off. New! Now, the tag plugin will automatically rescan exisiting tags included in stories in case of re-installation. New! Now, you can delete wrongly registered tags in the admin panel. New! Now, a tag cloud block will be created automatically during installation.
0.1.0	2008-01-12	Initial version