Difference between revisions of "ReNamer:Pascal Script"

From den4b Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
The [[ReNamer:Rules:PascalScript|'''PascalScript Rule''']] in ReNamer uses Pascal Script.  
 
The [[ReNamer:Rules:PascalScript|'''PascalScript Rule''']] in ReNamer uses Pascal Script.  
  
If you are new to Pascal script, follow these steps:  
+
To master Pascal script, follow these steps:  
  
 
#Learn the basic syntax of Pascal script  
 
#Learn the basic syntax of Pascal script  
Line 7: Line 7:
 
#Learn how to use these variables/functions/procedures in Pascal scripts <br>
 
#Learn how to use these variables/functions/procedures in Pascal scripts <br>
  
Let us see these steps in more details.<br>
+
Let us see these steps in more details.<br>  
  
== Learn Pascal script<br> ==
+
== Learn Pascal script<br> ==
  
Refer to the quick guide provided here:<br>
+
Refer to the quick guide provided here:<br>  
  
 
*[[ReNamer:Pascal Script:Pascal Script quick guide|Pascal Script Quick Guide]]
 
*[[ReNamer:Pascal Script:Pascal Script quick guide|Pascal Script Quick Guide]]
Line 24: Line 24:
 
== Script cookbook  ==
 
== Script cookbook  ==
  
In this section, we will see how to script for some common tasks.  
+
In this section, we will see how to write scripts for some common renaming tasks.  
  
 
They also demonstrate how to use ReNamer's types, procedures and functions.  
 
They also demonstrate how to use ReNamer's types, procedures and functions.  

Revision as of 02:22, 20 July 2009

The PascalScript Rule in ReNamer uses Pascal Script.

To master Pascal script, follow these steps:

  1. Learn the basic syntax of Pascal script
  2. Understand the specific variables, procedures and functions that are defined within ReNamer
  3. Learn how to use these variables/functions/procedures in Pascal scripts

Let us see these steps in more details.

Learn Pascal script

Refer to the quick guide provided here:

Types and functions defined in ReNamer

In this section, we will see all variable types, procedures and functions defined within ReNamer.
(These are not part of the "standard" Pascal Script; so you will not find them anywhere else.)

Script cookbook

In this section, we will see how to write scripts for some common renaming tasks.

They also demonstrate how to use ReNamer's types, procedures and functions.

  1. How to rename a file (using the FileName variable)
  2. How to skip extention (Basic FileName utilities) 
  3. How to convert the filename to ALLCAPS (the WideUpperCase function) 
  4. How to operate on words (Unicode string-handling routines) 
  5. How to serialize files (Basic conversion routines) 
  6. How to initialize variables
  7. How to create interactive dialogs (let the user decide)
  8. How to work with folders and paths (FilePath) 
  9. How to break the script execution


Scripts at the User Forum

The User Forum contains several ready scripts. Some examples are listed here. Study them and adopt them for your purpose.

Tips

A few quick tips:

  • In Pascal Script, ReNamer has defined the FileName variable to represent the New Name of the File.
    Therefore, in your script, you will have to manipulate this variable to change the filename.
  • The FilePath constant holds the original path of the file. It allows you to access the file directly.
  • ReNamer supports UDFs (User-Defined Functions) and also importing of external functions from DLLs.
    ??? what is the syntax for referencing such an external routine?
  • Try to use WideString type instead of an ordinary String type. This will allow ReNamer to handle Unicode filenames.
    (In other words, it will be able to handle non-English scripts, such as Cyrillic, Asian, German, French, etc.)

Warning: Do not override ReNamer's built-in variables, types and functions.

Warning: Some of the functions are able to alter your file system (create new folders, move files, etc.). So use them with caution!