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

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

adding modified version of Xiang Wei Zhuo's ImageManager? plugin that
now features a unified single entry-point backend.

Updated full_example to include ImageManager? checkbox.

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