ajung avatar ajung committed 608d8b0

updated

Comments (0)

Files changed (4)

src/pp.client-plone/docs/source/conf.py

 
 # General information about the project.
 project = u'Produce & Publish Plone Client Connector'
-copyright = u'2011, Andreas Jung'
+copyright = u'2013, ZOPYX Limited'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '2.1'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '2.1'
+release = '1.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

src/pp.client-plone/docs/source/index.rst

 Produce & Publish Plone Client Connector
 ========================================
 
-The Produce & Publish Plone Client connector integrates the Plone
-CMS with the Produce & Publishing platform and supports the
-generation of PDF (requires other external PDF converters).
-
-Documentation
--------------
-
-Primary documentation: http://docs.produce-and-publish.com
-
-Produce & Publish website: http://www.produce-and-publish.com
-
-Source code
------------
-See https://bitbucket.org/ajung/pp.client.plone
-
-Bugtracker
-----------
-See https://bitbucket.org/ajung/pp.client.plone/issues
-
-Licence
--------
-Published under the GNU Public Licence Version 2 (GPL 2)
-
-Author
-------
-| ZOPYX Limited
-| Hundskapfklinge 33
-| D-72074 Tuebingen, Germany
-| info@zopyx.com
-| www.zopyx.com
-
-
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   README.rst
+   HISTORY.rst
    installation.rst
    resource-directories.rst
    content-types.rst
    integration-ploneformgen.rst
-   HISTORY.rst
 
 Indices and tables
 ==================

src/pp.client-plone/docs/source/installation.rst

 zc.buildout.
 
 
-- edit your *buildout.cfg* -  add *pp.client.plone* to the 
-  **eggs** options of your buildout.cfg:
+- edit your *buildout.cfg* -  add *pp.client-plone* to the 
+  **eggs** options of your buildout.cfg::
 
-::
     eggs = ...
-        pp.client.plone
-
--  restart Zope/Plone
+        pp.client-plone
 
--  When running the Produce & Publish server on a different server, you must
-   adjust the ``PP_SERVER`` environment variables within your
-   *.bashrc* file (or a similar file) or you put those variables into your
-   buildout configuration using the *<environment>* section.  Username and
-   password are only needed when you run the Produce & Publish server behind a
-   reverse proxy (requiring authentcation).
+- restart Zope/Plone
 
-::
+- When running the Produce & Publish server on a different server, you must
+  adjust the ``PP_SERVER`` environment variables within your *.bashrc* file (or
+  a similar file) or you put those variables into your buildout configuration
+  using the *<environment>* section.  Username and password are only needed
+  when you run the Produce & Publish server behind a reverse proxy (requiring
+  authentcation)::
 
     export PP_SERVER=http://user:password@your.server:6543/api/1
 
-or
-
-::
+  or::
 
     <environment>
         PP_SERVER=http://user:password@your.server:6543/api/1
     </environment>
 
+.. note:: This version of the Produce & Publish Plone Client Connector
+    requires an installation of the new ``pp.server`` Produce & Publish Server.
+    It will not work with the older ``zopyx.smartprintng.server`` server implementation.
+
 
 Supported Plone content-types
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
--  Document
--  Folder (nested structure)
--  News item
--  PloneGlossary
--  Collection
+Archetypes-based content-types
+++++++++++++++++++++++++++++++
+
+- Document
+- Folder (nested structure)
+- News item
+- Collection (new-style collections Plone 4.3 only)
+- Image
+
+Dexterity-based content-types
++++++++++++++++++++++++++++++
+
+There is no direct support for Dexterity content-types available however the
+configuration contains an example configuration on how to register the
+interface of a Dexterity content-type with the Plone Client Connector. However
+support for Dexterity types will only work for filesystem-based Dexterity types
+with a related marker interface - there is no support for through-the-web
+defined Dexterity types.
 
 Usage
 ~~~~~
 The Plone connector provides a dedicated @@asPDF view that can
 be added to the URL of any of the supported content-types of Plone
 (Document, Folder, Newsitem, PloneGlossary). So when your document
-is for example associated with the URL
+is for example associated with the URL::
 
 ::
 

src/pp.client-plone/setup.py

 from setuptools import setup, find_packages
 import os
 
-version = '0.1.9'
+version = '0.2.0'
 
 setup(name='pp.client-plone',
       version=version,
-      description="Produce & Publisher server integration with Plone",
+      description="Produce & Publisher Plone Client Connector",
       long_description=open("README.rst").read() + "\n" +
                        open(os.path.join("docs", "source", "HISTORY.rst")).read(),
       # Get more strings from http://www.python.org/pypi?%3Aaction=list_classifiers
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.