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

root/Chameleon/trunk/Chameleon/LayerAttributes/LayerAttributes.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>layerattributes</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>ALPHA</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 LayerAttributes widget gets the contents of a mapfile layer and adds an array to
62 a SharedResource widget in a format suitable for feeding a JSList widget.
63 The layer to process must be passed in the url as nlayerindex.</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>   SHAREDRESOURCENAME ="[string]"</ca:line>
104           <ca:line>   LAYERNAME ="[string]"</ca:line>
105           <ca:line>   ITEM ="[string]"</ca:line>
106           <ca:line>   ONCHANGE ="[string]"</ca:line>
107           <ca:line>   VISIBILITY ="[boolean]"</ca:line>
108         </ca:codeblock>
109       </ca:code>
110     </ca:tagstructure>
111   </ca:tagstructures>
112   <ca:examples title="Examples">
113     <ca:widgetexamples title="Widget Examples">
114       <ca:example title="Example #1: Simple">
115         <ca:description></ca:description>
116         <ca:code title="">
117           <ca:description></ca:description>
118           <ca:codeblock bold="false">
119             <ca:line></ca:line>
120           </ca:codeblock>
121         </ca:code>
122       </ca:example>
123     </ca:widgetexamples>
124     <ca:sharedresourceexamples title="Shared Resources Examples">
125       <ca:example title="Example #1: Advanced">
126         <ca:description></ca:description>
127         <ca:code title="">
128           <ca:description></ca:description>
129           <ca:codeblock bold="false">
130             <ca:line></ca:line>
131           </ca:codeblock>
132         </ca:code>
133       </ca:example>
134     </ca:sharedresourceexamples>
135     <ca:sampleapps title="Sample Applications">
136       <ca:sampleapp>
137         <ca:name>Hawaii Demo</ca:name>
138         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
139         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
140       </ca:sampleapp>
141     </ca:sampleapps>
142     <ca:scriptexamples title="Script Examples">
143       <ca:example title="Example #1: Simple">
144         <ca:description></ca:description>
145         <ca:code title="">
146           <ca:description></ca:description>
147           <ca:codeblock bold="false">
148             <ca:line></ca:line>
149           </ca:codeblock>
150         </ca:code>
151       </ca:example>
152     </ca:scriptexamples>
153   </ca:examples>
154   <ca:attributegroups title="Attribute Groups">
155     <ca:description></ca:description>
156     <ca:attributegroup>
157       <ca:name>base</ca:name>
158     </ca:attributegroup>
159   </ca:attributegroups>
160   <ca:widgettag title="Attributes">
161     <ca:attribute>
162       <ca:name>SHAREDRESOURCENAME</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>LAYERNAME</ca:name>
176       <ca:type title="Type">
177         <ca:value>string</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:attribute>
187     <ca:attribute>
188       <ca:name>ITEM</ca:name>
189       <ca:type title="Type">
190         <ca:value>string</ca:value>
191         <ca:description></ca:description>
192       </ca:type>
193       <ca:class title="Class">
194         <ca:value>Required</ca:value>
195       </ca:class>
196       <ca:default title="Default">
197         <ca:description></ca:description>
198       </ca:default>
199       <ca:possvalues type="list" title="Value">
200         <ca:value>CLASSITEM</ca:value>
201         <ca:value>LABELITEM</ca:value>
202         <ca:value>TILEITEM</ca:value>
203         <ca:value>FILTERITEM</ca:value>
204         <ca:value>STYLEITEM</ca:value>
205       </ca:possvalues>
206     </ca:attribute>
207     <ca:attribute>
208       <ca:name>ONCHANGE</ca:name>
209       <ca:type title="Type">
210         <ca:value>string</ca:value>
211         <ca:description></ca:description>
212       </ca:type>
213       <ca:class title="Class">
214         <ca:value>Widget Only</ca:value>
215       </ca:class>
216       <ca:default title="Default">
217         <ca:description></ca:description>
218       </ca:default>
219     </ca:attribute>
220     <ca:attribute>
221       <ca:name>VISIBILITY</ca:name>
222       <ca:type title="Type">
223         <ca:value>boolean</ca:value>
224         <ca:description></ca:description>
225       </ca:type>
226       <ca:class title="Class">
227         <ca:value>Widget Only</ca:value>
228       </ca:class>
229       <ca:default title="Default">
230         <ca:description></ca:description>
231       </ca:default>
232       <ca:possvalues type="list" title="Value">
233         <ca:value>true</ca:value>
234         <ca:value>false</ca:value>
235       </ca:possvalues>
236     </ca:attribute>
237     <ca:subtag>
238       <ca:name></ca:name>
239       <ca:type title="Type">
240         <ca:value>XML</ca:value>
241         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
242       </ca:type>
243       <ca:class title="Class">
244         <ca:value>Widget &amp; Shared Resource</ca:value>
245       </ca:class>
246       <ca:description></ca:description>
247       <ca:attribute>
248         <ca:name></ca:name>
249         <ca:type title="Type">
250           <ca:value>float</ca:value>
251           <ca:description></ca:description>
252         </ca:type>
253         <ca:class title="Class">
254           <ca:value>Widget &amp; Shared Resource</ca:value>
255         </ca:class>
256         <ca:default title="Default">
257           <ca:value></ca:value>
258           <ca:description></ca:description>
259         </ca:default>
260         <ca:possvalues type="list" title="Value">
261           <ca:value></ca:value>
262         </ca:possvalues>
263         <ca:description></ca:description>
264       </ca:attribute>
265     </ca:subtag>
266   </ca:widgettag>
267   <ca:formelements title="Form Elements"/>
268   <ca:jsvariables title="JavaScript Variables"/>
269   <ca:jsfunctions title="JavaScript Functions"/>
270   <ca:jsfiles title="JavaScript Files">
271     <ca:jsfile>
272       <ca:name></ca:name>
273       <ca:description></ca:description>
274       <ca:jsvariables title="JavaScript Variables">
275         <ca:jsvariable>
276           <ca:name></ca:name>
277           <ca:type title="Type">
278             <ca:value>string</ca:value>
279           </ca:type>
280           <ca:scope title="Scope">
281             <ca:value>Private</ca:value>
282           </ca:scope>
283           <ca:default title="Default">
284             <ca:value></ca:value>
285           </ca:default>
286           <ca:possvalues type="list" title="Values">
287             <ca:value></ca:value>
288           </ca:possvalues>
289           <ca:description></ca:description>
290         </ca:jsvariable>
291       </ca:jsvariables>
292       <ca:jsfunctions title="JavaScript Functions">
293         <ca:jsfunction>
294           <ca:name></ca:name>
295           <ca:scope title="Scope">
296             <ca:value>Private</ca:value>
297           </ca:scope>
298           <ca:description></ca:description>
299           <ca:parameters title="Parameters">
300             <ca:parameter>
301               <ca:name></ca:name>
302               <ca:type title="Type">
303                 <ca:value>string</ca:value>
304               </ca:type>
305               <ca:required title="Required">
306                 <ca:value>false</ca:value>
307               </ca:required>
308               <ca:default title="Default">
309                 <ca:value></ca:value>
310                 <ca:description></ca:description>
311               </ca:default>
312               <ca:possvalues type="list" title="Values">
313                 <ca:value></ca:value>
314               </ca:possvalues>
315               <ca:description></ca:description>
316             </ca:parameter>
317           </ca:parameters>
318           <ca:returnvalues title="Function Return Value">
319             <ca:returnvalue>
320               <ca:type title="Type">
321                 <ca:value>unknown</ca:value>
322                 <ca:description></ca:description>
323               </ca:type>
324               <ca:default title="Default">
325                 <ca:value></ca:value>
326               </ca:default>
327               <ca:possvalues type="list" title="Values">
328                 <ca:value></ca:value>
329               </ca:possvalues>
330               <ca:description></ca:description>
331             </ca:returnvalue>
332           </ca:returnvalues>
333           <ca:triggeredjsapievents title="JSAPI Triggered Events">
334             <ca:triggeredjsapievent title="">
335               <ca:name></ca:name>
336               <ca:description></ca:description>
337             </ca:triggeredjsapievent>
338           </ca:triggeredjsapievents>
339         </ca:jsfunction>
340       </ca:jsfunctions>
341     </ca:jsfile>
342   </ca:jsfiles>
343   <ca:listenedjsapievents title="JSAPI Listened Events">
344     <ca:listenedjsapievent title="">
345       <ca:name></ca:name>
346       <ca:description></ca:description>
347       <ca:calledfunctions title="Functions Calls">
348         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
349         <ca:calledfunction>
350           <ca:name></ca:name>
351           <ca:description></ca:description>
352         </ca:calledfunction>
353       </ca:calledfunctions>
354     </ca:listenedjsapievent>
355   </ca:listenedjsapievents>
356   <ca:widgetevents title="Widget Events">
357     <ca:widgetevent>
358       <ca:name></ca:name>
359       <ca:parameters title="Parameters">
360         <ca:parameter>
361           <ca:name></ca:name>
362           <ca:type title="Type">
363             <ca:value>string</ca:value>
364           </ca:type>
365           <ca:required title="Required">
366             <ca:value>false</ca:value>
367           </ca:required>
368           <ca:default title="Default">
369             <ca:value></ca:value>
370             <ca:description></ca:description>
371           </ca:default>
372           <ca:possvalues type="list" title="Values">
373             <ca:value></ca:value>
374           </ca:possvalues>
375           <ca:description></ca:description>
376         </ca:parameter>
377       </ca:parameters>
378       <ca:description></ca:description>
379     </ca:widgetevent>
380   </ca:widgetevents>
381   <ca:errors title="Widget Errors">
382     <ca:error title="Error #1">
383       <ca:type title="Type">
384         <ca:value>PHP Mapscript</ca:value>
385       </ca:type>
386       <ca:severity title="Severity">
387         <ca:value>none</ca:value>
388         <ca:description></ca:description>
389       </ca:severity>
390       <ca:message title="Error Message">
391         <ca:paras title="">
392           <ca:para>Error message string....</ca:para>
393         </ca:paras>
394       </ca:message>
395       <ca:meaning title="Interpretation">
396         <ca:paras title="">
397           <ca:para>The description of what the message means......</ca:para>
398         </ca:paras>
399       </ca:meaning>
400       <ca:solution title="Troubleshooting Tips">
401         <ca:paras title="">
402           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
403         </ca:paras>
404       </ca:solution>
405     </ca:error>
406   </ca:errors>
407 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.