jQuery plugin for aggregating posts from many data sources
JavaScript
Pull request Compare This branch is 1 commit ahead, 2 commits behind devth:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
lib
src
.gitignore
CHANGELOG.md
LICENSE
README.md
VERSION
index.html

README.md

Soliloquy

Soliloquy is a jQuery plugin that aggregates posts from various data sources ("solos") and outputs them as structured HTML. It makes no assumptions about your design or formatting preferences and defaults to a minimalistic layout that's ready to be styled with CSS.

Read the annotated source.

Demo

See project page

Usage

<script type="text/javascript" charset="utf-8"> 
  $(function(){  
    $('.feed')
      .slq().facebook({ username: 'CriterionCollection', posts: 8, relativeDates: false } )
      .slq().twitter({username: 'devth', posts: 6, relativeDates: false })
      .slq().twitterList({username: 'rails', listname: 'core', posts: 2 })
      .slq().lastfm({ username: 'trevorhartman', apiKey: '930dbe080df156eb81444b27a63d948b', relativeDates: false });
  });
</script> 
<div class="feed"></div> 

Solos

A solo is a data source accessed via an API. Soliloquy's goal is to support many solos and make it extremely quick and easy to add additional solos. To facilitate this, AJAX data retrieval is abstracted away as much as possible, leaving the absolute necessary pieces to be described for each module. Each solo is comprised of:

  • Options: public options allowing user to set required fields (e.g. username on twitter) and optional settings (e.g. relativeDates: false).
  • Settings: internal settings that include properties such as the external API url and the local function to parse the data and create the HTML.

The soliloquy core then parses these objects and provides an interface for a user to call them. The abstracted architecture makes it simple to add new data sources as they come along. See the solos section of the source for examples.

Soliloquy currently supports the following solos:

  • Twitter twitter(options)
  • Twitter Lists twitterList(options)
  • Last.fm plays lastfm(options)
  • Facebook wall feeds facebook(options)

Contributing

Fork the project, add/improve solos and send a pull request.

License

Copyright (c) 2011 Trevor C. Hartman
Released under the MIT License