/*
NAME: TagListing
AUTHOR: Jay Allen, Textura Design
DATE: June 6, 2007
VERSION: 1.0
LICENSE: This code is licensed under the Artistic License
SUMMARY:
This library was developed to provide an easy method to output
Movable Type entry tags using Javascript to prevent spiders from
crawling the tag search links and kicking off CGI processes.
In addition, it provides for customizable output through use of
the DisplayTemplate library, which is a prerequisite. See
http://texturadesign.com/scripts/displaytemplate.js for more
information on that library.
PROPERTIES:
baseTagSearchURL - This convenience property allows you to specify the
base URL for your tag search without having to
define it for each tag listing or each tag. This
can be set either directly for the object or anywhere
before creating the object (e.g. the section)
through the baseTagSearchURL global variable.
template - This property defines the template to be used in creating each
linked tag. It contains the static markup for a linked tag
along with variable sections which are replaced by the value
of keys specified in the addtag() method. Alternately, you can
predefine this for all listings on a page through use of the
tagDisplayTemplate global variable. The default is
'[tagname]'
glue - This property defined the glue (if any) to be used between each
linked tag. You can predefine this for all listings using the
tagDisplayGlue global variable. The default is ", ".
strict - This controls whether or not the DisplayTemplate "strict" mode
is enabled. Please see that library's documentation for more
details. The default is enabled (1)
nocase - This controls whether or not the DisplayTemplate "nocase" mode
is enabled. Please see that library's documentation for more
details. The default is disabled (0) meaning case-sensitive keys.
limit - This optional attribute limits the output of tags to the specified
value. Default is no limit (0)
METHODS:
addtag - This method allows you to add a tag to a particular listing for
display. It takes as an argument a single object whose properties
and values define key/value pairs for string replacement in the
template in the compile() method.
compile - This method takes all tags added through the addtag() method,
formats them for display using the specified template and
concatenates them together using the value of the glue property.
It returns the entire formatted string for display on the page.
write - This convenience method calls the compile() method and then writes
the result to the page automatically.
EXAMPLE:
An example using minimal code to achieve the same tag listing as a basic
Movable Type installation. This example would be placed within the
context of an entry:
Tagged:
Here's a similar one but using MTTags and not within entry context:
Most popular tags on this blog:
A slightly longer example, not using any MT tags with some explanation
and other variables.
The previous example put into the context of a stripped down index
template:
<$MTEntryTitle$>
Tags:
Tags: None
*/
function TagListing() {
this.template = '[tagname]'
this.glue = ", "
this.strict = 1
this.nocase = undefined
this.limit = 0
this.tags = new Array()
if (window.baseTagSearchURL) this.baseTagSearchURL = window.baseTagSearchURL
if (window.tagDisplayTemplate !== undefined) this.template = window.tagDisplayTemplate
if (window.tagDisplayGlue !== undefined) this.glue = window.tagDisplayGlue
}
TagListing.prototype.addTag = function(tag) { this.tags[this.tags.length] = tag; }
TagListing.prototype.format = function(tag) {
if (tag.baseTagSearchURL == undefined)
tag.baseTagSearchURL = this.baseTagSearchURL
dt = new DisplayTemplate(this.template, tag)
dt.strict = this.strict
dt.nocase = this.nocase
return dt.eval()
}
TagListing.prototype.compile = function () {
if (this.baseTagSearchURL == undefined)
throw new Error("TagListing property 'baseTagSearchURL' not defined")
var tagarray = new Array();
var count = this.limit || this.tags.length
if (count > this.tags.length) count = this.tags.length
for (i=0; i