[Checkins] SVN: Sandbox/nadako/zope.app.publisher/README.txt Fix README to make it more actual.

[Dan Korostelev]

Log message for revision 103290:
  Fix README to make it more actual.

Changed:
  U   Sandbox/nadako/zope.app.publisher/README.txt

-=-
Modified: Sandbox/nadako/zope.app.publisher/README.txt
===================================================================
--- Sandbox/nadako/zope.app.publisher/README.txt	2009-08-27 15:04:14 UTC (rev 103289)
+++ Sandbox/nadako/zope.app.publisher/README.txt	2009-08-27 15:10:05 UTC (rev 103290)
@@ -6,97 +6,20 @@
 chunk of the Zope Toolkit and its assumptions. It is maintained by the*
 `Zope Toolkit project <http://docs.zope.org/zopetoolkit/>`_.
 
-``zope.publisher`` is a general purpose object publishing framework
-which delegates to a publication object for determining the
-to-be-published object.  With Zope 3's default publication from
-``zope.app.publication``, this is usually a view or a resource.
+This package used to provide browser page, resource and menu classes
+for use with zope.publisher object publishing framework, as well as some
+other useful utilities and adapters, but most of things was factored out
+to separate packages, leaving here only backward-compatibility imports.
 
-This package, ``zope.app.publisher``, provides base implementations
-for those.  It also provides ZCML directives for configuring views and
-resources.  More specifically, ``zope.app.publisher`` defines the
-following ZCML directives:
+However, some potentially useful things are still contained in this package:
 
-* browser:page
+ * "date" field converter for zope.publisher's BrowserRequest field converter
+   mechanism.
+ 
+ * "Browser Skins" vocabulary (a vocabulary for IBrowserSkinType utilities)
+ 
+ * ManagementViewSelector (a browser view that redirects to a first available
+   management view)
 
-* browser:pages
-
-* browser:view
-
-* browser:menu
-
-* browser:menuItem
-
-* browser:menuItems
-
-* browser:addMenuitem
-
-* browser:resource
-
-* browser:resourceDirectory
-
-* browser:defaultSkin
-
-* browser:icon
-
-* xmlrpc:view
-
-
-Views and Browser pages
-=======================
-
-XXX writeme
-
-
-Resources
-=========
-
-Resources are static files and directories that are served to the browser
-directly from the filesystem. The most common example are images, CSS style
-sheets, or JavaScript files.
-
-Resources are be registered under a symbolic name and can later be referred to
-by that name, so their usage is independent from their physical location.
-
-You can register a single file with the `<browser:resource>` directive, and a
-whole directory with the `<browser:resourceDirectory>` directive, for example
-
-  <browser:resource
-    directory="/path/to/static.file"
-    name="myfile"
-    />
-
-  <browser:resourceDirectory
-    directory="/path/to/images"
-    name="main-images"
-    />
-
-This causes a named adapter to be registered that adapts the request to
-zope.interface.Interface (XXX why do we not use an explicit interface?),
-so to later retrieve a resource, use
-`zope.component.getAdapter(request, name='myfile')`.
-
-There are two ways to traverse to a resource,
-
-1. with the 'empty' view on a site, e. g. `http://localhost/@@/myfile`
-   (This is declared by zope.app.publisher.browser)
-
-2. with the `++resource++` namespace, e. g. `http://localhost/++resource++myfile`
-   (This is declared by zope.traversing.namespace)
-
-In case of resource-directories traversal simply continues through its contents,
-e. g. `http://localhost/@@/main-images/subdir/sample.jpg`
-
-Rather than putting together the URL to a resource manually, you should use
-zope.traversing.browser.interfaces.IAbsoluteURL to get the URL, or for a
-shorthand, call the resource object. This has an additional benefit:
-
-If you want to serve resources from a different URL, for example
-because you want to use a web server specialized in serving static files instead
-of the appserver, you can register an IAbsoluteURL adapter for the site under
-the name 'resource' that will be used to compute the base URLs for resources.
-
-For example, if you register 'http://static.example.com/' as the base 'resource'
-URL, the resources from the above example would yield the following absolute
-URLs: http://static.example.com/myfile and
-http://static.example.com/main-images
-(XXX what about http://static.example.com/main-images/subdir/sample.jpg?)
+ * XML-RPC view and method publishing mechanism along with xmlrpc:view ZCML
+   directive.