[Checkins] SVN: zopeframework/trunk/ Update to use Zope Framework terminology.

Martijn Faassen faassen at infrae.com
Thu Mar 5 11:53:29 EST 2009


Log message for revision 97536:
  Update to use Zope Framework terminology.
  

Changed:
  _U  zopeframework/trunk/
  U   zopeframework/trunk/source/codingstyle/glossary.rst
  U   zopeframework/trunk/source/codingstyle/index.rst
  U   zopeframework/trunk/source/codingstyle/writingtests.rst
  U   zopeframework/trunk/source/conf.py
  U   zopeframework/trunk/source/index.rst
  U   zopeframework/trunk/source/migration/34to35.rst
  U   zopeframework/trunk/source/migration/index.rst
  U   zopeframework/trunk/source/process/communication.rst
  U   zopeframework/trunk/source/process/index.rst
  U   zopeframework/trunk/source/process/maintaining-software.rst
  U   zopeframework/trunk/source/process/old-references.rst
  U   zopeframework/trunk/source/process/repository.rst

-=-

Property changes on: zopeframework/trunk
___________________________________________________________________
Added: svn:ignore
   + build
parts
develop-eggs
bin
.installed.cfg



Modified: zopeframework/trunk/source/codingstyle/glossary.rst
===================================================================
--- zopeframework/trunk/source/codingstyle/glossary.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/codingstyle/glossary.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -53,7 +53,7 @@
 
 Name
     Objects are given names to help us find them. An object may be found
-    via more than one name. In Zope 3, we use names to guide the process
+    via more than one name. In the Zope Framework, we use names to guide the process
     of traversing from a container to a contained object.
 
 ZCML

Modified: zopeframework/trunk/source/codingstyle/index.rst
===================================================================
--- zopeframework/trunk/source/codingstyle/index.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/codingstyle/index.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -2,7 +2,7 @@
 ============
 
 The coding style is intended to support a consistent code base by laying
-out rules for how to work on Zope 3 code, for example how to structure
+out rules for how to work on Zope code, for example how to structure
 files, format your source code and naming things.
 
 .. note::

Modified: zopeframework/trunk/source/codingstyle/writingtests.rst
===================================================================
--- zopeframework/trunk/source/codingstyle/writingtests.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/codingstyle/writingtests.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -45,7 +45,7 @@
 one class per Interface.  WritingInterfaceTests expands
 on this concept in more detail.
 
-Within the unit tests themselves, the Zope3 style is to use
+Within the unit tests themselves, the Zope style is to use
 the positive rather than the double negative assertions.
 Thus, use ``assertEqual`` rather than ``failUnlessEqual``, 
 ``assertRaises`` rather than ``failUnlessRaises``, and ``assert_``

Modified: zopeframework/trunk/source/conf.py
===================================================================
--- zopeframework/trunk/source/conf.py	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/conf.py	2009-03-05 16:53:29 UTC (rev 97536)
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Zope 3 Documentation documentation build configuration file, created by
+# Zope Framework Documentation documentation build configuration file, created by
 # sphinx-quickstart on Mon Feb  2 16:17:40 2009.
 #
 # This file is execfile()d with the current directory set to its containing dir.
@@ -153,7 +153,7 @@
 #html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Zope3Documentationdoc'
+htmlhelp_basename = 'ZopeFrameworkdoc'
 
 
 # Options for LaTeX output
