SimplePie 1.5 is now available!

SimplePie Documentation.  Learn how to use this thing.  It's way better than going to school.

You are here: Documentation » SimplePie Live! » Requirements and Getting Started

Differences

This shows you the differences between two versions of the page.

live:setup:start [2007/09/10 06:59]
admin
live:setup:start [2013/08/11 04:50] (current)
rmccue old revision restored
Line 1: Line 1:
 ====== Requirements and Getting Started ====== ====== Requirements and Getting Started ======
 This section contains the first steps for getting started with SimplePie Live! Ready to get started? This section contains the first steps for getting started with SimplePie Live! Ready to get started?
 +
 +===== Requirements =====
 +  - A fundamental understanding of JavaScript is required, and an understanding of //JavaScript Object Notation// (aka [[http://json.org/js.html|JSON]]) is highly recommended.
 +  - It would also be valuable to know how to generate HTML via JavaScript using DOM manipulation methods (so that you can dynamically add the feeds to your pages).
 +  - Lastly, it would be valuable for you to have the latest version of [[http://getfirefox.com|Firefox]] installed along with the [[http://getfirebug.com|Firebug]] extension.  Firebug is **the best** JavaScript debugging tool on the face of the entire planet... and it's easy to use.  Even if you're a hard-core user of another browser, you should still install this combination of tools to that you can more easily dig through the data.
  
 ===== Web Browsers ===== ===== Web Browsers =====
-Because SimplePie Live simply returns a JSON object of data, it is expected to work in ANY modern web browser, including (but not limited to): +Because SimplePie Live simply returns a JSON object of data, it is generally expected to work in ANY modern web browser. Howeveras we move forward, we will be following Yahoo's [[http://developer.yahoo.com/yui/articles/gbs/|Graded Browser Support]] in supporting A-grade web browsers.
-  * Firefox (and the rest of the Mozilla family of browsers+
-  * Internet Explorer 6.+
-  * Opera 8 +
-  * Safari 2+
  
-In truth, you're more likely to be restricted by the minimum requirements of any JavaScript Framework than you are by SimplePie Live!+Older versions of these browsers may also work as well, but we're pretty sure that these versions DO.  In truth, you're more likely to be restricted by the minimum requirements of any JavaScript Framework than you are by SimplePie Live!
  
 ===== Getting Started ===== ===== Getting Started =====
Line 16: Line 17:
 ==== Step 1: Load the base library ==== ==== Step 1: Load the base library ====
 First, you need to load the ''base.js'' file from the server by adding it to the ''<head>'' section of your page. First, you need to load the ''base.js'' file from the server by adding it to the ''<head>'' section of your page.
-<code html><script type="application/javascript" src="http://live.simplepie.org/app/0.5/base.js"></script></code>+<code html><script type="text/javascript" src="http://live.simplepie.org/app/0.5/base.js"></script></code>
 This file is less than 1k and includes the base functionality for requesting feeds and handling callbacks.  Besides gzipping it (to make it super small), we've also resisted the temptation to add non-critical code to it, so this file should always remain very small (our goal is to always stay at or below 1k). This file is less than 1k and includes the base functionality for requesting feeds and handling callbacks.  Besides gzipping it (to make it super small), we've also resisted the temptation to add non-critical code to it, so this file should always remain very small (our goal is to always stay at or below 1k).
  
Line 22: Line 23:
 Secondly, you can request a feed and define callback functions for successful and failed requests.  If you've ever worked with a modern JavaScript framework like [[http://prototypejs.org|Prototype]], [[http://jquery.com|jQuery]], or [[http://mootools.net|MooTools]] this will look pretty familiar.  I should also note that you don't need to use one of these frameworks to use SimplePie Live -- you're free to use plain ol' JavaScript if you want. Secondly, you can request a feed and define callback functions for successful and failed requests.  If you've ever worked with a modern JavaScript framework like [[http://prototypejs.org|Prototype]], [[http://jquery.com|jQuery]], or [[http://mootools.net|MooTools]] this will look pretty familiar.  I should also note that you don't need to use one of these frameworks to use SimplePie Live -- you're free to use plain ol' JavaScript if you want.
 <code html> <code html>
-var feed = new SimplePie(feedUrl, options);+var feed = new SimplePie(feedUrl, jsonOptions);
 </code> </code>
 Or, if you're looking for a more realistic example: Or, if you're looking for a more realistic example:
Line 43: Line 44:
 </code> </code>
  
-That's basically the jist of it.  If you need help on what configuration options are available, or what properties are available in the API, check out [[live:reference:start]].+That's basically the gist of it.  If you need help on what configuration options are available, or what properties are available in the API, check out [[live:reference:start]].

live/setup/start.1189407551.txt.gz · Last modified: 2011/03/06 03:56 (external edit)