1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fi">
\r
7 <title>jSpeed - Highly customizable speedometer application</title>
\r
8 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
\r
9 <script type="text/javascript" src="http://code.jquery.com/jquery-1.4.2.min.js"></script>
\r
10 <script type="text/javascript" src="fancybox/jquery.mousewheel-3.0.2.pack.js"></script>
\r
11 <script type="text/javascript" src="fancybox/jquery.fancybox-1.3.1.js"></script>
\r
12 <script type="text/javascript" src="js/script.js"></script>
\r
13 <link rel="stylesheet" type="text/css" href="fancybox/jquery.fancybox-1.3.1.css" media="all" />
\r
14 <link rel="stylesheet" href="css/style.css" media="all" type="text/css" />
\r
21 <li><a href="http://jspeed.garage.maemo.org/">Info</a></li>
\r
22 <li><a href="#download">Download</a></li>
\r
23 <li><a href="http://jspeed.garage.maemo.org/themes.html">Themes</a></li>
\r
24 <li class="selected"><a href="http://jspeed.garage.maemo.org/theme-howto.html">Theme howto</a></li>
\r
29 <div id="main-content">
\r
31 <h1>Theme howto</h1>
\r
33 <ul class="contents">
\r
35 <a href="#screens">Mainscreen and detailscreen tags</a>
\r
38 <a href="#tag-spec">Tag specification</a>
\r
41 <a href="#common-options">Common options</a>
\r
43 <li><a href="#effects">Effects</a></li>
\r
47 <a href="#tag-rectangle">Tag: rectangle</a>
\r
50 <a href="#tag-image">Tag: image</a>
\r
53 <a href="#tag-pointer">Tag: pointer</a>
\r
56 <a href="#tag-text">Tag: text</a>
\r
62 <p>jSpeed theme files (ie. default.jspeed) are just <strong>regular zip-files</strong> renamed to .jspeed. The path for theme files is /home/user/.jspeed/themes.</p>
\r
64 <p>Each of these zip-files contains at least one file called theme.xml, which contains all the information required to draw the theme. Theme file may also contain image files and fonts required for the theme. A simple theme.xml could look like this:</p>
\r
68 <mainscreen orientation="landscape">
\r
70 <xpos>100</xpos>
\r
71 <ypos>100</ypos>
\r
72 <data>{SPEED}</data>
\r
73 <size>36</size>
\r
79 <p>This would print the current speed on screen at position (100, 100) using default font and font size 36. This kind of theme would only work in landscape mode. If one would like the get the theme to also work in portrait mode, there should be another <mainscreen> tag with orientation="portrait" and maybe different positions for speed display.</p>
\r
81 <h2 id="screens">Mainscreen and detailscreen tags</h2>
\r
83 <p>Each theme.xml must contain at least one <mainscreen> tag like in the example above. jSpeed contains also a detail screen which automatically contains specific speed, time and trip data. The font color and background of this screen can be changed similarly using <detailscreen> tag. Detail screen can also be themed differently in portrait and landscape mode, or the same specification can apply to both portrait and landscape mode by setting attribute orientation="both" on detailscreen tag.</p>
\r
85 <p>Here's the source code of jSpeed's default theme. The specific explanation of all possible tags is below.</p>
\r
89 <detailscreen orientation="both" color="#fff">
\r
91 <xpos>0</xpos>
\r
92 <ypos>0</ypos>
\r
93 <src>background.png</src>
\r
95 </detailscreen>
\r
96 <mainscreen orientation="landscape">
\r
98 <xpos>0</xpos>
\r
99 <ypos>0</ypos>
\r
100 <src>background.png</src>
\r
103 <data>000</data>
\r
104 <font>digital7.ttf</font>
\r
105 <size>320</size>
\r
106 <xpos>100</xpos>
\r
107 <ypos>75</ypos>
\r
108 <color>#17202b</color>
\r
109 <align>right</align>
\r
110 <width>600</width>
\r
113 <data>{SPEEDUNIT}</data>
\r
114 <xpos>520</xpos>
\r
115 <ypos>402</ypos>
\r
116 <font>Nokia Sans Bold</font>
\r
117 <size>24</size>
\r
118 <color>#fff</color>
\r
119 <bold>true</bold>
\r
120 <uppercase>true</uppercase>
\r
121 <effect name="dropshadow">
\r
122 <xoffset>0</xoffset>
\r
123 <yoffset>0</yoffset>
\r
124 <radius>35</radius>
\r
125 <color>#a5efff</color>
\r
129 <data>{SPEED}</data>
\r
130 <font>digital7.ttf</font>
\r
131 <size>320</size>
\r
132 <xpos>100</xpos>
\r
133 <ypos>75</ypos>
\r
134 <color>#fff</color>
\r
135 <align>right</align>
\r
136 <width>600</width>
\r
137 <format>%.0f</format>
\r
138 <effect name="dropshadow">
\r
139 <xoffset>0</xoffset>
\r
140 <yoffset>0</yoffset>
\r
141 <radius>35</radius>
\r
142 <color>#a5efff</color>
\r
145 </mainscreen>
\r
146 <mainscreen orientation="portrait">
\r
148 <xpos>0</xpos>
\r
149 <ypos>0</ypos>
\r
150 <src>background.png</src>
\r
153 <data>000</data>
\r
154 <font>digital7.ttf</font>
\r
155 <size>250</size>
\r
156 <xpos>0</xpos>
\r
157 <ypos>260</ypos>
\r
158 <color>#17202b</color>
\r
159 <align>right</align>
\r
160 <width>470</width>
\r
163 <data>{SPEEDUNIT}</data>
\r
164 <xpos>330</xpos>
\r
165 <ypos>522</ypos>
\r
166 <font>Nokia Sans Bold</font>
\r
167 <size>22</size>
\r
168 <color>#fff</color>
\r
169 <bold>true</bold>
\r
170 <uppercase>true</uppercase>
\r
171 <effect name="dropshadow">
\r
172 <xoffset>0</xoffset>
\r
173 <yoffset>0</yoffset>
\r
174 <radius>35</radius>
\r
175 <color>#a5efff</color>
\r
179 <data>{SPEED}</data>
\r
180 <font>digital7.ttf</font>
\r
181 <size>250</size>
\r
182 <xpos>0</xpos>
\r
183 <ypos>260</ypos>
\r
184 <color>#fff</color>
\r
185 <align>right</align>
\r
186 <width>470</width>
\r
187 <format>%.0f</format>
\r
188 <effect name="dropshadow">
\r
189 <xoffset>0</xoffset>
\r
190 <yoffset>0</yoffset>
\r
191 <radius>35</radius>
\r
192 <color>#a5efff</color>
\r
195 </mainscreen>
\r
199 <h2 id="tag-spec">Tag specification</h2>
\r
201 <p>As you can see on the example above, each detailscreen and mainscreen tags consists of other tags that cause something to be drawn on the screen. Each tag contains specific options to alter its look.</p>
\r
203 <h3 id="common-options">Common options</h3>
\r
205 <p>Common options that work on all tags are listed below.</p>
\r
207 <table class="spec">
\r
209 <th class="col1">Option</th>
\r
210 <th>Definition</th>
\r
211 <th class="col3">Example</th>
\r
215 <td>Defines the x-position of an element in pixels</td>
\r
216 <td><pre><xpos>80</xpos></pre></td>
\r
220 <td>Defines the y-position of an element in pixels.</td>
\r
221 <td><pre><ypos>40</xpos></pre></td>
\r
225 <td>Defines the z-index of an element. An element with bigger zpos gets painted over an element with smaller zpos.</td>
\r
226 <td><pre><zpos>5</xpos></pre></td>
\r
230 <td>Defines an effect to used with the element. See <a href="#effects">effects</a> for more details.</td>
\r
231 <td><pre><effect name="blur">
\r
232 <radius>20</radius>
\r
233 </effect></pre></td>
\r
237 <h4 id="effects">Effects</h4>
\r
239 <p>Each element can contain one effect which is used every time the element is painted or updated.</p>
\r
241 <table class="spec">
\r
243 <th class="col1">Effect name</th>
\r
244 <th>Possible options</th>
\r
245 <th class="col3">Example</th>
\r
250 <strong>radius: </strong>changes the blur radius. Bigger radius will cause the element to be blurred more.
\r
252 <td><pre><effect name="blur">
\r
253 <radius>20</radius>
\r
254 </effect></pre></td>
\r
257 <td>dropshadow</td>
\r
259 <strong>radius: </strong>changes the shadow radius. Bigger radius will cause the element to have bigger and more spread shadow.<br />
\r
260 <strong>color: </strong>sets the color of the shadow.<br />
\r
261 <strong>xoffset: </strong>shadow's x-distance from the element.<br />
\r
262 <strong>yoffset: </strong>shadow's y-distance from the element<br />
\r
265 <pre><effect name="dropshadow">
\r
266 <xoffset>0</xoffset>
\r
267 <yoffset>0</yoffset>
\r
268 <radius>35</radius>
\r
269 <color>#a5efff</color>
\r
277 <strong>opacity: </strong>sets the opacity of an element. Value of 1.0 means totally visible and value of 0.0 totally invisible.<br />
\r
280 <pre><effect name="opacity">
\r
281 <opacity>0.8</opacity>
\r
282 </effect></pre>
\r
287 <h3 id="tag-rectangle">Tag: rectangle</h3>
\r
289 <p>Rectangle tag draws an rectangle with specified size and color on the screen. Possible options for rectangle are listed below.</p>
\r
291 <table class="spec">
\r
293 <th class="col1">Option</th>
\r
294 <th>Definition</th>
\r
295 <th class="col3">Example</th>
\r
299 <td>Defines the width of the rectangle.</td>
\r
300 <td><pre><width>600</width></pre></td>
\r
304 <td>Defines the height of the rectangle.</td>
\r
305 <td><pre><height>400</height></pre></td>
\r
309 <td>Defines color of the rectangle. Color must be in hexadecimal form.</td>
\r
310 <td><pre><color>#2e94b5</color></pre></td>
\r
318 <xpos>100</xpos>
\r
319 <ypos>100</ypos>
\r
320 <width>300</width>
\r
321 <height>200</height>
\r
322 <color>#fff</color>
\r
328 <h3 id="tag-image">Tag: image</h3>
\r
330 <p>Draws an image on specific location on the screen. The image file should be placed in the same .jspeed file as theme.xml.</p>
\r
332 <table class="spec">
\r
334 <th class="col1">Option</th>
\r
335 <th>Definition</th>
\r
336 <th class="col3">Example</th>
\r
340 <td>Image is resized to this width. If width is set to 0, it is calculated automatically from height to constrain proportions. If both width and height are set to 0 or are not set at all, the image will be painted in its original size.</td>
\r
341 <td><pre><width>600</width></pre></td>
\r
345 <td>Image is resized to this width. If height is set to 0, it is calculated automatically from width to constrain proportions.</td>
\r
346 <td><pre><height>400</height></pre></td>
\r
354 <xpos>100</xpos>
\r
355 <ypos>100</ypos>
\r
356 <width>300</width>
\r
363 <h3 id="tag-pointer">Tag: pointer</h3>
\r
365 <p>Draws a pointer which moves according to current speed. Can be used to draw analog speedometers. The image file should be placed in the same .jspeed file as theme.xml. The xpos and ypos of a pointer are specified as the rotation point of the pointer on screen (usually somewhere in the middle of the screen).</p>
\r
367 <table class="spec">
\r
369 <th class="col1">Option</th>
\r
370 <th>Definition</th>
\r
371 <th class="col3">Example</th>
\r
375 <td>The image file used to draw the pointer.</td>
\r
376 <td><pre><src>pointer.png</src></pre></td>
\r
380 <td>The minimum speed in km/h of a pointer (usually 0).</td>
\r
381 <td><pre><zerospeed>0</zerospeed></pre></td>
\r
385 <td>The maximum speed of a pointer in km/h. (usually the maximum speed value in analog speedometer).</td>
\r
386 <td><pre><fullspeed>220</fullspeed></pre></td>
\r
390 <td>When speed is at zerospeed or lower, the pointer is rotated this much in degress from its original state.</td>
\r
391 <td><pre><zeroangle>-30</zeroangle></pre></td>
\r
395 <td>When speed is at fullspeed or higher, the pointer is rotated this much in degress from its original state.</td>
\r
396 <td><pre><fullangle>210</fullangle></pre></td>
\r
399 <td>xrotationpoint</td>
\r
400 <td>The pointer rotates around the point defined with xrotationpoint and yrotationpoint. It is usually located inside the pointer image.</td>
\r
401 <td><pre><xrotationpoint>200</xrotationpoint></pre></td>
\r
404 <td>yrotationpoint</td>
\r
405 <td>The pointer rotates around the point defined with xrotationpoint and yrotationpoint. It is usually located inside the pointer image.</td>
\r
406 <td><pre><yrotationpoint>12</yrotationpoint></pre></td>
\r
414 <src>pointer.png</src>
\r
415 <zeroangle>-20</zeroangle>
\r
416 <fullangle>210</fullangle>
\r
417 <zerospeed>0</zerospeed>
\r
418 <fullspeed>230</fullspeed>
\r
419 <xpos>400</xpos>
\r
420 <ypos>355</ypos>
\r
421 <xrotationpoint>278</xrotationpoint>
\r
422 <yrotationpoint>14</yrotationpoint>
\r
428 <h3 id="tag-text">Tag: text</h3>
\r
430 <p>Draws a text block on the screen.</p>
\r
432 <table class="spec">
\r
434 <th class="col1">Option</th>
\r
435 <th>Definition</th>
\r
436 <th class="col3">Example</th>
\r
440 <td>The actual textual data. Can be a plain text (ie. "Speed:") or a special field (ie. "{SPEED}"). Special fields are automatically updated to contain their value in unit which is specified in settings. Possible special fiels are listed below:<br/>
\r
441 <strong>{TRIP}: </strong>Trip value.<br />
\r
442 <strong>{TOTAL}: </strong>Total travelled kilometers or miles.<br />
\r
443 <strong>{SPEED}: </strong>Current speed.<br />
\r
444 <strong>{MAXSPEED}: </strong>Maximum speed.<br />
\r
445 <strong>{AVGSPEED}: </strong>Average speed.<br />
\r
446 <strong>{UNIT}: </strong>Distance unit (km or mi).<br />
\r
447 <strong>{SPEEDUNIT}: </strong>Speed unit (km/h or mph).<br />
\r
448 <strong>{TIME}: </strong>Current time, formatted according to timeformat tag.<br />
\r
449 <strong>{DATE}: </strong>Current date, formatted according to dateformat tag.<br/>
\r
451 <td><pre><data>{SPEED}</data></pre></td>
\r
455 <td>Special fields trip, total, speed, maxspeed and avgspeed will be printed according to this format. This field should be in <a href="http://en.wikipedia.org/wiki/Printf">prinf</a> format.</td>
\r
456 <td><pre><format>%.1f</format></pre></td>
\r
460 <td>The width of the text block.</td>
\r
461 <td><pre><width>200</width></pre></td>
\r
465 <td>Text align inside the text block (left, center or right).</td>
\r
466 <td><pre><align>right</align></pre></td>
\r
470 <td>Text color in hexadecimal form.</td>
\r
471 <td><pre><color>#000000</color></pre></td>
\r
475 <td>Text size in pixels.</td>
\r
476 <td><pre><size>20</size></pre></td>
\r
480 <td>Text font. Can be a font file inside the theme file (ie. "somefont.ttf") or a name of a font intalled in system (ie. "Tahoma").</td>
\r
481 <td><pre><font>arial.ttf</font></pre></td>
\r
485 <td>Sets <strong>bold</strong> text.</td>
\r
486 <td><pre><bold>true</bold></pre></td>
\r
490 <td>Sets <em>italic</em> text.</td>
\r
491 <td><pre><italic>true</italic></pre></td>
\r
495 <td>Prints all letters in UPPERCASE.</td>
\r
496 <td><pre><uppercase>true</uppercase></pre></td>
\r
499 <td>letterspacing</td>
\r
500 <td>Sets the spacing between letters.</td>
\r
501 <td><pre><letterspacing>150</letterspacing></pre></td>
\r
504 <td>timeformat</td>
\r
505 <td>Special field time will be printed according to this format. See <a href="http://doc.qt.nokia.com/4.6/qtime.html#toString">Qt QTime manual</a> for possible expressions.</td>
\r
506 <td><pre><timeformat>hh:mm</timeformat></pre></td>
\r
509 <td>dateformat</td>
\r
510 <td>Special field date will be printed according to this format. See <a href="http://doc.qt.nokia.com/4.6/qdate.html#toString">Qt QDate manual</a> for possible expressions.</td>
\r
511 <td><pre><dateformat>dd.MM.yyyy</dateformat></pre></td>
\r
519 <data>{SPEED}</data>
\r
520 <font>digital7.ttf</font>
\r
521 <size>320</size>
\r
522 <xpos>100</xpos>
\r
523 <ypos>75</ypos>
\r
524 <color>#fff</color>
\r
525 <align>right</align>
\r
526 <width>600</width>
\r
527 <format>%.0f</format>
\r
528 <effect name="dropshadow">
\r
529 <xoffset>0</xoffset>
\r
530 <yoffset>0</yoffset>
\r
531 <radius>35</radius>
\r
532 <color>#a5efff</color>
\r
538 <br class="clear" />
\r
546 <div id="bottom-content">
\r
548 <div class="bottom-box">
\r
550 <h3 id="download">Download</h3>
\r
552 <p>jSpeed can be downloaded from Maemo extras-devel repository.</p>
\r
556 <div class="bottom-box">
\r
560 <p>jSpeed is licensed under the terms of the <a href="http://www.gnu.org/licenses/gpl.txt">GNU General Public License</a>.</p>
\r
564 <div class="bottom-box">
\r
569 <li><a href="https://garage.maemo.org/projects/jspeed/">Project page</a></li>
\r
570 <li><a href="http://maemo.org/packages/view/jspeed/">Package overview and changelog</a></li>
\r
571 <li><a href="https://garage.maemo.org/tracker/?atid=6134&group_id=1756&func=browse">Bug tracker</a></li>
\r
576 <div id="copyright">
\r
577 Copyright © 2010 Jesse Hakanen | <a href="mailto:jessehakanen@gmail.com">Contact</a>
\r
projects / jspeed / blob