@@ -168,7 +168,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 latex_documents = [
-  ('index', 'Zope3Documentation.tex', ur'Zope 3 Documentation Documentation',
+  ('index', 'ZopeFrameworkDocumentation.tex',
+   ur'Zope Framework Documentation',
    ur'Zope Developers', 'manual'),
 ]
 

Modified: zopeframework/trunk/source/index.rst
===================================================================
--- zopeframework/trunk/source/index.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/index.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -1,9 +1,9 @@
-.. Zope 3 Documentation documentation master file, created by sphinx-quickstart on Mon Feb  2 16:17:40 2009.
+.. Zope Framework Documentation master file, created by sphinx-quickstart on Mon Feb  2 16:17:40 2009.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to the Zope 3 documentation
-===================================
+Welcome to the Zope Framework documentation
+===========================================
 
 Contents:
 

Modified: zopeframework/trunk/source/migration/34to35.rst
===================================================================
--- zopeframework/trunk/source/migration/34to35.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/migration/34to35.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -1,7 +1,8 @@
-Migrating from Zope 3.4 to Zope 3.5
-===================================
+Migrating from Zope 3.4 to Zope Framework 3.5
+=============================================
 
-This document covers major changes since Zope 3.4 release that can lead to
+This document covers major changes from the Zope 3.4 release to the
+Zope Framework 3.5 release that can lead to
 backward-incompatibilities.
 
 .. contents::
@@ -9,7 +10,19 @@
 Introduction
 ------------
 
-The 3.5 release of the Zope framework contains a number of
+The Zope Framework 3.5 release is the first release of the Zope
+Framework. The Zope Framework really is just a collection of libraries
+managed together by the Zope developers. We typically treat each
+library independently, so you would like to look at the CHANGES.txt in
+each library for updates. Here we note larger changes, especially ones
+that affect multiple libraries.
+
+The Zope Framework cannot be installed directly except as individual
+libraries (such as ``zope.component``). To install it you typically
+would install a framework or application that makes use of these
+libraries. The Zope project itself manages Zope 3, Zope 2, or Grok.
+
+The 3.5 release of the Zope Framework contains a number of
 refactorings that are aimed to clean up dependencies between pieces of
 code. Many packages in ``zope.app`` have had their code moved to
 existing or newly created packages in the ``zope`` namespace. These
@@ -133,20 +146,22 @@
 you don't use ZCML configuration of ``zope.location``, you may need to
 register ``zope.location.pickling.LocationCopyHook`` yourself.
 
-The ``zope.location.pickling.locationCopy`` and ``zope.location.pickling.CopyPersistent``
-are now deprecated in favor of ``zope.copy`` and were replaced by deprecated
-imports. See ``zope.copy`` package documentation for information on how to
-use the new mechanism.
+The ``zope.location.pickling.locationCopy`` and
+``zope.location.pickling.CopyPersistent`` are now deprecated in favor
+of ``zope.copy`` and were replaced by deprecated imports. See
+``zope.copy`` package documentation for information on how to use the
+new mechanism.
 
-The new version of the ``zc.copy`` package now only contains backward-compatibility
-imports and is deprecated. ``zope.copy`` should be preferred for new developments.
+The new version of the ``zc.copy`` package now only contains
+backward-compatibility imports and is deprecated. ``zope.copy`` should
+be preferred for new developments.
 
 ZODB 3.9 FileStorage native blob support
 ----------------------------------------
 
-The FileStorage component of ZODB 3.9 used in Zope 3.5 now supports
-blobs natively, so you don't need to use BlobStorage proxy for it
-anymore.
+The FileStorage component of ZODB 3.9 used in Zope Framework 3.5 now
+supports blobs natively, so you don't need to use BlobStorage proxy
+for it anymore.
 
 Thus, you can specify blob directory directly to FileStorage. If you
 use ZConfig, that means something like this::

Modified: zopeframework/trunk/source/migration/index.rst
===================================================================
--- zopeframework/trunk/source/migration/index.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/migration/index.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -1,8 +1,8 @@
-Migration to newer Zope versions
-================================
+Migration to newer Zope Framework versions
+==========================================
 
 This area collects information about the backward-incompatible changes and
-new techniques developed and proposed within new Zope 3 releases.
+new techniques developed and proposed within new Zope Framework releases.
 
 .. toctree::
     :maxdepth: 1

Modified: zopeframework/trunk/source/process/communication.rst
===================================================================
--- zopeframework/trunk/source/process/communication.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/process/communication.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -1,8 +1,8 @@
 Communication
 =============
 
-Communication for the Zope 3 development itself happens both on IRC and
-in a mailinglist.
+Communication for the Zope Framework development itself happens both
+on IRC and in a mailinglist.
 
 IRC
 ---
@@ -14,10 +14,12 @@
 Mailing list
 ------------
 
-The official Zope 3 development mailing list is zope-dev at zope.org. You
-can subscribe to it by visiting http://mail.zope.org/mailman/listinfo/zope-dev.
+The official Zope Framework development mailing list is
+zope-dev at zope.org. You can subscribe to it by visiting
+http://mail.zope.org/mailman/listinfo/zope-dev.
 
 .. note::
-    In the earlier days of Zope 3 development we used to have a separate
-    mailing list for development on Zope 3 (zope3-dev at zope.org). This list was merged into
-    the general zope-dev at zope.org list a while ago.
+    In the earlier days of Zope 3 development we used to have a
+    separate mailing list for development on Zope 3
+    (zope3-dev at zope.org). This list was merged into the general
+    zope-dev at zope.org list a while ago.

Modified: zopeframework/trunk/source/process/index.rst
===================================================================
--- zopeframework/trunk/source/process/index.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/process/index.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -2,7 +2,7 @@
 ===================
 
 This area covers the procedures and guidelines we adhere to when
-developing Zope 3 components.
+developing Zope Framework components.
 
 .. note::
     This area currently is heavy work-in-progress. We are pulling in

Modified: zopeframework/trunk/source/process/maintaining-software.rst
===================================================================
--- zopeframework/trunk/source/process/maintaining-software.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/process/maintaining-software.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -389,10 +389,10 @@
 
     * The list of `Trove classifiers`_ (``classifiers`` parameter)
       should be adjusted according to the specific package, of course.
-      Most of the software in the Zope repository is intended to be
-      used with the Zope 2 or Zope 3 framework (sometimes for both),
-      but not all (well-known exceptions are ``zope.interface`` or the
-      ``ZODB``).
+      Much of the software in the Zope repository is intended to be
+      used with the Zope 2 or Zope Framework (sometimes for both), we
+      aim to make more and more software available for independent use
+      (well-known examples are ``zope.interface`` or the ``ZODB``).
 
     * ``description`` should be a one-sentence description of the
       package while ``long_description`` is best taken from the

Modified: zopeframework/trunk/source/process/old-references.rst
===================================================================
--- zopeframework/trunk/source/process/old-references.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/process/old-references.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -2,10 +2,10 @@
 ======================
 
 This is a collection of documents I found while putting together
-material for the Zope 3 process documentation. Most of those are so
-outdated or never made it very far that I didn't want to include them
-directly. They're here for giving an overview on what we might want to
-think of.
+material for the Zope Framework process documentation. Most of those
+are so outdated or never made it very far that I didn't want to
+include them directly. They're here for giving an overview on what we
+might want to think of.
 
 - http://wiki.zope.org/DocumentationProcess
 - http://wiki.zope.org/DocsProcedures/FrontPage

Modified: zopeframework/trunk/source/process/repository.rst
===================================================================
--- zopeframework/trunk/source/process/repository.rst	2009-03-05 16:37:30 UTC (rev 97535)
+++ zopeframework/trunk/source/process/repository.rst	2009-03-05 16:53:29 UTC (rev 97536)
@@ -1,8 +1,8 @@
-Accessing the Zope 3 repository
-===============================
+Accessing the Zope Framework repository
+=======================================
 
-The Zope 3 code is maintained via Subversion in the official Zope repository at
-svn://svn.zope.org/repos/main.
+The Zope Framework code is maintained via Subversion in the official
+Zope repository at svn://svn.zope.org/repos/main.
 
 Code browsing
 -------------



More information about the Checkins mailing list