Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

add docs; prep for release

svn path=/collective.sharerizer/trunk/; revision=112173
  • Loading branch information...
commit e1ecb6e912c18cb7f9cbffd084e34d018b9f5da1 1 parent 6d4d73b
@davisagli davisagli authored
View
4 CHANGES.txt
@@ -1,8 +1,8 @@
Changelog
=========
-1.0 - Unreleased
-----------------
+1.0 - (2010-03-02)
+------------------
* Make sure the code is rendered even if there are no other active document
actions.
View
42 README.txt
@@ -1,4 +1,42 @@
-Introduction
-============
+Overview
+--------
+collective.sharerizer makes it easy to add a 3rd-party widget to the Plone
+document actions area to share a page via various methods.
+It does not assume the use of any particular 3rd-party tool, but instead
+provides a control panel where the relevant Javascript widget from the desired
+tool can be pasted. Some tools that could be used are `Add to Any`_ and
+`ShareThis`_.
+
+.. _`Add to Any`: http://www.addtoany.com/
+.. _`ShareThis`: http://sharethis.com/
+
+Configuration
+-------------
+
+Install collective.sharerizer via the quick installer or Add/Remove Products
+control panel.
+
+Now, in Site Setup, there is a new control panel called Sharerizer Settings.
+Here you can paste the Javascript snippet for your sharing widget of choice.
+
+There is also an unrelated option which enables icons for the document actions.
+These icons must be configured for each action in the ZMI, within portal_actions.
+
+
+Compatibility
+-------------
+
+collective.sharerizer is compatible with Plone 3 and Plone 4.
+
+It operates by overriding the document actions viewlet, so is not compatible
+with other add-ons or themes that do the same thing.
+
+
+Credits
+-------
+
+collective.sharerizer was built by `Groundwire`_.
+
+.. _`Groundwire`: http://groundwire.org
View
2  collective/sharerizer/tests/test_doctests.py
@@ -9,7 +9,7 @@ def test_suite():
# Demonstrate the main content types
ztc.FunctionalDocFileSuite(
'doctests.txt', package='collective.sharerizer.tests',
- test_class=base.TestCase,
+ test_class=base.FunctionalTestCase,
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE |
doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS),
View
6 setup.py
@@ -4,7 +4,7 @@
setup(name='collective.sharerizer',
version=version,
- description="A package to inject Web 2.0 style sharing buttons into a Plone 3.x's portal_actions.",
+ description="A package to inject Web 2.0 style sharing buttons into Plone's document_actions.",
long_description=open("README.txt").read() + "\n" +
open("CHANGES.txt").read(),
# Get more strings from http://www.python.org/pypi?%3Aaction=list_classifiers
@@ -14,8 +14,8 @@
"Topic :: Software Development :: Libraries :: Python Modules",
],
keywords='plone',
- author='ONE/Northwest',
- author_email='jonb@onenw.org',
+ author='Groundwire',
+ author_email='jonb@groundwire.org',
url='http://svn.plone.org/svn/collective/collective.sharerizer',
license='GPL',
packages=find_packages(exclude=['ez_setup']),
Please sign in to comment.
Something went wrong with that request. Please try again.