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

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