MT Blogroll 2.12 Manual

Installation

  1. Extract the distribution and preserve the directories. The directories that have been extracted correspond to the directories in your Movable Type installation. Upload these directories to your Movable Type installation such that file structure looks like so:

    MT_DIR/
    |__ plugins/
    |  \__ Blogroll/
    |     |__ Blogroll.pl
    |     |__ mt-blogroll.cgi
    |     |__ update-links.cgi
    |     |
    |     \__ lib/
    |     |  \__ Blogroll/
    |     |  |  |__ Blogroll.pm
    |     |  |  |__ Category.pm 
    |     |  |  |__ Links.pm
    |     |  |  |__ Placement.pm
    |     |  |  |__ Update.pm
    |     |  \__ URI/
    |     |  |  |__ Escape.pm
    |     |  |  |__ Title.pm
    |     |
    |     \__ schemas/
    |     |  |__ Blogroll_schema.mysql
    |     |  |__ Blogroll_schema.postgres
    |     |  |__ Blogroll_schema.sqlite
    |     |
    |     \__ tmpl/
    |     |  |__ (18 .tmpl files)
    |
    |__ php/
    |  \__ plugins/
    |     |__ (18 .php files)
    

    Set the permissions of mt-blogroll.cgi and update-links.cgi to 755 and if the plugin was successfully installed, you should see something similar to this on the Plugins listing under System Overview.

    MT Blogroll Registration

  2. Enter the following into your address bar changing it as appropriate for your website and Movable Type installation

    http://www.yourdomain.com/path/to/mt/plugins/Blogroll/mt-blogroll.cgi
    

    On doing so, you will be greeted by the MT Blogroll Installation screen. Simply follow the instructions to install MT Blogroll. If the installing/upgrading screen appears to hang, empty your browser's cache. Recommended browser: Mozilla Firefox

Usage

Each blog in Movable Type is given its own individual blogroll. To access a blog's blogroll, go to its Menu and under Plugin Actions click Edit My Blogroll

MT Blogroll Link

Clicking this link will take you to a screen that looks similar to:

MT Blogroll Registration

As you can see, the screen closely resembles Movable Type. Actions available in MT Blogroll are listed along the left hand side — Add a link, Import OPML etc.

You can switch between blogrolls using the drop down menu at the top.

At any time, you can click the Back To Blog link to return to Movable Type.

To configure the gathering of last update times for blogs on your blogroll, go to the Plugins listing in System Overview and click Show Settings for MT Blogroll. You will see a screen similar to

MT Blogroll Recently Updated

To have MT Blogroll get the last update times:

  1. Check the Enable box which will cause further settings to appear.
  2. Chose a Duration. The value of this field will be used to evaluate the MTBlogrollEntryIfUpdated tag - the tag compares the time of rebuild to the link's last update time and if the difference is within the duration selected, the tag is evaluated as true.
  3. Enter your Technorati API Key. One can be obtained here
  4. You will need to periodically run the update-links.cgi script found in the MT Blogroll folder. The easiest way to do this is via a cron job. You can use the following command and set it at intervals that correspond to the duration you selected.

    cd /full/path/to/MT_DIR; ./plugins/Blogroll/update-links.cgi
    

The MTBlogrollEntryIfUpdated tag compares the time of rebuild to the link's last update time and if the difference is within the duration selected, the tag is evaluated as true. If you statically publish, this tag will only be evaluated at the time of rebuilding. As a result, if you want real-time checking, you'll need to use dynamic publishing.

However, you only need to create one dynamic template with the blogroll code in there and you can include that template into your static template using the following code (this template will need to be a PHP template - i.e. have a .php extension)

<?php
    include('<$MTCGIServerPath$>/php/mt.php');
    $mt = new MT(<$MTBlogID$>, '<$MTConfigFile$>');
    $mt->display("mt:templateid");
?>

where templateid is the ID of the dynamic template. For example, if my dynamic template had an ID of 35, I would use this code

<?php
    include('<$MTCGIServerPath$>/php/mt.php');
    $mt = new MT(<$MTBlogID$>, '<$MTConfigFile$>');
    $mt->display("mt:35");
?>

Template Tags

The following template tags are available and need to be used in your templates to display your blogroll. These template tags can be used in both static and dynamic templates.

MTBlogrollEntries

<MTBlogrollEntries>
...
</MTBlogrollEntries>

A container tag representing all the links in your Blogroll. The default is to display all links sorted ascending by priority. To alter this behavior, you can provide one of the following attributes:

  • blog_id="X" — Display the blogroll assigned to blog X, where X is the blog_id of the appropriate blog.

  • lastn="N" — Display the last N links (according to sort_order and sort_by below), where N is some number greater than 0.

  • offset="M" — Starts M links from the first (according to sort_order and sort_by below), then displays the remaining links (or the next N links if used in combination with lastn). For example, the following tag:

    <MTBlogrollEntries lastn="5" offset="5">
    ...
    </MTBlogrollEntries>
  • category="C" — Display all posts from the category with name C. Note that this can result in a long list of links, and you may want to use lastn to only display a certain number of links.

    If you wish to pull links from several categories, or to restrict links to those that are assigned to several categories, category name can include boolean AND and OR logic. Note that it can only include one or the other, however, so you cannot say Foo AND Bar OR Baz —that will not work. You can only say Foo AND Bar AND ... or Foo OR Bar OR ....

    For example, if you wished to list all links assigned to both Foo and Bar you could use:

    <MTBlogrollEntries category="Foo AND Bar">
    ...
    </MTBlogrollEntries>
  • author="A" — Display all links created by by the author with username A. Note that this result in a long list of links, and you may want to use lastn to only display a certain number of links.

  • sort_order="ascend|descend" — Specifies the sort order for this particular <MTBlogrollEntries> tag. Valid values are ascend and descend. The default value is ascend.

  • sort_by="field name" — Specifies the field by which to sort. Valid values are name, uri, priority and updated

