[Checkins] SVN: zopyx.smartprintng.server/trunk/ updated

[Andreas Jung]

Log message for revision 101859:
  updated
  
  

Changed:
  U   zopyx.smartprintng.server/trunk/README.txt
  U   zopyx.smartprintng.server/trunk/docs/HISTORY.txt
  U   zopyx.smartprintng.server/trunk/setup.py

-=-
Modified: zopyx.smartprintng.server/trunk/README.txt
===================================================================
--- zopyx.smartprintng.server/trunk/README.txt	2009-07-13 16:26:41 UTC (rev 101858)
+++ zopyx.smartprintng.server/trunk/README.txt	2009-07-13 16:41:07 UTC (rev 101859)
@@ -2,8 +2,9 @@
 =========================
 
 A repoze.bfg based server implementation for the SmartPrintNG framework.
+The SmartPrintNG server is part of the SmartPrintNG web-to-print solution
+of ZOPYX.
 
-
 Installation
 ============
 
@@ -20,7 +21,7 @@
 
     bin/easy_install zopyx.smartprintng.server
 
-- create a ``server.ini`` configuration file::
+- create a ``server.ini`` configuration file (and change according to your needs)::
 
     [DEFAULT]
     debug = true
@@ -35,13 +36,40 @@
     use = egg:Paste#http
     host = 127.0.0.1
     port = 6543
-    bin/python setup.py develop
 
 - start the server::
 
     bin/paster serve server.ini 
 
+XMLRPC API
+==========
 
+The SmartPrintNG server exposes several methods through XMLRPC::
+
+    def convertZIP(zip_archive, converter_name):
+        """ 'zip_archive' is ZIP archive (encoded as base-64 byte string).
+            The archive must contain exactly *one* HTML file to be converted
+            including all related resources like stylesheets and images.
+            All files must be stored flat within the archive (no subfolders).
+            All references to externals resources like the 'src' attribute
+            of the IMG tag or references to the stylesheet(s) must use
+            relative paths.
+        """
+
+    def availableConverters():
+        """ returns a list of available converter names on the 
+            SmartPrintNG backend.
+        """
+
+    def ping():
+        """ says 'pong' - or something similar """
+
+Support
+=======
+
+Support for SmartPrintNG server is currently only available on a project basis.
+
+
 Contact
 =======
 

Modified: zopyx.smartprintng.server/trunk/docs/HISTORY.txt
===================================================================
--- zopyx.smartprintng.server/trunk/docs/HISTORY.txt	2009-07-13 16:26:41 UTC (rev 101858)
+++ zopyx.smartprintng.server/trunk/docs/HISTORY.txt	2009-07-13 16:41:07 UTC (rev 101859)
@@ -1,6 +1,12 @@
 Changelog
 =========
 
+0.3.4 (2009/07/13)
+------------------
+
+* updated documentation
+
+
 0.3.3 (2009/07/12)
 ------------------
 

Modified: zopyx.smartprintng.server/trunk/setup.py
===================================================================
--- zopyx.smartprintng.server/trunk/setup.py	2009-07-13 16:26:41 UTC (rev 101858)
+++ zopyx.smartprintng.server/trunk/setup.py	2009-07-13 16:41:07 UTC (rev 101859)
@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 import os
 
-version = '0.3.3'
+version = '0.3.4'
 
 setup(name='zopyx.smartprintng.server',
       version=version,