Permalink
Browse files

doc update

  • Loading branch information...
1 parent d2172d8 commit c1a5982fb1f92279728cd7d899c282bc19168253 @smcmahon smcmahon committed Sep 25, 2012
Showing with 41 additions and 44 deletions.
  1. +1 −1 MANIFEST.in
  2. +32 −24 README.rst
  3. +6 −6 buildout.cfg
  4. +2 −13 src/templer/dexterity/templates/dexterity/buildout.cfg_tmpl
View
@@ -1,3 +1,3 @@
-recursive-include zopeskel *
+recursive-include src *
recursive-include docs *
global-exclude *pyc
View
@@ -3,8 +3,9 @@ Introduction
Dexterity is a content-type development tool for Plone. It supports
Through-The-Web and filesystem development of new content types for Plone.
+Templer is a Python source package skeleton creator.
-zopeskel.dexterity provides a mechanism to quickly create Dexterity add on
+templer.dexterity provides a mechanism to quickly create Dexterity add-on
skeletons. It also makes it easy to add new content types to an existing
skeleton. New content types built with this tool will support round-trip
elaboration with Dexterity's TTW schema editor.
@@ -16,22 +17,22 @@ instance and be ready to start learning to use it.
Installation
============
-Add these lines into buildout::
+Add these lines into buildout.cfg::
[buildout]
- parts =
- zopeskel
-
- [zopeskel]
+ parts =
+ templer
+
+ [templer]
recipe = zc.recipe.egg
- eggs =
- ZopeSkel
- Paste
- PasteDeploy
+ eggs =
PasteScript
- zopeskel.dexterity
+ templer.core
+ templer.zope
+ templer.plone
+ templer.dexterity
${buildout:eggs}
-
+
And run the buildout
Usage
@@ -40,46 +41,53 @@ Usage
Creating a dexterity content package, typically done in your buildout's src
directory::
- ../bin/zopeskel dexterity
+ ../bin/templer dexterity
Adding a content-type skeleton to an existing package::
- cd yourbuildout/src/your-product
- ../../bin/paster addcontent dexterity_content
+ cd yourbuildout/src/your-product/src
+ ../../../bin/paster addcontent dexterity_content
Adding a behavior skeleton::
- cd yourbuildout/src/your-product
- ../../bin/paster addcontent dexterity_behavior
-
+ cd yourbuildout/src/your-product/src
+ ../../../bin/paster addcontent dexterity_behavior
+
Notes
=====
Egg Directories
---------------
-In order to support local commands, ZopeSkel/Paster will create Paste,
+In order to support local commands, templer will create Paste,
PasteDeploy and PasteScript eggs inside your product. These are only needed
for development. You can and should remove them from your add-on distribution.
+Also remove::
+
+ setup_requires=["PasteScript"],
+ paster_plugins=["templer.localcommands"],
+
+from the packages setup.py.
+
Errors
------
If you hit and error like this::
- pkg_resources.DistributionNotFound: plone.app.relationfield: Not Found for: my.product (did you run python setup.py develop?)
+ pkg_resources.DistributionNotFound: plone.app.relationfield: Not Found for: my.product (did you run python setup.py develop?)
when attempting to run `paster addcontent`, then you need to ensure that
Paster knows about all the relevant eggs from your buildout.
Add `${instance:eggs}` to your `paster` section in your buildout, thusly::
- [zopeskel]
+ [templer]
recipe = zc.recipe.egg
- eggs =
+ eggs =
...
${instance:eggs}
- entry-points = paster=paste.script.command:run
-
+ entry-points = paster=paste.script.command:run
+
where `instance` is the name of your ``plone.recipe.zope2instance`` section.
Re-run the buildout and the issue should be resolved.
View
@@ -1,16 +1,16 @@
[buildout]
-develop = .
-parts =
+develop = .
+parts =
scripts
- test
+ test
versions = versions
[versions]
ZopeSkel = 2.21.2
[scripts]
recipe = zc.recipe.egg
-eggs =
+eggs =
ZopeSkel
PasteScript
PasteDeploy
@@ -21,5 +21,5 @@ eggs =
[test]
recipe = zc.recipe.testrunner
defaults = ['--tests-pattern', '^f?tests$', '-v']
-eggs =
- zopeskel.dexterity
+eggs =
+ templer.dexterity
@@ -1,24 +1,13 @@
[buildout]
-develop = .
+develop = .
parts = scripts test
versions = versions
-extends =
+extends =
http://dist.plone.org/release/4.0.1/versions.cfg
http://good-py.appspot.com/release/dexterity/1.0b1?plone=4.0.1
[versions]
-[scripts]
-recipe = zc.recipe.egg
-eggs =
- ${namespace_package}.${package}
- zest.releaser
- ZopeSkel
- PasteScript
- PasteDeploy
- Paste
- zopeskel.dexterity
-
[test]
recipe = zc.recipe.testrunner
defaults = ['--tests-pattern', '^f?tests$', '-v']

0 comments on commit c1a5982

Please sign in to comment.