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

root/Chameleon/trunk/Chameleon/LegendTemplateLM/LegendTemplateLM.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>legendtemplatelm</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 Legend widget allows the user display a legend based on a legend template.
62 The Legend can either be embedded in the same page or displayed in a separate window.
63 This widget was coded especialy for LayerManager widget. It use a different MapObject.</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></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>   TEMPLATE ="[string]"</ca:line>
104           <ca:line>   CONTROLVISIBILITY ="[boolean]"</ca:line>
105           <ca:line>   EMBEDDED ="[boolean]"</ca:line>
106         </ca:codeblock>
107       </ca:code>
108     </ca:tagstructure>
109   </ca:tagstructures>
110   <ca:examples title="Examples">
111     <ca:widgetexamples title="Widget Examples">
112       <ca:example title="Example #1: Simple">
113         <ca:description></ca:description>
114         <ca:code title="">
115           <ca:description></ca:description>
116           <ca:codeblock bold="false">
117             <ca:line></ca:line>
118           </ca:codeblock>
119         </ca:code>
120       </ca:example>
121     </ca:widgetexamples>
122     <ca:sharedresourceexamples title="Shared Resources Examples">
123       <ca:example title="Example #1: Advanced">
124         <ca:description></ca:description>
125         <ca:code title="">
126           <ca:description></ca:description>
127           <ca:codeblock bold="false">
128             <ca:line></ca:line>
129           </ca:codeblock>
130         </ca:code>
131       </ca:example>
132     </ca:sharedresourceexamples>
133     <ca:sampleapps title="Sample Applications">
134       <ca:sampleapp>
135         <ca:name>Hawaii Demo</ca:name>
136         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
137         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
138       </ca:sampleapp>
139     </ca:sampleapps>
140     <ca:scriptexamples title="Script Examples">
141       <ca:example title="Example #1: Simple">
142         <ca:description></ca:description>
143         <ca:code title="">
144           <ca:description></ca:description>
145           <ca:codeblock bold="false">
146             <ca:line></ca:line>
147           </ca:codeblock>
148         </ca:code>
149       </ca:example>
150     </ca:scriptexamples>
151   </ca:examples>
152   <ca:attributegroups title="Attribute Groups">
153     <ca:description></ca:description>
154     <ca:attributegroup>
155       <ca:name>base</ca:name>
156       <ca:name>button</ca:name>
157       <ca:name>popup</ca:name>
158     </ca:attributegroup>
159   </ca:attributegroups>
160   <ca:widgettag title="Attributes">
161     <ca:attribute>
162       <ca:name>TEMPLATE</ca:name>
163       <ca:type title="Type">
164         <ca:value>string</ca:value>
165         <ca:description></ca:description>
166       </ca:type>
167       <ca:class title="Class">
168         <ca:value>Required</ca:value>
169       </ca:class>
170       <ca:default title="Default">
171         <ca:description></ca:description>
172       </ca:default>
173     </ca:attribute>
174     <ca:attribute>
175       <ca:name>CONTROLVISIBILITY</ca:name>
176       <ca:type title="Type">
177         <ca:value>boolean</ca:value>
178         <ca:description></ca:description>
179       </ca:type>
180       <ca:class title="Class">
181         <ca:value>Widget Only</ca:value>
182       </ca:class>
183       <ca:default title="Default">
184         <ca:description></ca:description>
185       </ca:default>
186       <ca:possvalues type="list" title="Value">
187         <ca:value>true</ca:value>
188         <ca:value>false</ca:value>
189       </ca:possvalues>
190     </ca:attribute>
191     <ca:attribute>
192       <ca:name>EMBEDDED</ca:name>
193       <ca:type title="Type">
194         <ca:value>boolean</ca:value>
195         <ca:description></ca:description>
196       </ca:type>
197       <ca:class title="Class">
198         <ca:value>Widget Only</ca:value>
199       </ca:class>
200       <ca:default title="Default">
201         <ca:description></ca:description>
202       </ca:default>
203       <ca:possvalues type="list" title="Value">
204         <ca:value>true</ca:value>
205         <ca:value>false</ca:value>
206       </ca:possvalues>
207     </ca:attribute>
208     <ca:subtag>
209       <ca:name></ca:name>
210       <ca:type title="Type">
211         <ca:value>XML</ca:value>
212         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
213       </ca:type>
214       <ca:class title="Class">
215         <ca:value>Widget &amp; Shared Resource</ca:value>
216       </ca:class>
217       <ca:description></ca:description>
218       <ca:attribute>
219         <ca:name></ca:name>
220         <ca:type title="Type">
221           <ca:value>float</ca:value>
222           <ca:description></ca:description>
223         </ca:type>
224         <ca:class title="Class">
225           <ca:value>Widget &amp; Shared Resource</ca:value>
226         </ca:class>
227         <ca:default title="Default">
228           <ca:value></ca:value>
229           <ca:description></ca:description>
230         </ca:default>
231         <ca:possvalues type="list" title="Value">
232           <ca:value></ca:value>
233         </ca:possvalues>
234         <ca:description></ca:description>
235       </ca:attribute>
236     </ca:subtag>
237   </ca:widgettag>
238   <ca:formelements title="Form Elements">
239     <ca:formelement>
240       <ca:name>LEGENDTEMPLATE_RESET</ca:name>
241       <ca:type title="Type">
242         <ca:value>unknown</ca:value>
243         <ca:description></ca:description>
244       </ca:type>
245       <ca:default title="Default">
246         <ca:value></ca:value>
247         <ca:description></ca:description>
248       </ca:default>
249       <ca:possvalues type="list" title="Values">
250         <ca:value></ca:value>
251       </ca:possvalues>
252       <ca:description></ca:description>
253     </ca:formelement>
254     <ca:formelement>
255       <ca:name>LEGENDTEMPLATE_LAYERS</ca:name>
256       <ca:type title="Type">
257         <ca:value>unknown</ca:value>
258         <ca:description></ca:description>
259       </ca:type>
260       <ca:default title="Default">
261         <ca:value></ca:value>
262         <ca:description></ca:description>
263       </ca:default>
264       <ca:possvalues type="list" title="Values">
265         <ca:value></ca:value>
266       </ca:possvalues>
267       <ca:description></ca:description>
268     </ca:formelement>
269   </ca:formelements>
270   <ca:jsvariables title="JavaScript Variables"/>
271   <ca:jsfunctions title="JavaScript Functions">
272     <ca:jsfunction>
273       <ca:name>LegendTemplateGetLayerName</ca:name>
274       <ca:scope title="Scope">
275         <ca:value>Private</ca:value>
276       </ca:scope>
277       <ca:description></ca:description>
278       <ca:parameters title="Parameters">
279         <ca:parameter>
280           <ca:name>index</ca:name>
281           <ca:type title="Type">
282             <ca:value>string</ca:value>
283           </ca:type>
284           <ca:default title="Default">
285             <ca:value></ca:value>
286             <ca:description></ca:description>
287           </ca:default>
288           <ca:possvalues type="list" title="Values">
289             <ca:value></ca:value>
290           </ca:possvalues>
291           <ca:description></ca:description>
292         </ca:parameter>
293       </ca:parameters>
294       <ca:returnvalues title="Function Return Value">
295         <ca:returnvalue>
296           <ca:type title="Type">
297             <ca:value>unknown</ca:value>
298             <ca:description></ca:description>
299           </ca:type>
300           <ca:default title="Default">
301             <ca:value></ca:value>
302           </ca:default>
303           <ca:possvalues type="list" title="Values">
304             <ca:value></ca:value>
305           </ca:possvalues>
306           <ca:description></ca:description>
307         </ca:returnvalue>
308       </ca:returnvalues>
309       <ca:triggeredjsapievents title="JSAPI Triggered Events">
310         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
311         <ca:triggeredjsapievent title="">
312           <ca:name></ca:name>
313           <ca:description></ca:description>
314         </ca:triggeredjsapievent>
315       </ca:triggeredjsapievents>
316     </ca:jsfunction>
317     <ca:jsfunction>
318       <ca:name>LegendTemplateLayerInfo</ca:name>
319       <ca:scope title="Scope">
320         <ca:value>Private</ca:value>
321       </ca:scope>
322       <ca:description></ca:description>
323       <ca:parameters title="Parameters">
324         <ca:parameter>
325           <ca:name>layername</ca:name>
326           <ca:type title="Type">
327             <ca:value>string</ca:value>
328           </ca:type>
329           <ca:default title="Default">
330             <ca:value></ca:value>
331             <ca:description></ca:description>
332           </ca:default>
333           <ca:possvalues type="list" title="Values">
334             <ca:value></ca:value>
335           </ca:possvalues>
336           <ca:description></ca:description>
337         </ca:parameter>
338       </ca:parameters>
339       <ca:returnvalues title="Function Return Value">
340         <ca:returnvalue>
341           <ca:type title="Type">
342             <ca:value>unknown</ca:value>
343             <ca:description></ca:description>
344           </ca:type>
345           <ca:default title="Default">
346             <ca:value></ca:value>
347           </ca:default>
348           <ca:possvalues type="list" title="Values">
349             <ca:value></ca:value>
350           </ca:possvalues>
351           <ca:description></ca:description>
352         </ca:returnvalue>
353       </ca:returnvalues>
354       <ca:triggeredjsapievents title="JSAPI Triggered Events">
355         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
356         <ca:triggeredjsapievent title="">
357           <ca:name></ca:name>
358           <ca:description></ca:description>
359         </ca:triggeredjsapievent>
360       </ca:triggeredjsapievents>
361     </ca:jsfunction>
362     <ca:jsfunction>
363       <ca:name>SelectSelectedLayer</ca:name>
364       <ca:scope title="Scope">
365         <ca:value>Private</ca:value>
366       </ca:scope>
367       <ca:description></ca:description>
368       <ca:returnvalues title="Function Return Value">
369         <ca:returnvalue>
370           <ca:type title="Type">
371             <ca:value>unknown</ca:value>
372             <ca:description></ca:description>
373           </ca:type>
374           <ca:default title="Default">
375             <ca:value></ca:value>
376           </ca:default>
377           <ca:possvalues type="list" title="Values">
378             <ca:value></ca:value>
379           </ca:possvalues>
380           <ca:description></ca:description>
381         </ca:returnvalue>
382       </ca:returnvalues>
383       <ca:triggeredjsapievents title="JSAPI Triggered Events">
384         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
385         <ca:triggeredjsapievent title="">
386           <ca:name></ca:name>
387           <ca:description></ca:description>
388         </ca:triggeredjsapievent>
389       </ca:triggeredjsapievents>
390     </ca:jsfunction>
391   </ca:jsfunctions>
392   <ca:jsfiles title="JavaScript Files">
393     <ca:jsfile>
394       <ca:name></ca:name>
395       <ca:description></ca:description>
396       <ca:jsvariables title="JavaScript Variables">
397         <ca:jsvariable>
398           <ca:name></ca:name>
399           <ca:type title="Type">
400             <ca:value>string</ca:value>
401           </ca:type>
402           <ca:scope title="Scope">
403             <ca:value>Private</ca:value>
404           </ca:scope>
405           <ca:default title="Default">
406             <ca:value></ca:value>
407           </ca:default>
408           <ca:possvalues type="list" title="Values">
409             <ca:value></ca:value>
410           </ca:possvalues>
411           <ca:description></ca:description>
412         </ca:jsvariable>
413       </ca:jsvariables>
414       <ca:jsfunctions title="JavaScript Functions">
415         <ca:jsfunction>
416           <ca:name></ca:name>
417           <ca:scope title="Scope">
418             <ca:value>Private</ca:value>
419           </ca:scope>
420           <ca:description></ca:description>
421           <ca:parameters title="Parameters">
422             <ca:parameter>
423               <ca:name></ca:name>
424               <ca:type title="Type">
425                 <ca:value>string</ca:value>
426               </ca:type>
427               <ca:required title="Required">
428                 <ca:value>false</ca:value>
429               </ca:required>
430               <ca:default title="Default">
431                 <ca:value></ca:value>
432                 <ca:description></ca:description>
433               </ca:default>
434               <ca:possvalues type="list" title="Values">
435                 <ca:value></ca:value>
436               </ca:possvalues>
437               <ca:description></ca:description>
438             </ca:parameter>
439           </ca:parameters>
440           <ca:returnvalues title="Function Return Value">
441             <ca:returnvalue>
442               <ca:type title="Type">
443                 <ca:value>unknown</ca:value>
444                 <ca:description></ca:description>
445               </ca:type>
446               <ca:default title="Default">
447                 <ca:value></ca:value>
448               </ca:default>
449               <ca:possvalues type="list" title="Values">
450                 <ca:value></ca:value>
451               </ca:possvalues>
452               <ca:description></ca:description>
453             </ca:returnvalue>
454           </ca:returnvalues>
455           <ca:triggeredjsapievents title="JSAPI Triggered Events">
456             <ca:triggeredjsapievent title="">
457               <ca:name></ca:name>
458               <ca:description></ca:description>
459             </ca:triggeredjsapievent>
460           </ca:triggeredjsapievents>
461         </ca:jsfunction>
462       </ca:jsfunctions>
463     </ca:jsfile>
464   </ca:jsfiles>
465   <ca:listenedjsapievents title="JSAPI Listened Events">
466     <ca:listenedjsapievent title="">
467       <ca:name></ca:name>
468       <ca:description></ca:description>
469       <ca:calledfunctions title="Functions Calls">
470         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
471         <ca:calledfunction>
472           <ca:name></ca:name>
473           <ca:description></ca:description>
474         </ca:calledfunction>
475       </ca:calledfunctions>
476     </ca:listenedjsapievent>
477   </ca:listenedjsapievents>
478   <ca:widgetevents title="Widget Events">
479     <ca:widgetevent>
480       <ca:name></ca:name>
481       <ca:parameters title="Parameters">
482         <ca:parameter>
483           <ca:name></ca:name>
484           <ca:type title="Type">
485             <ca:value>string</ca:value>
486           </ca:type>
487           <ca:required title="Required">
488             <ca:value>false</ca:value>
489           </ca:required>
490           <ca:default title="Default">
491             <ca:value></ca:value>
492             <ca:description></ca:description>
493           </ca:default>
494           <ca:possvalues type="list" title="Values">
495             <ca:value></ca:value>
496           </ca:possvalues>
497           <ca:description></ca:description>
498         </ca:parameter>
499       </ca:parameters>
500       <ca:description></ca:description>
501     </ca:widgetevent>
502   </ca:widgetevents>
503   <ca:errors title="Widget Errors">
504     <ca:error title="Error #1">
505       <ca:type title="Type">
506         <ca:value>PHP Mapscript</ca:value>
507       </ca:type>
508       <ca:severity title="Severity">
509         <ca:value>none</ca:value>
510         <ca:description></ca:description>
511       </ca:severity>
512       <ca:message title="Error Message">
513         <ca:paras title="">
514           <ca:para>Error message string....</ca:para>
515         </ca:paras>
516       </ca:message>
517       <ca:meaning title="Interpretation">
518         <ca:paras title="">
519           <ca:para>The description of what the message means......</ca:para>
520         </ca:paras>
521       </ca:meaning>
522       <ca:solution title="Troubleshooting Tips">
523         <ca:paras title="">
524           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
525         </ca:paras>
526       </ca:solution>
527     </ca:error>
528   </ca:errors>
529 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.