1 line
8.0 KiB
JSON
1 line
8.0 KiB
JSON
{"name":"OSync","body":"# The OSync Specification\r\n\r\n## Why OSync?\r\nSure we have RSS, RDF, and Atom which I have been working with for many years. There is one big issues with these formats… They all use XML which tends to be wordy and more importantly XML is overly complex to parse especially in languages like Javascript, PHP, Ruby and Python. However JSON thankfully is!\r\n\r\nWhile developing this format I set out with the following goals:\r\n\r\n* Easy/fast to parse and implement\r\n* Make it so feeds and items are location aware\r\n* a proper tagging system for feeds/items/attachments\r\n* multiple attachments\r\n* Able to be used cross-site/domain\r\n* Uses JSONP\r\n* Incorporate some of the RSS extension elements that were used in common implementations\r\n\r\n## Specification\r\n### Main Elements\r\n* id: Unique ID for the feed itself, great for using in conjunction with SUP, PubSubHubbub or rssCloud\r\n* hub: A central place to see which OSync feeds have been updated. Usually a location for a servers SUP, PubSubHubbub or rssCloud location (Optional)\r\n* title: Title of the feed\r\n* subtitle: Subtitle for this feed (Optional)\r\n* summary: A short description of this feed (Optional)\r\n* permalinkUrl: permalinkUrl to where on this content came from\r\n* lang: Based on the W3C standard language codes\r\n* copyrite: A string describing the copyrite for this feed\r\n* copyriteImage: Image representation of copyrite, such as a Creative Commons logo (Optional)\r\n* location: See Location (Optional)\r\n* postedTime: Date the feed was first published in ISO 8601 format example: 2009-08-05T11:17Z\r\n* updatedDate: Last time the feed was updated (Optional)\r\n* generator: What application/script created this output. Helpful for debugging. (Optional)\r\n* categories: See Categoies (Optional)\r\n* image: Should be a square .jpg image that is at least 600 x 600 pixels\r\n* thumbnail: A thumbnail version (32x32) of the image in the ‘image’ key\r\n* items: A list of items (see below for item description)\r\n\r\n### Globals\r\n**Location**\r\n\r\n* name: The name for the location (Optional)\r\n* address: Street Address (Optional)\r\n* city: City, Town, or Village for the location (Optional)\r\n* state: State or Provence (Optional)\r\n* zip: ZIPCODE or Postal Code (Optional)\r\n* latitude: Latitude (Optional if longitude not specified)\r\n* longitude: Longitude (Optional if latitude not specified)\r\n\r\n**Categories**\r\n\r\n* categories: A list of categories/keywords/tags that you wish to associate with this item\r\n\r\n### Items\r\n* id: Unique ID for this item\r\n* title: title for this item\r\n* permalinkUrl: Permanent URL of where to find this item\r\n* sources: A list of sources for this item. Sites like digg.com might want to specify the original article here. (Optional)\r\n* location: See Location (Optional)\r\n* postedTime: Date item was first published in ISO 8601 format example: 2009-08-05T11:17Z\r\n* updatedDate: Last time the item was updated (Optional)\r\n* summary: A short description of this item (Optional)\r\n* body: The full text for this item\r\n* author: Defines the author for this item (see below for description)\r\n* contributors: a list of authors that also contributed to this item (see author description below) (Optional)\r\n* categories: See Categoies (Optional)\r\n* attachments: A list of attached resources for this item (see below for description) (Optional)\r\n\r\n**Author**\r\n\r\n* name: Full name of the author\r\n* permalinkUrl: Permanent URL of where you can find the author online\r\n* email: E-Mail address of where you can contact the author (Optional)\r\n\r\n**Attachments**\r\n\r\n* id: Unique ID for this attachment\r\n* filename: Allows you to specify a specific name for this file (Optional)\r\n* permalinkUrl: Permanent URL of where to find this attachment\r\n* postedTime: Date item was first published in ISO 8601 format example: 2009-08-05T11:17Z\r\n* mimeType: mime-type that defines what type of attachment this is\r\n* bytes: Attachment size in bytes\r\n* duration: Duration in seconds, should be specified if type is audio or video (Optional)\r\n* location: See Location (Optional)\r\n* categories: See Categoies\r\n* hash: Hash for the file. Hashes are useful to help the consumer that they downloaded the file correctly. Prefix hashes with the hashing algorithm followed by a dash for example “md5-5b7c86d36cf17ada4853b1cbbdedf47f” (Optional)\r\n* explicit: Does the content contain explicit material? False if not specified (Optional)\r\n* hidden: This should stop a consumer from showing this file in their UI. False if not specified (Optional)\r\n\r\n### Example\r\n```\r\n{\r\n \"categories\": [\r\n \"web\",\r\n \"formats\",\r\n \"specifications\"\r\n ],\r\n \"copyrite\": \"Creative Commons Attribution-Noncommercial-No Derivative Works 3.0\",\r\n \"copyriteImage\": \"http://creativecommons.org/images/public/somerights20.png\",\r\n \"generator\": \"TextMate http://macromates.com/\",\r\n \"id\": \"c4dfcb75-8cd5-47e1-8a09-b19141ec2df8\",\r\n \"image\": \"http://www.osync.org/media/osync-600x600.jpg\",\r\n \"items\": [\r\n {\r\n \"attachments\": [\r\n {\r\n \"bytes\": 228223,\r\n \"duration\": 923282,\r\n \"explicit\": false,\r\n \"filename\": \"osync-podcast-01.mp3\",\r\n \"hash\": \"md5-6c6d81147f00bd6adb710d22bfe69f05\",\r\n \"hidden\": false,\r\n \"id\": \"25746ef0-b362-4d38-b4e6-a0443c634d7e\",\r\n \"permalinkUrl\": \"http://www.osync.org/pcasts/osync-podcast-01.mp3\",\r\n \"postedTime\": \"2009-08-05T11:17Z\",\r\n \"type\": \"audio/mpeg\"\r\n }\r\n ],\r\n \"author\": {\r\n \"email\": \"ray.slakinski@gmail.com\",\r\n \"name\": \"Ray Slakinski\",\r\n \"permalinkUrl\": \"http://www.slakinski.com\"\r\n },\r\n \"body\": \"We lauched OSync today! we had a big party and it was all kinds of fun. I hope you like it!\",\r\n \"categories\": [\r\n \"web\",\r\n \"formats\",\r\n \"specifications\"\r\n ],\r\n \"exeprt\": \"We lauched OSync today!\",\r\n \"id\": \"fd8e3a0e-5786-4583-9baa-bb65537eed70\",\r\n \"location\": {\r\n \"address\": \"2383 Dundas Street West\",\r\n \"city\": \"Oakville\",\r\n \"latitude\": 43.439957,\r\n \"longitude\": -79.772071999999994,\r\n \"name\": \"Funky Thai\",\r\n \"state\": \"Ontario\",\r\n \"zip\": \"L6M3X2\"\r\n },\r\n \"permalinkUrl\": \"http://www.osync.org/posts/osync-launched\",\r\n \"postedTime\": \"2009-08-05T11:17Z\",\r\n \"sources\": [\r\n \"http://www.osync.org\"\r\n ],\r\n \"title\": \"OSync Launched!\",\r\n \"updatedDate\": \"2009-08-05T11:17Z\"\r\n }\r\n ],\r\n \"lang\": \"en\",\r\n \"location\": {\r\n \"address\": \"2383 Dundas Street West\",\r\n \"city\": \"Oakville\",\r\n \"latitude\": 43.439957,\r\n \"longitude\": -79.772071999999994,\r\n \"name\": \"Funky Thai\",\r\n \"state\": \"Ontario\",\r\n \"zip\": \"L6M3X2\"\r\n },\r\n \"permalinkUrl\": \"http://www.osync.org\",\r\n \"postedTime\": \"2009-08-05T11:17Z\",\r\n \"subtitle\": \"Content Syndcation via JSONP\",\r\n \"summary\": \"All the news you can use about your favorite new web syndication format OSync\",\r\n \"thumbnail\": \"http://www.osync.org/media/osync-32x32.jpg\",\r\n \"title\": \"News about OSync\",\r\n \"updatedDate\": \"2009-08-05T12:17Z\"\r\n}\r\n```\r\n","tagline":"OSync Specification: Syndication with JSON","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} |