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

root/Chameleon/trunk/Chameleon/WMSCache/WMSCache.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>wmscache</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 WMSCache widget gets the contents (servers and layers) and places it inside
62 a SharedResource widget in a format suitable for accessing via a javascript-
63 enabled SharedResource.  It can either list the servers or list the layers
64 available in a single server.</ca:para>
65       </ca:paras>
66     </ca:description>
67     <ca:techrequirements title="Technical Requirements">
68       <ca:paras title="Not Available">
69         <ca:para></ca:para>
70       </ca:paras>
71     </ca:techrequirements>
72     <ca:dependancies title="Dependancies">
73       <ca:dependancy type="None" title="Not Available">
74         <ca:para></ca:para>
75       </ca:dependancy>
76     </ca:dependancies>
77     <ca:sharedresources title="Shared Resources">
78       <ca:paras title="Not Available">
79         <ca:para></ca:para>
80       </ca:paras>
81     </ca:sharedresources>
82     <ca:embeddedhelp title="General User Interface Help">
83       <ca:paras title="">
84         <ca:para></ca:para>
85       </ca:paras>
86     </ca:embeddedhelp>
87     <ca:guinotes title="Interface Functionality">
88       <ca:guinote type="None" title="None.">
89         <ca:para></ca:para>
90       </ca:guinote>
91     </ca:guinotes>
92     <ca:qanotes title="Quality Assurance">
93       <ca:paras title="None.">
94         <ca:para></ca:para>
95       </ca:paras>
96     </ca:qanotes>
97   </ca:descriptions>
98   <ca:tagstructures title="Tag Syntax">
99     <ca:tagstructure title="Widget Syntax">
100       <ca:description></ca:description>
101       <ca:code title="">
102         <ca:description></ca:description>
103         <ca:codeblock bold="false">
104           <ca:line>   SHAREDRESOURCENAME ="[string]"</ca:line>
105           <ca:line>   WMSCACHEDIRECTORY ="[string]"</ca:line>
106           <ca:line>   LISTSERVERS ="[boolean]"</ca:line>
107           <ca:line>   LISTLAYERS ="[boolean]"</ca:line>
108           <ca:line>   SERVERIMAGE ="[string]"</ca:line>
109           <ca:line>   THEMEIMAGE ="[string]"</ca:line>
110           <ca:line>   THEMEOPENIMAGE ="[string]"</ca:line>
111           <ca:line>   LAYERIMAGE ="[string]"</ca:line>
112         </ca:codeblock>
113       </ca:code>
114     </ca:tagstructure>
115   </ca:tagstructures>
116   <ca:examples title="Examples">
117     <ca:widgetexamples title="Widget Examples">
118       <ca:example title="Example #1: Simple">
119         <ca:description></ca:description>
120         <ca:code title="">
121           <ca:description></ca:description>
122           <ca:codeblock bold="false">
123             <ca:line></ca:line>
124           </ca:codeblock>
125         </ca:code>
126       </ca:example>
127     </ca:widgetexamples>
128     <ca:sharedresourceexamples title="Shared Resources Examples">
129       <ca:example title="Example #1: Advanced">
130         <ca:description></ca:description>
131         <ca:code title="">
132           <ca:description></ca:description>
133           <ca:codeblock bold="false">
134             <ca:line></ca:line>
135           </ca:codeblock>
136         </ca:code>
137       </ca:example>
138     </ca:sharedresourceexamples>
139     <ca:sampleapps title="Sample Applications">
140       <ca:sampleapp>
141         <ca:name>Hawaii Demo</ca:name>
142         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
143         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
144       </ca:sampleapp>
145     </ca:sampleapps>
146     <ca:scriptexamples title="Script Examples">
147       <ca:example title="Example #1: Simple">
148         <ca:description></ca:description>
149         <ca:code title="">
150           <ca:description></ca:description>
151           <ca:codeblock bold="false">
152             <ca:line></ca:line>
153           </ca:codeblock>
154         </ca:code>
155       </ca:example>
156     </ca:scriptexamples>
157   </ca:examples>
158   <ca:attributegroups title="Attribute Groups">
159     <ca:description></ca:description>
160     <ca:attributegroup>
161       <ca:name>base</ca:name>
162     </ca:attributegroup>
163   </ca:attributegroups>
164   <ca:widgettag title="Attributes">
165     <ca:attribute>
166       <ca:name>SHAREDRESOURCENAME</ca:name>
167       <ca:type title="Type">
168         <ca:value>string</ca:value>
169
170       </ca:type>
171       <ca:class title="Class">
172         <ca:value>Required</ca:value>
173       </ca:class>
174       <ca:default title="Default">
175         <ca:description></ca:description>
176       </ca:default>
177       <ca:description>The name of the SharedResource to populate with output from this widget.</ca:description>
178     </ca:attribute>
179     <ca:attribute>
180       <ca:name>WMSCACHEDIRECTORY</ca:name>
181       <ca:type title="Type">
182         <ca:value>string</ca:value>
183        
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:description>The directory to get the wms cached capabilities from.  May be relative or absolute.  If relative, then it is considered relative to the location of the template containing this widget.</ca:description>
192     </ca:attribute>
193     <ca:attribute>
194       <ca:name>LISTSERVERS</ca:name>
195       <ca:type title="Type">
196         <ca:value>boolean</ca:value>
197        
198       </ca:type>
199       <ca:class title="Class">
200         <ca:value>Widget Only</ca:value>
201       </ca:class>
202       <ca:default title="Default">
203         <ca:description></ca:description>
204       </ca:default>
205       <ca:possvalues type="list" title="Value">
206         <ca:value>true</ca:value>
207         <ca:value>false</ca:value>
208       </ca:possvalues>
209       <ca:description>Control the outputting of servers from the WMS Cache.  If true, then all servers will be copied into the selected SharedResource.  If false, then only the selected server will be copied.</ca:description>
210     </ca:attribute>
211     <ca:attribute>
212       <ca:name>LISTLAYERS</ca:name>
213       <ca:type title="Type">
214         <ca:value>boolean</ca:value>
215       </ca:type>
216       <ca:class title="Class">
217         <ca:value>Widget Only</ca:value>
218       </ca:class>
219       <ca:default title="Default">
220         <ca:description></ca:description>
221       </ca:default>
222       <ca:possvalues type="list" title="Value">
223         <ca:value>true</ca:value>
224         <ca:value>false</ca:value>
225       </ca:possvalues>
226       <ca:description>Control the outputting of layers from the WMS Cache.  If true, then all layers for all selected servers will be copied into the selected SharedResource.</ca:description>
227     </ca:attribute>
228     <ca:attribute>
229       <ca:name>SERVERIMAGE</ca:name>
230       <ca:type title="Type">
231         <ca:value>string</ca:value>
232
233       </ca:type>
234       <ca:class title="Class">
235         <ca:value>Widget Only</ca:value>
236       </ca:class>
237       <ca:default title="Default">
238         <ca:description></ca:description>
239       </ca:default>
240       <ca:description>The image to associate with servers.</ca:description>
241     </ca:attribute>
242     <ca:attribute>
243       <ca:name>THEMEIMAGE</ca:name>
244       <ca:type title="Type">
245         <ca:value>string</ca:value>
246
247       </ca:type>
248       <ca:class title="Class">
249         <ca:value>Widget Only</ca:value>
250       </ca:class>
251       <ca:default title="Default">
252         <ca:description></ca:description>
253       </ca:default>
254       <ca:description>The name of the default image to use with themes (a group of layers).  WMSCache will try to get an icon from the style associated with a theme and will use this image only if it cannot find a valid style.</ca:description>
255     </ca:attribute>
256     <ca:attribute>
257       <ca:name>THEMEOPENIMAGE</ca:name>
258       <ca:type title="Type">
259         <ca:value>string</ca:value>
260
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:description>The name of the default image to use with themes that have been expanded.  This will be overwritten if the theme has a valid style.</ca:description>
269     </ca:attribute>
270     <ca:attribute>
271       <ca:name>LAYERIMAGE</ca:name>
272       <ca:type title="Type">
273         <ca:value>string</ca:value>
274
275       </ca:type>
276       <ca:class title="Class">
277         <ca:value>Widget Only</ca:value>
278       </ca:class>
279       <ca:default title="Default">
280         <ca:description></ca:description>
281       </ca:default>
282       <ca:description>The name of the default image to use with layers.  WMSCache will try to get an icon from the style associated with a layer and will use this image only if it cannot find a valid style.</ca:description>
283     </ca:attribute>
284     <ca:subtag>
285       <ca:name></ca:name>
286       <ca:type title="Type">
287         <ca:value>XML</ca:value>
288         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
289       </ca:type>
290       <ca:class title="Class">
291         <ca:value>Widget &amp; Shared Resource</ca:value>
292       </ca:class>
293       <ca:description></ca:description>
294       <ca:attribute>
295         <ca:name></ca:name>
296         <ca:type title="Type">
297           <ca:value>float</ca:value>
298           <ca:description></ca:description>
299         </ca:type>
300         <ca:class title="Class">
301           <ca:value>Widget &amp; Shared Resource</ca:value>
302         </ca:class>
303         <ca:default title="Default">
304           <ca:value></ca:value>
305           <ca:description></ca:description>
306         </ca:default>
307         <ca:possvalues type="list" title="Value">
308           <ca:value></ca:value>
309         </ca:possvalues>
310         <ca:description></ca:description>
311       </ca:attribute>
312     </ca:subtag>
313   </ca:widgettag>
314   <ca:formelements title="Form Elements">
315     <ca:formelement>
316       <ca:name></ca:name>
317       <ca:type title="Type">
318         <ca:value>unknown</ca:value>
319         <ca:description></ca:description>
320       </ca:type>
321       <ca:default title="Default">
322         <ca:value></ca:value>
323         <ca:description></ca:description>
324       </ca:default>
325       <ca:possvalues type="list" title="Values">
326         <ca:value></ca:value>
327       </ca:possvalues>
328       <ca:description></ca:description>
329     </ca:formelement>
330   </ca:formelements>
331   <ca:jsvariables title="JavaScript Variables"/>
332   <ca:jsfunctions title="JavaScript Functions"/>
333   <ca:jsfiles title="JavaScript Files">
334     <ca:jsfile>
335       <ca:name></ca:name>
336       <ca:description></ca:description>
337       <ca:jsvariables title="JavaScript Variables">
338         <ca:jsvariable>
339           <ca:name></ca:name>
340           <ca:type title="Type">
341             <ca:value>string</ca:value>
342           </ca:type>
343           <ca:scope title="Scope">
344             <ca:value>Private</ca:value>
345           </ca:scope>
346           <ca:default title="Default">
347             <ca:value></ca:value>
348           </ca:default>
349           <ca:possvalues type="list" title="Values">
350             <ca:value></ca:value>
351           </ca:possvalues>
352           <ca:description></ca:description>
353         </ca:jsvariable>
354       </ca:jsvariables>
355       <ca:jsfunctions title="JavaScript Functions">
356         <ca:jsfunction>
357           <ca:name></ca:name>
358           <ca:scope title="Scope">
359             <ca:value>Private</ca:value>
360           </ca:scope>
361           <ca:description></ca:description>
362           <ca:parameters title="Parameters">
363             <ca:parameter>
364               <ca:name></ca:name>
365               <ca:type title="Type">
366                 <ca:value>string</ca:value>
367               </ca:type>
368               <ca:required title="Required">
369                 <ca:value>false</ca:value>
370               </ca:required>
371               <ca:default title="Default">
372                 <ca:value></ca:value>
373                 <ca:description></ca:description>
374               </ca:default>
375               <ca:possvalues type="list" title="Values">
376                 <ca:value></ca:value>
377               </ca:possvalues>
378               <ca:description></ca:description>
379             </ca:parameter>
380           </ca:parameters>
381           <ca:returnvalues title="Function Return Value">
382             <ca:returnvalue>
383               <ca:type title="Type">
384                 <ca:value>unknown</ca:value>
385                 <ca:description></ca:description>
386               </ca:type>
387               <ca:default title="Default">
388                 <ca:value></ca:value>
389               </ca:default>
390               <ca:possvalues type="list" title="Values">
391                 <ca:value></ca:value>
392               </ca:possvalues>
393               <ca:description></ca:description>
394             </ca:returnvalue>
395           </ca:returnvalues>
396           <ca:triggeredjsapievents title="JSAPI Triggered Events">
397             <ca:triggeredjsapievent title="">
398               <ca:name></ca:name>
399               <ca:description></ca:description>
400             </ca:triggeredjsapievent>
401           </ca:triggeredjsapievents>
402         </ca:jsfunction>
403       </ca:jsfunctions>
404     </ca:jsfile>
405   </ca:jsfiles>
406   <ca:listenedjsapievents title="JSAPI Listened Events">
407     <ca:listenedjsapievent title="">
408       <ca:name></ca:name>
409       <ca:description></ca:description>
410       <ca:calledfunctions title="Functions Calls">
411         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
412         <ca:calledfunction>
413           <ca:name></ca:name>
414           <ca:description></ca:description>
415         </ca:calledfunction>
416       </ca:calledfunctions>
417     </ca:listenedjsapievent>
418   </ca:listenedjsapievents>
419   <ca:widgetevents title="Widget Events">
420     <ca:widgetevent>
421       <ca:name></ca:name>
422       <ca:parameters title="Parameters">
423         <ca:parameter>
424           <ca:name></ca:name>
425           <ca:type title="Type">
426             <ca:value>string</ca:value>
427           </ca:type>
428           <ca:required title="Required">
429             <ca:value>false</ca:value>
430           </ca:required>
431           <ca:default title="Default">
432             <ca:value></ca:value>
433             <ca:description></ca:description>
434           </ca:default>
435           <ca:possvalues type="list" title="Values">
436             <ca:value></ca:value>
437           </ca:possvalues>
438           <ca:description></ca:description>
439         </ca:parameter>
440       </ca:parameters>
441       <ca:description></ca:description>
442     </ca:widgetevent>
443   </ca:widgetevents>
444   <ca:errors title="Widget Errors">
445     <ca:error title="Error #1">
446       <ca:type title="Type">
447         <ca:value>PHP Mapscript</ca:value>
448       </ca:type>
449       <ca:severity title="Severity">
450         <ca:value>none</ca:value>
451         <ca:description></ca:description>
452       </ca:severity>
453       <ca:message title="Error Message">
454         <ca:paras title="">
455           <ca:para>Error message string....</ca:para>
456         </ca:paras>
457       </ca:message>
458       <ca:meaning title="Interpretation">
459         <ca:paras title="">
460           <ca:para>The description of what the message means......</ca:para>
461         </ca:paras>
462       </ca:meaning>
463       <ca:solution title="Troubleshooting Tips">
464         <ca:paras title="">
465           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
466         </ca:paras>
467       </ca:solution>
468     </ca:error>
469   </ca:errors>
470 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.