µMint Plugin README:

Contents

• Information
• Installation
• Notes
• Known Issues

Information:

• Version 0.4
• Release Date: 5 December 2008
• Plugin Homepage: http://compu.terlicio.us/code/plugins/mint/
• Plugin Author: Christopher O'Connell

Installation:

The most basic installation simply requires that you upload the 'micromint' folder to your /wp-content/plugins directory. Then, from the Administration -> Plugins menu, simply activate the plugin and indicate where Mint is installed. Now the Mint tracking code is automatically inserted into wordpress. Done.

In order to integrate statistics into WordPress, you need to install an API for Mint. There are currently two supported options, the Exposé pepper, by Adam Livesley or the µAPI which is heavily based on the Exposé code, with some improvements. The µAPI is distributed along with this package. In the future, I hope to discontinue the µAPI and simply provide an exposure for Exposé, but at this time it is not mature enough to be the reccomended option. Although both pepper are supported, at this time I reccomend the µAPI pepper for several reasons:

• Although somewhat convoluted there is a way that the Exposé pepper can expose priveledged information. µAPI patches this.
• The µAPI includes better formed, XML based error responses, allowing the client application to integrate better.
• The µAPI is currently 100% compatible with Exposé exposures, as it uses the same serializer.
• µAPI has been more extensively tested with this release.

Please Note: You cannot have both Exposé and µAPI installed concurently. If you already have Exposé installed (with Firemint, for example), you should simply drop the included /exposures/micro.php file into the /exposures folder of your Exposé installation

To install the API (installation is the same for both), simply upload the pepper to the appropriate folder in mint (/pepper/chrisoconnell/ and /pepper/84degrees/ for µAPI and Exposé respectively). Go to the Mint control panel and enable the API. Enter an API key. If you are using the Exposé API, make sure that the micro.php file is in /pepper/84degrees/expose/exposures/.

In WordPress goto 'Settings > µMint'. Change your mint URL if neccessary. Select "Integrate Mint statistics into WordPress?". Select the appropriate API and enter the API key.

To setup the sidebar widget, visit 'Design > Widgets'. You can manually configure which datafields are displayed as well as display labels for different data.

Notes:

• As of this release, the local integration is not currently shipping with the plugin. I had several instances of mass data corruption on the testbed, and don't want to ship this integration until I am comfortable with the data integrity. The theory is that in an installation where WordPress and Mint both share a database, WordPress will simply query the Mint datatables directly without needing the API
• You cannot have both the µAPI and the Exposé API installed at the same time.
• Stats are only fetched every 10 minutes and cached. If you need a different value, you can edit the $MICROMINT_INTERVAL value at the top of microMint.php. This needs to be something which can be fed into php strtotime function.
• If you want to update the stats right now, or just want to see some debugging information, append &debug to the end of the µMint configuration page. This will both print debug information as well as perform and immediate update
• If you absolutely have to change the widgets, edit microMint.widget.php (sidebar) and mircoMint.dashboard.php

Known Issues:

• When used with the Exsposé API, error information is not that imaginative.
• Please post any questions or bugs on the Version Installation Page. Feature requests and comments of a more general nature should go on the Home Page. The author can be contacted here.
• API Keys with non-alphanumeric characters may not work.