NCCOOS Trac Projects: Top | Web | Platforms | Processing | Viz | Sprints | Sandbox | (Wind)

root/Chameleon/trunk/Chameleon/WMSBrowser/WMSBrowser.en-ca.doc.xml

Revision 13 (checked in by jcleary, 17 years ago)

Latest Chameleon code checkout from previous repository

Line 
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <ca:widgetdoc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ca="http://localhost/chameleon/utils/xml/schemas" xsi:schemaLocation="http://localhost/chameleon/utils/xml/schemas ..\..\..\utils\xml\schemas\chameleon.xsd">
3   <ca:docinfo title="Document Information">
4     <ca:language title="Document Language Code">
5       <ca:value>English (en-ca)</ca:value>
6     </ca:language>
7     <ca:docbuilddate title="Doc_Builder Date">
8       <ca:value>2004-12-18</ca:value>
9     </ca:docbuilddate>
10     <ca:docversion title="Document Repository Version">
11       <ca:value>$id: $</ca:value>
12     </ca:docversion>
13     <ca:authors title="Authors">
14       <ca:person>
15         <ca:name>Doc_Builder</ca:name>
16         <ca:company>DM Solutions Group Inc.</ca:company>
17         <ca:contact>chameleon@lists.maptools.org</ca:contact>
18         <ca:comment></ca:comment>
19       </ca:person>
20     </ca:authors>
21     <ca:editors title="Editors">
22       <ca:person>
23         <ca:name>Christopher R. Thorne</ca:name>
24         <ca:company>DM Solutions Group Inc.</ca:company>
25         <ca:contact>chameleon@lists.maptools.org</ca:contact>
26         <ca:comment></ca:comment>
27       </ca:person>
28     </ca:editors>
29   </ca:docinfo>
30   <ca:identification title="Identification">
31     <ca:name title="Name">
32       <ca:value>wmsbrowser</ca:value>
33     </ca:name>
34     <ca:chameleonpack title="Widet Package">
35       <ca:value>TBD</ca:value>
36     </ca:chameleonpack>
37     <ca:parentgroup title="Parent Group">
38       <ca:value>TBD</ca:value>
39     </ca:parentgroup>
40     <ca:version title="Version">
41       <ca:value>1.99</ca:value>
42     </ca:version>
43     <ca:releasedate title="Release Date">
44       <ca:value>1999-12-31</ca:value>
45     </ca:releasedate>
46     <ca:maturitylevel title="Maturity Level">
47       <ca:value>BETA</ca:value>
48     </ca:maturitylevel>
49     <ca:developers title="Developers">
50       <ca:person>
51         <ca:name>Paul Spencer</ca:name>
52         <ca:company>DM Solutions Group Inc.</ca:company>
53         <ca:contact>chameleon@lists.maptools.org</ca:contact>
54         <ca:comment></ca:comment>
55       </ca:person>
56     </ca:developers>
57   </ca:identification>
58   <ca:descriptions title="Description">
59     <ca:description title="General Functionality">
60       <ca:paras title="">
61         <ca:para>The WMSBrowser widget allows .....</ca:para>
62       </ca:paras>
63     </ca:description>
64     <ca:techrequirements title="Technical Requirements">
65       <ca:paras title="Not Available">
66         <ca:para></ca:para>
67       </ca:paras>
68     </ca:techrequirements>
69     <ca:dependancies title="Dependancies">
70       <ca:dependancy type="None" title="Not Available">
71         <ca:para></ca:para>
72       </ca:dependancy>
73     </ca:dependancies>
74     <ca:sharedresources title="Shared Resources">
75       <ca:paras title="Not Available">
76         <ca:para></ca:para>
77       </ca:paras>
78     </ca:sharedresources>
79     <ca:embeddedhelp title="General User Interface Help">
80       <ca:paras title="">
81         <ca:para></ca:para>
82       </ca:paras>
83     </ca:embeddedhelp>
84     <ca:guinotes title="Interface Functionality">
85       <ca:guinote type="None" title="None.">
86         <ca:para></ca:para>
87       </ca:guinote>
88     </ca:guinotes>
89     <ca:qanotes title="Quality Assurance">
90       <ca:paras title="None.">
91         <ca:para></ca:para>
92       </ca:paras>
93     </ca:qanotes>
94   </ca:descriptions>
95   <ca:tagstructures title="Tag Syntax">
96     <ca:tagstructure title="Widget Syntax">
97       <ca:description></ca:description>
98       <ca:code title="">
99         <ca:description></ca:description>
100         <ca:codeblock bold="false">
101           <ca:line>   WMSCACHEDIRECTORY ="[string]"</ca:line>
102           <ca:line>   USEUSERSESSION ="[boolean]"</ca:line>
103           <ca:line>   PREVIEWEXTENTS ="[string]"</ca:line>
104           <ca:line>   PREVIEWSRS ="[string]"</ca:line>
105         </ca:codeblock>
106       </ca:code>
107     </ca:tagstructure>
108   </ca:tagstructures>
109   <ca:examples title="Examples">
110     <ca:widgetexamples title="Widget Examples">
111       <ca:example title="Example #1: Simple">
112         <ca:description></ca:description>
113         <ca:code title="">
114           <ca:description></ca:description>
115           <ca:codeblock bold="false">
116             <ca:line></ca:line>
117           </ca:codeblock>
118         </ca:code>
119       </ca:example>
120     </ca:widgetexamples>
121     <ca:sharedresourceexamples title="Shared Resources Examples">
122       <ca:example title="Example #1: Advanced">
123         <ca:description></ca:description>
124         <ca:code title="">
125           <ca:description></ca:description>
126           <ca:codeblock bold="false">
127             <ca:line></ca:line>
128           </ca:codeblock>
129         </ca:code>
130       </ca:example>
131     </ca:sharedresourceexamples>
132     <ca:sampleapps title="Sample Applications">
133       <ca:sampleapp>
134         <ca:name>Hawaii Demo</ca:name>
135         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
136         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
137       </ca:sampleapp>
138     </ca:sampleapps>
139     <ca:scriptexamples title="Script Examples">
140       <ca:example title="Example #1: Simple">
141         <ca:description></ca:description>
142         <ca:code title="">
143           <ca:description></ca:description>
144           <ca:codeblock bold="false">
145             <ca:line></ca:line>
146           </ca:codeblock>
147         </ca:code>
148       </ca:example>
149     </ca:scriptexamples>
150   </ca:examples>
151   <ca:attributegroups title="Attribute Groups">
152     <ca:description></ca:description>
153     <ca:attributegroup>
154       <ca:name>base</ca:name>
155       <ca:name>button</ca:name>
156       <ca:name>popup</ca:name>
157     </ca:attributegroup>
158   </ca:attributegroups>
159   <ca:widgettag title="Attributes">
160     <ca:attribute>
161       <ca:name>WMSCACHEDIRECTORY</ca:name>
162       <ca:type title="Type">
163         <ca:value>string</ca:value>
164         <ca:description></ca:description>
165       </ca:type>
166       <ca:class title="Class">
167         <ca:value>Widget Only</ca:value>
168       </ca:class>
169       <ca:default title="Default">
170         <ca:description></ca:description>
171       </ca:default>
172     </ca:attribute>
173     <ca:attribute>
174       <ca:name>USEUSERSESSION</ca:name>
175       <ca:type title="Type">
176         <ca:value>boolean</ca:value>
177         <ca:description></ca:description>
178       </ca:type>
179       <ca:class title="Class">
180         <ca:value>Widget Only</ca:value>
181       </ca:class>
182       <ca:default title="Default">
183         <ca:description></ca:description>
184       </ca:default>
185       <ca:possvalues type="list" title="Value">
186         <ca:value>true</ca:value>
187         <ca:value>false</ca:value>
188       </ca:possvalues>
189     </ca:attribute>
190     <ca:attribute>
191       <ca:name>PREVIEWEXTENTS</ca:name>
192       <ca:type title="Type">
193         <ca:value>string</ca:value>
194         <ca:description></ca:description>
195       </ca:type>
196       <ca:class title="Class">
197         <ca:value>Widget Only</ca:value>
198       </ca:class>
199       <ca:default title="Default">
200         <ca:description></ca:description>
201       </ca:default>
202     </ca:attribute>
203     <ca:attribute>
204       <ca:name>PREVIEWSRS</ca:name>
205       <ca:type title="Type">
206         <ca:value>string</ca:value>
207         <ca:description></ca:description>
208       </ca:type>
209       <ca:class title="Class">
210         <ca:value>Widget Only</ca:value>
211       </ca:class>
212       <ca:default title="Default">
213         <ca:description></ca:description>
214       </ca:default>
215     </ca:attribute>
216     <ca:subtag>
217       <ca:name></ca:name>
218       <ca:type title="Type">
219         <ca:value>XML</ca:value>
220         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
221       </ca:type>
222       <ca:class title="Class">
223         <ca:value>Widget &amp; Shared Resource</ca:value>
224       </ca:class>
225       <ca:description></ca:description>
226       <ca:attribute>
227         <ca:name></ca:name>
228         <ca:type title="Type">
229           <ca:value>float</ca:value>
230           <ca:description></ca:description>
231         </ca:type>
232         <ca:class title="Class">
233           <ca:value>Widget &amp; Shared Resource</ca:value>
234         </ca:class>
235         <ca:default title="Default">
236           <ca:value></ca:value>
237           <ca:description></ca:description>
238         </ca:default>
239         <ca:possvalues type="list" title="Value">
240           <ca:value></ca:value>
241         </ca:possvalues>
242         <ca:description></ca:description>
243       </ca:attribute>
244     </ca:subtag>
245   </ca:widgettag>
246   <ca:formelements title="Form Elements">
247     <ca:formelement>
248       <ca:name>WMS_LAYERS_TOADD</ca:name>
249       <ca:type title="Type">
250         <ca:value>unknown</ca:value>
251         <ca:description></ca:description>
252       </ca:type>
253       <ca:default title="Default">
254         <ca:value></ca:value>
255         <ca:description></ca:description>
256       </ca:default>
257       <ca:possvalues type="list" title="Values">
258         <ca:value></ca:value>
259       </ca:possvalues>
260       <ca:description></ca:description>
261     </ca:formelement>
262   </ca:formelements>
263   <ca:jsvariables title="JavaScript Variables"/>
264   <ca:jsfunctions title="JavaScript Functions">
265     <ca:jsfunction>
266       <ca:name>BrowseWMSCallBack</ca:name>
267       <ca:scope title="Scope">
268         <ca:value>Private</ca:value>
269       </ca:scope>
270       <ca:description></ca:description>
271       <ca:parameters title="Parameters">
272         <ca:parameter>
273           <ca:name>actionId</ca:name>
274           <ca:type title="Type">
275             <ca:value>string</ca:value>
276           </ca:type>
277           <ca:default title="Default">
278             <ca:value></ca:value>
279             <ca:description></ca:description>
280           </ca:default>
281           <ca:possvalues type="list" title="Values">
282             <ca:value></ca:value>
283           </ca:possvalues>
284           <ca:description></ca:description>
285         </ca:parameter>
286         <ca:parameter>
287           <ca:name>wh</ca:name>
288           <ca:type title="Type">
289             <ca:value>string</ca:value>
290           </ca:type>
291           <ca:default title="Default">
292             <ca:value></ca:value>
293             <ca:description></ca:description>
294           </ca:default>
295           <ca:possvalues type="list" title="Values">
296             <ca:value></ca:value>
297           </ca:possvalues>
298           <ca:description></ca:description>
299         </ca:parameter>
300       </ca:parameters>
301       <ca:returnvalues title="Function Return Value">
302         <ca:returnvalue>
303           <ca:type title="Type">
304             <ca:value>unknown</ca:value>
305             <ca:description></ca:description>
306           </ca:type>
307           <ca:default title="Default">
308             <ca:value></ca:value>
309           </ca:default>
310           <ca:possvalues type="list" title="Values">
311             <ca:value></ca:value>
312           </ca:possvalues>
313           <ca:description></ca:description>
314         </ca:returnvalue>
315       </ca:returnvalues>
316       <ca:triggeredjsapievents title="JSAPI Triggered Events">
317         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
318         <ca:triggeredjsapievent title="">
319           <ca:name></ca:name>
320           <ca:description></ca:description>
321         </ca:triggeredjsapievent>
322       </ca:triggeredjsapievents>
323     </ca:jsfunction>
324     <ca:jsfunction>
325       <ca:name>clickWMSBrowser</ca:name>
326       <ca:scope title="Scope">
327         <ca:value>Private</ca:value>
328       </ca:scope>
329       <ca:description></ca:description>
330       <ca:returnvalues title="Function Return Value">
331         <ca:returnvalue>
332           <ca:type title="Type">
333             <ca:value>unknown</ca:value>
334             <ca:description></ca:description>
335           </ca:type>
336           <ca:default title="Default">
337             <ca:value></ca:value>
338           </ca:default>
339           <ca:possvalues type="list" title="Values">
340             <ca:value></ca:value>
341           </ca:possvalues>
342           <ca:description></ca:description>
343         </ca:returnvalue>
344       </ca:returnvalues>
345       <ca:triggeredjsapievents title="JSAPI Triggered Events">
346         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
347         <ca:triggeredjsapievent title="">
348           <ca:name></ca:name>
349           <ca:description></ca:description>
350         </ca:triggeredjsapievent>
351       </ca:triggeredjsapievents>
352     </ca:jsfunction>
353   </ca:jsfunctions>
354   <ca:jsfiles title="JavaScript Files">
355     <ca:jsfile>
356       <ca:name></ca:name>
357       <ca:description></ca:description>
358       <ca:jsvariables title="JavaScript Variables">
359         <ca:jsvariable>
360           <ca:name></ca:name>
361           <ca:type title="Type">
362             <ca:value>string</ca:value>
363           </ca:type>
364           <ca:scope title="Scope">
365             <ca:value>Private</ca:value>
366           </ca:scope>
367           <ca:default title="Default">
368             <ca:value></ca:value>
369           </ca:default>
370           <ca:possvalues type="list" title="Values">
371             <ca:value></ca:value>
372           </ca:possvalues>
373           <ca:description></ca:description>
374         </ca:jsvariable>
375       </ca:jsvariables>
376       <ca:jsfunctions title="JavaScript Functions">
377         <ca:jsfunction>
378           <ca:name></ca:name>
379           <ca:scope title="Scope">
380             <ca:value>Private</ca:value>
381           </ca:scope>
382           <ca:description></ca:description>
383           <ca:parameters title="Parameters">
384             <ca:parameter>
385               <ca:name></ca:name>
386               <ca:type title="Type">
387                 <ca:value>string</ca:value>
388               </ca:type>
389               <ca:required title="Required">
390                 <ca:value>false</ca:value>
391               </ca:required>
392               <ca:default title="Default">
393                 <ca:value></ca:value>
394                 <ca:description></ca:description>
395               </ca:default>
396               <ca:possvalues type="list" title="Values">
397                 <ca:value></ca:value>
398               </ca:possvalues>
399               <ca:description></ca:description>
400             </ca:parameter>
401           </ca:parameters>
402           <ca:returnvalues title="Function Return Value">
403             <ca:returnvalue>
404               <ca:type title="Type">
405                 <ca:value>unknown</ca:value>
406                 <ca:description></ca:description>
407               </ca:type>
408               <ca:default title="Default">
409                 <ca:value></ca:value>
410               </ca:default>
411               <ca:possvalues type="list" title="Values">
412                 <ca:value></ca:value>
413               </ca:possvalues>
414               <ca:description></ca:description>
415             </ca:returnvalue>
416           </ca:returnvalues>
417           <ca:triggeredjsapievents title="JSAPI Triggered Events">
418             <ca:triggeredjsapievent title="">
419               <ca:name></ca:name>
420               <ca:description></ca:description>
421             </ca:triggeredjsapievent>
422           </ca:triggeredjsapievents>
423         </ca:jsfunction>
424       </ca:jsfunctions>
425     </ca:jsfile>
426   </ca:jsfiles>
427   <ca:listenedjsapievents title="JSAPI Listened Events">
428     <ca:listenedjsapievent title="">
429       <ca:name></ca:name>
430       <ca:description></ca:description>
431       <ca:calledfunctions title="Functions Calls">
432         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
433         <ca:calledfunction>
434           <ca:name></ca:name>
435           <ca:description></ca:description>
436         </ca:calledfunction>
437       </ca:calledfunctions>
438     </ca:listenedjsapievent>
439   </ca:listenedjsapievents>
440   <ca:widgetevents title="Widget Events">
441     <ca:widgetevent>
442       <ca:name></ca:name>
443       <ca:parameters title="Parameters">
444         <ca:parameter>
445           <ca:name></ca:name>
446           <ca:type title="Type">
447             <ca:value>string</ca:value>
448           </ca:type>
449           <ca:required title="Required">
450             <ca:value>false</ca:value>
451           </ca:required>
452           <ca:default title="Default">
453             <ca:value></ca:value>
454             <ca:description></ca:description>
455           </ca:default>
456           <ca:possvalues type="list" title="Values">
457             <ca:value></ca:value>
458           </ca:possvalues>
459           <ca:description></ca:description>
460         </ca:parameter>
461       </ca:parameters>
462       <ca:description></ca:description>
463     </ca:widgetevent>
464   </ca:widgetevents>
465   <ca:errors title="Widget Errors">
466     <ca:error title="Error #1">
467       <ca:type title="Type">
468         <ca:value>PHP Mapscript</ca:value>
469       </ca:type>
470       <ca:severity title="Severity">
471         <ca:value>none</ca:value>
472         <ca:description></ca:description>
473       </ca:severity>
474       <ca:message title="Error Message">
475         <ca:paras title="">
476           <ca:para>Error message string....</ca:para>
477         </ca:paras>
478       </ca:message>
479       <ca:meaning title="Interpretation">
480         <ca:paras title="">
481           <ca:para>The description of what the message means......</ca:para>
482         </ca:paras>
483       </ca:meaning>
484       <ca:solution title="Troubleshooting Tips">
485         <ca:paras title="">
486           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
487         </ca:paras>
488       </ca:solution>
489     </ca:error>
490   </ca:errors>
491 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.