Le 7 juil. 09 à 12:22, Mikko Ohtamaa a écrit :
Hi,
Hi,
This is a notice for those who do not follow docteam list.
"Developer manual" (final name is not yet decided) is a process to
replace
the old "Common Plone programming recipes" tutorial. It is aimed to
be a
community maintained effort to have sane Plone developer
documentation. It
will mainly consist of snippets of code to show how to use Plone API
and
references to other documentation.
Current effort is in collective SVN until Plone Help Center gets
updated.
For more information, read this post:
http://n2.nabble.com/Plone-dev-manual-update-part-II-tp3218404p3218404.html
See the current effort:
https://svn.plone.org/svn/collective/collective.developermanual/trunk/
Great initiative.
May I suggest to use Sphinx to structure all this (table of contents,
code coloration, search engine, glossary, index...) ?
Most Python based projects - including Python itself - are documented
with Sphinx.
http://sphinx.pocoo.org/
I have a nice plone.org like skin for sphinx too.
Cheers
--
Gilles Lenfant
I am looking for volunteers to contribute to the effort - mainly
seasoned
Plone developers.
If you encounter undocumented tasks in your daily Plone work, just
drop few
lines of code snippets to the developer documentation repository as
plain
text, restructured text or HTML text files. I'll arrange all of it
together
later.
Some example areas which need to be covered: working with Archetypes
objects, using portal_catalog, events, using workflows
programmatically,
migrating old Common Plone recipes documentation.
Cheers,
Mikko
--
View this message in context:
http://n2.nabble.com/Plone-developer-manual-tp3218436p3218436.html
Sent from the Product Developers mailing list archive at Nabble.com.
_______________________________________________
Product-Developers mailing list
[email protected]
http://lists.plone.org/mailman/listinfo/product-developers
_______________________________________________
Product-Developers mailing list
[email protected]
http://lists.plone.org/mailman/listinfo/product-developers
