LiteStep v. 0.24.6 documentation

written by the LiteStep Documentation Effort, August 2000
Changes.TXT

  .: introduction   .: configuration   .: installation   .: theme installation   .: theme creation   .: development   .: glossary   .: links  
  .: command   .: desktop   .: hotkey   .: litestep   .: lstime   .: popup   .: shortcut   .: systray   .: taskbar   .: vwm   .: wharf  

Step.RC Parameter Descriptions
Here is a list of definitions for each of the different types of parameters used by Step.RC commands for the core modules.
ACTION Refers to a LiteStep !Bang command or a Windows executable. If the Action is an executable whose location is not already known to Windows, it must be referenced either with a full path or with Environment Variables. To specify that no action be executed, use the the dummy !Bang command, !None.

Note: To determine whether Windows knows the location of a particular executable, simply type the executable name in the Run dialog box and see if the program starts successfully.

BOOL A BOOL is a positive or negative statement used to tell the module to either make the Step.RC statement active or not. Allowed BOOL values are true/false, yes/no, and on/off. If no BOOL is specified after the statement, it is assumed to be True.
COLOR All COLOR settings in the Step.RC can be written in two different formats. Both formats combine Red (R), Green (G) and Blue (B) components to create a final color. The hexadecimal color format accepts values from 00 - FF for each RGB component and is expressed in the form "RRGGBB". An alternative format accepts values from 0 - 255 for each RGB component and is expressed in the form "RRR GGG BBB".

Example: "304C80" and "048 76 128" are both valid representations of the same color.

FILE The location of a specific file on your system. This can be referenced with a full path or with Environment Variables.
FOLDER The location of any directory on your system. This can be referenced with a full path or with Environment Variables.
HEIGHT
WIDTH
HEIGHT refers to the distance in pixels from the top of the module's display to the bottom of the display. Likewise, WIDTH refers to the pixel distance from the left side to the right side of the module's display.
ICON Icons can be referenced in two ways. Firstly, by entering the exact location of the .ico file on your system. Secondly, icons can be extracted from the applications that hold them. This is achieved by using the .extract command in your Step.RC. You must specify the location of the file containing the icons, as well as which number icon you wish to use. In modules that support it, .extract can be used wherever an image is required.

Example: .extract="C:\mirc\mirc32.exe",1

Note: Icons can be extracted from files with .exe and .dll extensions.

IMAGE.BMP All LiteStep images must be in Windows bitmap format and can be referenced in the Step.RC in two ways. If the image is stored in the LSImageFolder directory, it can be referenced with only the filename. If the image is stored outside the LSImageFolder directory, it must be referenced either with a full path or with Environment Variables. To specify that no image should be used, simply enter ".none".
NUMBER LiteStep only accepts integers (positive or negative whole numbers) for numeric parameters. Appropriate values differ between each Step.RC command.
SOUND.WAV This is used to set a sound for an action within a module. The location of the sound file must be referenced either with a full path or with Environment Variables. All sounds must be in wave format. To specify that no sound should be used, simply enter ".none".
STRING Any sequence of alphanumeric characters enclosed in single or double quotes.
X Co-ordinate
Y Co-ordinate
These commands are used to position modules on the desktop. X Co-ordinate refers to the horizontal position of the module and is expressed in the number of pixels from the left hand side of the screen. If a negative number is used, it is taken as the number of pixels from the right hand side of the screen.
Y Co-ordinate refers to the vertical position of the module and is expressed in the number of pixels from the top of the screen. If a negative number is used, the position is taken from the bottom of the screen.

Note: Negative co-ordinates are useful for making resolution-independent themes.