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

root/Chameleon/trunk/Chameleon/VarSharedResource/VarSharedResource.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>varsharedresource</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>VarSharedResourceWidget is a simple widget that simply return the value from a SharedResource variable.</ca:para>
62       </ca:paras>
63     </ca:description>
64     <ca:techrequirements title="Technical Requirements">
65       <ca:paras title="Not Available">
66         <ca:para></ca:para>
67       </ca:paras>
68     </ca:techrequirements>
69     <ca:dependancies title="Dependancies">
70       <ca:dependancy type="None" title="Not Available">
71         <ca:para></ca:para>
72       </ca:dependancy>
73     </ca:dependancies>
74     <ca:sharedresources title="Shared Resources">
75       <ca:paras title="Not Available">
76         <ca:para></ca:para>
77       </ca:paras>
78     </ca:sharedresources>
79     <ca:embeddedhelp title="General User Interface Help">
80       <ca:paras title="">
81         <ca:para></ca:para>
82       </ca:paras>
83     </ca:embeddedhelp>
84     <ca:guinotes title="Interface Functionality">
85       <ca:guinote type="None" title="None.">
86         <ca:para></ca:para>
87       </ca:guinote>
88     </ca:guinotes>
89     <ca:qanotes title="Quality Assurance">
90       <ca:paras title="None.">
91         <ca:para></ca:para>
92       </ca:paras>
93     </ca:qanotes>
94   </ca:descriptions>
95   <ca:tagstructures title="Tag Syntax">
96     <ca:tagstructure title="Widget Syntax">
97       <ca:description></ca:description>
98       <ca:code title="">
99         <ca:description></ca:description>
100         <ca:codeblock bold="false">
101           <ca:line>   SRVAR ="[string]"</ca:line>
102           <ca:line>   PREFIX ="[string]"</ca:line>
103           <ca:line>   SUFIX ="[string]"</ca:line>
104         </ca:codeblock>
105       </ca:code>
106     </ca:tagstructure>
107   </ca:tagstructures>
108   <ca:examples title="Examples">
109     <ca:widgetexamples title="Widget Examples">
110       <ca:example title="Example #1: Simple">
111         <ca:description></ca:description>
112         <ca:code title="">
113           <ca:description></ca:description>
114           <ca:codeblock bold="false">
115             <ca:line></ca:line>
116           </ca:codeblock>
117         </ca:code>
118       </ca:example>
119     </ca:widgetexamples>
120     <ca:sharedresourceexamples title="Shared Resources Examples">
121       <ca:example title="Example #1: Advanced">
122         <ca:description></ca:description>
123         <ca:code title="">
124           <ca:description></ca:description>
125           <ca:codeblock bold="false">
126             <ca:line></ca:line>
127           </ca:codeblock>
128         </ca:code>
129       </ca:example>
130     </ca:sharedresourceexamples>
131     <ca:sampleapps title="Sample Applications">
132       <ca:sampleapp>
133         <ca:name>Hawaii Demo</ca:name>
134         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
135         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
136       </ca:sampleapp>
137     </ca:sampleapps>
138     <ca:scriptexamples title="Script Examples">
139       <ca:example title="Example #1: Simple">
140         <ca:description></ca:description>
141         <ca:code title="">
142           <ca:description></ca:description>
143           <ca:codeblock bold="false">
144             <ca:line></ca:line>
145           </ca:codeblock>
146         </ca:code>
147       </ca:example>
148     </ca:scriptexamples>
149   </ca:examples>
150   <ca:attributegroups title="Attribute Groups">
151     <ca:description></ca:description>
152     <ca:attributegroup>
153       <ca:name>base</ca:name>
154     </ca:attributegroup>
155   </ca:attributegroups>
156   <ca:widgettag title="Attributes">
157     <ca:attribute>
158       <ca:name>SRVAR</ca:name>
159       <ca:type title="Type">
160         <ca:value>string</ca:value>
161         <ca:description></ca:description>
162       </ca:type>
163       <ca:class title="Class">
164         <ca:value>Required</ca:value>
165       </ca:class>
166       <ca:default title="Default">
167         <ca:description></ca:description>
168       </ca:default>
169     </ca:attribute>
170     <ca:attribute>
171       <ca:name>PREFIX</ca:name>
172       <ca:type title="Type">
173         <ca:value>string</ca:value>
174         <ca:description></ca:description>
175       </ca:type>
176       <ca:class title="Class">
177         <ca:value>Widget Only</ca:value>
178       </ca:class>
179       <ca:default title="Default">
180         <ca:description></ca:description>
181       </ca:default>
182     </ca:attribute>
183     <ca:attribute>
184       <ca:name>SUFIX</ca:name>
185       <ca:type title="Type">
186         <ca:value>string</ca:value>
187         <ca:description></ca:description>
188       </ca:type>
189       <ca:class title="Class">
190         <ca:value>Widget Only</ca:value>
191       </ca:class>
192       <ca:default title="Default">
193         <ca:description></ca:description>
194       </ca:default>
195     </ca:attribute>
196     <ca:subtag>
197       <ca:name></ca:name>
198       <ca:type title="Type">
199         <ca:value>XML</ca:value>
200         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
201       </ca:type>
202       <ca:class title="Class">
203         <ca:value>Widget &amp; Shared Resource</ca:value>
204       </ca:class>
205       <ca:description></ca:description>
206       <ca:attribute>
207         <ca:name></ca:name>
208         <ca:type title="Type">
209           <ca:value>float</ca:value>
210           <ca:description></ca:description>
211         </ca:type>
212         <ca:class title="Class">
213           <ca:value>Widget &amp; Shared Resource</ca:value>
214         </ca:class>
215         <ca:default title="Default">
216           <ca:value></ca:value>
217           <ca:description></ca:description>
218         </ca:default>
219         <ca:possvalues type="list" title="Value">
220           <ca:value></ca:value>
221         </ca:possvalues>
222         <ca:description></ca:description>
223       </ca:attribute>
224     </ca:subtag>
225   </ca:widgettag>
226   <ca:formelements title="Form Elements">
227     <ca:formelement>
228       <ca:name>sid</ca:name>
229       <ca:type title="Type">
230         <ca:value>unknown</ca:value>
231         <ca:description></ca:description>
232       </ca:type>
233       <ca:default title="Default">
234         <ca:value></ca:value>
235         <ca:description></ca:description>
236       </ca:default>
237       <ca:possvalues type="list" title="Values">
238         <ca:value></ca:value>
239       </ca:possvalues>
240       <ca:description></ca:description>
241     </ca:formelement>
242   </ca:formelements>
243   <ca:jsvariables title="JavaScript Variables"/>
244   <ca:jsfunctions title="JavaScript Functions"/>
245   <ca:jsfiles title="JavaScript Files">
246     <ca:jsfile>
247       <ca:name></ca:name>
248       <ca:description></ca:description>
249       <ca:jsvariables title="JavaScript Variables">
250         <ca:jsvariable>
251           <ca:name></ca:name>
252           <ca:type title="Type">
253             <ca:value>string</ca:value>
254           </ca:type>
255           <ca:scope title="Scope">
256             <ca:value>Private</ca:value>
257           </ca:scope>
258           <ca:default title="Default">
259             <ca:value></ca:value>
260           </ca:default>
261           <ca:possvalues type="list" title="Values">
262             <ca:value></ca:value>
263           </ca:possvalues>
264           <ca:description></ca:description>
265         </ca:jsvariable>
266       </ca:jsvariables>
267       <ca:jsfunctions title="JavaScript Functions">
268         <ca:jsfunction>
269           <ca:name></ca:name>
270           <ca:scope title="Scope">
271             <ca:value>Private</ca:value>
272           </ca:scope>
273           <ca:description></ca:description>
274           <ca:parameters title="Parameters">
275             <ca:parameter>
276               <ca:name></ca:name>
277               <ca:type title="Type">
278                 <ca:value>string</ca:value>
279               </ca:type>
280               <ca:required title="Required">
281                 <ca:value>false</ca:value>
282               </ca:required>
283               <ca:default title="Default">
284                 <ca:value></ca:value>
285                 <ca:description></ca:description>
286               </ca:default>
287               <ca:possvalues type="list" title="Values">
288                 <ca:value></ca:value>
289               </ca:possvalues>
290               <ca:description></ca:description>
291             </ca:parameter>
292           </ca:parameters>
293           <ca:returnvalues title="Function Return Value">
294             <ca:returnvalue>
295               <ca:type title="Type">
296                 <ca:value>unknown</ca:value>
297                 <ca:description></ca:description>
298               </ca:type>
299               <ca:default title="Default">
300                 <ca:value></ca:value>
301               </ca:default>
302               <ca:possvalues type="list" title="Values">
303                 <ca:value></ca:value>
304               </ca:possvalues>
305               <ca:description></ca:description>
306             </ca:returnvalue>
307           </ca:returnvalues>
308           <ca:triggeredjsapievents title="JSAPI Triggered Events">
309             <ca:triggeredjsapievent title="">
310               <ca:name></ca:name>
311               <ca:description></ca:description>
312             </ca:triggeredjsapievent>
313           </ca:triggeredjsapievents>
314         </ca:jsfunction>
315       </ca:jsfunctions>
316     </ca:jsfile>
317   </ca:jsfiles>
318   <ca:listenedjsapievents title="JSAPI Listened Events">
319     <ca:listenedjsapievent title="">
320       <ca:name></ca:name>
321       <ca:description></ca:description>
322       <ca:calledfunctions title="Functions Calls">
323         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
324         <ca:calledfunction>
325           <ca:name></ca:name>
326           <ca:description></ca:description>
327         </ca:calledfunction>
328       </ca:calledfunctions>
329     </ca:listenedjsapievent>
330   </ca:listenedjsapievents>
331   <ca:widgetevents title="Widget Events">
332     <ca:widgetevent>
333       <ca:name></ca:name>
334       <ca:parameters title="Parameters">
335         <ca:parameter>
336           <ca:name></ca:name>
337           <ca:type title="Type">
338             <ca:value>string</ca:value>
339           </ca:type>
340           <ca:required title="Required">
341             <ca:value>false</ca:value>
342           </ca:required>
343           <ca:default title="Default">
344             <ca:value></ca:value>
345             <ca:description></ca:description>
346           </ca:default>
347           <ca:possvalues type="list" title="Values">
348             <ca:value></ca:value>
349           </ca:possvalues>
350           <ca:description></ca:description>
351         </ca:parameter>
352       </ca:parameters>
353       <ca:description></ca:description>
354     </ca:widgetevent>
355   </ca:widgetevents>
356   <ca:errors title="Widget Errors">
357     <ca:error title="Error #1">
358       <ca:type title="Type">
359         <ca:value>PHP Mapscript</ca:value>
360       </ca:type>
361       <ca:severity title="Severity">
362         <ca:value>none</ca:value>
363         <ca:description></ca:description>
364       </ca:severity>
365       <ca:message title="Error Message">
366         <ca:paras title="">
367           <ca:para>Error message string....</ca:para>
368         </ca:paras>
369       </ca:message>
370       <ca:meaning title="Interpretation">
371         <ca:paras title="">
372           <ca:para>The description of what the message means......</ca:para>
373         </ca:paras>
374       </ca:meaning>
375       <ca:solution title="Troubleshooting Tips">
376         <ca:paras title="">
377           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
378         </ca:paras>
379       </ca:solution>
380     </ca:error>
381   </ca:errors>
382 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.