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

root/Chameleon/trunk/Chameleon/MapTitle/MapTitle.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="UTF-8"?>
2 <ca:widgetdoc xmlns:ca="http://localhost/chameleon/utils/xml/schemas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://localhost/chameleon/utils/xml/schemas ..\..\..\utils/xml/schemas/chameleon.xsd">
3   <ca:docinfo>
4     <ca:language>
5       <ca:value>en-ca</ca:value>
6     </ca:language>
7     <ca:docbuilddate>
8       <ca:value>1999-12-31</ca:value>
9     </ca:docbuilddate>
10     <ca:docversion>
11       <ca:value>$id:$</ca:value>
12     </ca:docversion>
13     <ca: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:person>
19     </ca:authors>
20     <ca:editors>
21       <ca:person>
22         <ca:name>Christopher R. Thorne</ca:name>
23         <ca:company>DM Solutions Group Inc.</ca:company>
24         <ca:contact>chameleon@lists.maptools.org</ca:contact>
25       </ca:person>
26       <ca:person>
27         <ca:name>Paul Spencer</ca:name>
28         <ca:company>DM Solutions Group Inc.</ca:company>
29         <ca:contact>chameleon@lists.maptools.org</ca:contact>
30       </ca:person>
31     </ca:editors>
32   </ca:docinfo>
33   <ca:identification>
34     <ca:name>
35       <ca:value>MapTitle</ca:value>
36     </ca:name>
37     <ca:chameleonpack>
38       <ca:value>TBD</ca:value>
39     </ca:chameleonpack>
40     <ca:parentgroup>
41       <ca:value>Label Widgets</ca:value>
42     </ca:parentgroup>
43     <ca:version>
44       <ca:value>2.0</ca:value>
45     </ca:version>
46     <ca:releasedate>
47       <ca:value>2005-01-10</ca:value>
48     </ca:releasedate>
49     <ca:maturitylevel>
50       <ca:value>TECHRELEASE</ca:value>
51     </ca:maturitylevel>
52     <ca:developers>
53       <ca:person>
54         <ca:name>Paul Spencer</ca:name>
55         <ca:company>DM Solutions Group Inc.</ca:company>
56         <ca:contact>chameleon@lists.maptools.org</ca:contact>
57       </ca:person>
58     </ca:developers>
59   </ca:identification>
60   <ca:descriptions>
61     <ca:description>
62       <ca:paras>
63         <ca:para>The MapTitle widget is used to display the title of the map. The title comes from either the OGC context or MapServer map file loaded into the application.  The primary reason to use this is for applications that allow the user to load arbitrary OGC contexts, or with a template that is designed to be reused with multiple map files without requiring changes to that template.</ca:para>
64       </ca:paras>
65     </ca:description>
66     <ca:dependancies>
67       <ca:dependancy type="Data" title="Map File Name">
68         <ca:para>The map name is extracted from either the MapServer map file (*.map) or the OGC Context map file (*.cml). If the map name is not defined, then nothing is displayed.</ca:para>
69       </ca:dependancy>
70     </ca:dependancies>
71     <ca:sharedresources>
72       <ca:paras title="None Available.">
73         <ca:para/>
74       </ca:paras>
75     </ca:sharedresources>
76     <ca:embeddedhelp>
77       <ca:paras>
78         <ca:para>This is a label showing a descriptive title for the map being viewed in the application.  If the application allows uploading of Context files or changing to a different map file, then the title may change to reflect the currently loaded Context or map.</ca:para>
79       </ca:paras>
80     </ca:embeddedhelp>
81     <ca:guinotes>
82       <ca:guinote type="Label" title="Dynamic Information">
83         <ca:para>If one of the functions of the mapping application is to show different maps, this widget is useful to indicate to the user the title of the current map.</ca:para>
84       </ca:guinote>   
85     </ca:guinotes>     
86   </ca:descriptions>
87   <ca:tagstructures>
88     <ca:tagstructure title="Widget Syntax">
89       <ca:description/>
90       <ca:code>
91         <ca:codeblock bold="true">
92           <ca:line>&lt;CWC2 TYPE="MapTitle"</ca:line>
93         </ca:codeblock>
94         <ca:codeblock bold="false">
95           <ca:line/>
96           <ca:line>   ENABLED="[TRUE|FALSE]"</ca:line>
97           <ca:line>   FORMINDEX="[0 &lt; integer]"</ca:line>
98           <ca:line>   VISIBLE="[TRUE|FALSE]"</ca:line>
99           <ca:line/>
100           <ca:line>    &lt;!-- MapTitle Attributes--&gt;</ca:line>
101           <ca:line/>
102           <ca:line>   WIDGETCLASS="[string]"</ca:line>
103           <ca:line>   WIDGETSTYLE="[string]"/&gt;</ca:line>
104         </ca:codeblock>
105       </ca:code>
106     </ca:tagstructure>
107   </ca:tagstructures>
108   <ca:examples>
109     <ca:widgetexamples>
110       <ca:example title="Example #1: Simple">
111         <ca:description>In most cases, the following is all you need to define.</ca:description>
112         <ca:code>
113           <ca:codeblock bold="false">
114             <ca:line>&lt;cwc2 type="MapTitle"/&gt;</ca:line>
115           </ca:codeblock>
116         </ca:code>
117       </ca:example>
118       <ca:example title="Example #2: Advanced">
119         <ca:description>To define a specific CSS style for the output map title text, use the widgetstyle  or widgetclass attributes.</ca:description>
120         <ca:code>
121           <ca:codeblock bold="false">
122             <ca:line>&lt;cwc2 type="MapTitle"</ca:line>
123             <ca:line>   widgetstyle="font-family:Ariel; font-size:14px;"/&gt;</ca:line>
124           </ca:codeblock>
125         </ca:code>
126       </ca:example>
127     </ca:widgetexamples>
128     <ca:sampleapps>
129       <ca:sampleapp>
130         <ca:name>Hawaii Demo</ca:name>
131         <ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl>
132         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
133       </ca:sampleapp>
134     </ca:sampleapps>
135     <ca:scriptexamples/>
136   </ca:examples>
137   <ca:attributegroups>
138     <ca:attributegroup>
139       <ca:name>Base</ca:name>
140     </ca:attributegroup>
141   </ca:attributegroups>
142   <ca:widgettag>
143     <ca:attribute>
144       <ca:name>WIDGETCLASS</ca:name>
145       <ca:type>
146         <ca:value>string</ca:value>
147       </ca:type>
148       <ca:class>
149         <ca:value>Widget Only</ca:value>
150       </ca:class>
151       <ca:default>
152         <ca:value>NULL</ca:value>
153         <ca:description/>
154       </ca:default>
155       <ca:description>Specify a CSS class to use on the title.</ca:description>
156     </ca:attribute>
157     <ca:attribute>
158       <ca:name>WIDGETSTYLE</ca:name>
159       <ca:type>
160         <ca:value>string</ca:value>
161       </ca:type>
162       <ca:class>
163         <ca:value>Widget Only</ca:value>
164       </ca:class>
165       <ca:default>
166         <ca:value>NULL</ca:value>
167         <ca:description/>
168       </ca:default>
169       <ca:description>Specify a CSS style to use on the title.</ca:description>
170     </ca:attribute>
171   </ca:widgettag>
172   <ca:formelements/>
173 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.