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

root/Chameleon/trunk/Chameleon/ProjectionSelector/ProjectionSelector.en-ca.doc.xml

Revision 13 (checked in by jcleary, 17 years ago)

Latest Chameleon code checkout from previous repository

Line 
1 <!-- This info is actually for the ProjectionSeletor Widget
2
3     <ca:tagstructure title="Shared Resource Syntax">
4       <ca:description/>
5       <ca:code>
6         <ca:codeblock bold="true">
7           <ca:line>&lt;CWC2 TYPE="SharedResource"</ca:line>
8         </ca:codeblock>
9         <ca:codeblock bold="false">
10           <ca:line>   ENABLED="[TRUE|FALSE]"</ca:line>
11           <ca:line>   FORMINDEX="[0 &lt; integer]"</ca:line>
12           <ca:line>   VISIBLE="[TRUE|FALSE]"</ca:line>
13           <ca:line/>
14           <ca:line>   &lt;!-- Shared Resource Attributes --&gt;</ca:line>
15           <ca:line/>
16         </ca:codeblock>
17         <ca:codeblock bold="true">
18           <ca:line>   NAME="Projection"</ca:line>
19         </ca:codeblock>
20         <ca:codeblock bold="false">
21           <ca:line>   ENABLEJS="[TRUE|FALSE]"&gt;</ca:line>
22           <ca:line/>
23           <ca:line>   &lt;!-- Projection Shared Resource SubTag --&gt;</ca:line>
24           <ca:line/>       
25           <ca:line>   &lt;PROJECTION NAME="[string]"</ca:line>
26           <ca:line>      SRS="[EPSG:Code]"</ca:line>
27           <ca:line>      DEFAULT="[TRUE|FALSE]"/&gt;</ca:line>
28         </ca:codeblock>
29         <ca:codeblock bold="true">
30           <ca:line>&lt;/CWC2&gt;</ca:line>
31         </ca:codeblock>
32       </ca:tagstructure> 
33 -->
34
35
36 <!-- This info is actually for the ProjectionSeletor Widget   
37     <ca:sharedresourceexamples>
38       <ca:example title="Example #2: Advance">
39         <ca:description>The is an example of projection <ca:description>
40         <ca:code>
41           <ca:codeblock bold="false">
42             <cwc2 type="SharedResource" name="projection">
43                 <projection name="NAD 83 / Geographic" srs="epsg:4269"/>
44                 <projection name="WGS 84 / Geographic" srs="epsg:4326"/>
45                 <projection name="WGS 84 / Auto UTM" srs="AUTO:42001"/>
46                 <projection name="WGS 84 / Auto Tr. Mercator" srs="AUTO:42002"/>
47                 <projection name="WGS 84 / Auto Orthographic" srs="AUTO:42003"/>
48                 <projection name="WGS 84 / Auto Equirectangular" srs="AUTO:42004"/>
49                 <projection name="WGS 84 / LCC Canada" srs="epsg:42101"/>
50                 <projection name="NAD 83 / NRCan LCC Canada" srs="epsg:42304" default="true"/>
51             </cwc2>   
52           </ca:codeblock>
53         </ca:code>
54       </ca:example>
55     </ca:sharedresourceexamples>
56 --> 
57
58
59 <?xml version="1.0" ?>
60 <cham:widgetdoc chameleonreleaseversion="1.99" xmlns:cham="http://www.maptools.org/chameleon/docs_xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.maptools.org/chameleon/docs_xsd http://www.maptools.org/chameleon/docs_xsd/chameleon_widget_doc.xsd">
61   <cham:identification>
62     <cham:name>ProjectionSelector</cham:name>
63     <cham:widgetpack></cham:widgetpack>
64     <cham:parentclass></cham:parentclass>
65     <cham:widgetversion>1.99</cham:widgetversion>
66     <cham:widgetreleasedate></cham:widgetreleasedate>
67     <cham:developer>
68       <cham:name>Paul Spencer</cham:name>
69       <cham:company>www.dmsolutions.ca</cham:company>
70       <cham:contact>chameleon@lists.maptools.org</cham:contact>
71     </cham:developer>
72   </cham:identification>
73   <cham:docinfo>
74     <cham:language>en-ca</cham:language>
75     <cham:reviewed>false</cham:reviewed>
76     <cham:docversion>0.1</cham:docversion>
77     <cham:author>
78       <cham:name></cham:name>
79       <cham:company></cham:company>
80       <cham:contact></cham:contact>
81     </cham:author>
82     <cham:editors>
83       <cham:editor>
84         <cham:name>Christopher R. Thorne</cham:name>
85         <cham:company>www.dmsolutions.ca</cham:company>
86         <cham:contact>chameleon@lists.maptools.org</cham:contact>
87       </cham:editor>
88     </cham:editors>
89   </cham:docinfo>
90   <cham:includes>
91 <!-- ******** REMOVED BY AUTO DOC ********    <cham:include>Base</cham:include> -->
92 <!-- ******** REMOVED BY AUTO DOC ********    <cham:include>Label</cham:include> -->
93 <!-- ******** REMOVED BY AUTO DOC ********    <cham:include>Icon</cham:include> -->
94     <cham:include>Button</cham:include>
95     <cham:include>Popup</cham:include>
96 <!-- ******** REMOVED BY AUTO DOC ********    <cham:include>TextButton</cham:include> -->
97   </cham:includes>
98   <cham:widgetrequirements>
99     <cham:widgetrequirement>
100       <cham:type>software</cham:type>
101       <cham:name>php_mapscript</cham:name>
102       <cham:version>4.x</cham:version>
103       <cham:description></cham:description>
104     </cham:widgetrequirement>
105     <cham:widgetrequirement>
106       <cham:type>software</cham:type>
107       <cham:name>php</cham:name>
108       <cham:version>4.x</cham:version>
109       <cham:configureoptions>
110         <cham:configureoption>--with-dbase</cham:configureoption>
111         <cham:configureoption>--with-mysql</cham:configureoption>
112       </cham:configureoptions>
113       <cham:description></cham:description>
114     </cham:widgetrequirement>
115   </cham:widgetrequirements>
116   <cham:description>
117     The ProjectionSelector widget allows the user to select a new projection for the current context from those defined in a common resource called "projection".  The structure of the common resource is: &ltprojection name="human name" srs="epsg code"/&gt;.  This structure is shared with the projection label widget if used.
118   </cham:description>
119   <cham:onlinehelp>
120     This button provides the capability to change the projection that the map is currently being viewed in. To change the projection of the map, click the Projection button to open the Projection dialog. Select a new projection from the drop-down combo box and click OK.
121   </cham:onlinehelp>
122   <cham:functionality>
123     <cham:interactionmethods>
124       <cham:interactionmethod>
125         <cham:type></cham:type>
126         <cham:description></cham:description>
127         <cham:output>
128           <cham:description></cham:description>
129         </cham:output>
130       </cham:interactionmethod>
131     </cham:interactionmethods>
132     <cham:designnotes></cham:designnotes>
133   </cham:functionality>
134   <cham:widgettemplatetag>
135     <cham:widgetdependancies>
136       <cham:widgetdependancy>
137         <cham:type></cham:type>
138         <cham:name></cham:name>
139         <cham:description></cham:description>
140       </cham:widgetdependancy>
141     </cham:widgetdependancies>
142     <cham:examples>
143       <cham:example>
144         <cham:type>simple</cham:type>
145         <cham:code></cham:code>
146         <cham:description></cham:description>
147       </cham:example>
148       <cham:example>
149         <cham:type>advanced</cham:type>
150         <cham:code></cham:code>
151         <cham:description></cham:description>
152       </cham:example>
153     </cham:examples>
154     <cham:description></cham:description>
155   </cham:widgettemplatetag>
156   <cham:widgettag>
157 <!-- ******** REMOVED BY AUTO DOC ********    <cham:attribute> -->
158 <!-- ******** REMOVED BY AUTO DOC ********      <cham:name></cham:name> -->
159 <!-- ******** REMOVED BY AUTO DOC ********      <cham:type>boolean</cham:type> -->
160 <!-- ******** REMOVED BY AUTO DOC ********      <cham:required>FALSE</cham:required> -->
161 <!-- ******** REMOVED BY AUTO DOC ********      <cham:changeappearance>FALSE</cham:changeappearance> -->
162 <!-- ******** REMOVED BY AUTO DOC ********      <cham:default></cham:default> -->
163 <!-- ******** REMOVED BY AUTO DOC ********      <cham:description></cham:description> -->
164 <!-- ******** REMOVED BY AUTO DOC ********    </cham:attribute> -->
165     <cham:attribute>
166       <cham:name></cham:name>
167       <cham:type>integer</cham:type>
168       <cham:required>FALSE</cham:required>
169       <cham:changeappearance>FALSE</cham:changeappearance>
170       <cham:default>0</cham:default>
171       <cham:possvalues type="range">
172         <cham:minimum>0</cham:minimum>
173         <cham:maximum>10</cham:maximum>
174       </cham:possvalues>
175       <cham:description></cham:description>
176     </cham:attribute>
177     <cham:attribute>
178       <cham:name></cham:name>
179       <cham:type>integer</cham:type>
180       <cham:required>FALSE</cham:required>
181       <cham:changeappearance>FALSE</cham:changeappearance>
182       <cham:default>2</cham:default>
183       <cham:possvalues type="list">
184         <cham:value>2</cham:value>
185         <cham:value>3</cham:value>
186         <cham:value>4</cham:value>
187         <cham:value>5</cham:value>
188       </cham:possvalues>
189       <cham:description></cham:description>
190     </cham:attribute>
191   </cham:widgettag>
192   <cham:sharedresources>
193     <cham:sharedresource>
194       <cham:name></cham:name>
195       <cham:description></cham:description>
196       <cham:examples>
197         <cham:example>
198           <cham:type>simple</cham:type>
199           <cham:code></cham:code>
200           <cham:description></cham:description>
201         </cham:example>
202         <cham:example>
203           <cham:type>advanced</cham:type>
204           <cham:code></cham:code>
205           <cham:description></cham:description>
206         </cham:example>
207       </cham:examples>
208     </cham:sharedresource>
209   </cham:sharedresources>
210   <cham:formelements>
211 <!-- ******** REMOVED BY AUTO DOC ********    <cham:formelement> -->
212 <!-- ******** REMOVED BY AUTO DOC ********      <cham:type></cham:type> -->
213 <!-- ******** REMOVED BY AUTO DOC ********      <cham:default></cham:default> -->
214 <!-- ******** REMOVED BY AUTO DOC ********      <cham:description></cham:description> -->
215 <!-- ******** REMOVED BY AUTO DOC ********    </cham:formelement> -->
216     <cham:formelement>
217       <cham:name>MAP_PROJECTION</cham:name>
218       <cham:type></cham:type>
219       <cham:default></cham:default>
220       <cham:description>The current projection of the map.</cham:description>
221     </cham:formelement>
222   </cham:formelements>
223   <cham:jsfunctions>
224     <cham:jsfunction>
225       <cham:name></cham:name>
226       <cham:description></cham:description>
227       <cham:scope>Private</cham:scope>
228       <cham:parameters>
229         <cham:parameter>
230           <cham:name></cham:name>
231           <cham:type>object</cham:type>
232           <cham:required>FALSE</cham:required>
233           <cham:description></cham:description>
234         </cham:parameter>
235       </cham:parameters>
236       <cham:returnvalue>
237         <cham:type>boolean</cham:type>
238         <cham:default>true</cham:default>
239         <cham:description></cham:description>
240       </cham:returnvalue>
241       <cham:examples>
242         <cham:example>
243           <cham:type>simple</cham:type>
244           <cham:code></cham:code>
245           <cham:description></cham:description>
246         </cham:example>
247         <cham:example>
248           <cham:type>advanced</cham:type>
249           <cham:code></cham:code>
250           <cham:description></cham:description>
251         </cham:example>
252       </cham:examples>
253     </cham:jsfunction>
254   </cham:jsfunctions>
255   <cham:jsvariables>
256     <cham:jsvariable>
257       <cham:name></cham:name>
258       <cham:type>float</cham:type>
259       <cham:scope>Private</cham:scope>
260       <cham:default>12.34</cham:default>
261       <cham:possvalues type="list">
262         <cham:value>23.5</cham:value>
263         <cham:value>43.1</cham:value>
264       </cham:possvalues>
265       <cham:description></cham:description>
266     </cham:jsvariable>
267   </cham:jsvariables>
268   <cham:widgetevents>
269     <cham:widgetevent>
270       <cham:name></cham:name>
271       <cham:description></cham:description>
272     </cham:widgetevent>
273     <cham:widgetevent>
274       <cham:name></cham:name>
275       <cham:description></cham:description>
276       <cham:parameters>
277         <cham:parameter>
278           <cham:name></cham:name>
279           <cham:type>integer</cham:type>
280           <cham:required>FALSE</cham:required>
281           <cham:default>0</cham:default>
282           <cham:possvalues type="list">
283             <cham:value>12</cham:value>
284             <cham:value>23</cham:value>
285           </cham:possvalues>
286           <cham:description></cham:description>
287         </cham:parameter>
288         <cham:parameter>
289           <cham:name></cham:name>
290           <cham:type>string</cham:type>
291           <cham:required>FALSE</cham:required>
292           <cham:default></cham:default>
293           <cham:description></cham:description>
294         </cham:parameter>
295       </cham:parameters>
296     </cham:widgetevent>
297   </cham:widgetevents>
298   <cham:jsapievents>
299     <cham:jsapievent>
300       <cham:name></cham:name>
301       <cham:behavior>listens</cham:behavior>
302       <cham:calledfunctions>
303         <cham:calledfunction>
304           <cham:name></cham:name>
305           <cham:description></cham:description>
306         </cham:calledfunction>
307       </cham:calledfunctions>
308       <cham:description></cham:description>
309     </cham:jsapievent>
310   </cham:jsapievents>
311   <cham:widgeterrors>
312     <cham:widgeterror>
313       <cham:severity></cham:severity>
314       <cham:type></cham:type>
315       <cham:message></cham:message>
316       <cham:description></cham:description>
317       <cham:solution></cham:solution>
318     </cham:widgeterror>
319   </cham:widgeterrors>
320   <cham:widgettests>
321     <cham:widgettest>
322       <cham:success>FALSE</cham:success>
323       <cham:client>
324         <cham:browser>
325           <cham:name></cham:name>
326           <cham:version></cham:version>
327         </cham:browser>
328         <cham:os>
329           <cham:name></cham:name>
330         </cham:os>
331         <cham:description></cham:description>
332       </cham:client>
333       <cham:server>
334         <cham:webserver>
335           <cham:name></cham:name>
336           <cham:version></cham:version>
337         </cham:webserver>
338         <cham:os>
339           <cham:name></cham:name>
340         </cham:os>
341         <cham:description></cham:description>
342       </cham:server>
343       <cham:description></cham:description>
344     </cham:widgettest>
345     <cham:description></cham:description>
346   </cham:widgettests>
347 </cham:widgetdoc>
Note: See TracBrowser for help on using the browser.