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

root/Chameleon/trunk/Chameleon/GpsUtil/GpsUtil.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>gpsutil</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 GpsUtil widget provides a dialog box that can be used to startup a gps
62 and render points on a map.</ca:para>
63       </ca:paras>
64     </ca:description>
65     <ca:techrequirements title="Technical Requirements">
66       <ca:paras title="Not Available">
67         <ca:para></ca:para>
68       </ca:paras>
69     </ca:techrequirements>
70     <ca:dependancies title="Dependancies">
71       <ca:dependancy type="None" title="Not Available">
72         <ca:para></ca:para>
73       </ca:dependancy>
74     </ca:dependancies>
75     <ca:sharedresources title="Shared Resources">
76       <ca:paras title="Not Available">
77         <ca:para></ca:para>
78       </ca:paras>
79     </ca:sharedresources>
80     <ca:embeddedhelp title="General User Interface Help">
81       <ca:paras title="">
82         <ca:para></ca:para>
83       </ca:paras>
84     </ca:embeddedhelp>
85     <ca:guinotes title="Interface Functionality">
86       <ca:guinote type="None" title="None.">
87         <ca:para></ca:para>
88       </ca:guinote>
89     </ca:guinotes>
90     <ca:qanotes title="Quality Assurance">
91       <ca:paras title="None.">
92         <ca:para></ca:para>
93       </ca:paras>
94     </ca:qanotes>
95   </ca:descriptions>
96   <ca:tagstructures title="Tag Syntax">
97     <ca:tagstructure title="Widget Syntax">
98       <ca:description></ca:description>
99       <ca:code title="">
100         <ca:description></ca:description>
101         <ca:codeblock bold="false">
102           <ca:line>   GPSURL ="[string]"</ca:line>
103           <ca:line>   PORT ="[string]"</ca:line>
104           <ca:line>   BAUD ="[integer]"</ca:line>
105           <ca:line>   DATABITS ="[integer]"</ca:line>
106           <ca:line>   STOPBITS ="[float]"</ca:line>
107           <ca:line>   PARITY ="[string]"</ca:line>
108           <ca:line>   DEBUG ="[integer]"</ca:line>
109           <ca:line>   GPSBINARY ="[string]"</ca:line>
110         </ca:codeblock>
111       </ca:code>
112     </ca:tagstructure>
113   </ca:tagstructures>
114   <ca:examples title="Examples">
115     <ca:widgetexamples title="Widget Examples">
116       <ca:example title="Example #1: Simple">
117         <ca:description></ca:description>
118         <ca:code title="">
119           <ca:description></ca:description>
120           <ca:codeblock bold="false">
121             <ca:line></ca:line>
122           </ca:codeblock>
123         </ca:code>
124       </ca:example>
125     </ca:widgetexamples>
126     <ca:sharedresourceexamples title="Shared Resources Examples">
127       <ca:example title="Example #1: Advanced">
128         <ca:description></ca:description>
129         <ca:code title="">
130           <ca:description></ca:description>
131           <ca:codeblock bold="false">
132             <ca:line></ca:line>
133           </ca:codeblock>
134         </ca:code>
135       </ca:example>
136     </ca:sharedresourceexamples>
137     <ca:sampleapps title="Sample Applications">
138       <ca:sampleapp>
139         <ca:name>Hawaii Demo</ca:name>
140         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
141         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
142       </ca:sampleapp>
143     </ca:sampleapps>
144     <ca:scriptexamples title="Script Examples">
145       <ca:example title="Example #1: Simple">
146         <ca:description></ca:description>
147         <ca:code title="">
148           <ca:description></ca:description>
149           <ca:codeblock bold="false">
150             <ca:line></ca:line>
151           </ca:codeblock>
152         </ca:code>
153       </ca:example>
154     </ca:scriptexamples>
155   </ca:examples>
156   <ca:attributegroups title="Attribute Groups">
157     <ca:description></ca:description>
158     <ca:attributegroup>
159       <ca:name>base</ca:name>
160       <ca:name>button</ca:name>
161       <ca:name>popup</ca:name>
162       <ca:name>label</ca:name>
163     </ca:attributegroup>
164   </ca:attributegroups>
165   <ca:widgettag title="Attributes">
166     <ca:attribute>
167       <ca:name>GPSURL</ca:name>
168       <ca:type title="Type">
169         <ca:value>string</ca:value>
170         <ca:description></ca:description>
171       </ca:type>
172       <ca:class title="Class">
173         <ca:value>Required</ca:value>
174       </ca:class>
175       <ca:default title="Default">
176         <ca:description></ca:description>
177       </ca:default>
178     </ca:attribute>
179     <ca:attribute>
180       <ca:name>PORT</ca:name>
181       <ca:type title="Type">
182         <ca:value>string</ca:value>
183         <ca:description></ca:description>
184       </ca:type>
185       <ca:class title="Class">
186         <ca:value>Required</ca:value>
187       </ca:class>
188       <ca:default title="Default">
189         <ca:description></ca:description>
190       </ca:default>
191     </ca:attribute>
192     <ca:attribute>
193       <ca:name>BAUD</ca:name>
194       <ca:type title="Type">
195         <ca:value>integer</ca:value>
196         <ca:description></ca:description>
197       </ca:type>
198       <ca:class title="Class">
199         <ca:value>Required</ca:value>
200       </ca:class>
201       <ca:default title="Default">
202         <ca:description></ca:description>
203       </ca:default>
204       <ca:possvalues type="range" title="Value">
205         <ca:minimum>-2147483647</ca:minimum>
206         <ca:maximum>2147483647</ca:maximum>
207       </ca:possvalues>
208     </ca:attribute>
209     <ca:attribute>
210       <ca:name>DATABITS</ca:name>
211       <ca:type title="Type">
212         <ca:value>integer</ca:value>
213         <ca:description></ca:description>
214       </ca:type>
215       <ca:class title="Class">
216         <ca:value>Required</ca:value>
217       </ca:class>
218       <ca:default title="Default">
219         <ca:description></ca:description>
220       </ca:default>
221       <ca:possvalues type="range" title="Value">
222         <ca:minimum>-2147483647</ca:minimum>
223         <ca:maximum>2147483647</ca:maximum>
224       </ca:possvalues>
225     </ca:attribute>
226     <ca:attribute>
227       <ca:name>STOPBITS</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>Required</ca:value>
234       </ca:class>
235       <ca:default title="Default">
236         <ca:description></ca:description>
237       </ca:default>
238       <ca:possvalues type="range" title="Value">
239         <ca:minimum>-1.#INF</ca:minimum>
240         <ca:maximum>1.#INF</ca:maximum>
241       </ca:possvalues>
242     </ca:attribute>
243     <ca:attribute>
244       <ca:name>PARITY</ca:name>
245       <ca:type title="Type">
246         <ca:value>string</ca:value>
247         <ca:description></ca:description>
248       </ca:type>
249       <ca:class title="Class">
250         <ca:value>Required</ca:value>
251       </ca:class>
252       <ca:default title="Default">
253         <ca:description></ca:description>
254       </ca:default>
255     </ca:attribute>
256     <ca:attribute>
257       <ca:name>DEBUG</ca:name>
258       <ca:type title="Type">
259         <ca:value>integer</ca:value>
260         <ca:description></ca:description>
261       </ca:type>
262       <ca:class title="Class">
263         <ca:value>Widget Only</ca:value>
264       </ca:class>
265       <ca:default title="Default">
266         <ca:description></ca:description>
267       </ca:default>
268       <ca:possvalues type="range" title="Value">
269         <ca:minimum>-2147483647</ca:minimum>
270         <ca:maximum>2147483647</ca:maximum>
271       </ca:possvalues>
272     </ca:attribute>
273     <ca:attribute>
274       <ca:name>GPSBINARY</ca:name>
275       <ca:type title="Type">
276         <ca:value>string</ca:value>
277         <ca:description></ca:description>
278       </ca:type>
279       <ca:class title="Class">
280         <ca:value>Widget Only</ca:value>
281       </ca:class>
282       <ca:default title="Default">
283         <ca:description></ca:description>
284       </ca:default>
285     </ca:attribute>
286     <ca:subtag>
287       <ca:name></ca:name>
288       <ca:type title="Type">
289         <ca:value>XML</ca:value>
290         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
291       </ca:type>
292       <ca:class title="Class">
293         <ca:value>Widget &amp; Shared Resource</ca:value>
294       </ca:class>
295       <ca:description></ca:description>
296       <ca:attribute>
297         <ca:name></ca:name>
298         <ca:type title="Type">
299           <ca:value>float</ca:value>
300           <ca:description></ca:description>
301         </ca:type>
302         <ca:class title="Class">
303           <ca:value>Widget &amp; Shared Resource</ca:value>
304         </ca:class>
305         <ca:default title="Default">
306           <ca:value></ca:value>
307           <ca:description></ca:description>
308         </ca:default>
309         <ca:possvalues type="list" title="Value">
310           <ca:value></ca:value>
311         </ca:possvalues>
312         <ca:description></ca:description>
313       </ca:attribute>
314     </ca:subtag>
315   </ca:widgettag>
316   <ca:formelements title="Form Elements">
317     <ca:formelement>
318       <ca:name>GPSUTIL_LATLONG_STRING</ca:name>
319       <ca:type title="Type">
320         <ca:value>unknown</ca:value>
321         <ca:description></ca:description>
322       </ca:type>
323       <ca:default title="Default">
324         <ca:value></ca:value>
325         <ca:description></ca:description>
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:formelement>
332     <ca:formelement>
333       <ca:name>GPSUTIL_PLOT_TYPE</ca:name>
334       <ca:type title="Type">
335         <ca:value>unknown</ca:value>
336         <ca:description></ca:description>
337       </ca:type>
338       <ca:default title="Default">
339         <ca:value></ca:value>
340         <ca:description></ca:description>
341       </ca:default>
342       <ca:possvalues type="list" title="Values">
343         <ca:value></ca:value>
344       </ca:possvalues>
345       <ca:description></ca:description>
346     </ca:formelement>
347     <ca:formelement>
348       <ca:name>GPSUTIL_SYMBOL_NAME</ca:name>
349       <ca:type title="Type">
350         <ca:value>unknown</ca:value>
351         <ca:description></ca:description>
352       </ca:type>
353       <ca:default title="Default">
354         <ca:value></ca:value>
355         <ca:description></ca:description>
356       </ca:default>
357       <ca:possvalues type="list" title="Values">
358         <ca:value></ca:value>
359       </ca:possvalues>
360       <ca:description></ca:description>
361     </ca:formelement>
362     <ca:formelement>
363       <ca:name>GPSUTIL_SYMBOL_SIZE</ca:name>
364       <ca:type title="Type">
365         <ca:value>unknown</ca:value>
366         <ca:description></ca:description>
367       </ca:type>
368       <ca:default title="Default">
369         <ca:value></ca:value>
370         <ca:description></ca:description>
371       </ca:default>
372       <ca:possvalues type="list" title="Values">
373         <ca:value></ca:value>
374       </ca:possvalues>
375       <ca:description></ca:description>
376     </ca:formelement>
377     <ca:formelement>
378       <ca:name>GPSUTIL_SYMBOL_COLOR</ca:name>
379       <ca:type title="Type">
380         <ca:value>unknown</ca:value>
381         <ca:description></ca:description>
382       </ca:type>
383       <ca:default title="Default">
384         <ca:value></ca:value>
385         <ca:description></ca:description>
386       </ca:default>
387       <ca:possvalues type="list" title="Values">
388         <ca:value></ca:value>
389       </ca:possvalues>
390       <ca:description></ca:description>
391     </ca:formelement>
392     <ca:formelement>
393       <ca:name>GPSUTIL_SYMBOL_OUTLINECOLOR</ca:name>
394       <ca:type title="Type">
395         <ca:value>unknown</ca:value>
396         <ca:description></ca:description>
397       </ca:type>
398       <ca:default title="Default">
399         <ca:value></ca:value>
400         <ca:description></ca:description>
401       </ca:default>
402       <ca:possvalues type="list" title="Values">
403         <ca:value></ca:value>
404       </ca:possvalues>
405       <ca:description></ca:description>
406     </ca:formelement>
407   </ca:formelements>
408   <ca:jsvariables title="JavaScript Variables"/>
409   <ca:jsfunctions title="JavaScript Functions">
410     <ca:jsfunction>
411       <ca:name>clickGpsPopup</ca:name>
412       <ca:scope title="Scope">
413         <ca:value>Private</ca:value>
414       </ca:scope>
415       <ca:description></ca:description>
416       <ca:returnvalues title="Function Return Value">
417         <ca:returnvalue>
418           <ca:type title="Type">
419             <ca:value>unknown</ca:value>
420             <ca:description></ca:description>
421           </ca:type>
422           <ca:default title="Default">
423             <ca:value></ca:value>
424           </ca:default>
425           <ca:possvalues type="list" title="Values">
426             <ca:value></ca:value>
427           </ca:possvalues>
428           <ca:description></ca:description>
429         </ca:returnvalue>
430       </ca:returnvalues>
431       <ca:triggeredjsapievents title="JSAPI Triggered Events">
432         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
433         <ca:triggeredjsapievent title="">
434           <ca:name></ca:name>
435           <ca:description></ca:description>
436         </ca:triggeredjsapievent>
437       </ca:triggeredjsapievents>
438     </ca:jsfunction>
439     <ca:jsfunction>
440       <ca:name>GpsUtilCB</ca:name>
441       <ca:scope title="Scope">
442         <ca:value>Private</ca:value>
443       </ca:scope>
444       <ca:description></ca:description>
445       <ca:parameters title="Parameters">
446         <ca:parameter>
447           <ca:name>actionID</ca:name>
448           <ca:type title="Type">
449             <ca:value>string</ca:value>
450           </ca:type>
451           <ca:default title="Default">
452             <ca:value></ca:value>
453             <ca:description></ca:description>
454           </ca:default>
455           <ca:possvalues type="list" title="Values">
456             <ca:value></ca:value>
457           </ca:possvalues>
458           <ca:description></ca:description>
459         </ca:parameter>
460         <ca:parameter>
461           <ca:name>wh</ca:name>
462           <ca:type title="Type">
463             <ca:value>string</ca:value>
464           </ca:type>
465           <ca:default title="Default">
466             <ca:value></ca:value>
467             <ca:description></ca:description>
468           </ca:default>
469           <ca:possvalues type="list" title="Values">
470             <ca:value></ca:value>
471           </ca:possvalues>
472           <ca:description></ca:description>
473         </ca:parameter>
474       </ca:parameters>
475       <ca:returnvalues title="Function Return Value">
476         <ca:returnvalue>
477           <ca:type title="Type">
478             <ca:value>unknown</ca:value>
479             <ca:description></ca:description>
480           </ca:type>
481           <ca:default title="Default">
482             <ca:value></ca:value>
483           </ca:default>
484           <ca:possvalues type="list" title="Values">
485             <ca:value></ca:value>
486           </ca:possvalues>
487           <ca:description></ca:description>
488         </ca:returnvalue>
489       </ca:returnvalues>
490       <ca:triggeredjsapievents title="JSAPI Triggered Events">
491         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
492         <ca:triggeredjsapievent title="">
493           <ca:name></ca:name>
494           <ca:description></ca:description>
495         </ca:triggeredjsapievent>
496       </ca:triggeredjsapievents>
497     </ca:jsfunction>
498   </ca:jsfunctions>
499   <ca:jsfiles title="JavaScript Files">
500     <ca:jsfile>
501       <ca:name></ca:name>
502       <ca:description></ca:description>
503       <ca:jsvariables title="JavaScript Variables">
504         <ca:jsvariable>
505           <ca:name></ca:name>
506           <ca:type title="Type">
507             <ca:value>string</ca:value>
508           </ca:type>
509           <ca:scope title="Scope">
510             <ca:value>Private</ca:value>
511           </ca:scope>
512           <ca:default title="Default">
513             <ca:value></ca:value>
514           </ca:default>
515           <ca:possvalues type="list" title="Values">
516             <ca:value></ca:value>
517           </ca:possvalues>
518           <ca:description></ca:description>
519         </ca:jsvariable>
520       </ca:jsvariables>
521       <ca:jsfunctions title="JavaScript Functions">
522         <ca:jsfunction>
523           <ca:name></ca:name>
524           <ca:scope title="Scope">
525             <ca:value>Private</ca:value>
526           </ca:scope>
527           <ca:description></ca:description>
528           <ca:parameters title="Parameters">
529             <ca:parameter>
530               <ca:name></ca:name>
531               <ca:type title="Type">
532                 <ca:value>string</ca:value>
533               </ca:type>
534               <ca:required title="Required">
535                 <ca:value>false</ca:value>
536               </ca:required>
537               <ca:default title="Default">
538                 <ca:value></ca:value>
539                 <ca:description></ca:description>
540               </ca:default>
541               <ca:possvalues type="list" title="Values">
542                 <ca:value></ca:value>
543               </ca:possvalues>
544               <ca:description></ca:description>
545             </ca:parameter>
546           </ca:parameters>
547           <ca:returnvalues title="Function Return Value">
548             <ca:returnvalue>
549               <ca:type title="Type">
550                 <ca:value>unknown</ca:value>
551                 <ca:description></ca:description>
552               </ca:type>
553               <ca:default title="Default">
554                 <ca:value></ca:value>
555               </ca:default>
556               <ca:possvalues type="list" title="Values">
557                 <ca:value></ca:value>
558               </ca:possvalues>
559               <ca:description></ca:description>
560             </ca:returnvalue>
561           </ca:returnvalues>
562           <ca:triggeredjsapievents title="JSAPI Triggered Events">
563             <ca:triggeredjsapievent title="">
564               <ca:name></ca:name>
565               <ca:description></ca:description>
566             </ca:triggeredjsapievent>
567           </ca:triggeredjsapievents>
568         </ca:jsfunction>
569       </ca:jsfunctions>
570     </ca:jsfile>
571   </ca:jsfiles>
572   <ca:listenedjsapievents title="JSAPI Listened Events">
573     <ca:listenedjsapievent title="">
574       <ca:name></ca:name>
575       <ca:description></ca:description>
576       <ca:calledfunctions title="Functions Calls">
577         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
578         <ca:calledfunction>
579           <ca:name></ca:name>
580           <ca:description></ca:description>
581         </ca:calledfunction>
582       </ca:calledfunctions>
583     </ca:listenedjsapievent>
584   </ca:listenedjsapievents>
585   <ca:widgetevents title="Widget Events">
586     <ca:widgetevent>
587       <ca:name></ca:name>
588       <ca:parameters title="Parameters">
589         <ca:parameter>
590           <ca:name></ca:name>
591           <ca:type title="Type">
592             <ca:value>string</ca:value>
593           </ca:type>
594           <ca:required title="Required">
595             <ca:value>false</ca:value>
596           </ca:required>
597           <ca:default title="Default">
598             <ca:value></ca:value>
599             <ca:description></ca:description>
600           </ca:default>
601           <ca:possvalues type="list" title="Values">
602             <ca:value></ca:value>
603           </ca:possvalues>
604           <ca:description></ca:description>
605         </ca:parameter>
606       </ca:parameters>
607       <ca:description></ca:description>
608     </ca:widgetevent>
609   </ca:widgetevents>
610   <ca:errors title="Widget Errors">
611     <ca:error title="Error #1">
612       <ca:type title="Type">
613         <ca:value>PHP Mapscript</ca:value>
614       </ca:type>
615       <ca:severity title="Severity">
616         <ca:value>none</ca:value>
617         <ca:description></ca:description>
618       </ca:severity>
619       <ca:message title="Error Message">
620         <ca:paras title="">
621           <ca:para>Error message string....</ca:para>
622         </ca:paras>
623       </ca:message>
624       <ca:meaning title="Interpretation">
625         <ca:paras title="">
626           <ca:para>The description of what the message means......</ca:para>
627         </ca:paras>
628       </ca:meaning>
629       <ca:solution title="Troubleshooting Tips">
630         <ca:paras title="">
631           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
632         </ca:paras>
633       </ca:solution>
634     </ca:error>
635   </ca:errors>
636 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.