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

root/Chameleon/trunk/Chameleon/PrintProduction/PrintProduction.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>printproduction</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 PrintPopup widget displays a popup dialog that allows the user to
62 create a printable version of the map with some additional cartographic
63 annotations.</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>This button is used to create and customize a map image with additional cartographic annotations. These annotations inclue a title, a neat line (black line around the map itself), a scale bar and a legend. The format section provides control over the size of the final image, the font size of the title and the type of the image. The Output Type of the image will depend on the server but will generally include GIF, PNG and JPEG.</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>   TEMPLATE ="[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:name>button</ca:name>
155       <ca:name>popup</ca:name>
156     </ca:attributegroup>
157   </ca:attributegroups>
158   <ca:widgettag title="Attributes">
159     <ca:attribute>
160       <ca:name>TEMPLATE</ca:name>
161       <ca:type title="Type">
162         <ca:value>string</ca:value>
163         <ca:description></ca:description>
164       </ca:type>
165       <ca:class title="Class">
166         <ca:value>Widget Only</ca:value>
167       </ca:class>
168       <ca:default title="Default">
169         <ca:description></ca:description>
170       </ca:default>
171     </ca:attribute>
172     <ca:subtag>
173       <ca:name></ca:name>
174       <ca:type title="Type">
175         <ca:value>XML</ca:value>
176         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
177       </ca:type>
178       <ca:class title="Class">
179         <ca:value>Widget &amp; Shared Resource</ca:value>
180       </ca:class>
181       <ca:description></ca:description>
182       <ca:attribute>
183         <ca:name></ca:name>
184         <ca:type title="Type">
185           <ca:value>float</ca:value>
186           <ca:description></ca:description>
187         </ca:type>
188         <ca:class title="Class">
189           <ca:value>Widget &amp; Shared Resource</ca:value>
190         </ca:class>
191         <ca:default title="Default">
192           <ca:value></ca:value>
193           <ca:description></ca:description>
194         </ca:default>
195         <ca:possvalues type="list" title="Value">
196           <ca:value></ca:value>
197         </ca:possvalues>
198         <ca:description></ca:description>
199       </ca:attribute>
200     </ca:subtag>
201   </ca:widgettag>
202   <ca:formelements title="Form Elements"/>
203   <ca:jsvariables title="JavaScript Variables"/>
204   <ca:jsfunctions title="JavaScript Functions">
205     <ca:jsfunction>
206       <ca:name>clickPrintPopup</ca:name>
207       <ca:scope title="Scope">
208         <ca:value>Private</ca:value>
209       </ca:scope>
210       <ca:description>callback function for the user clicking the Print button</ca:description>
211       <ca:returnvalues title="Function Return Value">
212         <ca:returnvalue>
213           <ca:type title="Type">
214             <ca:value>unknown</ca:value>
215             <ca:description></ca:description>
216           </ca:type>
217           <ca:default title="Default">
218             <ca:value></ca:value>
219           </ca:default>
220           <ca:possvalues type="list" title="Values">
221             <ca:value></ca:value>
222           </ca:possvalues>
223           <ca:description></ca:description>
224         </ca:returnvalue>
225       </ca:returnvalues>
226       <ca:triggeredjsapievents title="JSAPI Triggered Events">
227         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
228         <ca:triggeredjsapievent title="">
229           <ca:name></ca:name>
230           <ca:description></ca:description>
231         </ca:triggeredjsapievent>
232       </ca:triggeredjsapievents>
233     </ca:jsfunction>
234     <ca:jsfunction>
235       <ca:name>errorPrintPopup</ca:name>
236       <ca:scope title="Scope">
237         <ca:value>Private</ca:value>
238       </ca:scope>
239       <ca:description></ca:description>
240       <ca:parameters title="Parameters">
241         <ca:parameter>
242           <ca:name>obj</ca:name>
243           <ca:type title="Type">
244             <ca:value>string</ca:value>
245           </ca:type>
246           <ca:default title="Default">
247             <ca:value></ca:value>
248             <ca:description></ca:description>
249           </ca:default>
250           <ca:possvalues type="list" title="Values">
251             <ca:value></ca:value>
252           </ca:possvalues>
253           <ca:description></ca:description>
254         </ca:parameter>
255         <ca:parameter>
256           <ca:name>szError</ca:name>
257           <ca:type title="Type">
258             <ca:value>string</ca:value>
259           </ca:type>
260           <ca:default title="Default">
261             <ca:value></ca:value>
262             <ca:description></ca:description>
263           </ca:default>
264           <ca:possvalues type="list" title="Values">
265             <ca:value></ca:value>
266           </ca:possvalues>
267           <ca:description></ca:description>
268         </ca:parameter>
269       </ca:parameters>
270       <ca:returnvalues title="Function Return Value">
271         <ca:returnvalue>
272           <ca:type title="Type">
273             <ca:value>unknown</ca:value>
274             <ca:description></ca:description>
275           </ca:type>
276           <ca:default title="Default">
277             <ca:value></ca:value>
278           </ca:default>
279           <ca:possvalues type="list" title="Values">
280             <ca:value></ca:value>
281           </ca:possvalues>
282           <ca:description></ca:description>
283         </ca:returnvalue>
284       </ca:returnvalues>
285       <ca:triggeredjsapievents title="JSAPI Triggered Events">
286         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
287         <ca:triggeredjsapievent title="">
288           <ca:name></ca:name>
289           <ca:description></ca:description>
290         </ca:triggeredjsapievent>
291       </ca:triggeredjsapievents>
292     </ca:jsfunction>
293   </ca:jsfunctions>
294   <ca:jsfiles title="JavaScript Files">
295     <ca:jsfile>
296       <ca:name></ca:name>
297       <ca:description></ca:description>
298       <ca:jsvariables title="JavaScript Variables">
299         <ca:jsvariable>
300           <ca:name></ca:name>
301           <ca:type title="Type">
302             <ca:value>string</ca:value>
303           </ca:type>
304           <ca:scope title="Scope">
305             <ca:value>Private</ca:value>
306           </ca:scope>
307           <ca:default title="Default">
308             <ca:value></ca:value>
309           </ca:default>
310           <ca:possvalues type="list" title="Values">
311             <ca:value></ca:value>
312           </ca:possvalues>
313           <ca:description></ca:description>
314         </ca:jsvariable>
315       </ca:jsvariables>
316       <ca:jsfunctions title="JavaScript Functions">
317         <ca:jsfunction>
318           <ca:name></ca:name>
319           <ca:scope title="Scope">
320             <ca:value>Private</ca:value>
321           </ca:scope>
322           <ca:description></ca:description>
323           <ca:parameters title="Parameters">
324             <ca:parameter>
325               <ca:name></ca:name>
326               <ca:type title="Type">
327                 <ca:value>string</ca:value>
328               </ca:type>
329               <ca:required title="Required">
330                 <ca:value>false</ca:value>
331               </ca:required>
332               <ca:default title="Default">
333                 <ca:value></ca:value>
334                 <ca:description></ca:description>
335               </ca:default>
336               <ca:possvalues type="list" title="Values">
337                 <ca:value></ca:value>
338               </ca:possvalues>
339               <ca:description></ca:description>
340             </ca:parameter>
341           </ca:parameters>
342           <ca:returnvalues title="Function Return Value">
343             <ca:returnvalue>
344               <ca:type title="Type">
345                 <ca:value>unknown</ca:value>
346                 <ca:description></ca:description>
347               </ca:type>
348               <ca:default title="Default">
349                 <ca:value></ca:value>
350               </ca:default>
351               <ca:possvalues type="list" title="Values">
352                 <ca:value></ca:value>
353               </ca:possvalues>
354               <ca:description></ca:description>
355             </ca:returnvalue>
356           </ca:returnvalues>
357           <ca:triggeredjsapievents title="JSAPI Triggered Events">
358             <ca:triggeredjsapievent title="">
359               <ca:name></ca:name>
360               <ca:description></ca:description>
361             </ca:triggeredjsapievent>
362           </ca:triggeredjsapievents>
363         </ca:jsfunction>
364       </ca:jsfunctions>
365     </ca:jsfile>
366   </ca:jsfiles>
367   <ca:listenedjsapievents title="JSAPI Listened Events">
368     <ca:listenedjsapievent title="">
369       <ca:name></ca:name>
370       <ca:description></ca:description>
371       <ca:calledfunctions title="Functions Calls">
372         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
373         <ca:calledfunction>
374           <ca:name></ca:name>
375           <ca:description></ca:description>
376         </ca:calledfunction>
377       </ca:calledfunctions>
378     </ca:listenedjsapievent>
379   </ca:listenedjsapievents>
380   <ca:widgetevents title="Widget Events">
381     <ca:widgetevent>
382       <ca:name></ca:name>
383       <ca:parameters title="Parameters">
384         <ca:parameter>
385           <ca:name></ca:name>
386           <ca:type title="Type">
387             <ca:value>string</ca:value>
388           </ca:type>
389           <ca:required title="Required">
390             <ca:value>false</ca:value>
391           </ca:required>
392           <ca:default title="Default">
393             <ca:value></ca:value>
394             <ca:description></ca:description>
395           </ca:default>
396           <ca:possvalues type="list" title="Values">
397             <ca:value></ca:value>
398           </ca:possvalues>
399           <ca:description></ca:description>
400         </ca:parameter>
401       </ca:parameters>
402       <ca:description></ca:description>
403     </ca:widgetevent>
404   </ca:widgetevents>
405   <ca:errors title="Widget Errors">
406     <ca:error title="Error #1">
407       <ca:type title="Type">
408         <ca:value>PHP Mapscript</ca:value>
409       </ca:type>
410       <ca:severity title="Severity">
411         <ca:value>none</ca:value>
412         <ca:description></ca:description>
413       </ca:severity>
414       <ca:message title="Error Message">
415         <ca:paras title="">
416           <ca:para>Error message string....</ca:para>
417         </ca:paras>
418       </ca:message>
419       <ca:meaning title="Interpretation">
420         <ca:paras title="">
421           <ca:para>The description of what the message means......</ca:para>
422         </ca:paras>
423       </ca:meaning>
424       <ca:solution title="Troubleshooting Tips">
425         <ca:paras title="">
426           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
427         </ca:paras>
428       </ca:solution>
429     </ca:error>
430   </ca:errors>
431 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.