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

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