-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Hi Dave,
I've implemented a Python script for building the documentation in
the /doc/ directories of CPS products. This script will do the
following:
- Build HTML files for .txt files in /doc/ directories.
- Build PDF files.
- Generate index files, one for HTML and one for PDF.
- Produce distribution files containing the source and generated
files.
I've attached the script, documentation (README.txt and
README.html), and a support file.
That's really great !
Thanks a lot for your work on the documentation files.
I was almost dreaming of that. ;-)
Eventually, I'd like to use this to build distributions of the
documentation and then post it at cps-project.org under
"Documentation/For developers" (or maybe "Documentation/For
users"?).
For that, we have something interesting to propose.
Anahide (the famous one :-) is working on a project for one of our
customer to manage technical documentation (not for software, for
financial audits, but it's the same needs :-).
This project defines a new object called "Ouvrage". An "Ouvrage"
contains a hierarchy of "Chapters". Each "Chapter" can be described
with metadata. Sections contains other Chapters or "Texts".
A Text is a link (a proxy in fact) to a Document (HTML or PDF) in a
workspace or a section. A Document has metadatas and an attached file
that can be HTML or Docbook XML. Then the ouvrage can be published
into a section. When the ouvrage is published the version is frozen
so that next modification to the Ouvrage upgrade the version number
(yes, really ;-).
The Ouvrage offers some easy management interface and a tool to
identify which Texts/Documents have changed in workspaces/sections
since the last version and a one-click action to upgrade all links to
Documents.
The Basic idea would be to import regularly all HTML documents
produced by your tool into one or several workspaces (of cps-
project). Then build one or more Ouvrage that would use those
documents. Then we can publish regularly those Ouvrages in the public
area (and maybe add some features like PDF export of the whole stuff).
The interesting part is that we would have a flexible tool to manage
documentation books and easily organize the documentation in those
books.
Now the fun part... ;-)
When an Ouvrage is published CPS generate an export into a ZIP file
at a given format (I won't detail it here but I'm available for more
informations).
We build a rich client application (based on Eclipse) that can
connect to a repository of published ouvrage, download them and
install them locally. Then it provide a nice navigation interface,
with local search, bookmarks, annotations, etc.
Moreover, the rich client can synchronize with the repository of
ouvrage to download new ouvrage or update existing ones. With that,
you can have all the documentation available and searchable offline
with a powerful interface.
If you are interested to work on this project (Ouvrage in cps-
project), we would be very grateful. You can contact Anahide and me
in private if interested (of course, if others want to help, they are
really welcome :-). I think this would be the start of a good and
usable CPS documentation.
Anyway, thanks a lot for your work and I wish you an happy new year,
EB.
- --
Éric Barroca, Tel: +33 6 21 74 77 64 (mobile).
Nuxeo Collaborative Portal Server: http://www.nuxeo.com/cps
Gestion de contenu web / portail collaboratif / groupware / open source!
www.nuxeo.com - www.cps-project.org - www.indesko.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (Darwin)
iEYEARECAAYFAkO8g/wACgkQz/zbrAllSZ5JSwCdEm6yTyUFHa1ClEIT3hn7Ib/g
eycAnifuG1Xx44cY3DvTGPFGFSU3mbAI
=SowP
-----END PGP SIGNATURE-----
_______________________________________________
cps-devel mailing list
http://lists.nuxeo.com/mailman/listinfo/cps-devel
