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

root/Chameleon/trunk/Chameleon/TrueNorth/TrueNorth.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>truenorth</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 TrueNorth widget just display a bitmap rotated indicating the real north.</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>   TRUENORTHIMAGE ="[string]"</ca:line>
102         </ca:codeblock>
103       </ca:code>
104     </ca:tagstructure>
105   </ca:tagstructures>
106   <ca:examples title="Examples">
107     <ca:widgetexamples title="Widget Examples">
108       <ca:example title="Example #1: Simple">
109         <ca:description></ca:description>
110         <ca:code title="">
111           <ca:description></ca:description>
112           <ca:codeblock bold="false">
113             <ca:line></ca:line>
114           </ca:codeblock>
115         </ca:code>
116       </ca:example>
117     </ca:widgetexamples>
118     <ca:sharedresourceexamples title="Shared Resources Examples">
119       <ca:example title="Example #1: Advanced">
120         <ca:description></ca:description>
121         <ca:code title="">
122           <ca:description></ca:description>
123           <ca:codeblock bold="false">
124             <ca:line></ca:line>
125           </ca:codeblock>
126         </ca:code>
127       </ca:example>
128     </ca:sharedresourceexamples>
129     <ca:sampleapps title="Sample Applications">
130       <ca:sampleapp>
131         <ca:name>Hawaii Demo</ca:name>
132         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
133         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
134       </ca:sampleapp>
135     </ca:sampleapps>
136     <ca:scriptexamples title="Script Examples">
137       <ca:example title="Example #1: Simple">
138         <ca:description></ca:description>
139         <ca:code title="">
140           <ca:description></ca:description>
141           <ca:codeblock bold="false">
142             <ca:line></ca:line>
143           </ca:codeblock>
144         </ca:code>
145       </ca:example>
146     </ca:scriptexamples>
147   </ca:examples>
148   <ca:attributegroups title="Attribute Groups">
149     <ca:description></ca:description>
150     <ca:attributegroup>
151       <ca:name>base</ca:name>
152     </ca:attributegroup>
153   </ca:attributegroups>
154   <ca:widgettag title="Attributes">
155     <ca:attribute>
156       <ca:name>TRUENORTHIMAGE</ca:name>
157       <ca:type title="Type">
158         <ca:value>string</ca:value>
159         <ca:description></ca:description>
160       </ca:type>
161       <ca:class title="Class">
162         <ca:value>Required</ca:value>
163       </ca:class>
164       <ca:default title="Default">
165         <ca:description></ca:description>
166       </ca:default>
167     </ca:attribute>
168     <ca:subtag>
169       <ca:name></ca:name>
170       <ca:type title="Type">
171         <ca:value>XML</ca:value>
172         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
173       </ca:type>
174       <ca:class title="Class">
175         <ca:value>Widget &amp; Shared Resource</ca:value>
176       </ca:class>
177       <ca:description></ca:description>
178       <ca:attribute>
179         <ca:name></ca:name>
180         <ca:type title="Type">
181           <ca:value>float</ca:value>
182           <ca:description></ca:description>
183         </ca:type>
184         <ca:class title="Class">
185           <ca:value>Widget &amp; Shared Resource</ca:value>
186         </ca:class>
187         <ca:default title="Default">
188           <ca:value></ca:value>
189           <ca:description></ca:description>
190         </ca:default>
191         <ca:possvalues type="list" title="Value">
192           <ca:value></ca:value>
193         </ca:possvalues>
194         <ca:description></ca:description>
195       </ca:attribute>
196     </ca:subtag>
197   </ca:widgettag>
198   <ca:formelements title="Form Elements">
199     <ca:formelement>
200       <ca:name>sid</ca:name>
201       <ca:type title="Type">
202         <ca:value>unknown</ca:value>
203         <ca:description></ca:description>
204       </ca:type>
205       <ca:default title="Default">
206         <ca:value></ca:value>
207         <ca:description></ca:description>
208       </ca:default>
209       <ca:possvalues type="list" title="Values">
210         <ca:value></ca:value>
211       </ca:possvalues>
212       <ca:description></ca:description>
213     </ca:formelement>
214   </ca:formelements>
215   <ca:jsvariables title="JavaScript Variables"/>
216   <ca:jsfunctions title="JavaScript Functions"/>
217   <ca:jsfiles title="JavaScript Files">
218     <ca:jsfile>
219       <ca:name></ca:name>
220       <ca:description></ca:description>
221       <ca:jsvariables title="JavaScript Variables">
222         <ca:jsvariable>
223           <ca:name></ca:name>
224           <ca:type title="Type">
225             <ca:value>string</ca:value>
226           </ca:type>
227           <ca:scope title="Scope">
228             <ca:value>Private</ca:value>
229           </ca:scope>
230           <ca:default title="Default">
231             <ca:value></ca:value>
232           </ca:default>
233           <ca:possvalues type="list" title="Values">
234             <ca:value></ca:value>
235           </ca:possvalues>
236           <ca:description></ca:description>
237         </ca:jsvariable>
238       </ca:jsvariables>
239       <ca:jsfunctions title="JavaScript Functions">
240         <ca:jsfunction>
241           <ca:name></ca:name>
242           <ca:scope title="Scope">
243             <ca:value>Private</ca:value>
244           </ca:scope>
245           <ca:description></ca:description>
246           <ca:parameters title="Parameters">
247             <ca:parameter>
248               <ca:name></ca:name>
249               <ca:type title="Type">
250                 <ca:value>string</ca:value>
251               </ca:type>
252               <ca:required title="Required">
253                 <ca:value>false</ca:value>
254               </ca:required>
255               <ca:default title="Default">
256                 <ca:value></ca:value>
257                 <ca:description></ca:description>
258               </ca:default>
259               <ca:possvalues type="list" title="Values">
260                 <ca:value></ca:value>
261               </ca:possvalues>
262               <ca:description></ca:description>
263             </ca:parameter>
264           </ca:parameters>
265           <ca:returnvalues title="Function Return Value">
266             <ca:returnvalue>
267               <ca:type title="Type">
268                 <ca:value>unknown</ca:value>
269                 <ca:description></ca:description>
270               </ca:type>
271               <ca:default title="Default">
272                 <ca:value></ca:value>
273               </ca:default>
274               <ca:possvalues type="list" title="Values">
275                 <ca:value></ca:value>
276               </ca:possvalues>
277               <ca:description></ca:description>
278             </ca:returnvalue>
279           </ca:returnvalues>
280           <ca:triggeredjsapievents title="JSAPI Triggered Events">
281             <ca:triggeredjsapievent title="">
282               <ca:name></ca:name>
283               <ca:description></ca:description>
284             </ca:triggeredjsapievent>
285           </ca:triggeredjsapievents>
286         </ca:jsfunction>
287       </ca:jsfunctions>
288     </ca:jsfile>
289   </ca:jsfiles>
290   <ca:listenedjsapievents title="JSAPI Listened Events">
291     <ca:listenedjsapievent title="">
292       <ca:name></ca:name>
293       <ca:description></ca:description>
294       <ca:calledfunctions title="Functions Calls">
295         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
296         <ca:calledfunction>
297           <ca:name></ca:name>
298           <ca:description></ca:description>
299         </ca:calledfunction>
300       </ca:calledfunctions>
301     </ca:listenedjsapievent>
302   </ca:listenedjsapievents>
303   <ca:widgetevents title="Widget Events">
304     <ca:widgetevent>
305       <ca:name></ca:name>
306       <ca:parameters title="Parameters">
307         <ca:parameter>
308           <ca:name></ca:name>
309           <ca:type title="Type">
310             <ca:value>string</ca:value>
311           </ca:type>
312           <ca:required title="Required">
313             <ca:value>false</ca:value>
314           </ca:required>
315           <ca:default title="Default">
316             <ca:value></ca:value>
317             <ca:description></ca:description>
318           </ca:default>
319           <ca:possvalues type="list" title="Values">
320             <ca:value></ca:value>
321           </ca:possvalues>
322           <ca:description></ca:description>
323         </ca:parameter>
324       </ca:parameters>
325       <ca:description></ca:description>
326     </ca:widgetevent>
327   </ca:widgetevents>
328   <ca:errors title="Widget Errors">
329     <ca:error title="Error #1">
330       <ca:type title="Type">
331         <ca:value>PHP Mapscript</ca:value>
332       </ca:type>
333       <ca:severity title="Severity">
334         <ca:value>none</ca:value>
335         <ca:description></ca:description>
336       </ca:severity>
337       <ca:message title="Error Message">
338         <ca:paras title="">
339           <ca:para>Error message string....</ca:para>
340         </ca:paras>
341       </ca:message>
342       <ca:meaning title="Interpretation">
343         <ca:paras title="">
344           <ca:para>The description of what the message means......</ca:para>
345         </ca:paras>
346       </ca:meaning>
347       <ca:solution title="Troubleshooting Tips">
348         <ca:paras title="">
349           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
350         </ca:paras>
351       </ca:solution>
352     </ca:error>
353   </ca:errors>
354 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.