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

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