What is NuxDocument ?

  NuxDocument is a Zope product that represents generic documents by using
  plugins to convert native productivity suite formats to HTML (for viewing or
  previewing in a regular browser) or to plain text (for indexing).

  There are currently 6 available plugins:

    - MSOffice (Word / Excel / PowerPoint)

      Needs: wvWare (http://www.wvware.com), xlhtml (http://www.xlhtml.org/)
      and ppthtml (http://www.xlhtml.org/ too).

    - OpenOffice.org (word processor / presentation / spreadsheet)

      Needs: xsltproc from libxml2 (http://xmlsoft.org/XSLT/) and unzip.

    - RTF

      Needs: GNU unRTF (http://www.gnu.org/directory/GNUunRTF.html).

    - PDF
    
      Needs: xpdf (http://www.foolabs.com/xpdf/).

    - HTML

    - Dumb

  Note that the lynx web browser is also needed to run most of the NuxDocument
  plugins.

  NuxDocument is an extension of Eric Barroca's MSWordDocument. It's CMF aware
  but limited to Unix/Linux-like platforms. It needs external programs to
  actually do the conversions.

  We're starting to put internationalisation into NuxDocument using Localizer
  (http://www.nuxeo.org/localizer).

Installation

  Install the product in Products. The ZNuxDocument product should appear in
  the ZMI.

  If you want to use NuxDocument in the CMF, it's a bit more painful.  You have
  to:

    1) Go to 'portal_types' in the CMF, slectionner the 'Contents' tab, then
    'Factory-based type information' in the 'Add' menu.  Choose
    'id'='NuxDocument' and  'default type information'='NuxDocument:
    CMFNuxDocument'.

    2) Go to the 'portal_skins' tool in the CMF, then the 'Contents' tabs. Add
    a 'Filesystem Directory View'.  Choose
    'Products/NuxDocument/skins/NuxDocument' in the menu.

    Then go to the 'Properties' tab, and add 'NuxDocument' after 'custom' in
    each skin, then click 'Save'.

  'NuxDocument' should now appear in the CMF's 'Add Contents' page.


TODO

  Create an icon.

  Finish internationalisation.

  Fix all XXXes.

  Don't register a plugin when the appropriate external program is missing.

  Improve metadata support (title, etc).

  Provide the right mime type.

  Understand and correct the issues with file extensions and character
  encoding (UTF8 vs ...).

  Provide useful error messages.

  Correct bugs in file BOGUES (french).

  Add a configurer ? (to set storage policy, character set policy)


BUGS

  If you find bugs, please start by running the unit tests::

    EXPORT ZOPE_HOME=/your/zope/root
    cd Products/NuxDocument/tests
    python test_all.py

  Plugin tests should all pass, except when some external tool is missing.

  Send bug reports or comments to -> sf@fermigier.com


THANKS / CREDITS

  Eric Barroca <eb@nuxeo.com>: implementation of MSWordDocument, beta-testing.

  Jean-Paul Smets <jp@nexedi.com>: discussion about initial plugin system
  design.

  Dirk Datzert <Dirk.Datzert@gmx.de>: initial implementation of XLS and PPT
  support and internationalisation support.

  Juan David Ibanez Palomoar <jdavid@nuxeo.com>: initial Localizer support.

  Frank Bennett <bennett@nomolog.nagoya-u.ac.jp>: bug report.

  The Nuxeo CPS team: debugging.

  Zope Corp, Pythonlabs and all the crew.

  Chris H: bug report.

  Florent Guillaume (Nuxeo): icon support, refactoring of plugins.

  Bertrand Croq (Virtual Net): patches.

