[Checkins] SVN: Products.FSDump/trunk/docs/ Use .rst suffix.
Tres Seaver
tseaver at palladion.com
Sun Feb 22 12:07:31 EST 2009
Log message for revision 97109:
Use .rst suffix.
Changed:
A Products.FSDump/trunk/docs/Dumper_editForm.rst
D Products.FSDump/trunk/docs/Dumper_editForm.stx
A Products.FSDump/trunk/docs/Mappings.rst
D Products.FSDump/trunk/docs/Mappings.stx
-=-
Copied: Products.FSDump/trunk/docs/Dumper_editForm.rst (from rev 97108, Products.FSDump/trunk/docs/Dumper_editForm.stx)
===================================================================
--- Products.FSDump/trunk/docs/Dumper_editForm.rst (rev 0)
+++ Products.FSDump/trunk/docs/Dumper_editForm.rst 2009-02-22 17:07:31 UTC (rev 97109)
@@ -0,0 +1,36 @@
+Edit / Dump Dumper
+==================
+
+Description
+-----------
+
+The "Edit / Dump" view of an Dumper instance is used to set the
+filesystem path to which the object's parent will be dumped, and
+to initiate this dumping.
+how the operations
+
+Controls
+--------
+
+``ID``
+ The id of the Dumper object (readonly)
+
+``Filesystem path``
+ The path under which the Dumper's parent will have its filesystem
+ analog (a subdirectory) created. All children of the Dumper's
+ parent will have their analogs created under this subdirectory.
+ E.g., if the value of this field is ``/tmp``, and the parent folder
+ is called ``parent_folder``, then the dumper will create a
+ subdirectory, ``/tmp/parent_folder``, and build objects in it
+ corresponding to the dumper's "siblings".
+
+``Use .metadata file``
+ If checked, write a "new-style" .metadata file, in a format
+ compatilbie with CMF 1.4 and later. Properties go into the
+ ``[Default]`` section.
+
+``Change``
+ Changes the filesystem mapping.
+
+``Change and Dump``
+ Changes the filesystem mapping and performs the dumping.
Deleted: Products.FSDump/trunk/docs/Dumper_editForm.stx
===================================================================
--- Products.FSDump/trunk/docs/Dumper_editForm.stx 2009-02-22 17:07:07 UTC (rev 97108)
+++ Products.FSDump/trunk/docs/Dumper_editForm.stx 2009-02-22 17:07:31 UTC (rev 97109)
@@ -1,36 +0,0 @@
-Edit / Dump Dumper
-==================
-
-Description
------------
-
-The "Edit / Dump" view of an Dumper instance is used to set the
-filesystem path to which the object's parent will be dumped, and
-to initiate this dumping.
-how the operations
-
-Controls
---------
-
-``ID``
- The id of the Dumper object (readonly)
-
-``Filesystem path``
- The path under which the Dumper's parent will have its filesystem
- analog (a subdirectory) created. All children of the Dumper's
- parent will have their analogs created under this subdirectory.
- E.g., if the value of this field is ``/tmp``, and the parent folder
- is called ``parent_folder``, then the dumper will create a
- subdirectory, ``/tmp/parent_folder``, and build objects in it
- corresponding to the dumper's "siblings".
-
-``Use .metadata file``
- If checked, write a "new-style" .metadata file, in a format
- compatilbie with CMF 1.4 and later. Properties go into the
- ``[Default]`` section.
-
-``Change``
- Changes the filesystem mapping.
-
-``Change and Dump``
- Changes the filesystem mapping and performs the dumping.
Copied: Products.FSDump/trunk/docs/Mappings.rst (from rev 97108, Products.FSDump/trunk/docs/Mappings.stx)
===================================================================
--- Products.FSDump/trunk/docs/Mappings.rst (rev 0)
+++ Products.FSDump/trunk/docs/Mappings.rst 2009-02-22 17:07:31 UTC (rev 97109)
@@ -0,0 +1,181 @@
+Mapping TTW Code to the Filesystem
+==================================
+
+General Mapping
+---------------
+
+- Create the most "natural" filesystem analogue for each TTW
+ item: Folders -> directories, DTML Methods/Documents ->
+ DTML files, PythonMethods -> Python modules.
+
+- Trap non-inline properties in a companion file, with a
+ ``.properties`` suffix. Store one property per line, using
+ ``name:type=value`` syntax.
+
+ * XXX: in companion ``.metadata`` file, store the properties
+ in the ``[Default]`` 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.
+
+- Preserve enough metadata to be able to recreate the TTW
+ object, preferably by *using its web interface.* This rule
+ is the chief differentiator (in concept) from pickling; we
+ don't save state which cannot be set by a TTW manager.
+
+Specific Mappings
+-----------------
+
+Folder
+%%%%%%
+
+- Recursively store contained items into the folder's directory.
+
+- Store a list of the dumped items in an ``.objects`` file,
+ one line per item, using the format, ``name:meta_type``.
+
+ * XXX: in ``.metadata`` file, store the same lines in an
+ ``[Objects]`` directory.
+
+File / Image
+%%%%%%%%%%%%
+
+- Save the file contents themselves in binary format using the item's id.
+
+- Store properties in ``*.properties``.
+
+DTMLMethod
+%%%%%%%%%%
+
+- Create a single file containng the text of the template. Filename will
+ have extension, ``.dtml``.
+
+DTMLDocument
+%%%%%%%%%%%%
+
+- Create a single file containng the text of the template. Filename will
+ have extension, ``.dtml``.
+
+- Store properties in ``*.properties``.
+
+Python Script
+%%%%%%%%%%%%%
+
+- Create a module containing a single top-level function definition, using
+ the "read" format (bindings in comments at the top).
+
+PageTemplate
+%%%%%%%%%%%%
+
+- Create a single file containng the text of the template. Filename will
+ have extension, ``.pt``.
+
+- Store properties in '*.properties'.
+
+SQL Method
+%%%%%%%%%%
+
+- Inject the parameter list inline into the body, with a leading blank line.
+
+ZCatalog
+%%%%%%%%
+
+- Store the paths of the catalogued objects in a ``<id>.catalog`` file,
+ one line per item.
+
+- Store the index definititions in a ``<id>.indexes`` file,
+ one line per index, using the format, ``name:meta_type``.
+
+- Store the schema in a ``<id>.metadata`` file, one line per
+ field name.
+
+Controller Python Script
+%%%%%%%%%%%%%%%%%%%%%%%%
+
+- Create a module containing a single top-level function
+ definition, using the "read" format (bindings in comments
+ at the top). Filename will have extension, ``.cpy``
+
+- Store properties in ``*.properties``.
+
+Controller Validator
+%%%%%%%%%%%%%%%%%%%%
+
+- Create a module containing a single top-level function
+ definition, using the "read" format (bindings in comments
+ at the top). Filename will have extension, ``.vpy``
+
+- Store properties in ``*.properties``.
+
+Controller Page Template
+%%%%%%%%%%%%%%%%%%%%%%%%
+
+- Create a single file containng the text of the template.
+ Filename will have extension, ``.cpt``.
+
+- Store properties in ``*.properties``.
+
+
+Mappings for Obsolete Types
+---------------------------
+
+Python Method
+%%%%%%%%%%%%%
+
+- Create a module containing a single top-level function
+ definition, using the name, argument list, and body.
+
+ZClass
+%%%%%%
+
+- Map to a directory.
+
+- Store "basic" tab values in ``.properties``
+
+- Store icon in ``.icon``
+
+- Store propertysheets in ``propertysheets/common``.
+
+- Store method tab objects (including nested ZClasses)
+ in ``propertysheets/methods``.
+
+Common Instance Property Sheet (ZClass property sheet)
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+- Store properties as ``name:type=value`` in file of same name.
+
+Zope Permission
+%%%%%%%%%%%%%%%
+
+- Store values in ``*.properties``.
+
+Zope Factory
+%%%%%%%%%%%%
+
+- Store values in ``*.properties``.
+
+Wizard
+%%%%%%
+
+- Map to a directory.
+
+- Store properties in ``.properties``.
+
+- Store pages.
+
+WizardPage
+%%%%%%%%%%
+
+- Store text in ``*.wizardpage``.
+
+- Store properties in ``*.properties``.
Deleted: Products.FSDump/trunk/docs/Mappings.stx
===================================================================
--- Products.FSDump/trunk/docs/Mappings.stx 2009-02-22 17:07:07 UTC (rev 97108)
+++ Products.FSDump/trunk/docs/Mappings.stx 2009-02-22 17:07:31 UTC (rev 97109)
@@ -1,181 +0,0 @@
-Mapping TTW Code to the Filesystem
-==================================
-
-General Mapping
----------------
-
-- Create the most "natural" filesystem analogue for each TTW
- item: Folders -> directories, DTML Methods/Documents ->
- DTML files, PythonMethods -> Python modules.
-
-- Trap non-inline properties in a companion file, with a
- ``.properties`` suffix. Store one property per line, using
- ``name:type=value`` syntax.
-
- * XXX: in companion ``.metadata`` file, store the properties
- in the ``[Default]`` 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.
-
-- Preserve enough metadata to be able to recreate the TTW
- object, preferably by *using its web interface.* This rule
- is the chief differentiator (in concept) from pickling; we
- don't save state which cannot be set by a TTW manager.
-
-Specific Mappings
------------------
-
-Folder
-%%%%%%
-
-- Recursively store contained items into the folder's directory.
-
-- Store a list of the dumped items in an ``.objects`` file,
- one line per item, using the format, ``name:meta_type``.
-
- * XXX: in ``.metadata`` file, store the same lines in an
- ``[Objects]`` directory.
-
-File / Image
-%%%%%%%%%%%%
-
-- Save the file contents themselves in binary format using the item's id.
-
-- Store properties in ``*.properties``.
-
-DTMLMethod
-%%%%%%%%%%
-
-- Create a single file containng the text of the template. Filename will
- have extension, ``.dtml``.
-
-DTMLDocument
-%%%%%%%%%%%%
-
-- Create a single file containng the text of the template. Filename will
- have extension, ``.dtml``.
-
-- Store properties in ``*.properties``.
-
-Python Script
-%%%%%%%%%%%%%
-
-- Create a module containing a single top-level function definition, using
- the "read" format (bindings in comments at the top).
-
-PageTemplate
-%%%%%%%%%%%%
-
-- Create a single file containng the text of the template. Filename will
- have extension, ``.pt``.
-
-- Store properties in '*.properties'.
-
-SQL Method
-%%%%%%%%%%
-
-- Inject the parameter list inline into the body, with a leading blank line.
-
-ZCatalog
-%%%%%%%%
-
-- Store the paths of the catalogued objects in a ``<id>.catalog`` file,
- one line per item.
-
-- Store the index definititions in a ``<id>.indexes`` file,
- one line per index, using the format, ``name:meta_type``.
-
-- Store the schema in a ``<id>.metadata`` file, one line per
- field name.
-
-Controller Python Script
-%%%%%%%%%%%%%%%%%%%%%%%%
-
-- Create a module containing a single top-level function
- definition, using the "read" format (bindings in comments
- at the top). Filename will have extension, ``.cpy``
-
-- Store properties in ``*.properties``.
-
-Controller Validator
-%%%%%%%%%%%%%%%%%%%%
-
-- Create a module containing a single top-level function
- definition, using the "read" format (bindings in comments
- at the top). Filename will have extension, ``.vpy``
-
-- Store properties in ``*.properties``.
-
-Controller Page Template
-%%%%%%%%%%%%%%%%%%%%%%%%
-
-- Create a single file containng the text of the template.
- Filename will have extension, ``.cpt``.
-
-- Store properties in ``*.properties``.
-
-
-Mappings for Obsolete Types
----------------------------
-
-Python Method
-%%%%%%%%%%%%%
-
-- Create a module containing a single top-level function
- definition, using the name, argument list, and body.
-
-ZClass
-%%%%%%
-
-- Map to a directory.
-
-- Store "basic" tab values in ``.properties``
-
-- Store icon in ``.icon``
-
-- Store propertysheets in ``propertysheets/common``.
-
-- Store method tab objects (including nested ZClasses)
- in ``propertysheets/methods``.
-
-Common Instance Property Sheet (ZClass property sheet)
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-- Store properties as ``name:type=value`` in file of same name.
-
-Zope Permission
-%%%%%%%%%%%%%%%
-
-- Store values in ``*.properties``.
-
-Zope Factory
-%%%%%%%%%%%%
-
-- Store values in ``*.properties``.
-
-Wizard
-%%%%%%
-
-- Map to a directory.
-
-- Store properties in ``.properties``.
-
-- Store pages.
-
-WizardPage
-%%%%%%%%%%
-
-- Store text in ``*.wizardpage``.
-
-- Store properties in ``*.properties``.
More information about the Checkins
mailing list