Marcelo Origoni - mooTwits 1.0

mooTwits 1.0 Documentation

What's mooTwits?

mooTwits is a library that will allow you to retrieve your(or anybody else) latest tweets from twiter.

How to use it?

It's really simple, you just need mootools Core library
the file is included in the download, along with the mooCaption file.
You need to include the 2 files in betweend the <head> and </head> of your html code. and don't forget the style sheet.
then just add to your domready event, the call to mooTweets, something like:

	window.addEvent('domready', function(){
			new mooTweets('tweets');
		});

Which Properties you can pass to mooTweets, and which are the default values?

This are the available options:

type: 'user',
count: '5',
user: 'marceloOrigoni',
tweetTwit: 'tweet',
tweetText: 'text',
tweetDate: 'date',
tweetAuth: 'author',
tweetLoad: 'loading',
tweetPHP: './tweets.php',
dateFormat: 'mm/dd/yyyy hh:ii',
errorMessage: 'An Error Accoured While getting the latest Tweet'

type It's the type of statuses timeline to fetch from twiter, it can be either user or public. Public will bring the 20 ltest tweets, no matter the count number.
count The amount of tweets to bring, defaults to 5.
user the Twiter user, that you want to display the tweets, defautls to marceloOrigoni.
tweetPHP The location, relative to the webpage, of the tweets.php file, neeeded to get the JSON object.
dateFormat defaults to mm/dd/yyyy hh:ii, you can move around the letters, and replaced the / for any symbol. No short year for the moment. Any other string, than mm, dd, yyyy. hh or ii, won't be replaced
errorMessage In case something goes wrong, this error message will be displayed.
in Order to unserstand these 6 options, take a look at this code:

	<#container>
		<.twit>
			<.text />
			<.author />
			<.date />
		</.twit>
	</#container>

This is how mooTwits creates the twit element, and these options, set the classes, note the the #container, it's passed when you call mooTwits. tweetTwit The class for the container div of each tweet.
tweetText The class for the text.
tweetDate The class for the date div.
tweetAuth The class for the author anchor.
tweetLoad The class that will be assigned to #container, while the tweets are beign loaded.

I recommened to check the demo, since I'm not the best of the writers, when comes to write documentation, though, I think I made a descent job here.