DocumentLibrary / src / DocumentLibrary /
@Alex Tucker Alex Tucker authored on 23 Feb 2004
..
CVS Updated to CVS head 20 years ago
FileConverters Attempt to cope with latin-1 encoding from pdftotext. 20 years ago
document_icons Updated to CVS head 20 years ago
dtml Unpacked vendor sources 20 years ago
instance Unpacked vendor sources 20 years ago
tests Added new test for catalog re-initialization. Attempt to force use of UnicodeSplitter in CatalogPlus 20 years ago
www Unpacked vendor sources 20 years ago
CatalogPlus.py Added new test for catalog re-initialization. Attempt to force use of UnicodeSplitter in CatalogPlus 20 years ago
DLGlobals.py Unpacked vendor sources 20 years ago
Document.py Fixed exception when no topic defined. Added functionality to etools.py. Removed bogus fix for latin charset in Document.py. 20 years ago
DocumentLibrary.py Unpacked vendor sources 20 years ago
DocumentStore.py Fixed exception when no topic defined. Added functionality to etools.py. Removed bogus fix for latin charset in Document.py. 20 years ago
HISTORY.txt Unpacked vendor sources 20 years ago
INSTALL.txt Updated to CVS head 20 years ago
IconImage.py Unpacked vendor sources 20 years ago
LICENSE.txt Unpacked vendor sources 20 years ago
README.txt Updated to CVS head 20 years ago
TODO.txt Unpacked vendor sources 20 years ago
TopicIndex.py Updated to CVS head 20 years ago
__init__.py Unpacked vendor sources 20 years ago
etools.py Fixed exception when no topic defined. Added functionality to etools.py. Removed bogus fix for latin charset in Document.py. 20 years ago
refresh.txt Unpacked vendor sources 20 years ago
text.c.patch Unpacked vendor sources 20 years ago
version.txt Unpacked vendor sources 20 years ago
README.txt
DocumentLibrary Product

  The DocumentLibrary is designed to be a drop-in Zope product
  that allows you to create full-text searchable and browsable
  document libraries. It requires Zope 2.3.2 or higher.
  It also requires the BTreeFolder product version 0.2, which 
  is included in the package.

  Document Storage

    This product comes with a special document file class that
    allows you to store and index several file formats
    in the library. Since they are Zope objects, you can
    also associate arbitrary metadata with your documents.
    The default installation includes a subset of the 
    Dublin Core document metadata standard:

    - identifier:*    Absolute URL of the document

    - title:          User specified title

    - creator:        Original author

    - description:    Document abstract

    - date:           Creation or revision date

    - type:           General category

    - format:*        MIME format of the document data

    - source:*        URI of original document (if any)

    - subject:*       Topic index titles assigned to document.

    *Indicates attributes that are derived programmatically.    
    
    In addition, the following properties are available:

    - review_date:    Date the document was reviewed.

    - topics:         Python list of topic index ids assigned.    

    - filename:	      The original file name of the file submitted.

    Documents stored in the library have fixed property sheets
    that are managed centrally. This allows you to modify the 
    property metadata schema for all documents at once.

    The documents are indexed when they are submitted to the
    library. Currently full-text indexing is supported for
    the following file formats:

    - Plain Text

    - HTML/XML

    - PDF

    - Postscript

    - Microsoft Word (6.0/95, 97 & 2000 formats)

    - Microsoft Excel

    - Microsoft Powerpoint

    - Wordperfect

    A plug-in architecture for full-text converters has been
    implemented to make adding support for new file formats
    as simple as possible.

    Document file objects can also be used independently of the
    library if you want to use their text indexing facilities
    separately.

  Topic Index

    The library supports a hierarchical indexing system to
    categorize documents. A single document can be assigned to 
    as many different topic indexes as desired.

    To enhance the look and feel of your library interface,
    Topic Indexes can be assigned custom icons from within the
    Zope management interface.

    The default user interface is a hierarchical drill-down
    through the index. It is essentially a simplified tree
    interface. This can be completely customized for your needs
    by modifying the DTML methods in the library.

    An entire topic index hierarchy can be imported at once
    from a text file containing a tabbed outline. A sample
    legal services topic index is available for download.

  Searching

    The library includes two interfaces for users to use for
    queries: a simple search that searches all document 
    meta-data and text simultaneously and an advanced search 
    that allows more refined searches.

    The search machinery uses Zope Catalogs, and so has simple
    boolean search support ("and", "or", "and not" and near "...")
    for textual content and meta-data.

    Localized searching is also supported to allow users to
    perform searches on only those documents under a specific
    topic index.
    
  Document Submission and Review

    Documents can be submitted to the library by any users you
    choose to grant this permissions to, including anonymous users.
    Documents are submitted by uploading a file from the user's
    computer or by specifying a URL where the document resides.
    If a URL is specified, the file data is retrieved and stored
    in the document file at upload time.

    To guard against inappropriate submissions, a review feature
    is implemented to allow one or more reviewers to approve or
    reject submissions. To allow the delegation of this review
    process to several people, each reviewer can be assigned a
    separate topic index that review documents for.

    A further safeguard is a list of file types that are not
    allowed in the library. This can be modified to restrict
    certain unsafe file types. By default, all unknown binary
    files (such as executables) cannot be uploaded into the
    library. This can be modified by going to the Properties tab
    of a document library object.