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

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