source: trunk/plugins/ImageManager/README.txt @ 47

Last change on this file since 47 was 47, checked in by yermol, 15 years ago

images_url config option in image-manager.js relative to _editor_url
updated README file.

File size: 5.1 KB
Line 
1Originally Developed by: http://www.zhuo.org/htmlarea/
2
3> This is a plug-in for HTMLArea 3.0
4>
5> The PHP ImageManager + Editor provides an interface to
6> browser for image files on your web server. The Editor
7> allows some basic image manipulations such as, cropping,
8> rotation, flip, and scaling.
9>
10> Further and up-to-date documentation can be found at
11> http://www.zhuo.org/htmlarea/docs/index.html
12>
13> Cheer,
14> Wei
15
162005-03-20
17  by Yermo Lamers of DTLink, LLC (http://www.formvista.com/contact.html)
18
19Please post questions/comments/flames about this plugin in the Xinha forums
20at
21
22   http://xinha.gogo.co.nz/punbb/viewforum.php?id=1
23
24------------------------------------------------------------------------------
25To get this working check see config.inc.php for configuration values.
26
27Most likely you will need to adjust images_dir and images_url if you have
28not unpacked Xinha in your DOCUMENT_ROOT.
29
30For demo purposes ImageManager is set up to view images in the
31
32   /xinha/plugins/ImageManager/demo_images
33
34directory. This is governed by the images_dir and images_url config options.
35
36The permissions on the demo_images directory may not be correct. The directory
37should be owned by the user your webserver runs as and should have 755
38permissions.
39
40--------------------------------------------------------------------------------
41
42
43
44I've  packaged  this  up to be distributed with Xinha. In order
45for  this  to  work  as  is, you either have to unpack Xinha in
46DOCUMENT_ROOT  or you will need to edit config.inc.php to match
47your install.
48
49By  default this ImageManager is set up to browse some graphics
50in plugins/ImageManager/demo_images.
51
52For  security reasons image uploading is turned off by default.
53You can enable it by editing config.inc.php.
54
55---------------------------------
56For Developers
57---------------------------------
58
59CHANGES FROM Wei's Original Code:
60
61Single Backend:                                                         
62---------------
63
64All  requests  from  the javascript code back to the server now
65are  routed  through  a  single  configurable  backend  script,
66backend.php.
67
68Request URLs are of the form:
69
70 <config backend URL>(?|&)plugin=ImageManager&f=<function>&arg=value&arg=value
71
72The default URL is plugins/xinha/backend.php.
73
74This  approach  makes  it  possible  to  completely replace the
75backend  with  a  perl  or ASP implementation without having to
76change any of the client side code.
77
78You  can  override  the  location  and  name of the backend.php
79script by setting the config.ImageManager.backend property from
80the  calling  page. Make sure the URL ends in an "&". The code,
81for now, assumes it can just tack on variables.
82
83For  the moment the javascript files in the assets directory do
84not  have access to the main editor object and as a result have
85not  access to the config. For the moment we use a _backend_url
86variable  output  from  PHP  to communicate the location of the
87backend  to  these  assets.  It's  a  kludge. Ideally all these
88config  values  should  be  set  from  the  calling page and be
89available through the editor.config.ImageManager object.
90
91Debug Messages
92---------------
93
94The  php files include a simple debugging library, ddt.php. See
95config.inc.php  for  how  to  turn  it on. It can display trace
96messages to the browser or dump them to a log file.
97
98I'll  try  to  package  up  the client-side tracing-to-textarea
99_ddt()  functions  I've  put  together.  Having a trace message
100infrastructure has always served me well.
101
102-------------
103Flakey Editor
104-------------
105
106The  editor  I  use  is  flakey  (but  very  very fast). It has
107problems with tab to space conversion so if the indenting looks
108weird that's why.
109
110----
111TODO
112----
113
114ImageManager really needs a complete rewrite.
115
116. ImageManager should appear in a pane instead of a popup
117  window using Sleeman's windowpane support.
118
119.  html  and  php code are intermixed. It would be very nice to
120use  some  kind  of templating for the dialogs; this templating
121should be done long hand so it can be re-used regardless of the
122backend implementation language.
123
124.  the  config  should  probably  be  some format that would be
125easily  read  by  multiple  implementations of the back end. It
126would  be nice to have a single configuration system regardless
127of whether the backend is PHP, Perl or ASP.
128
129.  javascript assets are not objects. Passing config options to
130the  assets  functions requires intermediate variables which is
131really  ugly.  Everything should be cleanly integrated into the
132object heirarchy akin to the way Linker is done.
133
134.  if  an  image is selected from the document editor window it
135should  be  focused  and  highlighted  in  the  image selection
136window.
137
138. fix fully-qualified url in image selection box under MSIE.
139
140. per-image permissions. We should include some kind of backend
141permissions      management      so      users     can     only
142delete/edit/move/rename images that they have uploaded.
143
144. add a CANCEL button and a SAVE AS button to the editor.
145
146.  add  a  list view akin to EFM. (and include image properties
147width/height/depth/etc.)
148
149.  figure  out  a way for ImageManager to work "out of the box"
150regardless of install.
151
152. client-side tracing.
153
154. fancy stuff like adding a UI to define rollovers, animations,
155etc.
156
Note: See TracBrowser for help on using the repository browser.