Attributes of `MTBlogrollEntries` can be combined in arbitrary ways, for example:

<MTBlogrollEntries lastn="10" offset="10" category="foo" sort_order="ascend" sort_by="name">
...
</MTBlogrollEntries>

MTBlogrollEntryID

Each link in MT Blogroll is given a unique ID. This tag displays the ID of the link.

MTBlogrollEntryURI

A link's URI.

MTBlogrollEntryName

A link's name or title.

MTBlogrollEntryBlogAuthor

The name of the person who authors the link

MTBlogrollEntryDesc

A link's description

MTBlogrollEntryRel

MT Blogroll allows you to define an XFN Relationship for each link. This tag can be used to display this relationship. Typically it will be used within an anchor tag like so

<a href="<MTBlogrollEntryURI>" rel="<MTBlogrollEntryRel>">...</a>

MTBlogrollEntryIfRel

Not all your links may have an XFN Relationship hence you may find that some of your rel attributes are empty and as a result your pages no longer validate. This tag comes to the rescue, a conditional container tag that will display its contents only if the link has an XFN Relationship. Typical usage:

<a <MTBlogrollEntryIfRel>rel="<MTBlogrollEntryRel>"</MTBlogrollEntryIfRel>>...</a>

MTBlogrollEntryPriority

A link's priority

MTBlogrollEntryDate

The date the link was created. This tag can take the optional format and language attributes as described here

MTBlogrollEntryModifiedDate

The date the link was last modified within MT Blogroll, not to be confused with MTBlogrollEntryUpdated which displays the time the link was last updated.

This tag can take the optional format and language attributes as described here

MTBlogrollEntryCategory

The name of a link’s primary category

MTBlogrollEntryCategories

A container tag representing a list of all of the categories - including the primary category - to which the link belongs. Inside of this container you can use any of the MTBlogrollCategory tags to display information about each category.

You can supply this tag with the glue attribute to separate each of the categories, for example, to separate categories with a comma:

<MTBlogrollEntryCategories glue=", ">
    ...
</MTBlogrollEntryCategories>

Note: that the value of the glue attribute cannot contain a single or double quote.

MTBlogrollEntryTarget

A link’s target

MTBlogrollEntryUpdated

The time a link was last updated from Technorati. Note: MT Blogroll must be setup to gather last update times for this tag to work.

MTBlogrollEntryIfUpdated

A conditional container tag: the contents of this container will be displayed if this link has an update time that is within the duration constraint specified in the configuration.

This can be useful for manipulating recently updated links, for example the following code block will display *NEW* next to links that have been recently updated

<MTBlogrollEntryIfUpdated>*NEW*</MTBlogrollEntryIfUpdated>

MTBlogrollCategories

A container tag that represent all link categories in your blogroll. You can use any of the MTBlogrollCategory tags within this container to display information about your Link Categories.

You can also use MTBlogrollEntry tags to display links within each Link Category:

<MTBlogrollCategories>
    <MTBlogrollEntries>
        ..
    </MTBlogrollEntries>
</MTBlogrollCategories>

MTBlogrollCategoryLabel

The name of the category

MTBlogrollCategoryDesc

The description of the category

Examples

Here are a few examples of how to use the template tags.

  1. This code block will list all links in your blogroll with its description. The time the blog was last updated can be viewed up hovering over a link:

    <MTBlogrollEntries>
        <p><a href="<MTBlogrollEntryURI>" <MTBlogrollEntryIfRel>rel="<MTBlogrollEntryRel>"</MTBlogrollEntryIfRel> target="<MTBlogrollEntryTarget>" title="Last Updated: <MTBlogrollEntryUpdated>"><MTBlogrollEntryName></a><br />
    
        <MTBlogrollEntryDesc></p>
    </MTBlogrollEntries>
    
  2. This code block will go through each Link Category and list the links in the category along with its description. The time the blog was last updated can be viewed up hovering over a link:

    <MTBlogrollCategories>
        <h4><MTBlogrollCategoryLabel></h4>
    
        <MTBlogrollEntries>
             <p><a href="<MTBlogrollEntryURI>" <MTBlogrollEntryIfRel>rel="<MTBlogrollEntryRel>"</MTBlogrollEntryIfRel> target="<MTBlogrollEntryTarget>" title="Last Updated: <MTBlogrollEntryUpdated>"><MTBlogrollEntryName></a><br />
    
             <MTBlogrollEntryDesc></p>
        </MTBlogrollEntries> 
    </MTBlogrollCategories>
    

    Note: This will only work if you have created Link Categories and assigned links to them

About

This is part of the official user manual for MT Blogroll, a plugin for Movable Type by Arvind Satyanarayan.

More Information »

Screenshots

Click a screenshot to browse through the gallery or the arrows to flip through them

←→

I Heart Melody