Ma.gnolia Feeds Guide

From Ma.gnolia Community Wiki

Want to become a Ma.gnolia feed master? Here's a guide to all of our feed options. Be sure to share any of your own tips!

Contents 1 Full 2 Lite 3 Link Rolls 3.1 Additional Options 3.2 Custom Styling 4 JSON 4.1 Ma.gnolia JSON 4.2 Mirrord JSON 4.3 Parameters 5 Microformats 5.1 xFolk (RC1) 5.2 hAtom (0.1) 5.3 hreview (0.3) 5.4 All Combined 6 HTML

Full

• RSS (personal): http://ma.gnolia.com/rss/full/people/lhalff
• ATOM: http://ma.gnolia.com/atom/full/people/lhalff

Lite

• RSS (personal): http://ma.gnolia.com/rss/lite/people/lhalff
• ATOM: http://ma.gnolia.com/atom/lite/people/lhalff

Link Rolls

http://ma.gnolia.com/js/default/people/lhalff

Additional Options

You can add or modify the following parameters to the url in the src attribute of the Javascript tag.

• length=integer: Number of bookmarks to show. Default is 5, maximum is 20.
• byline=false: Don't show a byline after the bookmark list.
• title=string: Specify the title shown above your link roll.
• links=short: Use ma.gnolia short links.

Custom Styling

You can remove the default css declarations Ma.gnolia provides by changing "/js/default/" to "/js/none/". These are the classes that Ma.gnolia uses when displaing a link roll:

• A div with the class magnolia-linkroll wraps the entire link roll.
• The title is an h2 element with the class magnolia-linkroll-title
• The links are a definition list (dl) where each term (dt) is the bookmark title and link and the definition (dd) is the bookmark description.
• The dl element has a class of magnolia-mark and the anchor has a class of magnolia-link
• The dd element has a class of magnolia-description
• The byline, if shown, is a paragraph with a class of magnolia-byline

JSON

For all our flavors of JSON output, we provide the callback parameter, which is used as follows:

callback=function

Places the JSON output text in parentheses under a function name that you specify. For example:

http://ma.gnolia.com/json/default/bookmarks?callback=function_name

Ma.gnolia JSON

A Ma.gnolia JSON feed will create a Magnolia.bookmarks object, representing an array of bookmarks with the following attributes:

• id: string, short name
• url: string
• title: string
• description: string
• rating: integer, 1 to 5
• thumbnail: string, url to thumbnail image
• owner: object
• created: integer
• updated: integer
  • type: string, either "User" or "Group
  • id: string, screen name
  • name: string
• creator: object, see owner
• tags: array of strings

Mirrord JSON

This feed mirrors the format of the del.icio.us JSON output.

Parameters

Both feeds accept the following parameters:

• length=integer: Number of bookmarks. Default is 15, maximum is 100.
• raw: will remove the outer Magnolia or Delicious object.

Microformats

Ma.gnolia provides bare-bones HTML document bookmarks in various microformats feeds:

xFolk (RC1)

• URL schema (personal): http://ma.gnolia.com/html/xfolk/people/lhalff/
• URL schema (friends'): http://ma.gnolia.com/html/xfolk/people/lhalff/contacts
• URL schema (groups'): http://ma.gnolia.com/html/xfolk/people/lhalff/groups

hAtom (0.1)

• URL schema (personal): http://ma.gnolia.com/html/hatom/people/lhalff/
• URL schema (friends'): http://ma.gnolia.com/html/hatom/people/lhalff/contacts
• URL schema (groups'): http://ma.gnolia.com/html/hatom/people/lhalff/groups

hreview (0.3)

• URL schema (personal): http://ma.gnolia.com/html/hreview/people/lhalff/
• URL schema (friends'): http://ma.gnolia.com/html/hreview/people/lhalff/contacts
• URL schema (groups'): http://ma.gnolia.com/html/hreview/people/lhalff/groups

All Combined

• URL schema (personal): http://ma.gnolia.com/html/micro/people/lhalff/
• URL schema (friends'): http://ma.gnolia.com/html/micro/people/lhalff/contacts
• URL schema (groups'): http://ma.gnolia.com/html/micro/people/lhalff/groups

HTML

Want to modify the way the html feed is styled? We mirror the options that del.icio.us provides, so you can add the options below to the URL.

To add these options to your URL, add a question mark (?) and an ampersand (&) to the end of your HTML feed. Separate each option with an ampersand.

• count=integer: Number of bookmarks. Default is 15, the maximum is 100.
• bullet=string: Specifies the the html entity for the bullet. Don't include the surrounding "&amp" or ";"; or, set it to empty to remove. The default is "raquo".
• extended=description: Display the description after the title.
• extendeddiv=yes: Wraps the description in a div if description is displayed.
• extendedclass=string: Specify the class of the description div if shown.
• divclass=string: Specifies the class of div that surrounds each bookmark. Default is "delPost".
• aclass=string: Specifies the class for the bookmark link. Default is "delLink".
• tags=no: Don't show tags.
• tagclass=string: Specified the class for each tag link. Default is "delTag".
• tagsep=string: Specifies the character or string to separate a bookmark's tags from the title and description. Default is "/".
• tagsepclass=string: Specifies the class of the span that contains the tag separator. Default is "delTagSep".
• rssbutton=no: Don't show a RSS feed button to this bookmark list