[Checkins] SVN: hurry.tinymce/trunk/ Clean up documentation, preparing for release.
Martijn Faassen
faassen at infrae.com
Mon Oct 13 08:42:40 EDT 2008
Log message for revision 92101:
Clean up documentation, preparing for release.
Changed:
A hurry.tinymce/trunk/CHANGES.txt
U hurry.tinymce/trunk/README.txt
U hurry.tinymce/trunk/setup.py
D hurry.tinymce/trunk/src/hurry/tinymce/README.txt
A hurry.tinymce/trunk/src/hurry/tinymce/basic.txt
U hurry.tinymce/trunk/src/hurry/tinymce/prepare.py
U hurry.tinymce/trunk/src/hurry/tinymce/tests.py
-=-
Added: hurry.tinymce/trunk/CHANGES.txt
===================================================================
--- hurry.tinymce/trunk/CHANGES.txt (rev 0)
+++ hurry.tinymce/trunk/CHANGES.txt 2008-10-13 12:42:40 UTC (rev 92101)
@@ -0,0 +1,7 @@
+CHANGES
+*******
+
+3.2.0.2 (2008-10-13) (TinyMCE version: 3.2.0.2)
+===============================================
+
+* Initial public release.
Modified: hurry.tinymce/trunk/README.txt
===================================================================
--- hurry.tinymce/trunk/README.txt 2008-10-13 12:12:42 UTC (rev 92100)
+++ hurry.tinymce/trunk/README.txt 2008-10-13 12:42:40 UTC (rev 92101)
@@ -1,13 +1,52 @@
-Preparing hurry.yui before release
-==================================
+hurry.tinymce
+*************
-Follow the regular package release instructions, but before egg
-generation (``bdist_egg``) first execute ``bin/yuiprepare <version
-number>``, where version number is the version of the YUI release, such
-as ``2.6.0``. This will do two things:
+Introduction
+============
-* download the YUI of that version and place it in the egg
+This library packages TinyMCE_ for `hurry.resource`_.
-* download the YUI dependency structure of that YUI version and generate
- a ``yui.py`` file in the package that reflects this.
+.. _`hurry.resource`: http://pypi.python.org/pypi/hurry.resource
+.. _TinyMCE: http://tinymce.moxiecode.com/
+
+How to use?
+===========
+
+You can import ``tinymce`` like this::
+
+ from hurry.tinymce import tinymce
+
+And then to trigger inclusion in the web page, anywhere within
+your page or widget rendering code, do this::
+
+ tinymce.need()
+
+This requires integration between your web framework and
+``hurry.resource``, and making sure that the original resources
+(shipped in the ``tinymce-build`` directory in ``hurry.tinymce``) are
+published to some URL.
+
+The package has already been integrated for Grok_ and Zope 3. If you
+depend on the `hurry.zopetinymce`_ package in your ``setup.py``, the
+above example should work out of the box.
+
+.. _`hurry.zopetinymce`: http://pypi.python.org/pypi/hurry.zopetinymce
+
+.. _Grok: http://grok.zope.org
+
+Preparing hurry.tinymce before release
+======================================
+
+This section is only relevant to release managers of ``hurry.tinymce``; if
+you don't know whether you are, you aren't.
+
+When releasing ``hurry.tinymce``, an extra step should be
+taken. Follow the regular package `release instructions`_, but before
+egg generation (``python setup.py register sdist upload``) first
+execute ``bin/tinymceprepare <version number>``, where version number is
+the version of the TinyMCE release, such as ``3.2.0.2``. This will download
+the TinyMCE code of that version and place it in the egg.
+
+.. _`release instructions`: http://grok.zope.org/documentation/how-to/releasing-software
+
Modified: hurry.tinymce/trunk/setup.py
===================================================================
--- hurry.tinymce/trunk/setup.py 2008-10-13 12:12:42 UTC (rev 92100)
+++ hurry.tinymce/trunk/setup.py 2008-10-13 12:42:40 UTC (rev 92101)
@@ -1,11 +1,26 @@
from setuptools import setup, find_packages
-TINYMCE_VERSION = '2.6.0'
+TINYMCE_VERSION = '3.2.0.2'
+import sys, os
+
+def read(*rnames):
+ return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+
+long_description = (
+ read('README.txt')
+ + '\n' +
+ read('CHANGES.txt')
+ + '\n' +
+ 'Download\n'
+ '********\n'
+ )
+
setup(
name='hurry.tinymce',
version=TINYMCE_VERSION + 'dev',
- description="tinymce for hurry.resource.",
+ description="TinyMCE for hurry.resource.",
+ long_description=long_description,
classifiers=[],
keywords='',
author='Martijn Faassen',
Deleted: hurry.tinymce/trunk/src/hurry/tinymce/README.txt
===================================================================
--- hurry.tinymce/trunk/src/hurry/tinymce/README.txt 2008-10-13 12:12:42 UTC (rev 92100)
+++ hurry.tinymce/trunk/src/hurry/tinymce/README.txt 2008-10-13 12:42:40 UTC (rev 92101)
@@ -1,31 +0,0 @@
-hurry.yui
-=========
-
-Introduction
-------------
-
-This library packages tinymce for ``hurry.resource``.
-
-Let's set up a way to render URLs; typically the framework has already
-done this::
-
- >>> def get_library_url(library):
- ... return 'http://localhost/static/%s' % (
- ... library.name)
- >>> from hurry.resource import Library
- >>> from hurry.resource.interfaces import ILibraryUrl
- >>> from zope import component
- >>> component.provideAdapter(
- ... factory=get_library_url,
- ... adapts=(Library,),
- ... provides=ILibraryUrl)
-
-Let's now check whether we can need tinymce::
-
- >>> from hurry import tinymce
- >>> from hurry.resource import NeededInclusions
- >>> needed = NeededInclusions()
- >>> needed.need(tinymce.tinymce)
- >>> print needed.render()
- <script type="text/javascript" src="http://localhost/static/tinymce/tiny_mce_src.js"></script>
-
Copied: hurry.tinymce/trunk/src/hurry/tinymce/basic.txt (from rev 92096, hurry.tinymce/trunk/src/hurry/tinymce/README.txt)
===================================================================
--- hurry.tinymce/trunk/src/hurry/tinymce/basic.txt (rev 0)
+++ hurry.tinymce/trunk/src/hurry/tinymce/basic.txt 2008-10-13 12:42:40 UTC (rev 92101)
@@ -0,0 +1,28 @@
+some basic tests for hurry.tinymce
+==================================
+
+This library packages TinyMCE for ``hurry.resource``.
+
+Let's set up a way to render URLs; typically the framework has already
+done this::
+
+ >>> def get_library_url(library):
+ ... return 'http://localhost/static/%s' % (
+ ... library.name)
+ >>> from hurry.resource import Library
+ >>> from hurry.resource.interfaces import ILibraryUrl
+ >>> from zope import component
+ >>> component.provideAdapter(
+ ... factory=get_library_url,
+ ... adapts=(Library,),
+ ... provides=ILibraryUrl)
+
+Let's now check whether we can need tinymce::
+
+ >>> from hurry import tinymce
+ >>> from hurry.resource import NeededInclusions
+ >>> needed = NeededInclusions()
+ >>> needed.need(tinymce.tinymce)
+ >>> print needed.render()
+ <script type="text/javascript" src="http://localhost/static/tinymce/tiny_mce_src.js"></script>
+
Modified: hurry.tinymce/trunk/src/hurry/tinymce/prepare.py
===================================================================
--- hurry.tinymce/trunk/src/hurry/tinymce/prepare.py 2008-10-13 12:12:42 UTC (rev 92100)
+++ hurry.tinymce/trunk/src/hurry/tinymce/prepare.py 2008-10-13 12:42:40 UTC (rev 92101)
@@ -7,7 +7,7 @@
try:
version = sys.argv[1]
except IndexError:
- print "Usage: tinymceprepare <YUI version>"
+ print "Usage: tinymceprepare <tinyMCE version>"
return
# download tinymce library into package
Modified: hurry.tinymce/trunk/src/hurry/tinymce/tests.py
===================================================================
--- hurry.tinymce/trunk/src/hurry/tinymce/tests.py 2008-10-13 12:12:42 UTC (rev 92100)
+++ hurry.tinymce/trunk/src/hurry/tinymce/tests.py 2008-10-13 12:42:40 UTC (rev 92101)
@@ -7,7 +7,7 @@
suite = unittest.TestSuite()
suite.addTest(doctest.DocFileSuite(
- 'README.txt',
+ 'basic.txt',
globs=globs,
optionflags=optionflags))
return suite
More information about the Checkins
mailing list