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

root/Chameleon/trunk/Chameleon/ExtractSR/ExtractSR.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>extractsr</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="None.">
61         <ca:para>The ExtractSRWidget displays a popup dialog box that allows the user
62 download query results as a CSV file.</ca:para>
63       </ca:paras>
64     </ca:description>
65     <ca:techrequirements title="Technical Requirements">
66       <ca:paras title="None.">
67         <ca:para></ca:para>
68       </ca:paras>
69     </ca:techrequirements>
70     <ca:dependancies title="Dependancies">
71       <ca:dependancy type="None" title="None.">
72         <ca:para></ca:para>
73       </ca:dependancy>
74     </ca:dependancies>
75     <ca:sharedresources title="Shared Resources">
76       <ca:paras title="None.">
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>   SHAREDRESOURCE ="[string]"</ca:line>
103         </ca:codeblock>
104       </ca:code>
105     </ca:tagstructure>
106   </ca:tagstructures>
107   <ca:examples title="Examples">
108     <ca:widgetexamples title="Widget Examples">
109       <ca:example title="Example #1: Simple">
110         <ca:description></ca:description>
111         <ca:code title="">
112           <ca:description></ca:description>
113           <ca:codeblock bold="false">
114             <ca:line></ca:line>
115           </ca:codeblock>
116         </ca:code>
117       </ca:example>
118     </ca:widgetexamples>
119     <ca:sharedresourceexamples title="Shared Resources Examples">
120       <ca:example title="Example #1: Advanced">
121         <ca:description></ca:description>
122         <ca:code title="">
123           <ca:description></ca:description>
124           <ca:codeblock bold="false">
125             <ca:line></ca:line>
126           </ca:codeblock>
127         </ca:code>
128       </ca:example>
129     </ca:sharedresourceexamples>
130     <ca:sampleapps title="Sample Applications">
131       <ca:sampleapp>
132         <ca:name>Hawaii Demo</ca:name>
133         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
134         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
135       </ca:sampleapp>
136     </ca:sampleapps>
137     <ca:scriptexamples title="Script Examples">
138       <ca:example title="Example #1: Simple">
139         <ca:description></ca:description>
140         <ca:code title="">
141           <ca:description></ca:description>
142           <ca:codeblock bold="false">
143             <ca:line></ca:line>
144           </ca:codeblock>
145         </ca:code>
146       </ca:example>
147     </ca:scriptexamples>
148   </ca:examples>
149   <ca:attributegroups title="Attribute Groups">
150     <ca:description></ca:description>
151     <ca:attributegroup>
152       <ca:name>base</ca:name>
153       <ca:name>button</ca:name>
154       <ca:name>popup</ca:name>
155     </ca:attributegroup>
156   </ca:attributegroups>
157   <ca:widgettag title="Attributes">
158     <ca:attribute>
159       <ca:name>SHAREDRESOURCE</ca:name>
160       <ca:type title="Type">
161         <ca:value>string</ca:value>
162         <ca:description></ca:description>
163       </ca:type>
164       <ca:class title="Class">
165         <ca:value>Required</ca:value>
166       </ca:class>
167       <ca:default title="Default">
168         <ca:description></ca:description>
169       </ca:default>
170     </ca:attribute>
171     <ca:subtag>
172       <ca:name></ca:name>
173       <ca:type title="Type">
174         <ca:value>XML</ca:value>
175         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
176       </ca:type>
177       <ca:class title="Class">
178         <ca:value>Widget &amp; Shared Resource</ca:value>
179       </ca:class>
180       <ca:description></ca:description>
181       <ca:attribute>
182         <ca:name></ca:name>
183         <ca:type title="Type">
184           <ca:value>float</ca:value>
185           <ca:description></ca:description>
186         </ca:type>
187         <ca:class title="Class">
188           <ca:value>Widget &amp; Shared Resource</ca:value>
189         </ca:class>
190         <ca:default title="Default">
191           <ca:value></ca:value>
192           <ca:description></ca:description>
193         </ca:default>
194         <ca:possvalues type="list" title="Value">
195           <ca:value></ca:value>
196         </ca:possvalues>
197         <ca:description></ca:description>
198       </ca:attribute>
199     </ca:subtag>
200   </ca:widgettag>
201   <ca:formelements title="Form Elements"/>
202   <ca:jsvariables title="JavaScript Variables"/>
203   <ca:jsfunctions title="JavaScript Functions">
204     <ca:jsfunction>
205       <ca:name>clickExtractSR</ca:name>
206       <ca:scope title="Scope">
207         <ca:value>Private</ca:value>
208       </ca:scope>
209       <ca:description></ca:description>
210       <ca:returnvalues title="Function Return Value">
211         <ca:returnvalue>
212           <ca:type title="Type">
213             <ca:value>unknown</ca:value>
214             <ca:description></ca:description>
215           </ca:type>
216           <ca:default title="Default">
217             <ca:value></ca:value>
218           </ca:default>
219           <ca:possvalues type="list" title="Values">
220             <ca:value></ca:value>
221           </ca:possvalues>
222           <ca:description></ca:description>
223         </ca:returnvalue>
224       </ca:returnvalues>
225       <ca:triggeredjsapievents title="JSAPI Triggered Events">
226         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
227         <ca:triggeredjsapievent title="">
228           <ca:name></ca:name>
229           <ca:description></ca:description>
230         </ca:triggeredjsapievent>
231       </ca:triggeredjsapievents>
232     </ca:jsfunction>
233   </ca:jsfunctions>
234   <ca:jsfiles title="JavaScript Files">
235     <ca:jsfile>
236       <ca:name></ca:name>
237       <ca:description></ca:description>
238       <ca:jsvariables title="JavaScript Variables">
239         <ca:jsvariable>
240           <ca:name></ca:name>
241           <ca:type title="Type">
242             <ca:value>string</ca:value>
243           </ca:type>
244           <ca:scope title="Scope">
245             <ca:value>Private</ca:value>
246           </ca:scope>
247           <ca:default title="Default">
248             <ca:value></ca:value>
249           </ca:default>
250           <ca:possvalues type="list" title="Values">
251             <ca:value></ca:value>
252           </ca:possvalues>
253           <ca:description></ca:description>
254         </ca:jsvariable>
255       </ca:jsvariables>
256       <ca:jsfunctions title="JavaScript Functions">
257         <ca:jsfunction>
258           <ca:name></ca:name>
259           <ca:scope title="Scope">
260             <ca:value>Private</ca:value>
261           </ca:scope>
262           <ca:description></ca:description>
263           <ca:parameters title="Parameters">
264             <ca:parameter>
265               <ca:name></ca:name>
266               <ca:type title="Type">
267                 <ca:value>string</ca:value>
268               </ca:type>
269               <ca:required title="Required">
270                 <ca:value>false</ca:value>
271               </ca:required>
272               <ca:default title="Default">
273                 <ca:value></ca:value>
274                 <ca:description></ca:description>
275               </ca:default>
276               <ca:possvalues type="list" title="Values">
277                 <ca:value></ca:value>
278               </ca:possvalues>
279               <ca:description></ca:description>
280             </ca:parameter>
281           </ca:parameters>
282           <ca:returnvalues title="Function Return Value">
283             <ca:returnvalue>
284               <ca:type title="Type">
285                 <ca:value>unknown</ca:value>
286                 <ca:description></ca:description>
287               </ca:type>
288               <ca:default title="Default">
289                 <ca:value></ca:value>
290               </ca:default>
291               <ca:possvalues type="list" title="Values">
292                 <ca:value></ca:value>
293               </ca:possvalues>
294               <ca:description></ca:description>
295             </ca:returnvalue>
296           </ca:returnvalues>
297           <ca:triggeredjsapievents title="JSAPI Triggered Events">
298             <ca:triggeredjsapievent title="">
299               <ca:name></ca:name>
300               <ca:description></ca:description>
301             </ca:triggeredjsapievent>
302           </ca:triggeredjsapievents>
303         </ca:jsfunction>
304       </ca:jsfunctions>
305     </ca:jsfile>
306   </ca:jsfiles>
307   <ca:listenedjsapievents title="JSAPI Listened Events">
308     <ca:listenedjsapievent title="">
309       <ca:name></ca:name>
310       <ca:description></ca:description>
311       <ca:calledfunctions title="Functions Calls">
312         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
313         <ca:calledfunction>
314           <ca:name></ca:name>
315           <ca:description></ca:description>
316         </ca:calledfunction>
317       </ca:calledfunctions>
318     </ca:listenedjsapievent>
319   </ca:listenedjsapievents>
320   <ca:widgetevents title="Widget Events">
321     <ca:widgetevent>
322       <ca:name></ca:name>
323       <ca:parameters title="Parameters">
324         <ca:parameter>
325           <ca:name></ca:name>
326           <ca:type title="Type">
327             <ca:value>string</ca:value>
328           </ca:type>
329           <ca:required title="Required">
330             <ca:value>false</ca:value>
331           </ca:required>
332           <ca:default title="Default">
333             <ca:value></ca:value>
334             <ca:description></ca:description>
335           </ca:default>
336           <ca:possvalues type="list" title="Values">
337             <ca:value></ca:value>
338           </ca:possvalues>
339           <ca:description></ca:description>
340         </ca:parameter>
341       </ca:parameters>
342       <ca:description></ca:description>
343     </ca:widgetevent>
344   </ca:widgetevents>
345   <ca:errors title="Widget Errors">
346     <ca:error title="Error #1">
347       <ca:type title="Type">
348         <ca:value>PHP Mapscript</ca:value>
349       </ca:type>
350       <ca:severity title="Severity">
351         <ca:value>none</ca:value>
352         <ca:description></ca:description>
353       </ca:severity>
354       <ca:message title="Error Message">
355         <ca:paras title="">
356           <ca:para>Error message string....</ca:para>
357         </ca:paras>
358       </ca:message>
359       <ca:meaning title="Interpretation">
360         <ca:paras title="">
361           <ca:para>The description of what the message means......</ca:para>
362         </ca:paras>
363       </ca:meaning>
364       <ca:solution title="Troubleshooting Tips">
365         <ca:paras title="">
366           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
367         </ca:paras>
368       </ca:solution>
369     </ca:error>
370   </ca:errors>
371 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.