You need to log in before you can comment on or make changes to this bug.
The first draft of the "Application Developers Guide" has been checked into CVS. The source is in docs/xml/ApplicationDevelopersGuide.xml and the HTML version is in docs/html/ApplicationDevelopersGuide.html. I have tried to keep the changes to this document to a minimum (as more complete changes will be added for 2.0). However, there are substantial new sections, including "Widget Maturity Levels" and "Step 4 - Running Your Application". Some specific thing that still need to be done: * Are there any other sections that really need to be in this 1.99 version? If so, what are they? * Do you think we should include a basic section on mapfiles in this document - or is that for MapServer documentation to explain? * In the "Step 4 - Running Your Application" section, I need someone (Paul?) to write me a little material to fill out: "Chameleon allows PHP variables to be passed to the template via the setVar method. For more information see ?????." * In the "Step 4 - Running Your Application" section, I need someone (Paul?) to write me a little material to fill out: "If you have a context file you wish to load into your application you may:?????" Please read through it and make any changes/deletions/additions you feel are necessary. You can either change the *source* yourself (DO NOT CHANGE THE HTML), or make a comment in this bug about what you feel needs changing. Everyone is welcome to comment, but I need at least the following people to review the document: * Paul Spencer * Chris Thorne * Jeff McKenna * Jason Fournier If anyone feels that there's anyone else you definitely want to review this document, please contact them. Bug #828 is the tracking bug for this document and lists the preceding and following steps to this bug.
Set target to 1.99 RC 1.
Created an attachment (id=62) [details] a full description of the button architecture
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
Paul has asked me to review the "Customizing" sections of this document. Basically everything that has to do with css and buttonizer... I'll be reviewing that this week.
The whole skinning thing is applied NOT only to text button but to css and images also. Am I right?
it is primarily for the text buttons, but it does also apply to css, fonts and other images as well. There was something written on skinning, perhaps Jason has an electronic version of it?
OK. I have committed new XML/HTML versions of this document that contains Pauls suggestions/corrections to CVS. I also took the button architecture document and added some of it to the existing Button section of this document. I also think that it might be a good idea to release this button architecture document itself as a "technical" document for this release. What do you think, Paul? Is the additional material not already in the App. Dev. Guide worth publishing at this time? Paul, could you please have a look at what parts of it I included in the App. Dev. guide (and how I did it), and let me know what you think?
The sections that I contributed look good to me.
Created an attachment (id=65) [details] buttonizer diagram This diagram is an anatomy of a button that could be quite useful in the customising section dealing with buttonizer
TextButton SharedResource example: textbuttonbackgroundimage should be backgroundimage description of toolset: we need to add a note. Widgets that are part of a toolset maintain their state between page submits. Some widgets will automatically submit the page when clicked (like the ZoomAllLayers widget). If these widgets are made part of a toolset, then the application will go into an endless loop. Most widgets that could cause this behaviour will ignore the toolset to avoid it. However, to be safe, do not add a toolset to any widget that is not logically part of one. or something like that ... description of popupstyleresource: add "If this is not set and the styleresource is not set, then buttons in popup dialogs will be represented by <input type="button> rather than an image button." other than these minor comments, I think we should stop adding to this document for this release.
Darren, have the latest notes been incorporated? Also, Fred attached a nice image and description of the button architecture that should be incorporated. Please close if this is already done, otherwise action appropriately.
Paul, Comment 9 and Comment 10 have not been incorporated yet (which includes Fred's picture). I am assigning this bug to Jeff for him to make any remaining changes.
since Jeff isn't around today, these comments will have to be incorporated post 2.0
looking at this now
- added paul's latest comments - added fred's button graphic - corrected links in doc to ms docs - moved revision history - modified title checked xml and html into cvs
oh, also removed all references to '1.99'