[Chameleon-dev] [Bug 886] [Chameleon - Documentation] Review Application Developers Guide first draft

[bugzilla-daemon at maptools.org]

http://www.maptools.org/bugzilla/show_bug.cgi?id=886





------- Additional Comments From pspencer at dmsolutions.ca  2004-12-02 14:18 -------
Introduction:

o second para, first sentence, 'and then describes the advanced widget
configuration' ... I don't think 'the' is correct here.

Widget Basics:

o should add a note in here that quoting inside tags must use double quotes (").
 Single quotes (') will not work.  So type="WidgetName" is valid but
type='WidgetName' is not valid.  I'm not sure what the actual XML spec says
about this, it is possible that this is more restrictive than the XML spec and
so we should mention it.

o should add a note here that widget names are CaSe SeNsItIvE :)

Error Reporting:

o all errors will be reported in the content of the page generated by Chameleon
as HTML comments at the top of the page.  This means that you can 'view page
source' to see if there are any errors.  This is useful if you have made a
mistake with the ErrorReport widget, for instance :)  This information should be
given in this section.

Initialization File:

o right at the end of this section, it says "For more information see ?????." 
Obviously we need to document this feature or remove this bullet.  This brings
up the question of where stuff like this should be documented?

Building the Application:

o we don't need to assume Windows ... there doesn't seem to be anything that is
windows-specific here

o in Notes: we should say that if you are not using ms4w, you need to set
IMAGEPATH to a folder on your filesystem and the value in IMAGEURL must be a
web-accessible URL that points to the IMAGEPATH.  Jeff may have a better
explanation for this (perhaps from the mapserver docs?)

o last note in this section has ?????.  Let's drop this, it's an advanced topic

Widget Maturity Levels

o second sentence '... and that many others ...' use of that doesn't sound right?

o RELEASECANDIDATE - no known bugs, TECHNICALRELEASE - few known bugs (all
minor): is this reversed?  I think the TECHNICALRELEASE should have no known bugs :)

Customizing with CSS Files:

o there are a couple of [REPLACE THIS - ...] sections ...

  - 1st: default cwc2.css is available at the url that chameleon is available
at, for instance http://my.server.com/chameleon/cwc2.css

  -  2nd: can be removed.

  - may want to add that the name cwc2.css is not important, the file can be
copied, renamed and modified and then the new file can referred to in the link tag

Popup Classes:

 o PopupStylesheet should be PopupCSS.

 o same description for location and treatment of popup.css as for cwc2.css

Text Buttons:

 o this section is essentially correct but seems somewhat out of date.  For
instance:

   - TextButton is no longer used, it should now be referred to as Button.
   - the whole skinning thing should probably be described here

   I'll attach a text file that was written when the button stuff changed, some
of it is very technical but some of it would be useful in this section.  Fred
has a nice graphic of how buttons are created, and probably should review this
section as well



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.