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

root/Chameleon/trunk/Chameleon/Locate/Locate.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>locate</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 Locate widget provides a dialog box that can be used to search for
62 postal codes, place names and NTS map sheets and zoom the map to one of
63 the results of the search.</ca:para>
64       </ca:paras>
65     </ca:description>
66     <ca:techrequirements title="Technical Requirements">
67       <ca:paras title="Not Available">
68         <ca:para></ca:para>
69       </ca:paras>
70     </ca:techrequirements>
71     <ca:dependancies title="Dependancies">
72       <ca:dependancy type="None" title="Not Available">
73         <ca:para></ca:para>
74       </ca:dependancy>
75     </ca:dependancies>
76     <ca:sharedresources title="Shared Resources">
77       <ca:paras title="Not Available">
78         <ca:para></ca:para>
79       </ca:paras>
80     </ca:sharedresources>
81     <ca:embeddedhelp title="General User Interface Help">
82       <ca:paras title="">
83         <ca:para>This button provides the capability to find locations through a gazetteer service. It allows searching on Place or Feature names, Postal Codes (first three characters, or Forward Sortation Area, only), and NTS Map Sheet numbers. To find a place, type the name into the Place or Feature box and click Locate Place. The search results will be populated with any matches found. To zoom the map to show the feature, select it in the list and make sure the checkbox "Set map view to better see this location" is checked. To place a temporary label at the feature, check the checkbox "Add a point to this location".</ca:para>
84       </ca:paras>
85     </ca:embeddedhelp>
86     <ca:guinotes title="Interface Functionality">
87       <ca:guinote type="None" title="None.">
88         <ca:para></ca:para>
89       </ca:guinote>
90     </ca:guinotes>
91     <ca:qanotes title="Quality Assurance">
92       <ca:paras title="None.">
93         <ca:para></ca:para>
94       </ca:paras>
95     </ca:qanotes>
96   </ca:descriptions>
97   <ca:tagstructures title="Tag Syntax">
98     <ca:tagstructure title="Widget Syntax">
99       <ca:description></ca:description>
100       <ca:code title="">
101         <ca:description></ca:description>
102         <ca:codeblock bold="false">
103           <ca:line>   ZOOMTOSCALE ="[integer]"</ca:line>
104         </ca:codeblock>
105       </ca:code>
106     </ca:tagstructure>
107   </ca:tagstructures>
108   <ca:examples title="Examples">
109     <ca:widgetexamples title="Widget Examples">
110       <ca:example title="Example #1: Simple">
111         <ca:description></ca:description>
112         <ca:code title="">
113           <ca:description></ca:description>
114           <ca:codeblock bold="false">
115             <ca:line></ca:line>
116           </ca:codeblock>
117         </ca:code>
118       </ca:example>
119     </ca:widgetexamples>
120     <ca:sharedresourceexamples title="Shared Resources Examples">
121       <ca:example title="Example #1: Advanced">
122         <ca:description></ca:description>
123         <ca:code title="">
124           <ca:description></ca:description>
125           <ca:codeblock bold="false">
126             <ca:line></ca:line>
127           </ca:codeblock>
128         </ca:code>
129       </ca:example>
130     </ca:sharedresourceexamples>
131     <ca:sampleapps title="Sample Applications">
132       <ca:sampleapp>
133         <ca:name>Hawaii Demo</ca:name>
134         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
135         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
136       </ca:sampleapp>
137     </ca:sampleapps>
138     <ca:scriptexamples title="Script Examples">
139       <ca:example title="Example #1: Simple">
140         <ca:description></ca:description>
141         <ca:code title="">
142           <ca:description></ca:description>
143           <ca:codeblock bold="false">
144             <ca:line></ca:line>
145           </ca:codeblock>
146         </ca:code>
147       </ca:example>
148     </ca:scriptexamples>
149   </ca:examples>
150   <ca:attributegroups title="Attribute Groups">
151     <ca:description></ca:description>
152     <ca:attributegroup>
153       <ca:name>base</ca:name>
154       <ca:name>button</ca:name>
155       <ca:name>popup</ca:name>
156     </ca:attributegroup>
157   </ca:attributegroups>
158   <ca:widgettag title="Attributes">
159     <ca:attribute>
160       <ca:name>ZOOMTOSCALE</ca:name>
161       <ca:type title="Type">
162         <ca:value>integer</ca:value>
163        
164       </ca:type>
165       <ca:class title="Class">
166         <ca:value>Widget Only</ca:value>
167       </ca:class>
168       <ca:default title="Default">
169         <ca:description></ca:description>
170       </ca:default>
171       <ca:possvalues type="range" title="Value">
172         <ca:minimum>1</ca:minimum>
173         <ca:maximum>2147483647</ca:maximum>
174       </ca:possvalues>
175       <ca:description>The map scale to zoom to when the Locate widget to zoom to a location.  A value between 250000 and 1000000 would be reasonable in most applications.</ca:description>
176     </ca:attribute>
177     <ca:subtag>
178       <ca:name></ca:name>
179       <ca:type title="Type">
180         <ca:value>XML</ca:value>
181         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
182       </ca:type>
183       <ca:class title="Class">
184         <ca:value>Widget &amp; Shared Resource</ca:value>
185       </ca:class>
186       <ca:description></ca:description>
187       <ca:attribute>
188         <ca:name></ca:name>
189         <ca:type title="Type">
190           <ca:value>float</ca:value>
191           <ca:description></ca:description>
192         </ca:type>
193         <ca:class title="Class">
194           <ca:value>Widget &amp; Shared Resource</ca:value>
195         </ca:class>
196         <ca:default title="Default">
197           <ca:value></ca:value>
198           <ca:description></ca:description>
199         </ca:default>
200         <ca:possvalues type="list" title="Value">
201           <ca:value></ca:value>
202         </ca:possvalues>
203         <ca:description></ca:description>
204       </ca:attribute>
205     </ca:subtag>
206   </ca:widgettag>
207   <ca:formelements title="Form Elements">
208     <ca:formelement>
209       <ca:name>LOCATE_ZOOM_TO</ca:name>
210       <ca:type title="Type">
211         <ca:value>unknown</ca:value>
212        
213       </ca:type>
214       <ca:default title="Default">
215         <ca:value></ca:value>
216         <ca:description></ca:description>
217       </ca:default>
218       <ca:possvalues type="list" title="Values">
219         <ca:value></ca:value>
220       </ca:possvalues>
221       <ca:description>The geographic coordinates to zoom to when locating something</ca:description>
222     </ca:formelement>
223     <ca:formelement>
224       <ca:name>LOCATE_ADD_ELEMENT</ca:name>
225       <ca:type title="Type">
226         <ca:value>unknown</ca:value>
227         <ca:description></ca:description>
228       </ca:type>
229       <ca:default title="Default">
230         <ca:value></ca:value>
231         <ca:description></ca:description>
232       </ca:default>
233       <ca:possvalues type="list" title="Values">
234         <ca:value></ca:value>
235       </ca:possvalues>
236       <ca:description>Used to track the element that has been added to the map (point or rectangle)</ca:description>
237     </ca:formelement>
238     <ca:formelement>
239       <ca:name>LOCATE_LATLONG</ca:name>
240       <ca:type title="Type">
241         <ca:value>unknown</ca:value>
242         <ca:description></ca:description>
243       </ca:type>
244       <ca:default title="Default">
245         <ca:value></ca:value>
246         <ca:description></ca:description>
247       </ca:default>
248       <ca:possvalues type="list" title="Values">
249         <ca:value></ca:value>
250       </ca:possvalues>
251       <ca:description>The lat/long value to zoom to.</ca:description>
252     </ca:formelement>
253     <ca:formelement>
254       <ca:name>LOCATE_ELEMENT_TYPE</ca:name>
255       <ca:type title="Type">
256         <ca:value>unknown</ca:value>
257         <ca:description></ca:description>
258       </ca:type>
259       <ca:default title="Default">
260         <ca:value></ca:value>
261         <ca:description></ca:description>
262       </ca:default>
263       <ca:possvalues type="list" title="Values">
264         <ca:value></ca:value>
265       </ca:possvalues>
266       <ca:description></ca:description>
267     </ca:formelement>
268   </ca:formelements>
269   <ca:jsvariables title="JavaScript Variables"/>
270   <ca:jsfunctions title="JavaScript Functions">
271     <ca:jsfunction>
272       <ca:name>onClickLocate</ca:name>
273       <ca:scope title="Scope">
274         <ca:value>Private</ca:value>
275       </ca:scope>
276       <ca:description>callback when the locate button is clicked</ca:description>
277       <ca:returnvalues title="Function Return Value">
278         <ca:returnvalue>
279           <ca:type title="Type">
280             <ca:value>unknown</ca:value>
281             <ca:description></ca:description>
282           </ca:type>
283           <ca:default title="Default">
284             <ca:value></ca:value>
285           </ca:default>
286           <ca:possvalues type="list" title="Values">
287             <ca:value></ca:value>
288           </ca:possvalues>
289           <ca:description></ca:description>
290         </ca:returnvalue>
291       </ca:returnvalues>
292       <ca:triggeredjsapievents title="JSAPI Triggered Events">
293         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
294         <ca:triggeredjsapievent title="">
295           <ca:name></ca:name>
296           <ca:description></ca:description>
297         </ca:triggeredjsapievent>
298       </ca:triggeredjsapievents>
299     </ca:jsfunction>
300     <ca:jsfunction>
301       <ca:name>LocateCB</ca:name>
302       <ca:scope title="Scope">
303         <ca:value>Private</ca:value>
304       </ca:scope>
305       <ca:description>callback function to handle user input from the Locate dialog</ca:description>
306       <ca:parameters title="Parameters">
307         <ca:parameter>
308           <ca:name>actionID</ca:name>
309           <ca:type title="Type">
310             <ca:value>string</ca:value>
311           </ca:type>
312           <ca:default title="Default">
313             <ca:value></ca:value>
314             <ca:description></ca:description>
315           </ca:default>
316           <ca:possvalues type="list" title="Values">
317             <ca:value></ca:value>
318           </ca:possvalues>
319           <ca:description></ca:description>
320         </ca:parameter>
321         <ca:parameter>
322           <ca:name>wh</ca:name>
323           <ca:type title="Type">
324             <ca:value>string</ca:value>
325           </ca:type>
326           <ca:default title="Default">
327             <ca:value></ca:value>
328             <ca:description></ca:description>
329           </ca:default>
330           <ca:possvalues type="list" title="Values">
331             <ca:value></ca:value>
332           </ca:possvalues>
333           <ca:description></ca:description>
334         </ca:parameter>
335       </ca:parameters>
336       <ca:returnvalues title="Function Return Value">
337         <ca:returnvalue>
338           <ca:type title="Type">
339             <ca:value>unknown</ca:value>
340             <ca:description></ca:description>
341           </ca:type>
342           <ca:default title="Default">
343             <ca:value></ca:value>
344           </ca:default>
345           <ca:possvalues type="list" title="Values">
346             <ca:value></ca:value>
347           </ca:possvalues>
348           <ca:description></ca:description>
349         </ca:returnvalue>
350       </ca:returnvalues>
351       <ca:triggeredjsapievents title="JSAPI Triggered Events">
352         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
353         <ca:triggeredjsapievent title="">
354           <ca:name></ca:name>
355           <ca:description></ca:description>
356         </ca:triggeredjsapievent>
357       </ca:triggeredjsapievents>
358     </ca:jsfunction>
359   </ca:jsfunctions>
360   <ca:jsfiles title="JavaScript Files">
361     <ca:jsfile>
362       <ca:name></ca:name>
363       <ca:description></ca:description>
364       <ca:jsvariables title="JavaScript Variables">
365         <ca:jsvariable>
366           <ca:name></ca:name>
367           <ca:type title="Type">
368             <ca:value>string</ca:value>
369           </ca:type>
370           <ca:scope title="Scope">
371             <ca:value>Private</ca:value>
372           </ca:scope>
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:jsvariable>
381       </ca:jsvariables>
382       <ca:jsfunctions title="JavaScript Functions">
383         <ca:jsfunction>
384           <ca:name></ca:name>
385           <ca:scope title="Scope">
386             <ca:value>Private</ca:value>
387           </ca:scope>
388           <ca:description></ca:description>
389           <ca:parameters title="Parameters">
390             <ca:parameter>
391               <ca:name></ca:name>
392               <ca:type title="Type">
393                 <ca:value>string</ca:value>
394               </ca:type>
395               <ca:required title="Required">
396                 <ca:value>false</ca:value>
397               </ca:required>
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:parameter>
407           </ca:parameters>
408           <ca:returnvalues title="Function Return Value">
409             <ca:returnvalue>
410               <ca:type title="Type">
411                 <ca:value>unknown</ca:value>
412                 <ca:description></ca:description>
413               </ca:type>
414               <ca:default title="Default">
415                 <ca:value></ca:value>
416               </ca:default>
417               <ca:possvalues type="list" title="Values">
418                 <ca:value></ca:value>
419               </ca:possvalues>
420               <ca:description></ca:description>
421             </ca:returnvalue>
422           </ca:returnvalues>
423           <ca:triggeredjsapievents title="JSAPI Triggered Events">
424             <ca:triggeredjsapievent title="">
425               <ca:name></ca:name>
426               <ca:description></ca:description>
427             </ca:triggeredjsapievent>
428           </ca:triggeredjsapievents>
429         </ca:jsfunction>
430       </ca:jsfunctions>
431     </ca:jsfile>
432   </ca:jsfiles>
433   <ca:listenedjsapievents title="JSAPI Listened Events">
434     <ca:listenedjsapievent title="">
435       <ca:name></ca:name>
436       <ca:description></ca:description>
437       <ca:calledfunctions title="Functions Calls">
438         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
439         <ca:calledfunction>
440           <ca:name></ca:name>
441           <ca:description></ca:description>
442         </ca:calledfunction>
443       </ca:calledfunctions>
444     </ca:listenedjsapievent>
445   </ca:listenedjsapievents>
446   <ca:widgetevents title="Widget Events">
447     <ca:widgetevent>
448       <ca:name></ca:name>
449       <ca:parameters title="Parameters">
450         <ca:parameter>
451           <ca:name></ca:name>
452           <ca:type title="Type">
453             <ca:value>string</ca:value>
454           </ca:type>
455           <ca:required title="Required">
456             <ca:value>false</ca:value>
457           </ca:required>
458           <ca:default title="Default">
459             <ca:value></ca:value>
460             <ca:description></ca:description>
461           </ca:default>
462           <ca:possvalues type="list" title="Values">
463             <ca:value></ca:value>
464           </ca:possvalues>
465           <ca:description></ca:description>
466         </ca:parameter>
467       </ca:parameters>
468       <ca:description></ca:description>
469     </ca:widgetevent>
470   </ca:widgetevents>
471   <ca:errors title="Widget Errors">
472     <ca:error title="Error #1">
473       <ca:type title="Type">
474         <ca:value>PHP Mapscript</ca:value>
475       </ca:type>
476       <ca:severity title="Severity">
477         <ca:value>none</ca:value>
478         <ca:description></ca:description>
479       </ca:severity>
480       <ca:message title="Error Message">
481         <ca:paras title="">
482           <ca:para>Error message string....</ca:para>
483         </ca:paras>
484       </ca:message>
485       <ca:meaning title="Interpretation">
486         <ca:paras title="">
487           <ca:para>The description of what the message means......</ca:para>
488         </ca:paras>
489       </ca:meaning>
490       <ca:solution title="Troubleshooting Tips">
491         <ca:paras title="">
492           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
493         </ca:paras>
494       </ca:solution>
495     </ca:error>
496   </ca:errors>
497 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.