Hi,
We have set up a documentation system for extension points. The goal
of this system is to be able to generate documentation of existing
extension points in the platform as well as documenting contributions.
The document system is called nxpointdoc. It's a set of Python script
that can work on a Nuxeo EP checkout and generate HTML pages with the
documentation.
The documentation content for extension point declarations and
contributions can be directly authored inside corresponding xml
files. Maintenance should be easy since you just have to add dome tag
to your XPoint declaration or contribution to have them documented
and included into genrated pages.
Please start documenting your extension points to have them all
documented by the end of the week. It will also allow to test the
documentation system for real.
Laurent will send a mail with details.
Extension Point Documentation example site: <http://
public.dev.nuxeo.com/~lgodard/nxpointdoc/>.
To learn how to document your extension points, please see:
<http://svn.nuxeo.org/trac/nuxeo/browser/tools/nxpointdoc/doc/
DocumentingComponents.odt?format=raw>.
To download the software to try it:
<http://svn.nuxeo.org/trac/nuxeo/browser/tools/nxpointdoc>.
Do not hesitate to send feedback on this documentation system. It
will evolve to better match future requirements. For now it's
designed to be simple enough to enable easy documentation and
maintenance of extension points.
Thanks,
EB.
--
Éric Barroca - Ex. VP of Operations - +33 6 21 74 77 64
www.nuxeo.com - Nuxeo: Open Source ECM - www.nuxeo.org
Nuxeo EP 5: extensible, Java EE and standards based ECM Platform !
_______________________________________________
ECM mailing list
[email protected]
http://lists.nuxeo.com/mailman/listinfo/ecm
