[Checkins] SVN: z3c.language.switch/trunk/ Update docs.

Stephan Richter srichter at cosmos.phy.tufts.edu
Fri Jan 25 00:58:47 EST 2008


Log message for revision 83226:
  Update docs.
  

Changed:
  U   z3c.language.switch/trunk/CHANGES.txt
  U   z3c.language.switch/trunk/setup.py
  U   z3c.language.switch/trunk/src/z3c/language/switch/README.txt

-=-
Modified: z3c.language.switch/trunk/CHANGES.txt
===================================================================
--- z3c.language.switch/trunk/CHANGES.txt	2008-01-25 05:33:43 UTC (rev 83225)
+++ z3c.language.switch/trunk/CHANGES.txt	2008-01-25 05:58:47 UTC (rev 83226)
@@ -2,13 +2,13 @@
 CHANGES
 =======
 
-1.0.1dev (unreleased)
----------------------
+1.0.1 (2008-01-24)
+------------------
 
-- ...
+- Bug: Corrected meta-data.
 
 
-1.0.0 (2007-01-21)
+1.0.0 (2008-01-21)
 ------------------
 
-- Moved zope.language.switch to it's namespace package
+- Restructure: Moved ``zope.language.switch`` to it's namespace package.

Modified: z3c.language.switch/trunk/setup.py
===================================================================
--- z3c.language.switch/trunk/setup.py	2008-01-25 05:33:43 UTC (rev 83225)
+++ z3c.language.switch/trunk/setup.py	2008-01-25 05:58:47 UTC (rev 83226)
@@ -23,13 +23,18 @@
 
 setup (
     name='z3c.language.switch',
-    version='1.0.1dev',
+    version='1.0.1',
     author = "Roger Ineichen and the Zope Community",
-    author_email = "zope3-dev at zope.org",
+    author_email = "zope-dev at zope.org",
     description = "Zope3 i18n language switch.",
     long_description=(
         read('README.txt')
         + '\n\n' +
+        'Detailed Documentation\n'
+        '**********************'
+        + '\n\n' +
+        read('src', 'z3c', 'language', 'switch', 'README.txt')
+        + '\n\n' +
         read('CHANGES.txt')
         ),
     license = "ZPL 2.1",
@@ -44,7 +49,7 @@
         'Operating System :: OS Independent',
         'Topic :: Internet :: WWW/HTTP',
         'Framework :: Zope3'],
-    url = 'http://cheeseshop.python.org/pypi/z3c.language.switch',
+    url = 'http://pypi.python.org/pypi/z3c.language.switch',
     packages = find_packages('src'),
     include_package_data = True,
     package_dir = {'':'src'},
@@ -73,6 +78,5 @@
         'zope.lifecycleevent',
         'zope.app.generations',
         ],
-    dependency_links = ['http://download.zope.org/distribution'],
     zip_safe = False,
     )

Modified: z3c.language.switch/trunk/src/z3c/language/switch/README.txt
===================================================================
--- z3c.language.switch/trunk/src/z3c/language/switch/README.txt	2008-01-25 05:33:43 UTC (rev 83225)
+++ z3c.language.switch/trunk/src/z3c/language/switch/README.txt	2008-01-25 05:58:47 UTC (rev 83226)
@@ -1,8 +1,8 @@
-======
-README
-======
+=================
+Langauge Switcher
+=================
 
-Let's show how z3c.language.switch works:
+Let's show how ``z3c.language.switch`` works:
 
 Imports and placeless setup:
 
@@ -47,29 +47,29 @@
   >>> obj._data.keys()
   ['de', 'fr']
 
-Remove default language object will end in a ValueError error:
+Remove default language object will end in a ``ValueError`` error:
 
   >>> obj.removeLanguage('de')
   Traceback (most recent call last):
   ...
   ValueError: cannot remove default language (de)
 
-Remove nonexistent language object will end in a ValueError error:
+Remove nonexistent language object will end in a ``ValueError`` error:
 
   >>> obj.removeLanguage('undefined')
   Traceback (most recent call last):
   ...
   ValueError: cannot remove nonexistent language (undefined)
 
-Set default language to a non existent language will end in a ValueError:
+Set default language to a non existent language will end in a ``ValueError``:
 
   >>> obj.setDefaultLanguage('en')
   Traceback (most recent call last):
   ...
   ValueError: cannot set nonexistent language (en) as default
 
-Access the language directly via the II18nLanguageSwitch adapter,
-first register the adapter for the I18nContentObject:
+Access the language directly via the ``II18nLanguageSwitch`` adapter,
+first register the adapter for the ``I18nContentObject``:
 
   >>> zope.component.provideAdapter(I18nContentObjectLanguageSwitch,
   ...     (II18nContentObject,), provides=II18nLanguageSwitch)
@@ -80,13 +80,13 @@
   >>> adapted.title
   u'de_title'
 
-Change the default language and access the title again, the title should not 
+Change the default language and access the title again, the title should not
 switch to another language:
 
   >>> obj.setDefaultLanguage('fr')
   >>> adapted.title
   u'de_title'
-  
+
 Switch the language to 'fr'  via the adapter:
 
   >>> adapted.setLanguage('fr')
@@ -98,10 +98,10 @@
   >>> placelesssetup.tearDown()
 
 
-AvailableLanguagesVocabulary
-----------------------------
+``AvailableLanguagesVocabulary`` Vocabulary
+-------------------------------------------
 
-Use this vocabulary for get the available languages from the object 
+Use this vocabulary for get the available languages from the object
 itself.
 
   >>> from z3c.language.switch import vocabulary



More information about the Checkins mailing list