]> git.sesse.net Git - vlc/blobdiff - doc/skins/skins2-howto.xml
lua/intf: Fix a memleak.
[vlc] / doc / skins / skins2-howto.xml
index 55db43dc2daca0a598e640e6777bc323258d2733..0ff3d3022ae9e2174016b2aab07c57e5ffe250a4 100644 (file)
@@ -41,6 +41,7 @@ website</ulink>.
 </authorgroup>
 
 <keywordset>
+    <keyword>VLC</keyword>
     <keyword>Skin</keyword>
     <keyword>XML</keyword>
     <keyword>Bezier</keyword>
@@ -363,10 +364,12 @@ difficulty to understand how VLC skins work.</para>
   <sect3 id="panelwidth">
     <title>width</title>
     <para>Initial width of this container box (see the <link linkend="layoutmodel">Layout model</link> for more details).</para>
+    <para><emphasis>Required.</emphasis></para>
   </sect3>
   <sect3 id="panelheight">
     <title>height</title>
     <para>Initial height of this container box (see the <link linkend="layoutmodel">Layout model</link> for more details).</para>
+    <para><emphasis>Required.</emphasis></para>
   </sect3>
   <sect3 id="panellefttop">
     <title>lefttop</title>
@@ -526,6 +529,11 @@ difficulty to understand how VLC skins work.</para>
     <para>Action executed when the button is clicked. See <link linkend="actions">Actions</link> for a list of possible actions.</para>
     <para>Default value: none</para>
   </sect3>
+  <sect3 id="buttontooltiptext">
+    <title>tooltiptext</title>
+    <para>Tooltip associated with the button. See also <link linkend="textvars">Text variables</link>.</para>
+    <para>Default value: </para>
+  </sect3>
 </sect2>
 
 <sect2 id="Checkbox">
@@ -995,6 +1003,12 @@ difficulty to understand how VLC skins work.</para>
   <listitem><para>
     <emphasis>WindowID.hide()</emphasis>: Hide the <link linkend="Window">Window</link> whose <link linkend="windowid">id</link> attribute is 'WindowID'.
   </para></listitem>
+  <listitem><para>
+    <emphasis>WindowID.maximize()</emphasis>: Maximize the <link linkend="Window">Window</link> whose <link linkend="windowid">id</link> attribute is 'WindowID'. Since VLC 0.9.0.
+  </para></listitem>
+  <listitem><para>
+    <emphasis>WindowID.unmaximize()</emphasis>: Unmaximize the <link linkend="Window">Window</link> whose <link linkend="windowid">id</link> attribute is 'WindowID'. Since VLC 0.9.0.
+  </para></listitem>
   <listitem><para>
     <emphasis>WindowID.setLayout(LayoutID)</emphasis>: Change the layout of the <link linkend="Window">Window</link> whose <link linkend="windowid">id</link> attribute is 'WindowID', using the <link linkend="Layout">Layout</link> whose <link linkend="layoutid">id</link> attribute is 'LayoutID'.
   </para></listitem>
@@ -1097,6 +1111,9 @@ difficulty to understand how VLC skins work.</para>
   <listitem><para>
    <emphasis>dvd.isActive</emphasis>: True when a DVD is currently playing. This variable can be used to display buttons associated to the <link linkend="dvdactions">dvd.* actions</link> only when needed (since VLC 0.8.5).
   </para></listitem>
+  <listitem><para>
+    <emphasis>WindowID.isMaximized</emphasis>: True when the window whose <link linkend="windowid">id</link> is "WindowID" is maximized, false otherwise (since VLC 0.9.0).
+  </para></listitem>
   <listitem><para>
     <emphasis>WindowID.isVisible</emphasis>: True when the window whose <link linkend="windowid">id</link> is "WindowID" is visible, false otherwise.
   </para></listitem>
@@ -1153,7 +1170,7 @@ difficulty to understand how VLC skins work.</para>
 <para>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):</para>
 <itemizedlist>
   <listitem><para>
-    <emphasis>corners anchoring</emphasis>: 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!
+    <emphasis>corners anchoring</emphasis>: 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!
   </para>
   <para>This mechanism is controlled by the <link linkend="lefttop">lefttop</link> and <link linkend="rightbottom">rightbottom</link> attributes of the controls.
   </para></listitem>
@@ -1234,26 +1251,17 @@ VLC is able to give warnings and error messages about a loaded skin if it finds
 
   <sect2>
   <title>Relative paths</title>
-
-  <para>
-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.
-  </para>
+  <para>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.</para>
   </sect2>
 
   <sect2>
   <title>Get inspiration</title>
-
-  <para>
-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...
-  </para>
+  <para>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 <ulink url="http://wiki.videolan.org/DefaultSkinRequirements">on the wiki</ulink> a list of features usually expected from a skin. </para>
   </sect2>
 
   <sect2>
   <title>Submit your skin!</title>
-
-  <para>
-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.
-  </para>
+  <para>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 <ulink url="http://forum.videolan.org/viewforum.php?f=15">skins forum</ulink>. Feel free to ask for support there if you have any problems...</para>
   </sect2>
 
 </sect1>