* ./modules/gui/skins/src/vlcproc.cpp: added the "title" option to the

[vlc] / doc / skins / events-howto.txt

diff --git a/doc/skins/events-howto.txt b/doc/skins/events-howto.txt
index d03555a8327422d108bb0d503e2ce07f3df68363..c8968410474c70f70424a46a34fcb1f5cd905c76 100644 (file)
--- a/doc/skins/events-howto.txt
+++ b/doc/skins/events-howto.txt
@@ -1,5 +1,5 @@
 Before reading this document, you should first take a look at skins-howto.txt
-to understand general purpose about VLC skins.
+to understand the general functioning of VLC skins.
 
 What is an event ?
 ==================
@@ -16,7 +16,7 @@ How to create an event ?
 ========================
 
 An event describes a simple action as seen above.
-All attibutes are explained in the 'skins-howto.txt' file except the 'event'
+All attiributes are explained in the 'skins-howto.txt' file except the 'event'
 attribute wich is a bit special.
 In the 'event' attribute you will enter a simple script with the following
 syntax :
@@ -25,7 +25,7 @@ syntax :
 The number of parameters depends on EVENT.
 All this is case sensitive.
 Don't add spaces.
-EVENT is the action to execute, it can be one of the followings
+EVENT is the action to execute, it can be one of the following:
 
  - VLC_NOTHING:
    Action    : none, it executes nothing so don't use it !
@@ -65,23 +65,23 @@ EVENT is the action to execute, it can be one of the followings
    Parameters: none.
 
  - VLC_CHANGE_TRAY:
-   Action    : if VLC is not visible in system tray, show it, else, hide it.
+   Action    : if VLC is not visible in system tray, show it, else hide it.
    Parameters: none.
 
  - VLC_CHANGE_TASKBAR:
-   Action    : if VLC is not visible in taskbar, show it, else, hide it.
+   Action    : if VLC is not visible in taskbar, show it, else hide it.
    Parameters: none.
 
  - VLC_FULLSCREEN:
-   Action    : switch current playing file to fullscreen mode.
+   Action    : switch current playlist item to fullscreen mode.
    Parameters: none.
 
  - VLC_PLAY:
-   Action    : play stream.
+   Action    : play the stream.
    Parameters: none.
 
  - VLC_STOP:
-   Action    : stop playing stream.
+   Action    : stop the stream.
    Parameters: none.
 
  - VLC_PAUSE:
@@ -89,11 +89,11 @@ EVENT is the action to execute, it can be one of the followings
    Parameters: none.
 
  - VLC_NEXT:
-   Action    : go to next file in playlist.
+   Action    : go to the next file in the playlist.
    Parameters: none.
 
  - VLC_PREV:
-   Action    : go to previous file in playlist.
+   Action    : go to the previous file in the playlist.
    Parameters: none.
 
  - VLC_STREAMPOS:
@@ -122,14 +122,14 @@ EVENT is the action to execute, it can be one of the followings
    Parameters:
      1: ID of the window to open.
      2: Describe what to do. Nothing is opening. 'TRUE' is the same. 'FALSE' is
-        closing window. 'CHANGE' is switching between this to state.
+        closing window. 'CHANGE' is switching between these two states.
 
  - VLC_WINDOW_CLOSE:
    Action    : close a window with a fading effect if selected.
    Parameters:
      1: ID of the window to close.
      2: Describe what to do. Nothing is closing. 'TRUE' is the same. 'FALSE' is
-        opening window. 'CHANGE' is switching between this to state.
+        opening window. 'CHANGE' is switching between these two states.
 
  - CTRL_SET_SLIDER:
    Not supported yet.
@@ -141,8 +141,9 @@ EVENT is the action to execute, it can be one of the followings
    Action    : hide/show a control.
    Parameters:
      1: ID of the control to hide/show.
-     2: Describe what to do. Nothing is showing control. TRUE is the same. FALSE
-        is hiding control. CHANGE is switching between this to state.
+     2: Describe what to do. Nothing is showing control. 'TRUE' is the same.
+        'FALSE' is hiding control. 'CHANGE' is switching between these two
+        states.
 
  - CTRL_ID_ENABLED:
    Not supported yet.
@@ -160,13 +161,13 @@ EVENT is the action to execute, it can be one of the followings
      1: ID of the playlist.
 
 
-What to do with event ?
+What to do with events ?
 =======================
 
 When creating your event, you must assign an ID to each of them.
 Now you have to associate events with controls.
 Some attributes of some controls are supposed to be filled with those IDs. That
-is to say that when the action correspounding to the attribute will be done,
+is to say that when the action corresponding to the attribute will be done,
 the event associated will be executed. The best exemple is assigning an event
 to the 'onclick' attribute of a button control. The event will be executed when
 clicking on the button.