Install/Uninstall instruction for the Geeklog Metatags plugin

Author: Kenji ITO (geeklog AT mystral-kk DOT net)
Version: 1.0.3
License: GPLv2 or later

Overview

The Metatags plugin allows you to set <meta name="keywords" content="some,key,words"> and <meta name="descrition" content="Some description"> meta tags in HTML <head> section according to the page content. Currently meta tags are supported in articles and staticpages.

INSTALL

In the following descriptions

<geeklog_dir> is the directory where the system db-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>)

Uncompress the metatags plugin archive while in the <geeklog_dir>/plugins directory. The archive will create a directory called metatags in the plugins directory.
Create the admin directory. Under your <admin>/plugins/ directory create a directory called metatags.
Change to your <geeklog_dir>/plugins/metatags/ directory. Copy the files in the admin directory to the <admin>/plugins/metatags/ directory your created in step 2.
Log in to your Geeklog as a root user and go to plugin editor and install "metatags" plugin. The install page will tell you if the install was successful or not. If not, examine Geeklog system errorlog for possible problems. The metatags plugin should now be installed and functioning.
You can configure the plugin through Configuration UI.

USAGE

First of all, go to Configuation and set "Default keywords" and "Default description" (see CONFIGURATION below).

The Metatags plugin uses Geeklog's autolink feature. If you have disabled it, please enable the feature in Configuration UI (Miscellaneous - Miscellaneous - Disable Autolinks).

In an article or a staticpage, if you write [meta:key comma_separated_keywords] as an autotag, this tag will be converted into <meta name="keywords" content="comma_separated_keywords">. Likewise, if you write [meta:desc description of the current page], the tag will be converted into <meta name="description" content="description of the current page">. In both cases, autotags themselves are not visible in the content except when you are logged in as an editor.

Caution: Your keywords and description MUST NOT contain a right square bracket(']').

CONFIGURATION

Once you have installed the Metatags plugin, it works well without manual configuration. However, if you would like to change the name of autotag (default value is 'meta') or keys translated into meta tag keys (default values are 'key' and 'desc'), you can set up the plugin through Configuration UI (http://yoursite/admin/configuration.php).

Autotag name: the name Geeklog recognizes as an autotag (meta in the above USAGE)
Replace: keys (the label left to an textarea) will be converted into meta tag keys (the string in an textarea) (key and desc in the above USAGE)
Important: keys not defined here will silently be ignored, so they won't appear as meta tags.
Default keywords (comma separated): keywords used globally when no article or staticpage is displayed, e.g., at the site's homepage
Default description: description used globally when no article or staticpage is displayed, e.g., at the site's homepage

ADVANCED

As some of you might have guessed, to tell you the truth, this plugin converts an autotag [meta:any_key any_value] into <meta name="any_key" content="any_value">. So any any_key will do, as long as it is defined in the above "Replace" setting.

UNINSTALL

Log in to your Geeklog as a root user and go to plugin editor and uninstall "metatags" plugin. This will remove all the data from your database.
Delete the two plugin directories created in the install process: <geeklog-dir>/plugins/metatags/ and <admin>/plugins/metatags/

That's it.

CHANGES

Version	Date	Detail
1.0.3	2009-04-24	[New] added an option as to whether to execute PHP in staticpages. Since v1.0.3, the metatags plugin does NOT execute PHP in staticpages by default.
1.0.2	2009-03-29	[Fixed] to properly generate default meta tags when no keywords or description tags are defined.
1.0.1	2009-03-25	[Fixed] an error occurring when you try to enabled the plugin. Thanks, Auge! [New] Added "ADVANCED" section to this document.
1.0.0	2009-03-24	[New] Initial release