Annotation of kupu/doc/IMAGEUPLOADER.txt, revision 1.1.1.1

1.1       dwinter     1: ===============================
                      2: Local image upload enhancement
                      3: ===============================
                      4: 
                      5: This document gives an overview of the enhancement and describes how
                      6: to add support for other back-end servers or CMSes.
                      7: 
                      8: Overview
                      9: ---------
                     10: 
                     11: Usage of the enhancement should be practically self-evident. Use the
                     12: image drawer to navigate to the folder/directory you want to upload
                     13: the image to, click "upload", which opens up an upload form, select an
                     14: image from your computer, enter a title for it, and click "insert".
                     15: 
                     16: 
                     17: Installation
                     18: -------------
                     19: 
                     20: By default, the enhancement is disabled. This is because initially,
                     21: there is only back-end server / CMS support for plone. Once we get
                     22: support for a few other backends, the enhancement will be enabled by
                     23: default.
                     24: 
                     25: To enable the enhancement include a tag `<uploadbutton>` in the xml
                     26: for the folder. See plone/kupu_plone_layer/kupucollection.xml.pt for
                     27: an example.
                     28: 
                     29: Technical notes
                     30: ----------------
                     31: 
                     32: The image uploader adds new code to the following files:
                     33: 
                     34:  * common/kupudrawers.js
                     35: 
                     36:  * common/kupudrawerstyles.css
                     37:  
                     38:  * common/kupudrawers/drawer.xsl
                     39: 
                     40: 
                     41: It adds the following:
                     42: 
                     43:  * this file
                     44: 
                     45:  * plone/kupu_plone_layer/kupuUploadImage.py
                     46: 
                     47:  * plone/kupu_plone_layer/kupuUploadImage.py.metadata
                     48: 
                     49: 
                     50: See kupuUploadImage.py on how to add support for uploading images to
                     51: another server/CMS.
                     52: 
                     53: 
                     54: Bugs, caveats et cetera
                     55: ------------------------
                     56: 
                     57: * After image upload, the library/collection of images does not get
                     58:   reloaded if you're using a Mozilla browser, such as FireFox. In order
                     59:   for the uploaded image(s) to be listed in the image drawer, save your
                     60:   changes and reload kupu (ie. "edit" the document again by clicking the
                     61:   "edit" tab on plone.
                     62: 
                     63: * Because of the above problem, there's an extra "reload current"
                     64:   button to manually refresh the image drawer contents

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>