Forgot your password?
New user?
Document Actions
confdoctool
Category: Development tools, Documentation management
—
Other products by this author
Current release
No stable release available yet.
Experimental releases
Upcoming and alpha/beta/candidate releases
- Alpha releases should only be used for testing and development.
- Beta releases and Release Candidates are normally released for production testing, but should not be used on mission-critical sites.
- Always install on a separate test server first, and make sure you have proper backups before installing.
Project Description
- Project resources
Releasesconfdoc.py
Goal
XML (ZCML) is very powerful for describing things. When you write a Zope3 package or a Plone Product, you write some *.zcml and if you use GenericSetup, some *.xml files as well.
But, having to read several (*.zcml, or *.xml) files is not practical.
If you get any Zope3 package or Plone Product, you have to open many files to see what is configured in these files !
How much time lost to open/close files! I don't talk about time to abstract tags when you read these files.
Saying "Grrrr " each time is not optimal :)
A beginning of an elegant solution (without using Grok :)) is confdoc.py.
confdoc.py browses your package :
- creates a configure.html file which gathers *.zcml configuration in one tree you can expand/fold with a simple clic on any branch.
- makes same thing with your profiles directory (if exists) and its *xml files (case of a Plone's Product)
- this files are created on a 'docs'(created too if not exists) in your package directory.
You can see results of this script in :
demo/optilux/policy/docs :
- configure.html
- profiles.html
Usage
run ./confdoc.py package/path/ like this for rebuild demo Martin Aspeli
$ python confdoc.py demo/optilux/policy/
Ok now, if you like this script I encourage you to improve it, and document your Zope3 package / Plone products with it.
Enjoy !
| Author: | Jean-Philippe Camguilhem |
|---|---|
| Contact: | jpc@makina-corpus.com |
