Submitted by admin on Wed, 02/25/2009 - 11:09.

Installation and Configuration

System Requirements

In order to allow Marmoset to work, your Web server requirements are as follows:

Support PHP 4 or 5
CURL PHP extension should be enabled
The Web server should be allowed to establish outbound connections to http://api.opencalais.com/ (some Web hosting services disable outbound connections for security reasons, and allow such connections only upon specific request)

Installation

Extract the files in the package you downloaded. Under the public directory you will find a directory called calaismf. Copy this directory to a public location on your Web server.

Example

If your public root folder is /var/www/html copy the calaismf directory under /var/www/html. You should now have a new directory called /var/www/html/calaismf.

Configuration

Edit conf.php found under the calaismf directory that you copied to your Web server.

Find the line:

$calaismf_APIKey = "your-api-key-goes-here";

Replace the value within the double quotes with your OpenCalais API key. To obtain an API key please see http://opencalais.com/GetStarted. Make sure the key starts immediately after the first double quotes and ends immediately before the second double quotes. Do not insert any space characters.

It is recommended that you leave other values in conf.php at their original values. If you wish to make changes, the following table explains each value.

Name	Description	When to change
$calaismf_InvokeEnlightenTimeout	When invoking the OpenCalais Web service in order to inject semantic data for a search robot, this is the maximum time in seconds for the Web service to provide the results.	If you see that your pages do not include the additional semantic data in your tests try increasing this value.
$calaismf_UserAgentSubstringList	When a request is received Marmoset checks whether the HTTP User-Agent header field in the request includes one of the values in this list as a substring. If it does, the request is treated as a request by a search robot and Microformats data is injected. Otherwise, the original page is returned.	If you wish to provide Microformats data to additional search robots, and you know the User-Agent used by the search robot you can add the User-Agent or a substring to this list. Add a comma after the last double quotes, and insert the value, enclosed by double quotes, before the closing parenthesis. Important: Make sure the value you enter is specific, otherwise it might coincide with certain Web browsers, causing visitors to your site to see the Microformats data.
$calaismf_LogIdentity	When errors occur Marmoset outputs them to the system log (under Windows you can see these values in the Event Viewer). Marmoset will use the value to identify itself when writing error messages.	If you wish to see a different value in Calais Marmoset log messages, change this value to any other value.
$calaismf_ReltagBaseURL	This prefix will be attached to rel-tags returned inserted by Marmoset (see section below for details)	See section below

NOTE: Additional values in conf.php are for internal use and should not be changed.

ReltagBaseURL

The $calaismf_ReltagBaseURL is used as the base URL for OpenCalais generated Rel-Tags microformats. (More information about OpenCalais microformats support can be found in the OpenCalais API Documentation).

Rel-tags generated by Calais meet the rel-tag definition (http://microformats.org/wiki/rel-tag) and appear in this format:

<a href=”http://www.YourWebSite.com/YourPath/TagName rel=”tag”>Tag</a>

Note that this URL MUST exist; therefore the part provided by you (www.YourWebSite.com/YourPath/), which is the value of $calaismf_ReltagBaseURL in conf.php, along with the Calais generated tag must create a valid URL.

In many cases this link would look like this:

http://www.MyWebSite.com/Tags?name=CalaisGenerateTag

Where $calaismf_ReltagBaseURL = www.MyWebSite.com/Tags?name=

Calais adds/attaches the suggested Tag.

Attachment	Size
CalaisMarmoset_09May13.tar_.gz	13.39 KB
CalaisMarmoset_09May13.zip	22.67 KB