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

root/Chameleon/trunk/Chameleon/Table/Table.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>table</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 Table widget provides the functionality to display
62 shared resource as Table.</ca:para>
63       </ca:paras>
64     </ca:description>
65     <ca:techrequirements title="Technical Requirements">
66       <ca:paras title="Not Available">
67         <ca:para></ca:para>
68       </ca:paras>
69     </ca:techrequirements>
70     <ca:dependancies title="Dependancies">
71       <ca:dependancy type="None" title="Not Available">
72         <ca:para></ca:para>
73       </ca:dependancy>
74     </ca:dependancies>
75     <ca:sharedresources title="Shared Resources">
76       <ca:paras title="Not Available">
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>   SHAREDRESOURCENAME ="[string]"</ca:line>
103           <ca:line>   SORTBY ="[string]"</ca:line>
104           <ca:line>   START ="[integer]"</ca:line>
105           <ca:line>   COUNT ="[integer]"</ca:line>
106           <ca:line>   REVERSE ="[boolean]"</ca:line>
107           <ca:line>   NEXTBUTTON ="[string]"</ca:line>
108           <ca:line>   PREVBUTTON ="[string]"</ca:line>
109           <ca:line>   NAME ="[string]"</ca:line>
110         </ca:codeblock>
111       </ca:code>
112     </ca:tagstructure>
113   </ca:tagstructures>
114   <ca:examples title="Examples">
115     <ca:widgetexamples title="Widget Examples">
116       <ca:example title="Example #1: Simple">
117         <ca:description></ca:description>
118         <ca:code title="">
119           <ca:description></ca:description>
120           <ca:codeblock bold="false">
121             <ca:line></ca:line>
122           </ca:codeblock>
123         </ca:code>
124       </ca:example>
125     </ca:widgetexamples>
126     <ca:sharedresourceexamples title="Shared Resources Examples">
127       <ca:example title="Example #1: Advanced">
128         <ca:description></ca:description>
129         <ca:code title="">
130           <ca:description></ca:description>
131           <ca:codeblock bold="false">
132             <ca:line></ca:line>
133           </ca:codeblock>
134         </ca:code>
135       </ca:example>
136     </ca:sharedresourceexamples>
137     <ca:sampleapps title="Sample Applications">
138       <ca:sampleapp>
139         <ca:name>Hawaii Demo</ca:name>
140         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
141         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
142       </ca:sampleapp>
143     </ca:sampleapps>
144     <ca:scriptexamples title="Script Examples">
145       <ca:example title="Example #1: Simple">
146         <ca:description></ca:description>
147         <ca:code title="">
148           <ca:description></ca:description>
149           <ca:codeblock bold="false">
150             <ca:line></ca:line>
151           </ca:codeblock>
152         </ca:code>
153       </ca:example>
154     </ca:scriptexamples>
155   </ca:examples>
156   <ca:attributegroups title="Attribute Groups">
157     <ca:description></ca:description>
158     <ca:attributegroup>
159       <ca:name>base</ca:name>
160     </ca:attributegroup>
161   </ca:attributegroups>
162   <ca:widgettag title="Attributes">
163     <ca:attribute>
164       <ca:name>SHAREDRESOURCENAME</ca:name>
165       <ca:type title="Type">
166         <ca:value>string</ca:value>
167         <ca:description></ca:description>
168       </ca:type>
169       <ca:class title="Class">
170         <ca:value>Required</ca:value>
171       </ca:class>
172       <ca:default title="Default">
173         <ca:description></ca:description>
174       </ca:default>
175     </ca:attribute>
176     <ca:attribute>
177       <ca:name>SORTBY</ca:name>
178       <ca:type title="Type">
179         <ca:value>string</ca:value>
180         <ca:description></ca:description>
181       </ca:type>
182       <ca:class title="Class">
183         <ca:value>Widget Only</ca:value>
184       </ca:class>
185       <ca:default title="Default">
186         <ca:description></ca:description>
187       </ca:default>
188     </ca:attribute>
189     <ca:attribute>
190       <ca:name>START</ca:name>
191       <ca:type title="Type">
192         <ca:value>integer</ca:value>
193         <ca:description></ca:description>
194       </ca:type>
195       <ca:class title="Class">
196         <ca:value>Widget Only</ca:value>
197       </ca:class>
198       <ca:default title="Default">
199         <ca:description></ca:description>
200       </ca:default>
201       <ca:possvalues type="range" title="Value">
202         <ca:minimum>-2147483647</ca:minimum>
203         <ca:maximum>2147483647</ca:maximum>
204       </ca:possvalues>
205     </ca:attribute>
206     <ca:attribute>
207       <ca:name>COUNT</ca:name>
208       <ca:type title="Type">
209         <ca:value>integer</ca:value>
210         <ca:description></ca:description>
211       </ca:type>
212       <ca:class title="Class">
213         <ca:value>Widget Only</ca:value>
214       </ca:class>
215       <ca:default title="Default">
216         <ca:description></ca:description>
217       </ca:default>
218       <ca:possvalues type="range" title="Value">
219         <ca:minimum>-2147483647</ca:minimum>
220         <ca:maximum>2147483647</ca:maximum>
221       </ca:possvalues>
222     </ca:attribute>
223     <ca:attribute>
224       <ca:name>REVERSE</ca:name>
225       <ca:type title="Type">
226         <ca:value>boolean</ca:value>
227         <ca:description></ca:description>
228       </ca:type>
229       <ca:class title="Class">
230         <ca:value>Widget Only</ca:value>
231       </ca:class>
232       <ca:default title="Default">
233         <ca:description></ca:description>
234       </ca:default>
235       <ca:possvalues type="list" title="Value">
236         <ca:value>true</ca:value>
237         <ca:value>false</ca:value>
238       </ca:possvalues>
239     </ca:attribute>
240     <ca:attribute>
241       <ca:name>NEXTBUTTON</ca:name>
242       <ca:type title="Type">
243         <ca:value>string</ca:value>
244         <ca:description></ca:description>
245       </ca:type>
246       <ca:class title="Class">
247         <ca:value>Widget Only</ca:value>
248       </ca:class>
249       <ca:default title="Default">
250         <ca:description></ca:description>
251       </ca:default>
252     </ca:attribute>
253     <ca:attribute>
254       <ca:name>PREVBUTTON</ca:name>
255       <ca:type title="Type">
256         <ca:value>string</ca:value>
257         <ca:description></ca:description>
258       </ca:type>
259       <ca:class title="Class">
260         <ca:value>Widget Only</ca:value>
261       </ca:class>
262       <ca:default title="Default">
263         <ca:description></ca:description>
264       </ca:default>
265     </ca:attribute>
266     <ca:attribute>
267       <ca:name>NAME</ca:name>
268       <ca:type title="Type">
269         <ca:value>string</ca:value>
270         <ca:description></ca:description>
271       </ca:type>
272       <ca:class title="Class">
273         <ca:value>Widget Only</ca:value>
274       </ca:class>
275       <ca:default title="Default">
276         <ca:description></ca:description>
277       </ca:default>
278     </ca:attribute>
279     <ca:subtag>
280       <ca:name></ca:name>
281       <ca:type title="Type">
282         <ca:value>XML</ca:value>
283         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
284       </ca:type>
285       <ca:class title="Class">
286         <ca:value>Widget &amp; Shared Resource</ca:value>
287       </ca:class>
288       <ca:description></ca:description>
289       <ca:attribute>
290         <ca:name></ca:name>
291         <ca:type title="Type">
292           <ca:value>float</ca:value>
293           <ca:description></ca:description>
294         </ca:type>
295         <ca:class title="Class">
296           <ca:value>Widget &amp; Shared Resource</ca:value>
297         </ca:class>
298         <ca:default title="Default">
299           <ca:value></ca:value>
300           <ca:description></ca:description>
301         </ca:default>
302         <ca:possvalues type="list" title="Value">
303           <ca:value></ca:value>
304         </ca:possvalues>
305         <ca:description></ca:description>
306       </ca:attribute>
307     </ca:subtag>
308   </ca:widgettag>
309   <ca:formelements title="Form Elements">
310     <ca:formelement>
311       <ca:name>SORTBY_</ca:name>
312       <ca:type title="Type">
313         <ca:value>unknown</ca:value>
314         <ca:description></ca:description>
315       </ca:type>
316       <ca:default title="Default">
317         <ca:value></ca:value>
318         <ca:description></ca:description>
319       </ca:default>
320       <ca:possvalues type="list" title="Values">
321         <ca:value></ca:value>
322       </ca:possvalues>
323       <ca:description></ca:description>
324     </ca:formelement>
325     <ca:formelement>
326       <ca:name>START_</ca:name>
327       <ca:type title="Type">
328         <ca:value>unknown</ca:value>
329         <ca:description></ca:description>
330       </ca:type>
331       <ca:default title="Default">
332         <ca:value></ca:value>
333         <ca:description></ca:description>
334       </ca:default>
335       <ca:possvalues type="list" title="Values">
336         <ca:value></ca:value>
337       </ca:possvalues>
338       <ca:description></ca:description>
339     </ca:formelement>
340     <ca:formelement>
341       <ca:name>COUNT_</ca:name>
342       <ca:type title="Type">
343         <ca:value>unknown</ca:value>
344         <ca:description></ca:description>
345       </ca:type>
346       <ca:default title="Default">
347         <ca:value></ca:value>
348         <ca:description></ca:description>
349       </ca:default>
350       <ca:possvalues type="list" title="Values">
351         <ca:value></ca:value>
352       </ca:possvalues>
353       <ca:description></ca:description>
354     </ca:formelement>
355     <ca:formelement>
356       <ca:name>REVERSE_</ca:name>
357       <ca:type title="Type">
358         <ca:value>unknown</ca:value>
359         <ca:description></ca:description>
360       </ca:type>
361       <ca:default title="Default">
362         <ca:value></ca:value>
363         <ca:description></ca:description>
364       </ca:default>
365       <ca:possvalues type="list" title="Values">
366         <ca:value></ca:value>
367       </ca:possvalues>
368       <ca:description></ca:description>
369     </ca:formelement>
370   </ca:formelements>
371   <ca:jsvariables title="JavaScript Variables"/>
372   <ca:jsfunctions title="JavaScript Functions">
373     <ca:jsfunction>
374       <ca:name>SortBy_</ca:name>
375       <ca:scope title="Scope">
376         <ca:value>Private</ca:value>
377       </ca:scope>
378       <ca:description></ca:description>
379       <ca:parameters title="Parameters">
380         <ca:parameter>
381           <ca:name>sCol</ca:name>
382           <ca:type title="Type">
383             <ca:value>string</ca:value>
384           </ca:type>
385           <ca:default title="Default">
386             <ca:value></ca:value>
387             <ca:description></ca:description>
388           </ca:default>
389           <ca:possvalues type="list" title="Values">
390             <ca:value></ca:value>
391           </ca:possvalues>
392           <ca:description></ca:description>
393         </ca:parameter>
394       </ca:parameters>
395       <ca:returnvalues title="Function Return Value">
396         <ca:returnvalue>
397           <ca:type title="Type">
398             <ca:value>unknown</ca:value>
399             <ca:description></ca:description>
400           </ca:type>
401           <ca:default title="Default">
402             <ca:value></ca:value>
403           </ca:default>
404           <ca:possvalues type="list" title="Values">
405             <ca:value></ca:value>
406           </ca:possvalues>
407           <ca:description></ca:description>
408         </ca:returnvalue>
409       </ca:returnvalues>
410       <ca:triggeredjsapievents title="JSAPI Triggered Events">
411         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
412         <ca:triggeredjsapievent title="">
413           <ca:name></ca:name>
414           <ca:description></ca:description>
415         </ca:triggeredjsapievent>
416       </ca:triggeredjsapievents>
417     </ca:jsfunction>
418     <ca:jsfunction>
419       <ca:name>NextPage_</ca:name>
420       <ca:scope title="Scope">
421         <ca:value>Private</ca:value>
422       </ca:scope>
423       <ca:description></ca:description>
424       <ca:parameters title="Parameters">
425         <ca:parameter>
426           <ca:name>sCol</ca:name>
427           <ca:type title="Type">
428             <ca:value>string</ca:value>
429           </ca:type>
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:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
457         <ca:triggeredjsapievent title="">
458           <ca:name></ca:name>
459           <ca:description></ca:description>
460         </ca:triggeredjsapievent>
461       </ca:triggeredjsapievents>
462     </ca:jsfunction>
463     <ca:jsfunction>
464       <ca:name>PrevPage_</ca:name>
465       <ca:scope title="Scope">
466         <ca:value>Private</ca:value>
467       </ca:scope>
468       <ca:description></ca:description>
469       <ca:parameters title="Parameters">
470         <ca:parameter>
471           <ca:name>sCol</ca:name>
472           <ca:type title="Type">
473             <ca:value>string</ca:value>
474           </ca:type>
475           <ca:default title="Default">
476             <ca:value></ca:value>
477             <ca:description></ca:description>
478           </ca:default>
479           <ca:possvalues type="list" title="Values">
480             <ca:value></ca:value>
481           </ca:possvalues>
482           <ca:description></ca:description>
483         </ca:parameter>
484       </ca:parameters>
485       <ca:returnvalues title="Function Return Value">
486         <ca:returnvalue>
487           <ca:type title="Type">
488             <ca:value>unknown</ca:value>
489             <ca:description></ca:description>
490           </ca:type>
491           <ca:default title="Default">
492             <ca:value></ca:value>
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:returnvalue>
499       </ca:returnvalues>
500       <ca:triggeredjsapievents title="JSAPI Triggered Events">
501         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
502         <ca:triggeredjsapievent title="">
503           <ca:name></ca:name>
504           <ca:description></ca:description>
505         </ca:triggeredjsapievent>
506       </ca:triggeredjsapievents>
507     </ca:jsfunction>
508   </ca:jsfunctions>
509   <ca:jsfiles title="JavaScript Files">
510     <ca:jsfile>
511       <ca:name></ca:name>
512       <ca:description></ca:description>
513       <ca:jsvariables title="JavaScript Variables">
514         <ca:jsvariable>
515           <ca:name></ca:name>
516           <ca:type title="Type">
517             <ca:value>string</ca:value>
518           </ca:type>
519           <ca:scope title="Scope">
520             <ca:value>Private</ca:value>
521           </ca:scope>
522           <ca:default title="Default">
523             <ca:value></ca:value>
524           </ca:default>
525           <ca:possvalues type="list" title="Values">
526             <ca:value></ca:value>
527           </ca:possvalues>
528           <ca:description></ca:description>
529         </ca:jsvariable>
530       </ca:jsvariables>
531       <ca:jsfunctions title="JavaScript Functions">
532         <ca:jsfunction>
533           <ca:name></ca:name>
534           <ca:scope title="Scope">
535             <ca:value>Private</ca:value>
536           </ca:scope>
537           <ca:description></ca:description>
538           <ca:parameters title="Parameters">
539             <ca:parameter>
540               <ca:name></ca:name>
541               <ca:type title="Type">
542                 <ca:value>string</ca:value>
543               </ca:type>
544               <ca:required title="Required">
545                 <ca:value>false</ca:value>
546               </ca:required>
547               <ca:default title="Default">
548                 <ca:value></ca:value>
549                 <ca:description></ca:description>
550               </ca:default>
551               <ca:possvalues type="list" title="Values">
552                 <ca:value></ca:value>
553               </ca:possvalues>
554               <ca:description></ca:description>
555             </ca:parameter>
556           </ca:parameters>
557           <ca:returnvalues title="Function Return Value">
558             <ca:returnvalue>
559               <ca:type title="Type">
560                 <ca:value>unknown</ca:value>
561                 <ca:description></ca:description>
562               </ca:type>
563               <ca:default title="Default">
564                 <ca:value></ca:value>
565               </ca:default>
566               <ca:possvalues type="list" title="Values">
567                 <ca:value></ca:value>
568               </ca:possvalues>
569               <ca:description></ca:description>
570             </ca:returnvalue>
571           </ca:returnvalues>
572           <ca:triggeredjsapievents title="JSAPI Triggered Events">
573             <ca:triggeredjsapievent title="">
574               <ca:name></ca:name>
575               <ca:description></ca:description>
576             </ca:triggeredjsapievent>
577           </ca:triggeredjsapievents>
578         </ca:jsfunction>
579       </ca:jsfunctions>
580     </ca:jsfile>
581   </ca:jsfiles>
582   <ca:listenedjsapievents title="JSAPI Listened Events">
583     <ca:listenedjsapievent title="">
584       <ca:name></ca:name>
585       <ca:description></ca:description>
586       <ca:calledfunctions title="Functions Calls">
587         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
588         <ca:calledfunction>
589           <ca:name></ca:name>
590           <ca:description></ca:description>
591         </ca:calledfunction>
592       </ca:calledfunctions>
593     </ca:listenedjsapievent>
594   </ca:listenedjsapievents>
595   <ca:widgetevents title="Widget Events">
596     <ca:widgetevent>
597       <ca:name></ca:name>
598       <ca:parameters title="Parameters">
599         <ca:parameter>
600           <ca:name></ca:name>
601           <ca:type title="Type">
602             <ca:value>string</ca:value>
603           </ca:type>
604           <ca:required title="Required">
605             <ca:value>false</ca:value>
606           </ca:required>
607           <ca:default title="Default">
608             <ca:value></ca:value>
609             <ca:description></ca:description>
610           </ca:default>
611           <ca:possvalues type="list" title="Values">
612             <ca:value></ca:value>
613           </ca:possvalues>
614           <ca:description></ca:description>
615         </ca:parameter>
616       </ca:parameters>
617       <ca:description></ca:description>
618     </ca:widgetevent>
619   </ca:widgetevents>
620   <ca:errors title="Widget Errors">
621     <ca:error title="Error #1">
622       <ca:type title="Type">
623         <ca:value>PHP Mapscript</ca:value>
624       </ca:type>
625       <ca:severity title="Severity">
626         <ca:value>none</ca:value>
627         <ca:description></ca:description>
628       </ca:severity>
629       <ca:message title="Error Message">
630         <ca:paras title="">
631           <ca:para>Error message string....</ca:para>
632         </ca:paras>
633       </ca:message>
634       <ca:meaning title="Interpretation">
635         <ca:paras title="">
636           <ca:para>The description of what the message means......</ca:para>
637         </ca:paras>
638       </ca:meaning>
639       <ca:solution title="Troubleshooting Tips">
640         <ca:paras title="">
641           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
642         </ca:paras>
643       </ca:solution>
644     </ca:error>
645   </ca:errors>
646 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.