zimki | documentation | search
 
Zimki Documentation - zimki.render.feed

Currently provided as an external library only -

  zimki.library.require('library', 'feed.js');

Usage:

  zimki.render.feed( feed properties, objects, mapping )

Where feed properties is:

  { title:"title of feed",
    link:"link to root of feed",
    type:"feed type - rss1, rss2, atom",
    description:"description of the feed",
    language:'en-us'
  }

Objects is either a raw class (for the simplest possible case) or an array of objects.

mapping looks like

  {
    title:"name of field containing the title, defaults to the 'name' property of the instance",
    description:"name of field containing description, defaults to 'content'",
    link:"url for object",
    date:"date of object - must return a Date object. Defaults to the creation_date of the instance",
    guid:'unique ID for object. Defaults to the ID of the instance',
    author:'author of the feed item. Defaults to the username of the instance owner'
  }

Parent

zimki.render