{ "info": { "author": "Derek Richardson", "author_email": "syndication@derekrichardson.net", "bugtrack_url": null, "classifiers": [ "Framework :: Plone", "Programming Language :: Python", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "===================\nvice.plone.outbound\n===================\n\n.. contents::\n\nWhat is it?\n===========\n\nvice.plone.outbound provides Plone with the ability to syndicate web\nfeeds (rss, atom, etc). It is configurable by users and extensible by\ndevelopers.\n\nPlone requirement: version 3.1\n\nFeatures\n========\n\nvice.plone.outbound gives you outbound syndication for all \"out of the\nbox\" Archetype Content Types (ATCT) and subclasses. Any folder (including\nthe site root) can be configured with any number of feeds. This can\nbe used to provide granular or bulk content feeds in multiple formats.\n\nAny feed can be set as recursive or not. A recursive feed will\ninclude all the content at the location of the feed as well as any\ncontent contained in sub-folders of the feed at any depth. A\nnon-recursive feed will only syndicate the content directly present at\nthe level of the feed.\n\nAuto discover can be set on any feed. This will enable modern\naggregators and browsers to \"sense\" the location of the feed by simply\nproviding the URL for the feed folder. NB only one feed per folder\n(location) should be configured with auto discover on.\n\nUsers may also include a \"Published URL\" on any feed. This will\nenable site managers to easily route all traffic through services like\n\"feedburner\", by first registering the local syndicated feed with\nfeedburner, and then entering the respective feedburner URL as the\n\"Published URL\" for the feed.\n\nEnabling or disabling feeds can be done for the whole site (see the\nadd-on product configuration for \"Syndication (Outbound)\" in the Plone\ncontrol panel), on any folder, or each feed itself.\n\nThere are global and per folder configuration options for the maximum\nnumber of items to be syndicated from any respective feed as well.\nThe modified date is used to sort all feed content, with the most\nrecently added or modified items appering first.\n\nInstallation instructions are in `INSTALL.txt`_.\n\n.. _INSTALL.txt: http://dev.plone.org/collective/browser/vice.plone.outbound/trunk/src/vice.plone.outbound/docs/INSTALL.txt\n\nHistory\n=======\n\n (name of developer listed in brackets)\n\nvice.plone.outbound - 1.0rc2 (not yet released)\n------------------------------------------------------------\n\n - Fixed reST errors and improved documentation [pbugni]\n\nvice.plone.outbound - 1.0rc1 To be released October 12, 2008\n------------------------------------------------------------\n\n - Removed viewlets and configlet on uninstall.\n [MatthewWilkes]\n\n - Add a doctest to show how to create new adapters for feeds and items.\n [pilz]\n\n - Turn off KSS validation of the feed config grid. Because the name is a\n required attribute, KSS was reporting an error unless name was filled in\n first. Now, the name field will only be checked for presence during\n server round trips. Thanks to Godefroid for the KSS hints!\n Was http://plone.org/products/vice/issues/6\n [pbugni and derek_richardson]\n\n - Use plone.browserlayer to prevent availability of pages and views until\n installation (via GS or quickinstaller). This solves the symptom where,\n when vice eggs were present but installation had not been finished,\n the vice eggs broke the Plone site.\n [derek_richardson]\n\n - Fixed http://plone.org/products/vice/issues/3\n (Autodiscovered feed inserts redundant tag )\n [pbugni]\n\nvice.plone.outbound - 1.0a1 Released April 29, 2008\n---------------------------------------------------\n\n - Change package name\n [derek_richardson]\n\n - Change to use vice.zope2.outbound\n [derek_richardson]\n\n - Add configlet icon\n [derek_richardson]\n\n - Add autodiscovery viewlet for Plone 3.1\n [derek_richardson]\n\n - Add portlet for feeds\n [tim2p]\n\n - Make published_url hideable on individual feed configs\n [derek_richardson]\n\n - Make recursion hideable on individual feed configs\n [derek_richardson]\n\nplone.app.syndication.oubound - 1.0a3 Released December 19, 2007\n----------------------------------------------------------------\n\n - Add metadata.xml to default GS profile, declaring version 1.\n Importing the profile will cause the global feed settings to be\n reset, so you'll need to reconfigure it through the site settings\n configlet. Hopefully this is the last time that will happen, as the\n new metadata.xml should prevent that in the future.\n [derek_richardson]\n\n - Display standard feed icons next to feed links in viewlet.\n [derek_richardson]\n\n - Store the ID on the FeedConfig annotation, so it cannot change.\n Fix bad ID generation, bug #002.\n [derek_richardson]\n\n - New SyndicationTool that delegates to global FeedConfig utility.\n Issues deprecation warnings when used.\n [matthewwilkes]\n\nplone.app.syndication.outbound - 1.0a2 Released October 24, 2007\n----------------------------------------------------------------\n\n - Published feed urls different from their internal urls\n [derek_richardson]\n\n - Remove '@@' view marker from feed URLs\n [matthewwilkes]\n\nplone.app.syndication.outbound - 1.0a1 Released October 15, 2007\n----------------------------------------------------------------\n\n - Initial release.\n [lots of people]\n\n\nInstallation\n============\n\nAssuming you have your buildout.cfg in an editor:\n\n1) Add ``vice.plone.outbound`` in your list of eggs to install, e.g.::\n\n eggs =\n vice.plone.outbound\n\n2) Tell the ``plone.recipe.zope2instance`` recipe to install a ZCML slug::\n\n zcml =\n vice.plone.outbound\n\n3) Configure the ``plone.recipe.zope2install`` recipe to use\n ``fake-zope-eggs``. In your buildout.cfg file, find the\n ``[zope2]`` section, and add ``fake-zope-eggs = true``::\n \n [zope2]\n fake-zope-eggs = true\n ...\n\n5) Re-run your buildout::\n\n $ ./bin/buildout -v\n\n6) Install from the control panel in plone\n\n7) Configure for use in the ``Add-on Product Configuration`` section\n in the Plone control panel.\n\n\nCustomization\n=============\n\nThis document talks about the various ways vice.plone.outbound may be\nextended.\n\nSyndicating new feed and item types - new adapters\n--------------------------------------------------\n\nYou can syndicate new feed types by writing new adapters for your feed types.\nIf you want a content type to be an item, adapt it to IFeedItem; if you want\nit to be a feed, adapt it to IFeed. If you look at atct.py in adapters/,\nyou will see plenty of examples - just do, in your own package, the type of\nthing that is done in this package. Also, there is an example of this type\nof customization in: \n\n`src/vice.plone.outbound/vice/plone/outbound/tests/adapting_contenttypes.txt`_\n\nModifying attributes of feed and item types - new adapters\n----------------------------------------------------------\n\nYou can change the way data is gathered from content types and turned into\nfeeds and items by writing a new adapter that performs in the way that you\nwish and overriding the stock Vice adapter. You can override the stock Vice\nadapters by changing the contents of DefaultFeedFormats or providing your own\nfeed format ovject to replace the default.\n\nChanging the body of a feed item - page templates\n-------------------------------------------------\n\nAll stock Vice feed items use a page template to render the body of the feed\nitem. You can customize the bodies, therefore, by plugging in new page \ntemplates that render the body in the way you prefer.\n\nCreating new formats - page templates\n-------------------------------------\n\nThe formats for Vice (rss1, rss2, atom) are governed by the page templates for\nformats that are available. You can add new formats by adding new page \ntemplates and wiring them up similarly to the stock formats.\n\nRemoving feed types - editing feed formats\n------------------------------------------\n\nIf you wish to remove formats that are provided by default with Vice (say, you \nonly want users to be able to create Atom feeds), you can do this by changing\nDefaultFeedFormats or by providing your own feed format utility.\n\n.. _src/vice.plone.outbound/vice/plone/outbound/tests/adapting_contenttypes.txt: http://dev.plone.org/collective/browser/vice.plone.outbound/trunk/src/vice.plone.outbound/vice/plone/outbound/tests/adapting_contenttypes.txt\n\nContact us\n==========\n\nPlease `file any bugs`_ you find. Join or mail the `discussion list`_\nto share comments and questions, or find us in the ``#vice`` IRC\nchannel on Freenode_.\n\nIf you'd like to contribute to future vice development, please join\nthe `developers list`_. We welcome contributions. More information\nis available at the `vice project`_ on `open plans`_.\n\n.. _file any bugs: http://plone.org/products/vice/issues\n.. _discussion list: http://www.openplans.org/projects/vice/lists/vice-discussion\n.. _developers list: http://www.openplans.org/projects/vice/lists/vice-squad\n.. _Freenode: http://freenode.net\n.. _vice project: http://www.openplans.org/projects/vice/project-home\n.. _open plans: http://www.openplans.org", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://www.openplans.org/projects/vice/", "keywords": "syndication atom rdf rss zope feeds plone", "license": "GPL", "maintainer": null, "maintainer_email": null, "name": "vice.plone.outbound", "package_url": "https://pypi.org/project/vice.plone.outbound/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/vice.plone.outbound/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://www.openplans.org/projects/vice/" }, "release_url": "https://pypi.org/project/vice.plone.outbound/1.0rc1/", "requires_dist": null, "requires_python": null, "summary": "Plone package for outbound syndication.", "version": "1.0rc1" }, "last_serial": 801384, "releases": { "1.0a1": [ { "comment_text": "", "digests": { "md5": "5500b33668a611fde38b7b152ad6e2d6", "sha256": "0f9d9c9ffd2bece66803c22daf2e514862659dce761a27ec099c99b948d567a0" }, "downloads": -1, "filename": "vice.plone.outbound-1.0a1-py2.4.egg", "has_sig": false, "md5_digest": "5500b33668a611fde38b7b152ad6e2d6", "packagetype": "bdist_egg", "python_version": "2.4", "requires_python": null, "size": 79743, "upload_time": "2008-05-03T20:10:49", "url": "https://files.pythonhosted.org/packages/82/e6/74adbf1ee9c510155fd7fc99fe7639908578742f140e2fb7c3f31709ccb8/vice.plone.outbound-1.0a1-py2.4.egg" }, { "comment_text": "", "digests": { "md5": "2bc7ff23c9c71598205fda8aaf228f78", "sha256": "f97f3768163f3c1df27768eef779ef6fb54437c7f8ab6adcbfdd26bda04d9891" }, "downloads": -1, "filename": "vice.plone.outbound-1.0a1.tar.gz", "has_sig": false, "md5_digest": "2bc7ff23c9c71598205fda8aaf228f78", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 36237, "upload_time": "2008-05-03T20:10:47", "url": "https://files.pythonhosted.org/packages/5d/88/f50e1473968e8dcb1e2c03b0b8768743c2679b85fb83570a2de3cb18eeda/vice.plone.outbound-1.0a1.tar.gz" } ], "1.0rc1": [ { "comment_text": "", "digests": { "md5": "4676b4dfb0b38168b241bf439b36588f", "sha256": "e23a1c43d63d27d801ed5974094367c86f62a2ad7ff13a9926274686ae96d685" }, "downloads": -1, "filename": "vice.plone.outbound-1.0rc1.tar.gz", "has_sig": false, "md5_digest": "4676b4dfb0b38168b241bf439b36588f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 45884, "upload_time": "2008-10-12T18:53:18", "url": "https://files.pythonhosted.org/packages/b6/25/39104ea30509af86b9300653a0438871de710663118d16b5fa07e356e7bd/vice.plone.outbound-1.0rc1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4676b4dfb0b38168b241bf439b36588f", "sha256": "e23a1c43d63d27d801ed5974094367c86f62a2ad7ff13a9926274686ae96d685" }, "downloads": -1, "filename": "vice.plone.outbound-1.0rc1.tar.gz", "has_sig": false, "md5_digest": "4676b4dfb0b38168b241bf439b36588f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 45884, "upload_time": "2008-10-12T18:53:18", "url": "https://files.pythonhosted.org/packages/b6/25/39104ea30509af86b9300653a0438871de710663118d16b5fa07e356e7bd/vice.plone.outbound-1.0rc1.tar.gz" } ] }