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

root/Chameleon/trunk/Chameleon/LayerManager/LayerManager.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>layermanager</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 LayerManager 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:code>
102     </ca:tagstructure>
103   </ca:tagstructures>
104   <ca:examples title="Examples">
105     <ca:widgetexamples title="Widget Examples">
106       <ca:example title="Example #1: Simple">
107         <ca:description></ca:description>
108         <ca:code title="">
109           <ca:description></ca:description>
110           <ca:codeblock bold="false">
111             <ca:line></ca:line>
112           </ca:codeblock>
113         </ca:code>
114       </ca:example>
115     </ca:widgetexamples>
116     <ca:sharedresourceexamples title="Shared Resources Examples">
117       <ca:example title="Example #1: Advanced">
118         <ca:description></ca:description>
119         <ca:code title="">
120           <ca:description></ca:description>
121           <ca:codeblock bold="false">
122             <ca:line></ca:line>
123           </ca:codeblock>
124         </ca:code>
125       </ca:example>
126     </ca:sharedresourceexamples>
127     <ca:sampleapps title="Sample Applications">
128       <ca:sampleapp>
129         <ca:name>Hawaii Demo</ca:name>
130         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
131         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
132       </ca:sampleapp>
133     </ca:sampleapps>
134     <ca:scriptexamples title="Script Examples">
135       <ca:example title="Example #1: Simple">
136         <ca:description></ca:description>
137         <ca:code title="">
138           <ca:description></ca:description>
139           <ca:codeblock bold="false">
140             <ca:line></ca:line>
141           </ca:codeblock>
142         </ca:code>
143       </ca:example>
144     </ca:scriptexamples>
145   </ca:examples>
146   <ca:attributegroups title="Attribute Groups">
147     <ca:description></ca:description>
148     <ca:attributegroup>
149       <ca:name>base</ca:name>
150       <ca:name>button</ca:name>
151       <ca:name>popup</ca:name>
152     </ca:attributegroup>
153   </ca:attributegroups>
154   <ca:widgettag title="Attributes">
155     <ca:subtag>
156       <ca:name></ca:name>
157       <ca:type title="Type">
158         <ca:value>XML</ca:value>
159         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
160       </ca:type>
161       <ca:class title="Class">
162         <ca:value>Widget &amp; Shared Resource</ca:value>
163       </ca:class>
164       <ca:description></ca:description>
165       <ca:attribute>
166         <ca:name></ca:name>
167         <ca:type title="Type">
168           <ca:value>float</ca:value>
169           <ca:description></ca:description>
170         </ca:type>
171         <ca:class title="Class">
172           <ca:value>Widget &amp; Shared Resource</ca:value>
173         </ca:class>
174         <ca:default title="Default">
175           <ca:value></ca:value>
176           <ca:description></ca:description>
177         </ca:default>
178         <ca:possvalues type="list" title="Value">
179           <ca:value></ca:value>
180         </ca:possvalues>
181         <ca:description></ca:description>
182       </ca:attribute>
183     </ca:subtag>
184   </ca:widgettag>
185   <ca:formelements title="Form Elements">
186     <ca:formelement>
187       <ca:name>LAYERMANAGER_APPLY</ca:name>
188       <ca:type title="Type">
189         <ca:value>unknown</ca:value>
190         <ca:description></ca:description>
191       </ca:type>
192       <ca:default title="Default">
193         <ca:value></ca:value>
194         <ca:description></ca:description>
195       </ca:default>
196       <ca:possvalues type="list" title="Values">
197         <ca:value></ca:value>
198       </ca:possvalues>
199       <ca:description></ca:description>
200     </ca:formelement>
201     <ca:formelement>
202       <ca:name>LAYERMANAGER_CURRENT_STATE</ca:name>
203       <ca:type title="Type">
204         <ca:value>unknown</ca:value>
205         <ca:description></ca:description>
206       </ca:type>
207       <ca:default title="Default">
208         <ca:value></ca:value>
209         <ca:description></ca:description>
210       </ca:default>
211       <ca:possvalues type="list" title="Values">
212         <ca:value></ca:value>
213       </ca:possvalues>
214       <ca:description></ca:description>
215     </ca:formelement>
216   </ca:formelements>
217   <ca:jsvariables title="JavaScript Variables"/>
218   <ca:jsfunctions title="JavaScript Functions">
219     <ca:jsfunction>
220       <ca:name>LayerManagerCallBack</ca:name>
221       <ca:scope title="Scope">
222         <ca:value>Private</ca:value>
223       </ca:scope>
224       <ca:description>callback function to handle user input from the Layer Manager dialog</ca:description>
225       <ca:parameters title="Parameters">
226         <ca:parameter>
227           <ca:name>actionId</ca:name>
228           <ca:type title="Type">
229             <ca:value>string</ca:value>
230           </ca:type>
231           <ca:default title="Default">
232             <ca:value></ca:value>
233             <ca:description></ca:description>
234           </ca:default>
235           <ca:possvalues type="list" title="Values">
236             <ca:value></ca:value>
237           </ca:possvalues>
238           <ca:description></ca:description>
239         </ca:parameter>
240         <ca:parameter>
241           <ca:name>wh</ca:name>
242           <ca:type title="Type">
243             <ca:value>string</ca:value>
244           </ca:type>
245           <ca:default title="Default">
246             <ca:value></ca:value>
247             <ca:description></ca:description>
248           </ca:default>
249           <ca:possvalues type="list" title="Values">
250             <ca:value></ca:value>
251           </ca:possvalues>
252           <ca:description></ca:description>
253         </ca:parameter>
254       </ca:parameters>
255       <ca:returnvalues title="Function Return Value">
256         <ca:returnvalue>
257           <ca:type title="Type">
258             <ca:value>unknown</ca:value>
259             <ca:description></ca:description>
260           </ca:type>
261           <ca:default title="Default">
262             <ca:value></ca:value>
263           </ca:default>
264           <ca:possvalues type="list" title="Values">
265             <ca:value></ca:value>
266           </ca:possvalues>
267           <ca:description></ca:description>
268         </ca:returnvalue>
269       </ca:returnvalues>
270       <ca:triggeredjsapievents title="JSAPI Triggered Events">
271         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
272         <ca:triggeredjsapievent title="">
273           <ca:name></ca:name>
274           <ca:description></ca:description>
275         </ca:triggeredjsapievent>
276       </ca:triggeredjsapievents>
277     </ca:jsfunction>
278     <ca:jsfunction>
279       <ca:name>clickLayerManager</ca:name>
280       <ca:scope title="Scope">
281         <ca:value>Private</ca:value>
282       </ca:scope>
283       <ca:description>callback function for the user clicking the Layer Management button</ca:description>
284       <ca:returnvalues title="Function Return Value">
285         <ca:returnvalue>
286           <ca:type title="Type">
287             <ca:value>unknown</ca:value>
288             <ca:description></ca:description>
289           </ca:type>
290           <ca:default title="Default">
291             <ca:value></ca:value>
292           </ca:default>
293           <ca:possvalues type="list" title="Values">
294             <ca:value></ca:value>
295           </ca:possvalues>
296           <ca:description></ca:description>
297         </ca:returnvalue>
298       </ca:returnvalues>
299       <ca:triggeredjsapievents title="JSAPI Triggered Events">
300         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
301         <ca:triggeredjsapievent title="">
302           <ca:name></ca:name>
303           <ca:description></ca:description>
304         </ca:triggeredjsapievent>
305       </ca:triggeredjsapievents>
306     </ca:jsfunction>
307   </ca:jsfunctions>
308   <ca:jsfiles title="JavaScript Files">
309     <ca:jsfile>
310       <ca:name></ca:name>
311       <ca:description></ca:description>
312       <ca:jsvariables title="JavaScript Variables">
313         <ca:jsvariable>
314           <ca:name></ca:name>
315           <ca:type title="Type">
316             <ca:value>string</ca:value>
317           </ca:type>
318           <ca:scope title="Scope">
319             <ca:value>Private</ca:value>
320           </ca:scope>
321           <ca:default title="Default">
322             <ca:value></ca:value>
323           </ca:default>
324           <ca:possvalues type="list" title="Values">
325             <ca:value></ca:value>
326           </ca:possvalues>
327           <ca:description></ca:description>
328         </ca:jsvariable>
329       </ca:jsvariables>
330       <ca:jsfunctions title="JavaScript Functions">
331         <ca:jsfunction>
332           <ca:name></ca:name>
333           <ca:scope title="Scope">
334             <ca:value>Private</ca:value>
335           </ca:scope>
336           <ca:description></ca:description>
337           <ca:parameters title="Parameters">
338             <ca:parameter>
339               <ca:name></ca:name>
340               <ca:type title="Type">
341                 <ca:value>string</ca:value>
342               </ca:type>
343               <ca:required title="Required">
344                 <ca:value>false</ca:value>
345               </ca:required>
346               <ca:default title="Default">
347                 <ca:value></ca:value>
348                 <ca:description></ca:description>
349               </ca:default>
350               <ca:possvalues type="list" title="Values">
351                 <ca:value></ca:value>
352               </ca:possvalues>
353               <ca:description></ca:description>
354             </ca:parameter>
355           </ca:parameters>
356           <ca:returnvalues title="Function Return Value">
357             <ca:returnvalue>
358               <ca:type title="Type">
359                 <ca:value>unknown</ca:value>
360                 <ca:description></ca:description>
361               </ca:type>
362               <ca:default title="Default">
363                 <ca:value></ca:value>
364               </ca:default>
365               <ca:possvalues type="list" title="Values">
366                 <ca:value></ca:value>
367               </ca:possvalues>
368               <ca:description></ca:description>
369             </ca:returnvalue>
370           </ca:returnvalues>
371           <ca:triggeredjsapievents title="JSAPI Triggered Events">
372             <ca:triggeredjsapievent title="">
373               <ca:name></ca:name>
374               <ca:description></ca:description>
375             </ca:triggeredjsapievent>
376           </ca:triggeredjsapievents>
377         </ca:jsfunction>
378       </ca:jsfunctions>
379     </ca:jsfile>
380   </ca:jsfiles>
381   <ca:listenedjsapievents title="JSAPI Listened Events">
382     <ca:listenedjsapievent title="">
383       <ca:name></ca:name>
384       <ca:description></ca:description>
385       <ca:calledfunctions title="Functions Calls">
386         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
387         <ca:calledfunction>
388           <ca:name></ca:name>
389           <ca:description></ca:description>
390         </ca:calledfunction>
391       </ca:calledfunctions>
392     </ca:listenedjsapievent>
393   </ca:listenedjsapievents>
394   <ca:widgetevents title="Widget Events">
395     <ca:widgetevent>
396       <ca:name></ca:name>
397       <ca:parameters title="Parameters">
398         <ca:parameter>
399           <ca:name></ca:name>
400           <ca:type title="Type">
401             <ca:value>string</ca:value>
402           </ca:type>
403           <ca:required title="Required">
404             <ca:value>false</ca:value>
405           </ca:required>
406           <ca:default title="Default">
407             <ca:value></ca:value>
408             <ca:description></ca:description>
409           </ca:default>
410           <ca:possvalues type="list" title="Values">
411             <ca:value></ca:value>
412           </ca:possvalues>
413           <ca:description></ca:description>
414         </ca:parameter>
415       </ca:parameters>
416       <ca:description></ca:description>
417     </ca:widgetevent>
418   </ca:widgetevents>
419   <ca:errors title="Widget Errors">
420     <ca:error title="Error #1">
421       <ca:type title="Type">
422         <ca:value>PHP Mapscript</ca:value>
423       </ca:type>
424       <ca:severity title="Severity">
425         <ca:value>none</ca:value>
426         <ca:description></ca:description>
427       </ca:severity>
428       <ca:message title="Error Message">
429         <ca:paras title="">
430           <ca:para>Error message string....</ca:para>
431         </ca:paras>
432       </ca:message>
433       <ca:meaning title="Interpretation">
434         <ca:paras title="">
435           <ca:para>The description of what the message means......</ca:para>
436         </ca:paras>
437       </ca:meaning>
438       <ca:solution title="Troubleshooting Tips">
439         <ca:paras title="">
440           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
441         </ca:paras>
442       </ca:solution>
443     </ca:error>
444   </ca:errors>
445 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.