https://github.com/devth/soliloquy.js

jQuery plugin for aggregating posts from many data sources
https://github.com/devth/soliloquy.js

Last synced: 9 months ago
JSON representation

jQuery plugin for aggregating posts from many data sources

• Host: GitHub
• URL: https://github.com/devth/soliloquy.js
• Owner: devth
• License: mit
• Created: 2010-03-05T19:18:35.000Z (almost 16 years ago)
• Default Branch: master
• Last Pushed: 2011-04-17T04:19:12.000Z (over 14 years ago)
• Last Synced: 2025-03-29T16:41:20.521Z (9 months ago)
• Language: JavaScript
• Homepage: http://devth.github.com/soliloquy.js/
• Size: 639 KB
• Stars: 7
• Watchers: 4
• Forks: 2
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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.](http://devth.github.com/soliloquy/docs/jquery.soliloquy.html)

## Demo

See [project page](http://devth.github.com/soliloquy/)

## Usage

     

      $(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 });

      });

     

    
 


## 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](https://github.com/devth/soliloquy/blob/master/src/jquery.soliloquy.js#L260-325) 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](http://github.com/devth/soliloquy/blob/master/LICENSE)