X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fskins%2Fskins2-howto.xml;h=71b0446d8530c7cfd9234effcd000eff825345d2;hb=917555567e3bb1f160ec732f495aef0e618e706a;hp=55db43dc2daca0a598e640e6777bc323258d2733;hpb=8086b07cf076736d43c955c00c4cbb1464e53dd7;p=vlc diff --git a/doc/skins/skins2-howto.xml b/doc/skins/skins2-howto.xml index 55db43dc2d..71b0446d85 100644 --- a/doc/skins/skins2-howto.xml +++ b/doc/skins/skins2-howto.xml @@ -10,7 +10,7 @@ HowTo create your own skin -2004-2006 +2004-2010 the VideoLAN project @@ -41,6 +41,7 @@ website. + VLC Skin XML Bezier @@ -83,7 +84,7 @@ difficulty to understand how VLC skins work. XML is a markup language, like HTML. It won't be explained here any further, please use Google if you don't know what XML is. You'll see, it is rather easy to understand. -The XML file used for the VLC skins follows a predefined DTD. You can find this DTD in VLC SVN, and its reading is strongly advised, since it contains the default values used for the parameters. A skin that does not follow the DTD with which VLC was compiled won't be loaded by VLC (and it might even crash it...). +The XML file used for the VLC skins follows a predefined DTD. You can find this DTD in VLC Git, and its reading is strongly advised, since it contains the default values used for the parameters. A skin that does not follow the DTD with which VLC was compiled won't be loaded by VLC (and it might even crash it...). For a better undestanding of what follows, you should have a look at the DTD and/or at an example of valid XML skin. @@ -175,6 +176,11 @@ difficulty to understand how VLC skins work. Only used in animated bitmaps; it is the number of frames (images) per seconds of the animation. (since VLC 0.8.5) Default value: 0 + + loop + Only used in animated bitmaps; it is the number of loops before animation stops. Default value 0 means animation doesn't stop. Otherwise, animation stops on the last frame after the number of loops has been reached (since VLC 1.1) + Default value: 0 + @@ -215,6 +221,10 @@ difficulty to understand how VLC skins work. fps Same as in Bitmap tag. + + loop + Same as in Bitmap tag. + @@ -265,6 +275,7 @@ difficulty to understand how VLC skins work. id Name of the window (it may be used for actions). Two windows cannot have the same id. Default value: none + As of vlc1.1, a special id has been added to provide a skinnable fullscreen controller. This value id="fullscreenController" allows the window to be displayed only in fullscreen mode. Display is toggled by pressing the 'i' hotkey or clicking the mouse middle button visible @@ -363,10 +374,12 @@ difficulty to understand how VLC skins work. width Initial width of this container box (see the Layout model for more details). + Required. height Initial height of this container box (see the Layout model for more details). + Required. lefttop @@ -488,6 +501,7 @@ difficulty to understand how VLC skins work. resize Since VLC 0.8.2. Specify the behaviour of the image when it is resized. Possible values are 'mosaic' (the image is repeated as many times as necessary to reach the wanted dimensions) and 'scale' (the image is actually rescaled). Beware that the 'scale' behaviour is much slower than the 'mosaic' one, so make sure to use it only when it's really needed. + In future VLC 1.2. a third value 'scale2' is available to scale an image, yet preserving its aspect ratio. The image is centered and scaled either heightwise or widthwise to fill up as much area as possible. Extra borders are made transparent. Default value: mosaic. @@ -500,6 +514,11 @@ difficulty to understand how VLC skins work. Action triggered by a double-click on the control. See Actions for a list of possible actions. (Since VLC 0.8.5). Default value: none + + art + if set to true, the skin engine reuses the control to display the art file of the resource currently being played back. Usually, resize="scale2" is desirable, for art to be rendered in the best possible way. (in future VLC 1.2). + Default value: false + @@ -526,6 +545,11 @@ difficulty to understand how VLC skins work. Action executed when the button is clicked. See Actions for a list of possible actions. Default value: none + + tooltiptext + Tooltip associated with the button. See also Text variables. + Default value: + @@ -926,6 +950,12 @@ difficulty to understand how VLC skins work. vlc.snapshot(): Take a snapshot (since VLC 0.8.5). + + vlc.toggleRecord(): Start/Stop recording (since VLC 1.1). + + + vlc.nextFrame(): Advance one frame at a time (since VLC 1.1). + vlc.onTop(): Toggle the "Always on top" status (since VLC 0.8.0). @@ -995,6 +1025,12 @@ difficulty to understand how VLC skins work. WindowID.hide(): Hide the Window whose id attribute is 'WindowID'. + + WindowID.maximize(): Maximize the Window whose id attribute is 'WindowID'. Since VLC 0.9.0. + + + WindowID.unmaximize(): Unmaximize the Window whose id attribute is 'WindowID'. Since VLC 0.9.0. + WindowID.setLayout(LayoutID): Change the layout of the Window whose id attribute is 'WindowID', using the Layout whose id attribute is 'LayoutID'. @@ -1079,6 +1115,12 @@ difficulty to understand how VLC skins work. vlc.isSeekable: True when the stream is seekable, false otherwise. This one can be used if you want to display a slider only when seeking is allowed. + + vlc.canRecord: True if the stream can be recorded, false otherwise. (since vlc1.1) + + + vlc.isRecording: True if the stream is being recorded, false otherwise. (since vlc1.1) + vlc.isMute: True when the sound is mute (in VLC, not on your OS), false otherwise. @@ -1097,6 +1139,9 @@ difficulty to understand how VLC skins work. dvd.isActive: True when a DVD is currently playing. This variable can be used to display buttons associated to the dvd.* actions only when needed (since VLC 0.8.5). + + WindowID.isMaximized: True when the window whose id is "WindowID" is maximized, false otherwise (since VLC 0.9.0). + WindowID.isVisible: True when the window whose id is "WindowID" is visible, false otherwise. @@ -1153,7 +1198,7 @@ difficulty to understand how VLC skins work. A box inside a container box always defines how it should react when its container box is resized. Two different mechanisms are provided: corners anchoring (useful when resizing of the inner box is wanted, for example) and constant ratio (mainly useful to keep the inner box centered inside its parent): - corners anchoring: The top-left-hand corner (TL) and the bottom-right-hand corner (BR) of the inner box are "tied" to corners of the container box (TL, TR, BL or BR). When any resizing occurs, tied corners move together, which can move or resize the inner box. For example, if the TL corner of the inner box is tied to the TL corner of the container (let's write it TL/TL), and if the BR corner of the inner box is also tied to the TL corner of the container box (BR/TL), the inner box will not be resized, and will always stay at the same place (this is the default behaviour). If we have TL/TL and TL/BL, the inner box is resized vertically its container is resized. If we have TL/TR and BR/TR, the inner box moves with the TR corner of its container. We could even define TL/BR and BR/TL, in which case increasing the size of the container box would shrink the size of the inner box... until it disappears completely! + corners anchoring: The top-left-hand corner (TL) and the bottom-right-hand corner (BR) of the inner box are "tied" to corners of the container box (TL, TR, BL or BR). When any resizing occurs, tied corners move together, which can move or resize the inner box. For example, if the TL corner of the inner box is tied to the TL corner of the container (let's write it TL/TL), and if the BR corner of the inner box is also tied to the TL corner of the container box (BR/TL), the inner box will not be resized, and will always stay at the same place (this is the default behaviour). If we have TL/TL and TL/BL, the inner box is resized vertically when its container is resized. If we have TL/TR and BR/TR, the inner box moves with the TR corner of its container. We could even define TL/BR and BR/TL, in which case increasing the size of the container box would shrink the size of the inner box... until it disappears completely! This mechanism is controlled by the lefttop and rightbottom attributes of the controls. @@ -1234,26 +1279,17 @@ VLC is able to give warnings and error messages about a loaded skin if it finds Relative paths - - -For the Bitmap tags, do not use absolute paths but relative paths (they are relative to the XML file directory), so that your skin can be reused by anybody without a particular file structure. - + For the Bitmap tags, do not use absolute paths but relative paths (they are relative to the XML file directory), so that your skin can be reused by anybody without a particular file structure. Get inspiration - - -In order to use plainly the possibilities given, you should look at how existing skins are made, it may give you ideas for your own skins... - + In order to use plainly the possibilities given, you should look at how existing skins are made, it may give you ideas for your own skins... You can also consult on the wiki a list of features usually expected from a skin. Submit your skin! - - -Once your skin is finished, you can share it with other people. The easiest way is probably to send it by email to vlc -at- videolan -dot- org, so that we can put it on the website with the other ones. - + Once your skin is finished, you can share it with other people. The easiest way is probably to send it by email to vlc -at- videolan -dot- org, so that we can put it on the website with the other ones. You can also post it in the skins forum. Feel free to ask for support there if you have any problems...