• use cases

  last modified August 20, 2007 by derek

These are potential scenarios (use cases) we hope to fulfill with vice

  1. GT wants recursion ... sometimes
    1. syndicate a container
    2. syndicate a container and all syndicatable subcontainers recursively
  2. Visibility
    1. a named feed should have a state (enabled | disabled) for public accessibility
  3. Multiplicity and Naming
    1. Allow for naming individual feeds, not just relying on another object attribute
    2. Allow multiple feeds per container to fulfill differing requirements on same content
    3. Each feed is configurable by recursion / no recursion

    4. Each feed has a version of RSS syndication associated with it (e.g. RSS 1.0, RSS 2.0 or Atom)

  4. Atom support
    1. Need to interoperate with feedfeeder for inter-site usage
  5. RSS 2.0 support
    1. PLIP 128 requires it
  6. iTunes support
    1. Provide iTunes as a format for syndication (using iTunes namespace)
  7. Make syndication formats pluggable / adaptable to accomodate other formats
    1. We can't decide what to support / not support
    2. PLIP #128 requires it
  8. Pluggable syndication configuration
    1. want to be able to configure feed filters based on workflow support
      1. not part of synz
      2. pleasure will have to adapt synz configuration
    2. whit: "Walk up to a container object, tell it you want *these* types of objects listed with *these* limitations ..."
  9. Make a site syndicatable by putting the slug in; turn off syndication by pulling it out
  10. Initial State
    1. all syndicatable items are eligible for syndication by default but are not syndicated
    2. cases of migration from earlier versions of Plone will be handled by pleasure (the plone-based layer of vice)
  11. Configure feeds either through
    1. a tab or
    2. through a viewlet
  12. Basic configuration
    1. feed name/label,
    2. on/off,
    3. format (rss2.0, atom, etc),
    4. feed limit (count or days),
    5. recursivity / nestedocity
  13. Access feeds through a viewlet
    1. should display either horizontal or vertical, depending on shape of the slot
    2. should include standard icons for feed format types, if available
  14. Syndicate containers as feeds and content as items
  15. Syndicate content as feeds and versions as items
  16. Zope 3
    1. Needs to work in Zope 3.3.1
    2. Needs to adhere to Zope 3 "best practices" (zcml, interfaces, pluggability, etc)

Design

  • Annotations will be used to mark items as syndication feeds and to configure them

stories