ReNamer:Pascal Script

From den4b Wiki
Revision as of 16:59, 13 August 2009 by Krtek (talk | contribs) (Script cookbook)
Jump to: navigation, search

The PascalScript Rule in ReNamer uses Pascal Script component to allow users to program their own renaming rule.

To master Pascal Script, follow these steps:

  1. Learn the basic syntax and concepts 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 scripts

Let us see these steps in more details.

Learn Pascal Script

To learn the basics of Pascal Script, please refer to the Pascal Script Quick Guide.

Types and functions

In this section, we will see all types, procedures and functions which can be used within ReNamer.

Note: Most of these are not part of the "standard" Pascal Script, so you will not find them in other applications.

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
  8. How to work with folders and paths(FilePath)
  9. How to break the script execution
  10. How to read file content
  11. How to import functions

Scripts at the User Forum

The User Forum contains several ready scripts. Some examples are listed on the Scripts page. 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.
  • 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! Remember that scripts are executed during Preview (NOT Rename) operation. So you let the script alter your system by pressing Preview or having Auto Preview on.

Important: The only product of PascalScript that doesn't affect your files until Rename operation is the content of the FileName variable. "New Name" (and "New Path") fields of filetable are replaced with this variable content. After Preview you may check if you like them and if you do - press Rename. Only then the actual renaming of the files will take place.

External links

Developers of the Pascal Script component.
Help and reference for the fundamentals of the Delphi/Pascal language.