Mercurial > mplayer.hg
annotate DOCS/xml/en/skin.xml @ 33174:29c59e557575
Revise skin documentation.
Move example behind positioning explanation (this was already the case
in the German translation) and add explanation on X and Y parameters.
author | ib |
---|---|
date | Fri, 15 Apr 2011 09:24:00 +0000 |
parents | 1dec9b8e53c6 |
children | da4608a8c4df |
rev | line source |
---|---|
20535 | 1 <?xml version="1.0" encoding="utf-8"?> |
10913
49b1a67e7381
Add revision keyword to english xml files, to ease translation synchronization
lumag
parents:
10875
diff
changeset
|
2 <!-- $Revision$ --> |
9675 | 3 <appendix id="skin"> |
11540 | 4 <title><application>MPlayer</application> skin format</title> |
9675 | 5 |
6 <sect1 id="skin-overview"> | |
7 <title>Overview</title> | |
21521 | 8 |
9 <!-- ********** --> | |
10 | |
9675 | 11 <sect2 id="skin-overview-components"> |
12 <title>Skin components</title> | |
21521 | 13 |
9675 | 14 <para> |
11715 | 15 Skins are quite free-format (unlike the fixed-format skins of |
16 <application>Winamp</application>/<application>XMMS</application>, | |
9675 | 17 for example), so it is up to you to create something great. |
18 </para> | |
19 | |
20 <para> | |
12405 | 21 Currently there are four windows to be decorated: the |
9675 | 22 <link linkend="skin-file-main">main window</link>, the |
23 <link linkend="skin-file-subwindow">subwindow</link>, the | |
24 <link linkend="skin-file-main">playbar</link>, and the | |
32872 | 25 <link linkend="skin-file-menu">skin menu</link>. |
9675 | 26 |
27 <itemizedlist> | |
21521 | 28 <listitem> |
29 <para> | |
32872 | 30 The <emphasis role="bold">main window</emphasis> is where you can control |
31 <application>MPlayer</application>. The <emphasis role="bold">playbar</emphasis> | |
32 shows up in fullscreen mode when moving the mouse to the bottom of | |
33 the screen. The background of the windows is an image. | |
21521 | 34 Various items can (and must) be placed in the window: |
35 <emphasis>buttons</emphasis>, <emphasis>potmeters</emphasis> (sliders) and | |
36 <emphasis>labels</emphasis>. | |
11540 | 37 For every item, you must specify its position and size. |
21521 | 38 </para> |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
29243
diff
changeset
|
39 |
21521 | 40 <para> |
9675 | 41 A <emphasis role="bold">button</emphasis> has three states (pressed, released, |
42 disabled), thus its image must be divided into three parts vertically. See the | |
43 <link linkend="skin-button">button</link> item for details. | |
21521 | 44 </para> |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
29243
diff
changeset
|
45 |
21521 | 46 <para> |
9675 | 47 A <emphasis role="bold">potmeter</emphasis> (mainly used for the seek bar and |
48 volume/balance control) can have any number of phases by dividing its image | |
49 into different parts below each other. See | |
50 <link linkend="skin-hpotmeter">hpotmeter</link> and | |
51 <link linkend="skin-potmeter">potmeter</link> for details. | |
21521 | 52 </para> |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
29243
diff
changeset
|
53 |
21521 | 54 <para> |
9675 | 55 <emphasis role="bold">Labels</emphasis> are a bit special: The characters |
56 needed to draw them are taken from an image file, and the characters in the | |
21521 | 57 image are described by a |
58 <link linkend="skin-fonts">font description file</link>. | |
9675 | 59 The latter is a plain text file which specifies the x,y position and size of |
60 each character in the image (the image file and its font description file | |
21521 | 61 form a font <emphasis>together</emphasis>). |
62 See <link linkend="skin-dlabel">dlabel</link> | |
9675 | 63 and <link linkend="skin-slabel">slabel</link> for details. |
21521 | 64 </para> |
65 | |
66 <note><para> | |
67 All images can have full transparency as described in the section about | |
9675 | 68 <link linkend="skin-overview-formats">image formats</link>. If the X server |
69 doesn't support the XShape extension, the parts marked transparent will be | |
70 black. If you'd like to use this feature, the width of the main window's | |
71 background image must be dividable by 8. | |
21521 | 72 </para></note> |
9675 | 73 </listitem> |
74 | |
75 <listitem><para> | |
76 The <emphasis role="bold">subwindow</emphasis> is where the movie appears. It | |
77 can display a specified image if there is no movie loaded (it is quite boring | |
21521 | 78 to have an empty window :-)) <emphasis role="bold">Note:</emphasis> |
79 transparency is <emphasis role="bold">not allowed</emphasis> here. | |
9675 | 80 </para></listitem> |
81 | |
21521 | 82 <listitem> |
83 <para> | |
11540 | 84 The <emphasis role="bold">skin menu</emphasis> is just a way to control |
32872 | 85 <application>MPlayer</application> by means of menu entries (which can be |
86 activated by a middle mouse button click). Two images | |
11540 | 87 are required for the menu: one of them is the base image that shows the |
88 menu in its normal state, the other one is used to display the selected | |
89 entries. When you pop up the menu, the first image is shown. If you move | |
90 the mouse over the menu entries, the currently selected entry is copied | |
91 from the second image over the menu entry below the mouse pointer | |
9675 | 92 (the second image is never shown as a whole). |
21521 | 93 </para> |
94 <para> | |
9675 | 95 A menu entry is defined by its position and size in the image (see the |
21521 | 96 section about the <link linkend="skin-file-menu">skin menu</link> for |
97 details). | |
98 </para> | |
99 </listitem> | |
9675 | 100 </itemizedlist> |
101 </para> | |
102 | |
103 <para> | |
21521 | 104 There is an important thing not mentioned yet: For buttons, potmeters and |
105 menu entries to work, <application>MPlayer</application> must know what to | |
106 do if they are clicked. This is done by <link linkend="skin-gui">messages</link> | |
107 (events). For these items you must define the messages to be generated when | |
108 they are clicked. | |
9675 | 109 </para> |
110 </sect2> | |
111 | |
29242
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
112 <sect2 id="skin-overview-formats"> |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
113 <title>Image formats</title> |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
114 |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
115 <para>Images must be truecolor (24 or 32 bpp) PNGs.</para> |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
116 <para> |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
117 In the main window and in the playbar (see below) you can use images with |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
118 `transparency': Regions filled with the color #FF00FF (magenta) are fully |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
119 transparent when viewed by <application>MPlayer</application>. This means |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
120 that you can even have shaped windows if your X server has the XShape extension. |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
121 </para> |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
122 </sect2> |
75dce2e34e81
Move image formats section to a more appropriate place.
diego
parents:
26958
diff
changeset
|
123 |
21521 | 124 <!-- ********** --> |
125 | |
9675 | 126 <sect2 id="skin-files"> |
127 <title>Files</title> | |
21521 | 128 |
9675 | 129 <para> |
130 You need the following files to build a skin: | |
131 <itemizedlist> | |
132 <listitem><para> | |
133 The configuration file named <link linkend="skin-file">skin</link> tells | |
11540 | 134 <application>MPlayer</application> how to put different parts of the skin |
135 together and what to do if you click somewhere in the window. | |
9675 | 136 </para></listitem> |
137 <listitem><para> | |
138 The background image for the main window. | |
139 </para></listitem> | |
140 <listitem><para> | |
141 Images for the items in the main window (including one or more font | |
142 description files needed to draw labels). | |
143 </para></listitem> | |
144 <listitem><para> | |
145 The image to be displayed in the subwindow (optional). | |
146 </para></listitem> | |
147 <listitem><para> | |
148 Two images for the skin menu (they are needed only if you want to create | |
149 a menu). | |
150 </para></listitem> | |
151 </itemizedlist> | |
152 With the exception of the skin configuration file, you can name the other | |
153 files whatever you want (but note that font description files must have | |
154 a <filename>.fnt</filename> extension). | |
155 </para> | |
156 </sect2> | |
157 </sect1> | |
12815 | 158 |
21521 | 159 |
160 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> | |
161 | |
162 | |
9675 | 163 <sect1 id="skin-file"> |
164 <title>The skin file</title> | |
21521 | 165 |
9675 | 166 <para> |
167 As mentioned above, this is the skin configuration file. It is line oriented; | |
33068 | 168 comments start with a '<literal>;</literal>' character and continue until |
33080 | 169 the end of the line, or start with a '<literal>#</literal>' character at the |
170 beginning of the line (in that case only spaces and tabs are allowed before the | |
171 '<literal>#</literal>'). | |
9675 | 172 </para> |
173 | |
174 <para> | |
175 The file is made up of sections. Each section describes the skin for an | |
176 application and has the following form: | |
177 <programlisting> | |
178 section = <replaceable>section name</replaceable> | |
179 . | |
180 . | |
181 . | |
182 end | |
183 </programlisting> | |
184 </para> | |
185 | |
186 <para> | |
21521 | 187 Currently there is only one application, so you need only one section: its name |
188 is <emphasis role="bold">movieplayer</emphasis>. | |
10111 | 189 </para> |
190 | |
191 <para> | |
192 Within this section each window is described by a block of the following form: | |
193 <programlisting> | |
194 window = <replaceable>window name</replaceable> | |
195 . | |
196 . | |
197 . | |
198 end | |
199 </programlisting> | |
200 </para> | |
201 | |
202 <para> | |
9675 | 203 where <replaceable>window name</replaceable> can be one of these strings: |
204 <itemizedlist> | |
21521 | 205 <listitem><para> |
206 <emphasis role="bold">main</emphasis> - for the main window | |
207 </para></listitem> | |
208 <listitem><para> | |
209 <emphasis role="bold">sub</emphasis> - for the subwindow | |
210 </para></listitem> | |
211 <listitem><para> | |
32872 | 212 <emphasis role="bold">playbar</emphasis> - for the playbar |
21521 | 213 </para></listitem> |
214 <listitem><para> | |
32872 | 215 <emphasis role="bold">menu</emphasis> - for the skin menu |
21521 | 216 </para></listitem> |
9675 | 217 </itemizedlist> |
218 </para> | |
219 | |
220 <para> | |
32872 | 221 (The sub, playbar and menu blocks are optional - you do not need to decorate |
222 the subwindow, have a playbar or create a menu. A default menu is always | |
223 available by a right mouse button click.) | |
9675 | 224 </para> |
225 | |
226 <para> | |
227 Within a window block, you can define each item for the window by a line in | |
228 this form: | |
229 <programlisting>item = parameter</programlisting> | |
230 Where <literal>item</literal> is a string that identifies the type of the GUI | |
231 item, <literal>parameter</literal> is a numeric or textual value (or a list of | |
232 values separated by commas). | |
233 </para> | |
234 | |
235 <para> | |
236 Putting the above together, the whole file looks something like this: | |
237 <programlisting> | |
238 section = movieplayer | |
239 window = main | |
240 ; ... items for main window ... | |
241 end | |
242 | |
243 window = sub | |
244 ; ... items for subwindow ... | |
245 end | |
12815 | 246 |
9675 | 247 window = menu |
248 ; ... items for menu ... | |
249 end | |
250 | |
251 window = playbar | |
252 ; ... items for playbar ... | |
253 end | |
254 end | |
255 </programlisting> | |
256 </para> | |
257 | |
258 <para> | |
259 The name of an image file must be given without leading directories - images | |
17974
9a5a62f480e6
Rename the default GUI skins directory from 'Skin' to 'skins', keeping
diego
parents:
17276
diff
changeset
|
260 are searched for in the <filename class="directory">skins</filename> directory. |
9675 | 261 You may (but you need not) specify the extension of the file. If the file does |
11540 | 262 not exist, <application>MPlayer</application> tries to load the file |
9675 | 263 <filename><filename>.<ext></filename>, where <literal>png</literal> |
264 and <literal>PNG</literal> are tried for <filename><ext></filename> | |
265 (in this order). The first matching file will be used. | |
266 </para> | |
267 | |
268 <para> | |
21521 | 269 Finally some words about positioning. The main window and the subwindow can be |
270 placed in the different corners of the screen by giving <literal>X</literal> | |
271 and <literal>Y</literal> coordinates. <literal>0</literal> is top or left, | |
9675 | 272 <literal>-1</literal> is center and <literal>-2</literal> is right or bottom, as |
273 shown in this illustration: | |
274 <informalfigure> | |
275 <screen> | |
276 (0, 0)----(-1, 0)----(-2, 0) | |
277 | | | | |
278 | | | | |
279 (0,-1)----(-1,-1)----(-2,-1) | |
280 | | | | |
281 | | | | |
282 (0,-2)----(-1,-2)----(-2,-2) | |
283 </screen> | |
284 </informalfigure> | |
285 </para> | |
286 | |
33174 | 287 <para> |
288 Here is an example to make this clear. Suppose that you have an image called | |
289 <filename>main.png</filename> that you use for the main window: | |
290 <programlisting>base = main, -1, -1</programlisting> | |
291 <application>MPlayer</application> tries to load <filename>main</filename>, | |
292 <filename>main.png</filename>, <filename>main.PNG</filename> files and centers it. | |
293 </para> | |
294 | |
21521 | 295 <!-- ********** --> |
9675 | 296 |
297 <sect2 id="skin-file-main"> | |
298 <title>Main window and playbar</title> | |
21521 | 299 |
9675 | 300 <para> |
301 Below is the list of entries that can be used in the | |
11444
d6ef9000aed5
removed for added consistency, we do not use them anywhere else.
diego
parents:
10913
diff
changeset
|
302 '<literal>window = main</literal>' ... '<literal>end</literal>', |
d6ef9000aed5
removed for added consistency, we do not use them anywhere else.
diego
parents:
10913
diff
changeset
|
303 and the '<literal>window = playbar</literal>' ... '<literal>end</literal>' |
9675 | 304 blocks. |
305 </para> | |
306 | |
307 <variablelist> | |
308 <varlistentry> | |
309 <term><literal> | |
310 <anchor id="skin-main-base"/>base = image, X, Y | |
311 </literal></term> | |
21521 | 312 <listitem> |
313 <para> | |
314 Lets you specify the background image to be used for the main window. | |
315 The window will appear at the given <literal>X,Y</literal> position on | |
316 the screen The window will have the size of the image. | |
317 </para> | |
318 <note><para> | |
33171 | 319 These coordinates do not currently work for the subwindow. |
21521 | 320 </para></note> |
321 <warning><para>Transparent regions in the image (colored #FF00FF) appear black | |
322 on X servers without the XShape extension. The image's width must be dividable | |
323 by 8.</para></warning> | |
324 </listitem> | |
9675 | 325 </varlistentry> |
326 | |
327 <varlistentry> | |
328 <term><literal> | |
329 <anchor id="skin-button"/>button = image, X, Y, width, height, message | |
330 </literal></term> | |
21521 | 331 <listitem> |
332 <para> | |
333 Place a button of <literal>width</literal> * <literal>height</literal> size at | |
334 position <literal>X,Y</literal>. The specified <literal>message</literal> is | |
335 generated when the button is clicked. The image given by | |
336 <literal>image</literal> must have three parts below each other (according to | |
337 the possible states of the button), like this: | |
338 </para> | |
339 <informalfigure> | |
340 <screen> | |
9675 | 341 +------------+ |
342 | pressed | | |
343 +------------+ | |
344 | released | | |
345 +------------+ | |
346 | disabled | | |
21521 | 347 +------------+<!-- |
348 --></screen> | |
349 </informalfigure> | |
9675 | 350 </listitem> |
351 </varlistentry> | |
352 | |
353 <varlistentry> | |
354 <term><literal> | |
355 <anchor id="skin-decoration"/>decoration = enable|disable | |
356 </literal></term> | |
21521 | 357 <listitem> |
358 <para> | |
359 Enable or disable window manager decoration of the main window. Default is | |
360 <emphasis role="bold">disable</emphasis>. | |
361 </para> | |
362 <note><para> | |
33171 | 363 This doesn't work for the subwindow, there is no need to. |
21521 | 364 </para></note> |
9675 | 365 </listitem> |
366 </varlistentry> | |
367 | |
368 <varlistentry> | |
369 <term><literal> | |
370 <anchor id="skin-hpotmeter"/>hpotmeter = button, bwidth, bheight, phases, numphases, default, X, Y, width, height, message | |
371 </literal></term> | |
372 <listitem><para> | |
21521 | 373 </para></listitem> |
9675 | 374 </varlistentry> |
375 | |
376 <varlistentry> | |
377 <term><literal> | |
378 <anchor id="skin-vpotmeter"/>vpotmeter = button, bwidth, bheight, phases, numphases, default, X, Y, width, height, message | |
379 </literal></term> | |
380 <listitem><para> | |
21521 | 381 Place a horizontal (hpotmeter) or vertical (vpotmeter) potmeter of |
382 <literal>width</literal> * <literal>height</literal> size at position | |
383 <literal>X,Y</literal>. The image can be divided into different parts for the | |
384 different phases of the potmeter (for example, you can have a pot for volume | |
385 control that turns from green to red while its value changes from the minimum | |
386 to the maximum.). <literal>hpotmeter</literal> can have a button that can be | |
387 dragged horizontally. The parameters are: | |
388 <itemizedlist> | |
389 <listitem><para> | |
390 <literal>button</literal> - the image to be used for the | |
9675 | 391 button (must have three parts below each other, like in case of |
392 <link linkend="skin-button">button</link>) | |
21521 | 393 </para></listitem> |
394 <listitem><para> | |
395 <literal>bwidth</literal>, <literal>bheight</literal> - size | |
9675 | 396 of the button |
21521 | 397 </para></listitem> |
398 <listitem><para> | |
399 <literal>phases</literal> - the image to be used for the | |
400 different phases of the hpotmeter. A special value of <literal>NULL</literal> | |
401 can be used if you want no such image. The image must be divided into | |
402 <literal>numphases</literal> parts vertically like this: | |
403 <informalfigure><screen> | |
9675 | 404 +------------+ |
405 | phase #1 | | |
406 +------------+ | |
407 | phase #2 | | |
408 +------------+ | |
409 ... | |
410 +------------+ | |
411 | phase #n | | |
21521 | 412 +------------+<!-- |
413 --></screen></informalfigure> | |
414 </para></listitem> | |
415 <listitem><para> | |
416 <literal>numphases</literal> - number of phases stored in the | |
9675 | 417 <literal>phases</literal> image |
21521 | 418 </para></listitem> |
419 <listitem><para> | |
420 <literal>default</literal> - default value for hpotmeter | |
9675 | 421 (in the range <literal>0</literal> to <literal>100</literal>) |
21521 | 422 </para></listitem> |
423 <listitem><para> | |
424 <literal>X</literal>, <literal>Y</literal> - position for the hpotmeter | |
425 </para></listitem> | |
426 <listitem><para> | |
427 <literal>width</literal>, <literal>height</literal> - width and height | |
9675 | 428 of the <literal>hpotmeter</literal> |
21521 | 429 </para></listitem> |
430 <listitem><para> | |
431 <literal>message</literal> - the message to be generated when the | |
9675 | 432 value of <literal>hpotmeter</literal> is changed |
21521 | 433 </para></listitem> |
434 </itemizedlist> | |
435 </para></listitem> | |
9675 | 436 </varlistentry> |
437 | |
438 <varlistentry> | |
439 <term><literal> | |
440 <anchor id="skin-potmeter"/>potmeter = phases, numphases, default, X, Y, width, height, message | |
441 </literal></term> | |
442 <listitem><para> | |
21521 | 443 A <literal>hpotmeter</literal> without a button. (I guess it is meant to be |
444 turned around, but it reacts to horizontal dragging only.) For the description | |
445 of the parameters see <link linkend="skin-hpotmeter">hpotmeter</link>. | |
446 <literal>phases</literal> can be <literal>NULL</literal>, but it is quite | |
447 useless, since you cannot see where the <literal>potmeter</literal> is set. | |
448 </para></listitem> | |
9675 | 449 </varlistentry> |
450 | |
451 <varlistentry> | |
452 <term><literal> | |
32740 | 453 <anchor id="skin-font"/>font = fontfile |
9675 | 454 </literal></term> |
455 <listitem><para> | |
21521 | 456 Defines a font. <literal>fontfile</literal> is the name of a font description |
457 file with a <filename>.fnt</filename> extension (do not specify the extension | |
32740 | 458 here) and is used to refer to the font |
21521 | 459 (see <link linkend="skin-dlabel">dlabel</link> |
460 and <link linkend="skin-slabel">slabel</link>). Up to 25 fonts can be defined. | |
461 </para></listitem> | |
9675 | 462 </varlistentry> |
463 | |
464 <varlistentry> | |
465 <term><literal> | |
32740 | 466 <anchor id="skin-slabel"/>slabel = X, Y, fontfile, "text" |
9675 | 467 </literal></term> |
468 <listitem><para> | |
21521 | 469 Place a static label at the position <literal>X,Y</literal>. |
470 <literal>text</literal> is displayed using the font identified by | |
32740 | 471 <literal>fontfile</literal>. The text is just a raw string |
21521 | 472 (<literal>$x</literal> variables do not work) that must be enclosed between |
21596 | 473 double quotes (but the " character cannot be part of the text). The |
32740 | 474 label is displayed using the font identified by <literal>fontfile</literal>. |
21521 | 475 </para></listitem> |
9675 | 476 </varlistentry> |
477 | |
478 <varlistentry> | |
479 <term><literal> | |
32910 | 480 <anchor id="skin-dlabel"/>dlabel = X, Y, width, align, fontfile, "text" |
9675 | 481 </literal></term> |
482 <listitem> | |
21521 | 483 <para> |
484 Place a dynamic label at the position <literal>X,Y</literal>. The label is | |
32910 | 485 called dynamic because its text is refreshed periodically. The maximum width |
486 of the label is given by <literal>width</literal> (its height is the height | |
21521 | 487 of a character). If the text to be displayed is wider than that, it will be |
488 scrolled, | |
489 otherwise it is aligned within the specified space by the value of the | |
490 <literal>align</literal> parameter: <literal>0</literal> is for right, | |
491 <literal>1</literal> is for center, <literal>2</literal> is for left. | |
492 </para> | |
493 <para> | |
494 The text to be displayed is given by <literal>text</literal>: It must be | |
21596 | 495 written between double quotes (but the " character cannot be part of the |
21521 | 496 text). The label is displayed using the font identified by |
32740 | 497 <literal>fontfile</literal>. You can use the following variables in the text: |
21521 | 498 </para> |
9675 | 499 |
21521 | 500 <informaltable> |
501 <tgroup cols="2"> | |
502 <thead> | |
30990 | 503 <row><entry>Variable</entry><entry>Meaning</entry></row> |
21521 | 504 </thead> |
505 <tbody> | |
506 <row> | |
507 <entry>$1</entry> | |
508 <entry>play time in <emphasis>hh:mm:ss</emphasis> format</entry> | |
509 </row> | |
510 <row> | |
30990 | 511 <entry>$2</entry> |
512 <entry>play time in <emphasis>mmmm:ss</emphasis> format</entry> | |
21521 | 513 </row> |
514 <row> | |
30990 | 515 <entry>$3</entry> |
516 <entry>play time in <emphasis>hh</emphasis> format (hours)</entry> | |
21521 | 517 </row> |
518 <row> | |
30990 | 519 <entry>$4</entry> |
520 <entry>play time in <emphasis>mm</emphasis> format (minutes)</entry> | |
21521 | 521 </row> |
522 <row> | |
30990 | 523 <entry>$5</entry> |
524 <entry>play time in <emphasis>ss</emphasis> format (seconds)</entry> | |
21521 | 525 </row> |
526 <row> | |
30990 | 527 <entry>$6</entry> |
528 <entry>movie length in <emphasis>hh:mm:ss</emphasis> format</entry> | |
21521 | 529 </row> |
530 <row> | |
30990 | 531 <entry>$7</entry> |
532 <entry>movie length in <emphasis>mmmm:ss</emphasis> format</entry> | |
21521 | 533 </row> |
534 <row> | |
30990 | 535 <entry>$8</entry> |
536 <entry>play time in <emphasis>h:mm:ss</emphasis> format</entry> | |
21521 | 537 </row> |
538 <row> | |
30990 | 539 <entry>$v</entry> |
540 <entry>volume in <emphasis>xxx.xx</emphasis>% format</entry> | |
21521 | 541 </row> |
542 <row> | |
30990 | 543 <entry>$V</entry> |
544 <entry>volume in <emphasis>xxx.xx</emphasis> format</entry> | |
21521 | 545 </row> |
546 <row> | |
30990 | 547 <entry>$b</entry> |
548 <entry>balance in <emphasis>xxx.xx</emphasis>% format</entry> | |
21521 | 549 </row> |
550 <row> | |
30990 | 551 <entry>$B</entry> |
552 <entry>balance in <emphasis>xxx.xx</emphasis> format</entry> | |
21521 | 553 </row> |
554 <row> | |
30990 | 555 <entry>$$</entry> |
556 <entry>the $ character</entry> | |
21521 | 557 </row> |
558 <row> | |
30990 | 559 <entry>$a</entry> |
560 <entry>a character according to the audio type (none: <literal>n</literal>, | |
561 mono: <literal>m</literal>, stereo: <literal>t</literal>)</entry> | |
21521 | 562 </row> |
563 <row> | |
30990 | 564 <entry>$t</entry> |
565 <entry>track number (in playlist)</entry> | |
21521 | 566 </row> |
567 <row> | |
30990 | 568 <entry>$o</entry> |
569 <entry>filename</entry> | |
21521 | 570 </row> |
571 <row> | |
30990 | 572 <entry>$f</entry> |
573 <entry>filename in lower case</entry> | |
21521 | 574 </row> |
575 <row> | |
30990 | 576 <entry>$F</entry> |
577 <entry>filename in upper case</entry> | |
21521 | 578 </row> |
579 <row> | |
30990 | 580 <entry>$T</entry> |
581 <entry> | |
582 a character according to the stream type (file: <literal>f</literal>, | |
583 Video CD: <literal>v</literal>, DVD: <literal>d</literal>, | |
584 URL: <literal>u</literal>) | |
585 </entry> | |
21521 | 586 </row> |
587 <row> | |
30990 | 588 <entry>$p</entry> |
21521 | 589 <entry>the <keycap>p</keycap> character (if a movie is playing and the font |
590 has the <keycap>p</keycap> character)</entry> | |
591 </row> | |
592 <row> | |
593 <entry>$s</entry> | |
594 <entry>the <keycap>s</keycap> character (if the movie is stopped and the | |
595 font has the <keycap>s</keycap> character)</entry> | |
596 </row> | |
597 <row> | |
598 <entry>$e</entry> | |
599 <entry>the <keycap>e</keycap> character (if playback is paused and the font | |
600 has the <keycap>e</keycap> character)</entry> | |
601 </row> | |
602 <row> | |
603 <entry>$x</entry> | |
604 <entry>movie width</entry> | |
605 </row> | |
606 <row> | |
607 <entry>$y</entry> | |
608 <entry>movie height</entry> | |
609 </row> | |
610 <row> | |
611 <entry>$C</entry> | |
612 <entry>name of the codec used</entry> | |
613 </row> | |
614 </tbody> | |
615 </tgroup> | |
616 </informaltable> | |
9675 | 617 |
21521 | 618 <note><para> |
619 The <literal>$a, $T, $p, $s</literal> and <literal>$e</literal> | |
620 variables all return characters that should be displayed as special symbols | |
621 (for example, <keycap>e</keycap> is for the pause symbol that usually looks | |
622 something like ||). You should have a font for normal characters and | |
623 a different font for symbols. See the section about | |
624 <link linkend="skin-fonts-symbols">symbols</link> for more information. | |
625 </para></note> | |
626 </listitem> | |
9675 | 627 </varlistentry> |
628 </variablelist> | |
21521 | 629 </sect2> |
9675 | 630 |
21521 | 631 <!-- ********** --> |
9675 | 632 |
633 <sect2 id="skin-file-subwindow"> | |
634 <title>Subwindow</title> | |
21521 | 635 |
9675 | 636 <para> |
637 The following entries can be used in the | |
638 '<literal>window = sub</literal>' . . . '<literal>end</literal>' block. | |
639 </para> | |
640 | |
641 <variablelist> | |
642 <varlistentry> | |
643 <term><literal> | |
644 <anchor id="skin-sub-base"/>base = image, X, Y, width, height | |
645 </literal></term> | |
646 <listitem><para> | |
21521 | 647 The image to be displayed in the window. The window will appear at the given |
648 <literal>X,Y</literal> position on the screen (<literal>0,0</literal> is the | |
649 top left corner). You can specify <literal>-1</literal> for center and | |
650 <literal>-2</literal> for right (<literal>X</literal>) and bottom | |
651 (<literal>Y</literal>). The window will be as large as the image. | |
652 <literal>width</literal> and <literal>height</literal> | |
653 denote the size of the window; they are optional (if they are missing, the | |
654 window is the same size as the image). | |
655 </para></listitem> | |
9675 | 656 </varlistentry> |
657 | |
658 <varlistentry> | |
659 <term><literal> | |
660 <anchor id="skin-background"/>background = R, G, B | |
661 </literal></term> | |
662 <listitem><para> | |
21521 | 663 Lets you set the background color. It is useful if the image is smaller than |
664 the window. <literal>R</literal>, <literal>G</literal> and | |
665 <literal>B</literal> specifies the red, green and blue component of the color | |
666 (each of them is a decimal number from 0 to 255). | |
667 </para></listitem> | |
9675 | 668 </varlistentry> |
669 </variablelist> | |
670 </sect2> | |
671 | |
21521 | 672 <!-- ********** --> |
673 | |
9675 | 674 <sect2 id="skin-file-menu"> |
675 <title>Skin menu</title> | |
21521 | 676 |
9675 | 677 <para> |
678 As mentioned earlier, the menu is displayed using two images. Normal menu | |
679 entries are taken from the image specified by the <literal>base</literal> item, | |
680 while the currently selected entry is taken from the image specified by the | |
681 <literal>selected</literal> item. You must define the position and size of each | |
682 menu entry through the menu item. | |
683 </para> | |
684 | |
685 <para> | |
686 The following entries can be used in the | |
687 '<literal>window = menu</literal>'. . .'<literal>end</literal>' block. | |
688 </para> | |
689 | |
690 <variablelist> | |
691 <varlistentry> | |
692 <term><literal> | |
693 <anchor id="skin-menu-base"/>base = image | |
694 </literal></term> | |
695 <listitem><para> | |
21521 | 696 The image for normal menu entries. |
697 </para></listitem> | |
9675 | 698 </varlistentry> |
699 | |
700 <varlistentry> | |
701 <term><literal> | |
702 <anchor id="skin-selected"/>selected = image | |
703 </literal></term> | |
704 <listitem><para> | |
21521 | 705 The image showing the menu with all entries selected. |
706 </para></listitem> | |
9675 | 707 </varlistentry> |
708 | |
709 <varlistentry> | |
710 <term><literal> | |
711 <anchor id="skin-menu"/>menu = X, Y, width, height, message | |
712 </literal></term> | |
713 <listitem><para> | |
21521 | 714 Defines the <literal>X,Y</literal> position and the size of a menu entry in |
715 the image. <literal>message</literal> is the message to be generated when the | |
716 mouse button is released over the entry. | |
717 </para></listitem> | |
9675 | 718 </varlistentry> |
719 </variablelist> | |
720 </sect2> | |
721 </sect1> | |
722 | |
21521 | 723 |
724 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> | |
725 | |
726 | |
9675 | 727 <sect1 id="skin-fonts"> |
728 <title>Fonts</title> | |
729 <para> | |
730 As mentioned in the section about the parts of a skin, a font is defined by an | |
21521 | 731 image and a description file. You can place the characters anywhere in the |
732 image, but make sure that their position and size is given in the description | |
733 file exactly. | |
9675 | 734 </para> |
735 | |
736 <para> | |
737 The font description file (with <filename>.fnt</filename> extension) can have | |
33080 | 738 comments like the skin configuration file starting with '<literal>;</literal>' |
739 (or '<literal>#</literal>', but only at the beginning of the line). The file must have a line | |
9675 | 740 in the form |
741 <anchor id="skin-font-image"/> | |
742 <programlisting>image = <replaceable>image</replaceable></programlisting> | |
743 Where <literal><replaceable>image</replaceable></literal> is the name of the | |
744 image file to be used for the font (you do not have to specify the extension). | |
745 <anchor id="skin-font-char"/> | |
21596 | 746 <programlisting>"char" = X, Y, width, height</programlisting> |
9675 | 747 Here <literal>X</literal> and <literal>Y</literal> specify the position of the |
748 <literal>char</literal> character in the image (<literal>0,0</literal> is the | |
749 upper left corner). <literal>width</literal> and <literal>height</literal> are | |
32734
cc58a1e919d9
Allow character in the font description file to be in UTF-8.
ib
parents:
30990
diff
changeset
|
750 the dimensions of the character in pixels. The character may be in UTF-8 |
cc58a1e919d9
Allow character in the font description file to be in UTF-8.
ib
parents:
30990
diff
changeset
|
751 encoding. |
9675 | 752 </para> |
753 | |
754 <para> | |
755 This example defines the A, B, C characters using <filename>font.png</filename>. | |
756 <programlisting> | |
21596 | 757 ; Can be "font" instead of "font.png". |
9675 | 758 image = font.png |
759 | |
760 ; Three characters are enough for demonstration purposes :-) | |
21596 | 761 "A" = 0,0, 7,13 |
762 "B" = 7,0, 7,13 | |
763 "C" = 14,0, 7,13 | |
9675 | 764 </programlisting> |
765 </para> | |
766 | |
21521 | 767 <!-- ********** --> |
768 | |
9675 | 769 <sect2 id="skin-fonts-symbols"> |
770 <title>Symbols</title> | |
21521 | 771 |
9675 | 772 <para> |
773 Some characters have special meanings when returned by some of the variables | |
774 used in <link linkend="skin-dlabel">dlabel</link>. These characters are meant | |
775 to be shown as symbols so that things like a nice DVD logo can be displayed | |
776 instead of the character '<literal>d</literal>' for a DVD stream. | |
777 </para> | |
21521 | 778 |
9675 | 779 <para> |
780 The following table lists all the characters that can be used to display | |
781 symbols (and thus require a different font). | |
782 </para> | |
783 | |
784 <informaltable> | |
785 <tgroup cols="2"> | |
786 <thead> | |
787 <row><entry>Character</entry><entry>Symbol</entry></row> | |
788 </thead> | |
789 <tbody> | |
21521 | 790 <row><entry><keycap>p</keycap></entry><entry>play</entry></row> |
791 <row><entry><keycap>s</keycap></entry><entry>stop</entry></row> | |
792 <row><entry><keycap>e</keycap></entry><entry>pause</entry></row> | |
793 <row><entry><keycap>n</keycap></entry><entry>no sound</entry></row> | |
794 <row><entry><keycap>m</keycap></entry><entry>mono sound</entry></row> | |
795 <row><entry><keycap>t</keycap></entry><entry>stereo sound</entry></row> | |
796 <row><entry><keycap>f</keycap></entry><entry>stream is a file</entry></row> | |
797 <row><entry><keycap>v</keycap></entry><entry>stream is a Video CD</entry></row> | |
798 <row><entry><keycap>d</keycap></entry><entry>stream is a DVD</entry></row> | |
799 <row><entry><keycap>u</keycap></entry><entry>stream is a URL</entry></row> | |
9675 | 800 </tbody> |
801 </tgroup> | |
802 </informaltable> | |
803 </sect2> | |
804 </sect1> | |
805 | |
21521 | 806 |
807 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> | |
808 | |
809 | |
9675 | 810 <sect1 id="skin-gui"> |
811 <title>GUI messages</title> | |
21521 | 812 |
9675 | 813 <para> |
814 These are the messages that can be generated by buttons, potmeters and | |
815 menu entries. | |
816 </para> | |
817 | |
818 <variablelist> | |
819 <title>Playback control:</title> | |
820 <varlistentry> | |
821 <term><emphasis role="bold">evNext</emphasis></term> | |
822 <listitem><para> | |
21521 | 823 Jump to next track in the playlist. |
824 </para></listitem> | |
9675 | 825 </varlistentry> |
826 | |
827 <varlistentry> | |
828 <term><emphasis role="bold">evPause</emphasis></term> | |
829 <listitem><para> | |
21521 | 830 Forms a switch together with <literal>evPlaySwitchToPause</literal>. They can |
831 be used to have a common play/pause button. Both messages should be assigned | |
832 to buttons displayed at the very same position in the window. This message | |
833 pauses playing and the image for the <literal>evPlaySwitchToPause</literal> | |
834 button is displayed (to indicate that the button can be pressed to continue | |
835 playing). | |
836 </para></listitem> | |
9675 | 837 </varlistentry> |
838 | |
839 <varlistentry> | |
840 <term><emphasis role="bold">evPlay</emphasis></term> | |
841 <listitem><para> | |
21521 | 842 Start playing. |
843 </para></listitem> | |
9675 | 844 </varlistentry> |
845 | |
846 <varlistentry> | |
847 <term><emphasis role="bold">evPlaySwitchToPause</emphasis></term> | |
848 <listitem><para> | |
21521 | 849 The opposite of <literal>evPauseSwitchToPlay</literal>. This message starts |
850 playing and the image for the <literal>evPauseSwitchToPlay</literal> button | |
851 is displayed (to indicate that the button can be pressed to pause playing). | |
852 </para></listitem> | |
9675 | 853 </varlistentry> |
854 | |
855 <varlistentry> | |
856 <term><emphasis role="bold">evPrev</emphasis></term> | |
857 <listitem><para> | |
21521 | 858 Jump to previous track in the playlist. |
859 </para></listitem> | |
9675 | 860 </varlistentry> |
861 | |
862 <varlistentry> | |
863 <term><emphasis role="bold">evStop</emphasis></term> | |
864 <listitem><para> | |
21521 | 865 Stop playing. |
866 </para></listitem> | |
9675 | 867 </varlistentry> |
868 </variablelist> | |
869 | |
870 <variablelist> | |
871 <title>Seeking:</title> | |
872 <varlistentry> | |
873 <term><emphasis role="bold">evBackward10sec</emphasis></term> | |
874 <listitem><para> | |
21521 | 875 Seek backward 10 seconds. |
876 </para></listitem> | |
9675 | 877 </varlistentry> |
878 | |
879 <varlistentry> | |
880 <term><emphasis role="bold">evBackward1min</emphasis></term> | |
881 <listitem><para> | |
21521 | 882 Seek backward 1 minute. |
883 </para></listitem> | |
9675 | 884 </varlistentry> |
885 | |
886 <varlistentry> | |
887 <term><emphasis role="bold">evBackward10min</emphasis></term> | |
888 <listitem><para> | |
21521 | 889 Seek backward 10 minutes. |
890 </para></listitem> | |
9675 | 891 </varlistentry> |
892 | |
893 <varlistentry> | |
894 <term><emphasis role="bold">evForward10sec</emphasis></term> | |
895 <listitem><para> | |
21521 | 896 Seek forward 10 seconds. |
897 </para></listitem> | |
9675 | 898 </varlistentry> |
899 | |
900 <varlistentry> | |
901 <term><emphasis role="bold">evForward1min</emphasis></term> | |
902 <listitem><para> | |
21521 | 903 Seek forward 1 minute. |
904 </para></listitem> | |
9675 | 905 </varlistentry> |
906 | |
907 <varlistentry> | |
908 <term><emphasis role="bold">evForward10min</emphasis></term> | |
909 <listitem><para> | |
21521 | 910 Seek forward 10 minutes. |
911 </para></listitem> | |
9675 | 912 </varlistentry> |
913 | |
914 <varlistentry> | |
915 <term><emphasis role="bold">evSetMoviePosition</emphasis></term> | |
916 <listitem><para> | |
21521 | 917 Seek to position (can be used by a potmeter; the |
918 relative value (0-100%) of the potmeter is used). | |
919 </para></listitem> | |
9675 | 920 </varlistentry> |
921 </variablelist> | |
922 | |
923 <variablelist> | |
924 <title>Video control:</title> | |
925 <varlistentry> | |
14589 | 926 <term><emphasis role="bold">evHalfSize</emphasis></term> |
927 <listitem><para> | |
21521 | 928 Set the movie window to half size. |
929 </para></listitem> | |
14589 | 930 </varlistentry> |
931 <varlistentry> | |
9675 | 932 <term><emphasis role="bold">evDoubleSize</emphasis></term> |
933 <listitem><para> | |
21521 | 934 Set the movie window to double size. |
935 </para></listitem> | |
9675 | 936 </varlistentry> |
937 <varlistentry> | |
938 <term><emphasis role="bold">evFullScreen</emphasis></term> | |
939 <listitem><para> | |
21521 | 940 Switch fullscreen mode on/off. |
941 </para></listitem> | |
9675 | 942 </varlistentry> |
943 <varlistentry> | |
944 <term><emphasis role="bold">evNormalSize</emphasis></term> | |
945 <listitem><para> | |
21521 | 946 Set the movie window to its normal size. |
947 </para></listitem> | |
9675 | 948 </varlistentry> |
949 </variablelist> | |
950 | |
951 <variablelist> | |
952 <title>Audio control:</title> | |
953 <varlistentry> | |
954 <term><emphasis role="bold">evDecAudioBufDelay</emphasis></term> | |
955 <listitem><para> | |
21521 | 956 Decrease audio buffer delay. |
957 </para></listitem> | |
9675 | 958 </varlistentry> |
959 | |
960 <varlistentry> | |
961 <term><emphasis role="bold">evDecBalance</emphasis></term> | |
962 <listitem><para> | |
21521 | 963 Decrease balance. |
964 </para></listitem> | |
9675 | 965 </varlistentry> |
966 | |
967 <varlistentry> | |
968 <term><emphasis role="bold">evDecVolume</emphasis></term> | |
969 <listitem><para> | |
21521 | 970 Decrease volume. |
971 </para></listitem> | |
9675 | 972 </varlistentry> |
973 | |
974 <varlistentry> | |
975 <term><emphasis role="bold">evIncAudioBufDelay</emphasis></term> | |
976 <listitem><para> | |
21521 | 977 Increase audio buffer delay. |
978 </para></listitem> | |
9675 | 979 </varlistentry> |
980 | |
981 <varlistentry> | |
982 <term><emphasis role="bold">evIncBalance</emphasis></term> | |
983 <listitem><para> | |
21521 | 984 Increase balance. |
985 </para></listitem> | |
9675 | 986 </varlistentry> |
987 | |
988 <varlistentry> | |
989 <term><emphasis role="bold">evIncVolume</emphasis></term> | |
990 <listitem><para> | |
21521 | 991 Increase volume. |
992 </para></listitem> | |
9675 | 993 </varlistentry> |
994 | |
995 <varlistentry> | |
996 <term><emphasis role="bold">evMute</emphasis></term> | |
997 <listitem><para> | |
21521 | 998 Mute/unmute the sound. |
999 </para></listitem> | |
9675 | 1000 </varlistentry> |
1001 | |
1002 <varlistentry> | |
1003 <term><emphasis role="bold">evSetBalance</emphasis></term> | |
1004 <listitem><para> | |
21521 | 1005 Set balance (can be used by a potmeter; the |
1006 relative value (0-100%) of the potmeter is used). | |
1007 </para></listitem> | |
9675 | 1008 </varlistentry> |
1009 | |
1010 <varlistentry> | |
1011 <term><emphasis role="bold">evSetVolume</emphasis></term> | |
1012 <listitem><para> | |
21521 | 1013 Set volume (can be used by a potmeter; the relative |
1014 value (0-100%) of the potmeter is used). | |
1015 </para></listitem> | |
9675 | 1016 </varlistentry> |
1017 </variablelist> | |
1018 | |
1019 <variablelist> | |
1020 <title>Miscellaneous:</title> | |
1021 <varlistentry> | |
1022 <term><emphasis role="bold">evAbout</emphasis></term> | |
1023 <listitem><para> | |
21521 | 1024 Open the about window. |
1025 </para></listitem> | |
9675 | 1026 </varlistentry> |
1027 | |
1028 <varlistentry> | |
1029 <term><emphasis role="bold">evDropSubtitle</emphasis></term> | |
1030 <listitem><para> | |
21521 | 1031 Disables the currently used subtitle. |
1032 </para></listitem> | |
9675 | 1033 </varlistentry> |
1034 | |
1035 <varlistentry> | |
1036 <term><emphasis role="bold">evEqualizer</emphasis></term> | |
1037 <listitem><para> | |
21521 | 1038 Turn the equalizer on/off. |
1039 </para></listitem> | |
9675 | 1040 </varlistentry> |
1041 | |
1042 <varlistentry> | |
1043 <term><emphasis role="bold">evExit</emphasis></term> | |
1044 <listitem><para> | |
21521 | 1045 Quit the program. |
1046 </para></listitem> | |
9675 | 1047 </varlistentry> |
1048 | |
1049 <varlistentry> | |
1050 <term><emphasis role="bold">evIconify</emphasis></term> | |
1051 <listitem><para> | |
21521 | 1052 Iconify the window. |
1053 </para></listitem> | |
9675 | 1054 </varlistentry> |
1055 | |
1056 <varlistentry> | |
1057 <term><emphasis role="bold">evLoad</emphasis></term> | |
1058 <listitem><para> | |
21521 | 1059 Load a file (by opening a file browser window, where you can choose a file). |
1060 </para></listitem> | |
9675 | 1061 </varlistentry> |
1062 | |
1063 <varlistentry> | |
1064 <term><emphasis role="bold">evLoadPlay</emphasis></term> | |
1065 <listitem><para> | |
21521 | 1066 Does the same as <literal>evLoad</literal>, but it automatically starts |
1067 playing after the file is loaded. | |
1068 </para></listitem> | |
9675 | 1069 </varlistentry> |
1070 | |
1071 <varlistentry> | |
1072 <term><emphasis role="bold">evLoadSubtitle</emphasis></term> | |
1073 <listitem><para> | |
26958 | 1074 Loads a subtitle file (with the file selector). |
21521 | 1075 </para></listitem> |
9675 | 1076 </varlistentry> |
1077 | |
1078 <varlistentry> | |
1079 <term><emphasis role="bold">evLoadAudioFile</emphasis></term> | |
1080 <listitem><para> | |
26958 | 1081 Loads an audio file (with the file selector). |
21521 | 1082 </para></listitem> |
9675 | 1083 </varlistentry> |
1084 | |
1085 <varlistentry> | |
1086 <term><emphasis role="bold">evNone</emphasis></term> | |
1087 <listitem><para> | |
33070 | 1088 Empty message, it has no effect. |
21521 | 1089 </para></listitem> |
9675 | 1090 </varlistentry> |
1091 | |
1092 <varlistentry> | |
13752
e193600132d5
Important typo noticed by Piero di Vita <scognito at libero dot it>
diego
parents:
12815
diff
changeset
|
1093 <term><emphasis role="bold">evPlaylist</emphasis></term> |
9675 | 1094 <listitem><para> |
21521 | 1095 Open/close the playlist window. |
1096 </para></listitem> | |
9675 | 1097 </varlistentry> |
1098 | |
1099 <varlistentry> | |
1100 <term><emphasis role="bold">evPlayDVD</emphasis></term> | |
1101 <listitem><para> | |
21521 | 1102 Tries to open the disc in the given DVD-ROM drive. |
1103 </para></listitem> | |
9675 | 1104 </varlistentry> |
1105 | |
1106 <varlistentry> | |
1107 <term><emphasis role="bold">evPlayVCD</emphasis></term> | |
1108 <listitem><para> | |
21521 | 1109 Tries to open the disc in the given CD-ROM drive. |
1110 </para></listitem> | |
9675 | 1111 </varlistentry> |
1112 | |
1113 <varlistentry> | |
1114 <term><emphasis role="bold">evPreferences</emphasis></term> | |
1115 <listitem><para> | |
21521 | 1116 Open the preferences window. |
1117 </para></listitem> | |
9675 | 1118 </varlistentry> |
1119 | |
1120 <varlistentry> | |
1121 <term><emphasis role="bold">evSetAspect</emphasis></term> | |
1122 <listitem><para> | |
21521 | 1123 Sets displayed image aspect. |
1124 </para></listitem> | |
9675 | 1125 </varlistentry> |
1126 | |
1127 <varlistentry> | |
1128 <term><emphasis role="bold">evSetURL</emphasis></term> | |
1129 <listitem><para> | |
21521 | 1130 Displays the URL dialog window. |
1131 </para></listitem> | |
9675 | 1132 </varlistentry> |
1133 | |
1134 <varlistentry> | |
1135 <term><emphasis role="bold">evSkinBrowser</emphasis></term> | |
1136 <listitem><para> | |
21521 | 1137 Open the skin browser window. |
1138 </para></listitem> | |
9675 | 1139 </varlistentry> |
1140 </variablelist> | |
21521 | 1141 </sect1> |
9675 | 1142 |
21521 | 1143 |
1144 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> | |
1145 | |
9675 | 1146 |
17276 | 1147 <sect1 id="skin-quality"> |
1148 <title>Creating quality skins</title> | |
1149 | |
1150 <para> | |
1151 So you have read up on creating skins for the | |
1152 <application>MPlayer</application> GUI, done your best with the | |
1153 <application>Gimp</application> and wish to submit your skin to us? | |
1154 Read on for some guidelines to avoid common mistakes and produce | |
1155 a high quality skin. | |
1156 </para> | |
1157 | |
1158 <para> | |
1159 We want skins that we add to our repository to conform to certain | |
1160 quality standards. There are also a number of things that you can do | |
1161 to make our lives easier. | |
1162 </para> | |
1163 | |
1164 <para> | |
1165 As an example you can look at the <systemitem>Blue</systemitem> skin, | |
1166 it satisfies all the criteria listed below since version 1.5. | |
1167 </para> | |
1168 | |
1169 <itemizedlist> | |
21521 | 1170 <listitem><para> |
1171 Each skin should come with a | |
17276 | 1172 <filename>README</filename> file that contains information about |
1173 you, the author, copyright and license notices and anything else | |
1174 you wish to add. If you wish to have a changelog, this file is a | |
21521 | 1175 good place. |
1176 </para></listitem> | |
17276 | 1177 |
21521 | 1178 <listitem><para> |
1179 There should be a file <filename>VERSION</filename> | |
17276 | 1180 with nothing more than the version number of the skin on a single |
21521 | 1181 line (e.g. 1.0). |
1182 </para></listitem> | |
17276 | 1183 |
21521 | 1184 <listitem><para> |
1185 Horizontal and vertical controls (sliders like volume | |
17276 | 1186 or position) should have the center of the knob properly centered on |
1187 the middle of the slider. It should be possible to move the knob to | |
21521 | 1188 both ends of the slider, but not past it. |
1189 </para></listitem> | |
17276 | 1190 |
21521 | 1191 <listitem><para> |
1192 Skin elements should have the right sizes declared | |
17276 | 1193 in the skin file. If this is not the case you can click outside of |
1194 e.g. a button and still trigger it or click inside its area and not | |
21521 | 1195 trigger it. |
1196 </para></listitem> | |
17276 | 1197 |
21521 | 1198 <listitem><para> |
1199 The <filename>skin</filename> file should be | |
17276 | 1200 prettyprinted and not contain tabs. Prettyprinted means that the |
21521 | 1201 numbers should line up neatly in columns. |
1202 </para></listitem> | |
17276 | 1203 </itemizedlist> |
1204 | |
1205 </sect1> | |
9675 | 1206 </appendix> |