Difference between revisions of "ReNamer:Pascal Script"

From den4b Wiki
Jump to navigation Jump to search
m (→‎Script cookbook: reuse variable article redirect fixed)
(→‎Tips: Minor corrections.)
 
(3 intermediate revisions by the same user not shown)
Line 22: Line 22:
 
*[[ReNamer:Pascal Script:Functions|Procedures and functions]]
 
*[[ReNamer:Pascal Script:Functions|Procedures and functions]]
  
−
<span style="color: red">Note:</span> Most of these are <u>not</u> part of the "standard" Pascal Script, so you will not find them in other applications.
+
<span style="color: red">Note:</span> Most of these are <u>not</u> part of the "standard" Pascal Script, so you may not find them in other applications.
  
 
== Script cookbook ==
 
== Script cookbook ==
Line 55: Line 55:
 
A few quick tips:  
 
A few quick tips:  
  
−
* In Pascal Script, ReNamer has defined the '''FileName''' variable to represent the New Name of the File. <br>Therefore, in your script, you will have to manipulate this variable to change the filename.  
+
* In Pascal Script, ReNamer has defined the '''FileName''' variable to represent the "New Name" of a file. Therefore, in your script, you will have to manipulate this variable to change the filename. Changes to the '''FileName''' variable do not actually change the name of the file, they simply change the value in the "New Name" column. Changes are applied only when you click the "Rename" button.
−
* The '''FilePath''' constant holds the original path of the file. It allows you to access the file directly.<br>
+
* 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 [[ReNamer:Pascal Script:Import functions|importing of external functions from DLLs]].<br>
+
* ReNamer supports User Defined Functions (UDF) and also [[ReNamer:Pascal Script:Import functions|importing of external functions from DLLs]].
−
* Try to use '''WideString '''[[ReNamer:Pascal Script:Types|type]] instead of an ordinary '''String''' type. This will allow ReNamer to handle Unicode filenames.<br>(In other words, it will be able to handle non-English scripts, such as Cyrillic, Asian, German, French, etc.)
+
* Try to use '''WideString '''[[ReNamer:Pascal Script:Types|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.
 +
* You may use <code>{$INCLUDE 'filename.inc'}</code> directive to include code from an external file, allowing for easier reuse and better organization of your code. ''Available since v6.5.0.1 Beta.''
  
−
<span style="color: red">'''Warning:''' Do not override ReNamer's built-in variables, types and functions.</span>
+
<div style="color: red">
−
 
+
'''Warnings:'''
−
<span style="color: red">'''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.</span>
+
* Do not override ReNamer's built-in variables, types and functions.
−
 
+
* Some functions are able to alter your file system, e.g. create new folders, change file content, delete files, etc. Use such functions with caution!
−
'''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.
+
* Remember that scripts are executed during the Preview (not the Rename) operation and can also get executed automatically if Auto Preview is enabled.
 +
</div >
  
 
== External links ==
 
== External links ==

Latest revision as of 19:47, 7 March 2022

Arrow Return.png ReNamer  

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 the basics

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 may 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 constant)
  9. How to break the script execution
  10. How to read file content
  11. How to import functions
  12. How to split file path into parts (folders, base, extension)
  13. How to store/load variables for later reuse

Scripts repository

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 a file. Therefore, in your script, you will have to manipulate this variable to change the filename. Changes to the FileName variable do not actually change the name of the file, they simply change the value in the "New Name" column. Changes are applied only when you click the "Rename" button.
  • The FilePath constant holds the original path of the file. It allows you to access the file directly.
  • ReNamer supports User Defined Functions (UDF) 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.
  • You may use {$INCLUDE 'filename.inc'} directive to include code from an external file, allowing for easier reuse and better organization of your code. Available since v6.5.0.1 Beta.

Warnings:

  • Do not override ReNamer's built-in variables, types and functions.
  • Some functions are able to alter your file system, e.g. create new folders, change file content, delete files, etc. Use such functions with caution!
  • Remember that scripts are executed during the Preview (not the Rename) operation and can also get executed automatically if Auto Preview is enabled.

External links

Developers of the Pascal Script component.
Help and reference for the fundamentals of the Delphi/Pascal language.
Retrieved from "http://www.den4b.com/w/index.php?title=ReNamer:Pascal_Script&oldid=3468"