[Checkins] SVN: Products.FSDump/trunk/docs/ Finish Sphinxifying docs.
Tres Seaver
tseaver at palladion.com
Sun Feb 22 12:26:44 EST 2009
Log message for revision 97112:
Finish Sphinxifying docs.
Changed:
A Products.FSDump/trunk/docs/INSTALL.rst
D Products.FSDump/trunk/docs/INSTALL.txt
U Products.FSDump/trunk/docs/Mappings.rst
A Products.FSDump/trunk/docs/TODO.rst
D Products.FSDump/trunk/docs/TODO.txt
U Products.FSDump/trunk/docs/index.rst
-=-
Copied: Products.FSDump/trunk/docs/INSTALL.rst (from rev 97106, Products.FSDump/trunk/docs/INSTALL.txt)
===================================================================
--- Products.FSDump/trunk/docs/INSTALL.rst (rev 0)
+++ Products.FSDump/trunk/docs/INSTALL.rst 2009-02-22 17:26:44 UTC (rev 97112)
@@ -0,0 +1,15 @@
+Installing FSDump
+=================
+
+1. Unpack the tarball into a temporary location. E.g.::
+
+ $ cd /tmp
+ $ tar xzf FSDump-0.9.2.tar.gz
+
+2. Copy the FSDump directory from that location into the 'Products'
+ directory of your Zope application server instance. E.g.::
+
+ $ cd FSDump-0.9.2
+ $ cp -r FSDump /var/zope/Products/
+
+3. Restart Zope.
Deleted: Products.FSDump/trunk/docs/INSTALL.txt
===================================================================
--- Products.FSDump/trunk/docs/INSTALL.txt 2009-02-22 17:26:30 UTC (rev 97111)
+++ Products.FSDump/trunk/docs/INSTALL.txt 2009-02-22 17:26:44 UTC (rev 97112)
@@ -1,14 +0,0 @@
-Installing FSDump
-
- 1. Unpack the tarball into a temporary location. E.g.::
-
- $ cd /tmp
- $ tar xzf FSDump-0.9.2.tar.gz
-
- 2. Copy the FSDump directory from that location into the 'Products'
- directory of your Zope application server instance. E.g.::
-
- $ cd FSDump-0.9.2
- $ cp -r FSDump /var/zope/Products/
-
- 3. Restart Zope.
Modified: Products.FSDump/trunk/docs/Mappings.rst
===================================================================
--- Products.FSDump/trunk/docs/Mappings.rst 2009-02-22 17:26:30 UTC (rev 97111)
+++ Products.FSDump/trunk/docs/Mappings.rst 2009-02-22 17:26:44 UTC (rev 97112)
@@ -80,7 +80,7 @@
- Create a single file containng the text of the template. Filename will
have extension, ``.pt``.
-- Store properties in '*.properties'.
+- Store properties in ``*.properties``.
SQL Method
%%%%%%%%%%
Copied: Products.FSDump/trunk/docs/TODO.rst (from rev 97106, Products.FSDump/trunk/docs/TODO.txt)
===================================================================
--- Products.FSDump/trunk/docs/TODO.rst (rev 0)
+++ Products.FSDump/trunk/docs/TODO.rst 2009-02-22 17:26:44 UTC (rev 97112)
@@ -0,0 +1,37 @@
+FSDump ToDos
+============
+
+Planned
+-------
+
+- [x] Target .metadata file expected by newer CMF releases.
+ (in the ``[Default]`` section); write ``.objects`` entries into its
+ ``[Objects]`` section.
+
+- [x] Map the permission-role map in the ``[Permissions]`` section of the
+ companion ``.metadata`` file (XXX this feature not present before
+ the switch to ``.metadata``, although it might have mapped to the
+ ".security" file supported by CMF 1.3)
+
+- [x] Map local roles in the ``[LocalRoles]`` section of the
+ companion ``.metadata`` file (XXX this feature not present before
+ the switch to ``.metadata``)
+
+- [x] Write proxy roles to a ``proxy`` property (XXX CMF 1.4 compatibility;
+ this is an *ugly* spelling). Should probably put it into a "prettier"
+ spelling, as well, and lobby to change the spelling used in CMF.
+
+- [_] Finish out the typelist for "standard" metatypes:
+
+ * Database connectors
+
+- [_] Make the dumper easier to extend (e.g., by adding *more* TTW code
+ to emit FS code ;), or by registering handlers for new metatypes.)
+
+No Way
+------
+
+- Integrate with the HelpSystem.
+
+- Introspect ZClass instances to export them using their propertysheets.
+
Deleted: Products.FSDump/trunk/docs/TODO.txt
===================================================================
--- Products.FSDump/trunk/docs/TODO.txt 2009-02-22 17:26:30 UTC (rev 97111)
+++ Products.FSDump/trunk/docs/TODO.txt 2009-02-22 17:26:44 UTC (rev 97112)
@@ -1,34 +0,0 @@
-FSDump ToDo's
-
- (x) Target .metadata file expected by newer CMF releases.
- (in the '[Default]' section); write '.objects' entries into its
- '[Objects]' section.
-
- ( ) Map the permission-role map in the '[Permissions]' section of the
- companion ".metadata" file (XXX this feature not present before
- the switch to '.metadata', although it might have mapped to the
- ".security" file supported by CMF 1.3)
-
- ( ) Map local roles in the '[LocalRoles]' section of the
- companion ".metadata" file (XXX this feature not present before
- the switch to '.metadata')
-
- ( ) Write proxy roles to a 'proxy' property (XXX CMF 1.4 compatibility;
- this is an *ugly* spelling). Should probably put it into a "prettier"
- spelling, as well, and lobby to change the spelling used in CMF.
-
- ( ) Finish out the typelist for "standard" metatypes:
-
- - Database connectors
-
- ( ) Make the dumper easier to extend (e.g., by adding
- *more* TTW code to emit FS code ;), or by registering
- handlers for new metatypes.)
-
- No Way
-
- * Integrate with the HelpSystem.
-
- * Introspect ZClass instances to export them using their
- propertysheets?
-
Modified: Products.FSDump/trunk/docs/index.rst
===================================================================
--- Products.FSDump/trunk/docs/index.rst 2009-02-22 17:26:30 UTC (rev 97111)
+++ Products.FSDump/trunk/docs/index.rst 2009-02-22 17:26:44 UTC (rev 97112)
@@ -1,22 +1,78 @@
-.. Products.FSDump documentation master file, created by sphinx-quickstart on Sun Feb 22 11:54:55 2009.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
Products.FSDump Documentation
=============================
+:Author: Tres Seaver, mailto:tseaver at palladion.com, Palladion Software
+:Version: |version|
+
Contents:
.. toctree::
:maxdepth: 2
- Dumper_editform.rst
- Mappings.rst
+ INSTALL
+ Dumper_editForm
+ Mappings
+ TODO
-Indices and tables
-==================
+Overview
+--------
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+FSDump grew out of an itch which many Zope developers have:
+through-the-web development is faster and easier to do, but
+causes significant deployment and configuration management
+problems. Through-the-web code cannot (easily) be checked into
+CVS, or diffed to show changes, or grepped to find the source
+of an error message.
+Goals
+-----
+
+- The first goal is to ease the burden of getting TTW code
+ under version control: i.e., to make it possible to check
+ a representation of the TTW code into CVS, and then to see
+ what changes between versions.
+
+- Keep the file-system representations of the TTW objects
+ simple and "natural" (we are explicitly avoiding XML here).
+
+- Future goals might include:
+
+ o Two-way migration (e.g., make changes to dumped items in
+ vim/emacs, and then import those changes back into the
+ TTW code).
+
+Installation
+------------
+
+See the separate `installation directions <INSTALL.html>`_.
+
+
+Usage
+-----
+
+- Use the "Add list" to create a "Dumper" instance in a folder
+ (or Product) which contains the TTW code to be dumped.
+
+- Supply an absolute path to a directory on the filesystem
+ in which the dumper is to create the files (note that the
+ user as whom Zope is running needs write access to this
+ directory). See the `form help <Dumper_editForm.html>`_.
+
+- Click the "Change and Dump" button to do the dump to the
+ indicated directory.
+
+
+Mapping TTW Code to the Filesystem
+----------------------------------
+
+See the `mappings documentation <Mappings.html>`_.
+
+
+Known Issues
+------------
+
+- Some types of metadata (``bobobase_modification_time``) won't
+ be exported as a property.
+
+- See the `TODO list <TODO.html>`_.
More information about the Checkins
mailing list