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

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

couple last minute config tweaks.

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