den4b Wiki - User contributions [en]

ReNamer:Scripts

2019-05-20T09:39:40Z

Narayan: /* 3rd party libraries */

{{Up|ReNamer:Pascal Script}}

This page contains a collection of scripts which can be used in [[ReNamer]]'s [[ReNamer:Rules:PascalScript|PascalScript rule]].

== Educational scripts ==

{| class="wikitable"
! Script
! Description
|-
| [[ReNamer:Scripts:Initialize|Initialize]]
| How to initialize the code.
|-
| [[ReNamer:Scripts:Import DLL|Import DLL]]
| Demonstrates how to call functions of 3rd party DLL.
|-
| [[ReNamer:Scripts:Date and Time|Date and Time]]
| How to use date and time of the file.
|-
| [[ReNamer:Scripts:Move filename portion|Move filename portion]]
| How to move part of the filename to a new position.
|-
| [[ReNamer:Scripts:Index filenames|Index filenames]]
| How to insert an incrementing number into the filename.
|}

== 3rd party libraries ==

Each of these scripts needs a third-party software ("library").

Download the software as directed, and place in a particular folder. Then copy the script into the PascalScript Rule and save it. Restart ReNamer.

{| class="wikitable"
! Script
! Description
! Forum Link
|-
| [[ReNamer:Scripts:TrID|TrID]]
| Detecting file extension.
| http://www.den4b.com/forum/viewtopic.php?id=550
|-
| [[ReNamer:Scripts:Xpdf|Xpdf]]
| Extract PDF tags.
| http://www.den4b.com/forum/viewtopic.php?id=349
|-
| [[ReNamer:Scripts:Exiv2|Exiv2]]
| Extract EXIF/IPTC/XMP tags from any images.
| http://www.den4b.com/forum/viewtopic.php?id=407 http://www.den4b.com/forum/viewtopic.php?id=109
|-
| [[ReNamer:Scripts:MediaInfo|MediaInfo]]
| Extract meta information from audio and video files.
|}

== User scripts ==
The following scripts are taken from the User forum. In some cases, links are provided to the thread, so that you can check the details of the use case.

{| class="wikitable"
|-
! Script
! Description
! Forum Link
|-
| [[ReNamer:Scripts:Separate words|Separate words]]
| Insert a space in front of each capitalized letter.
| http://www.den4b.com/forum/viewtopic.php?pid=2529#p2529
|-
| [[ReNamer:Scripts:AVI video codec|AVI video codec]]
| Extract name of video codec used encoding AVI file.
| http://www.den4b.com/forum/viewtopic.php?pid=3484#p3484
|-
| [[ReNamer:Scripts:RegEx Case Convertion|RegEx Case Convertion]]
| Convert case of capturing groups of your regular expression.
| http://www.den4b.com/forum/viewtopic.php?pid=3454#p3454 http://www.den4b.com/forum/viewtopic.php?pid=3459#p3459
|-
| [[ReNamer:Scripts:Using MasterFile|Using MasterFile]]
| Renaming folder basing on the MetaTag of the first file in the folder. In this particular case: adding the ID3_Year metatag from the mp3 file to it's parent folder name.
| http://www.den4b.com/forum/viewtopic.php?pid=1626#p1626
|-
| [[ReNamer:Scripts:Hours span|Hours span]]
| Add hours to a date embedded in the filename in format "yyyy-mm-dd hh-nn-ss.JPG".
| http://www.den4b.com/forum/viewtopic.php?id=696
|-
| [[ReNamer:Scripts:Roman numerals serialization|Roman numerals serialization]]
| Serialization with Roman numerals.
| http://www.den4b.com/forum/viewtopic.php?id=828 http://www.den4b.com/forum/viewtopic.php?pid=3327#p3327
|-
| [[ReNamer:Scripts:EAN-13|EAN-13 checksum]]
| Calculate the checksum digit for the [http://en.wikipedia.org/wiki/EAN-13 EAN-13 barcode].
| http://www.den4b.com/forum/viewtopic.php?id=930
|-
| [[ReNamer:Scripts:Serialize duplicates|Serialize duplicates]]
|colspan="2"| Serialize duplicated filenames by append a counter to the filename.
|-
| [[ReNamer:Scripts:Partial case change|Partial case change]]
|colspan="2"| Change case of specific parts of the file name.
|-
| [[ReNamer:Scripts:URL decode|URL decode]]
|colspan="2"| Decode a URL encoded filename.
|-
| [[ReNamer:Scripts:Index files per folder|Index files per folder]]
|colspan="2"| This script adds a serialization index to the end of every file on per folder basis. The index is incremented only when the folder path changes.
|-
| [[ReNamer:Scripts:Random characters and length|Random characters and length]]
|colspan="2"| Generate new names consisting of random selection of characters and of random length.
|-
| [[ReNamer:Scripts:Convert file content from ANSI to UTF-8|Convert file content from ANSI to UTF-8]]
|colspan="2"| Convert the content of processed files from ANSI (default system code page) to UTF-8 encoding.
|}

[[Category:ReNamer]]
[[Category:Pascal Script]]

ReNamer:Scripts

2019-05-20T09:38:44Z

Narayan: /* User scripts */

ReNamer:Scripts

2019-05-20T09:37:14Z

Narayan: /* 3rd party libraries */

{{Up|ReNamer:Pascal Script}}

This page contains a collection of scripts which can be used in [[ReNamer]]'s [[ReNamer:Rules:PascalScript|PascalScript rule]].

== Educational scripts ==

{| class="wikitable"
! Script
! Description
|-
| [[ReNamer:Scripts:Initialize|Initialize]]
| How to initialize the code.
|-
| [[ReNamer:Scripts:Import DLL|Import DLL]]
| Demonstrates how to call functions of 3rd party DLL.
|-
| [[ReNamer:Scripts:Date and Time|Date and Time]]
| How to use date and time of the file.
|-
| [[ReNamer:Scripts:Move filename portion|Move filename portion]]
| How to move part of the filename to a new position.
|-
| [[ReNamer:Scripts:Index filenames|Index filenames]]
| How to insert an incrementing number into the filename.
|}

== 3rd party libraries ==

Each of these scripts needs a third-party software ("library").

Download the software as directed, and place in a particular folder. Then copy the script into the PascalScript Rule and save it. Restart ReNamer.

{| class="wikitable"
! Script
! Description
! Forum Link
|-
| [[ReNamer:Scripts:TrID|TrID]]
| Detecting file extension.
| http://www.den4b.com/forum/viewtopic.php?id=550
|-
| [[ReNamer:Scripts:Xpdf|Xpdf]]
| Extract PDF tags.
| http://www.den4b.com/forum/viewtopic.php?id=349
|-
| [[ReNamer:Scripts:Exiv2|Exiv2]]
| Extract EXIF/IPTC/XMP tags from any images.
| http://www.den4b.com/forum/viewtopic.php?id=407 http://www.den4b.com/forum/viewtopic.php?id=109
|-
| [[ReNamer:Scripts:MediaInfo|MediaInfo]]
| Extract meta information from audio and video files.
|}

== User scripts ==

{| class="wikitable"
|-
! Script
! Description
! Forum Link
|-
| [[ReNamer:Scripts:Separate words|Separate words]]
| Insert a space in front of each capitalized letter.
| http://www.den4b.com/forum/viewtopic.php?pid=2529#p2529
|-
| [[ReNamer:Scripts:AVI video codec|AVI video codec]]
| Extract name of video codec used encoding AVI file.
| http://www.den4b.com/forum/viewtopic.php?pid=3484#p3484
|-
| [[ReNamer:Scripts:RegEx Case Convertion|RegEx Case Convertion]]
| Convert case of capturing groups of your regular expression.
| http://www.den4b.com/forum/viewtopic.php?pid=3454#p3454 http://www.den4b.com/forum/viewtopic.php?pid=3459#p3459
|-
| [[ReNamer:Scripts:Using MasterFile|Using MasterFile]]
| Renaming folder basing on the MetaTag of the first file in the folder. In this particular case: adding the ID3_Year metatag from the mp3 file to it's parent folder name.
| http://www.den4b.com/forum/viewtopic.php?pid=1626#p1626
|-
| [[ReNamer:Scripts:Hours span|Hours span]]
| Add hours to a date embedded in the filename in format "yyyy-mm-dd hh-nn-ss.JPG".
| http://www.den4b.com/forum/viewtopic.php?id=696
|-
| [[ReNamer:Scripts:Roman numerals serialization|Roman numerals serialization]]
| Serialization with Roman numerals.
| http://www.den4b.com/forum/viewtopic.php?id=828 http://www.den4b.com/forum/viewtopic.php?pid=3327#p3327
|-
| [[ReNamer:Scripts:EAN-13|EAN-13 checksum]]
| Calculate the checksum digit for the [http://en.wikipedia.org/wiki/EAN-13 EAN-13 barcode].
| http://www.den4b.com/forum/viewtopic.php?id=930
|-
| [[ReNamer:Scripts:Serialize duplicates|Serialize duplicates]]
|colspan="2"| Serialize duplicated filenames by append a counter to the filename.
|-
| [[ReNamer:Scripts:Partial case change|Partial case change]]
|colspan="2"| Change case of specific parts of the file name.
|-
| [[ReNamer:Scripts:URL decode|URL decode]]
|colspan="2"| Decode a URL encoded filename.
|-
| [[ReNamer:Scripts:Index files per folder|Index files per folder]]
|colspan="2"| This script adds a serialization index to the end of every file on per folder basis. The index is incremented only when the folder path changes.
|-
| [[ReNamer:Scripts:Random characters and length|Random characters and length]]
|colspan="2"| Generate new names consisting of random selection of characters and of random length.
|-
| [[ReNamer:Scripts:Convert file content from ANSI to UTF-8|Convert file content from ANSI to UTF-8]]
|colspan="2"| Convert the content of processed files from ANSI (default system code page) to UTF-8 encoding.
|}

[[Category:ReNamer]]
[[Category:Pascal Script]]

ReNamer:Scripts

2019-05-20T09:29:40Z

Narayan: /* 3rd party libraries */

{{Up|ReNamer:Pascal Script}}

This page contains a collection of scripts which can be used in [[ReNamer]]'s [[ReNamer:Rules:PascalScript|PascalScript rule]].

== Educational scripts ==

{| class="wikitable"
! Script
! Description
|-
| [[ReNamer:Scripts:Initialize|Initialize]]
| How to initialize the code.
|-
| [[ReNamer:Scripts:Import DLL|Import DLL]]
| Demonstrates how to call functions of 3rd party DLL.
|-
| [[ReNamer:Scripts:Date and Time|Date and Time]]
| How to use date and time of the file.
|-
| [[ReNamer:Scripts:Move filename portion|Move filename portion]]
| How to move part of the filename to a new position.
|-
| [[ReNamer:Scripts:Index filenames|Index filenames]]
| How to insert an incrementing number into the filename.
|}

== 3rd party libraries ==

Each of these scripts needs a third-party software. You have to download the software as directed, and place in a particular folder. Then copy the script into the PascalScript Rule and save it. Restart ReNamer. Now add a new rule with the new script.

{| class="wikitable"
! Script
! Description
! Forum Link
|-
| [[ReNamer:Scripts:TrID|TrID]]
| Detecting file extension.
| http://www.den4b.com/forum/viewtopic.php?id=550
|-
| [[ReNamer:Scripts:Xpdf|Xpdf]]
| Extract PDF tags.
| http://www.den4b.com/forum/viewtopic.php?id=349
|-
| [[ReNamer:Scripts:Exiv2|Exiv2]]
| Extract EXIF/IPTC/XMP tags from any images.
| http://www.den4b.com/forum/viewtopic.php?id=407 http://www.den4b.com/forum/viewtopic.php?id=109
|-
| [[ReNamer:Scripts:MediaInfo|MediaInfo]]
| Extract meta information from audio and video files.
|}

== User scripts ==

{| class="wikitable"
|-
! Script
! Description
! Forum Link
|-
| [[ReNamer:Scripts:Separate words|Separate words]]
| Insert a space in front of each capitalized letter.
| http://www.den4b.com/forum/viewtopic.php?pid=2529#p2529
|-
| [[ReNamer:Scripts:AVI video codec|AVI video codec]]
| Extract name of video codec used encoding AVI file.
| http://www.den4b.com/forum/viewtopic.php?pid=3484#p3484
|-
| [[ReNamer:Scripts:RegEx Case Convertion|RegEx Case Convertion]]
| Convert case of capturing groups of your regular expression.
| http://www.den4b.com/forum/viewtopic.php?pid=3454#p3454 http://www.den4b.com/forum/viewtopic.php?pid=3459#p3459
|-
| [[ReNamer:Scripts:Using MasterFile|Using MasterFile]]
| Renaming folder basing on the MetaTag of the first file in the folder. In this particular case: adding the ID3_Year metatag from the mp3 file to it's parent folder name.
| http://www.den4b.com/forum/viewtopic.php?pid=1626#p1626
|-
| [[ReNamer:Scripts:Hours span|Hours span]]
| Add hours to a date embedded in the filename in format "yyyy-mm-dd hh-nn-ss.JPG".
| http://www.den4b.com/forum/viewtopic.php?id=696
|-
| [[ReNamer:Scripts:Roman numerals serialization|Roman numerals serialization]]
| Serialization with Roman numerals.
| http://www.den4b.com/forum/viewtopic.php?id=828 http://www.den4b.com/forum/viewtopic.php?pid=3327#p3327
|-
| [[ReNamer:Scripts:EAN-13|EAN-13 checksum]]
| Calculate the checksum digit for the [http://en.wikipedia.org/wiki/EAN-13 EAN-13 barcode].
| http://www.den4b.com/forum/viewtopic.php?id=930
|-
| [[ReNamer:Scripts:Serialize duplicates|Serialize duplicates]]
|colspan="2"| Serialize duplicated filenames by append a counter to the filename.
|-
| [[ReNamer:Scripts:Partial case change|Partial case change]]
|colspan="2"| Change case of specific parts of the file name.
|-
| [[ReNamer:Scripts:URL decode|URL decode]]
|colspan="2"| Decode a URL encoded filename.
|-
| [[ReNamer:Scripts:Index files per folder|Index files per folder]]
|colspan="2"| This script adds a serialization index to the end of every file on per folder basis. The index is incremented only when the folder path changes.
|-
| [[ReNamer:Scripts:Random characters and length|Random characters and length]]
|colspan="2"| Generate new names consisting of random selection of characters and of random length.
|-
| [[ReNamer:Scripts:Convert file content from ANSI to UTF-8|Convert file content from ANSI to UTF-8]]
|colspan="2"| Convert the content of processed files from ANSI (default system code page) to UTF-8 encoding.
|}

[[Category:ReNamer]]
[[Category:Pascal Script]]

ReNamer:Rules:PascalScript

2019-05-20T09:24:19Z

Narayan: /* Borrowing scripts from forum */

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:RegEx|next=ReNamer:Rules:UserInput}}

[[Image:PascalScriptRule.png|center]]

This rule uses [[ReNamer:Pascal Script|Pascal Script programming engine]] with syntax and conventions similar to Delphi/Pascal. ReNamer comes with some preloaded scripts. We will see how to use them, and how to add a new script.

== Using a ready script ==

# Click on the [[Image:ScriptsButton.png]] button (located just below the '''Configuration '''pane).
#: A list of scripts appears.
#: [[Image:PascalScriptsMenu.png]]
# All available scripts are listed ''above'' the line. Click on any script to load it into the '''Configuration '''pane.
# Edit the script if required
# Press [[Image:AddRuleButton.png]] button to add the script to the rule stack.

Alternatively, you can ''drag and drop'' an existing file from your desktop of favourite explorer straight into the script window.

Hold <tt>SHIFT</tt> key when opening a new script to insert it into the current script at the cursor position, instead of completely replacing the current script. This can be useful when you store your commonly used functions in separate script files, and with this feature they can be easily merged into the current script.

== Borrowing readymade scripts ==

Even if you do not know how to write a script, you can easily use scripts written by others.

There are two sources of such readymade scripts:
1. The [http://www.den4b.com/wiki/ReNamer:Scripts '''Scripts repository''']
2. The [http://www.den4b.com/forum/ '''User Forum''']

Search for a suitable script.

Some of these scripts have embedded comments about how to customize the script. If you cannot find a suitable script, you can request other users to write the script for you (or customize an existing script).

'''TIP:''' If you are looking for scripts only, try to use '''begin''' or '''end''' words in your search phrase as these are the words that are present in every single script.

Once you find such a script, follow these simple steps:

{| class="wikitable"
|-
! Step
! Details
|-
! 1
| '''Copy the script'''
Copy the script from the forum (ensure that nothing is left out).

|-
! 2
| '''Clear the ReNamer's Configuration pane'''
Open the '''Pascal Script''' Rule in ReNamer. Select the three lines you see in the '''Configuration''' pane, and press DEL or paste the script while these lines are selected.
*The three lines already provided in the window are meant to begin a script from scratch; but since you are pasting a ready-made script, they must be removed first, otherwise they will interfere with your script.

|-
! 3
| '''Paste the script into ReNamer pane'''
Use the '''CTRL+V''' shortcut or right-click and select '''Paste'''.

|-
! 4
| '''Compile the script'''
Press the [[Image:TryToCompileButton.png]] button.

*In case some error comes up, the error message will identify the line number of the faulty statement.
*:You can try and troubleshoot the problematic statement in the script using the [[Image:GotoButton.png]] button.
*:ReNamer opens a window like this:
*:<center>[[Image:GotoLineDialog.png]]</center>
*:Now enter the line number in the window and press '''OK'''. It takes you to the faulty statement.
*: Try to edit the statement and compile the script again.
*: (Note that if the script compiles successfully, the [[Image:GotoButton.png]] button is not required at all.)

|-
! 5
| '''Saving the script and giving it a name:'''
The '''save '''button is hidden under the '''scripts '''menu. So first click on the [[Image:ScriptsButton.png]] button. It pops up a window like this:
<center>[[Image:PascalScriptsMenu.png]]</center>
Note that all the existing scripts are listed here. (When you save the new script, it will also be added to this list.)

Select the '''Save script... '''option (at the very bottom of the menu). Another window pops up.
<center>[[Image:SaveScriptDialog.png]]</center>
Enter a name that suggests the function of your script. Press '''OK'''. The new name is added to the list of scripts. Now use it as described [[#Using_a_ready_script|above]].

|}

== Writing your own scripts ==

To write your own scripts, you must have knowledge of Pascal script. Learning Pascal script is easy. Refer to the [[ReNamer:Pascal Script|Pascal Script section]].

Here, we will assume that you already know how to write pascal scripts.

The step-by-step procedure is as follows:

# Click in the Configuration pane and enter the script directly. (You can also copy it from anywhere and paste it into the pane by pressing '''CTRL+V'''. Or right-click in the pane and select the '''Paste''' option from the context menu.)
# Compile the script by pressing the [[Image:TryToCompileButton.png]] button located below the Configuration pane.
#* If an error message comes up, troubleshoot the script. The fault message usually includes the line number of the problematic statement in the script. Press the [[Image:GotoButton.png]] button and enter that line number to locate the faulty statement quickly. Then correct the errors and press the [[Image:TryToCompileButton.png]] button again. Repeat this till a '''''Compiled successfully!''''' message pops up.
# Now you can add the script as a rule by pressing [[Image:AddRuleButton.png]] button or save it for later use.
# To save the script press the [[Image:ScriptsButton.png]] button. A list pops up:
#: <center>[[Image:PascalScriptsMenu.png]]</center>
# Click on the '''Save Script...'''(the last option in the list). Now this script is added to the list (it appears above the line in the list).
#* Now you can use that script as described [[#Using a ready script|above]].

[[Category:ReNamer]]

ReNamer:Rules:Rearrange

2018-10-13T03:40:15Z

Narayan: /* Rearrange rule */

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Replace|next=ReNamer:Rules:Extension}}

== Rearrange rule ==

[[Image:RearrangeRule.png|center]]

This rule allows you to chop up the existing file name and reuse any/all of the parts in any order to compose a new name.

*You can also add your own text, or use meta tags while composing the new name.
*You can also use the whole original name, and insert literal text (or meta tags) around it. 

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Description
|-
| Split using
|
Specifies how to split the existing name into parts.

*You can use only one of the three options at a time (you cannot combine the chopping methods)

For detailed explanation of split methods please look below at the [[#Split options explained|split options explained]] section.

|-
| Right-to-left
|
If selected, the numbering starts from right.

*The characters of the original names are counted from right (the count begins with 1)
*The chopped parts will also be numbered from right ($1, $2, etc.)

|-
| [[Image:PlusButton.png]]
| Add a separator for additional delimiters. The separator is a "{{Pipe}}" (vertical pipe) character, which can also be entered manually.
|-
| New pattern
|
How to compose the new name from the parts created from the original name (see above).

*You can add meta tags and literal text wherever you want.
*$0 refers to the whole original name. This allows you to quickly compose a new name by inserting a string at the beginning and/or end.

|-
| [[Image:ReNamer Insert Meta Tag Button.png]]
| Click the button to see a list of [[ReNamer:Meta Tags|meta-tags]]. Select any meta tag to insert it in the new name template.
|}

=== Split options explained ===

{| class="wikitable"
|-
! Option
! Description
|-
| Delimiters
|
Chop the name where the delimiter occurs.

*The delimiter can be a single character or a string.
*The chopped parts do ''not'' contain the delimiters (they are omitted totally)
*Spaces, numbers and symbols are treated like normal characters.
*Several delimiters can be used at a time. Use the {{pipe}} character to separate them.
*The chopped parts are numbered from left, as $1, $2, $3, etc.

:The same parts can be referred from the end as $-1, $-2, $-3, etc.

*If the delimiter occurs at the very beginning of the name, the resultant $1 contains nothing (because there is nothing on the left side of the delimiter).

'''Warning:''' The number of parts into which the filename is broken down depends solely on the number of delimiters in the filename. If you reference fewer parts in the output pattern that the number of available parts - not referenced parts will be lost! For example, take filename "Artist - Title" and to swap them around one would use " - " as a delimiter and "$2 - $1" as a new pattern which will result in "Title - Artist", but if some filename appears with more dashes like "Artist - Title - Album" the result will also be "Title - Artist" and last part will be lost. To make sure that no parts are lost use '''Exact pattern of delimiters''' option instead.

|-
| Positions
|
Chop the name at the indicated position (the position count begins with 1).

*If you enter position '''n''', ReNamer will chop the '''n'''-th character and all characters beyond that in a separate piece.
*Spaces, numbers and symbols are treated like normal characters.
*No part of the original name is omitted during chopping.
*You can enter multiple positions. Separate them with the '''*|*''' sequence.
*The chopped parts are numbered from left, as $1, $2, $3, etc.

:The same parts can be referred from the end as $-1, $-2, $-3, etc.

|-
| Exact pattern of delimiters
|
Chop the name using the exact pattern (sequence) of the delimiters.

With this option you basically define how many parts you want the filename to be split into and the order in which the delimiters must occur. If you specify 1 delimiter then you end up with exactly 2 parts, if you specify 2 delimiters you'll get 3 parts, and so on.

|}

== Examples ==

This rule is so versatile that it can be used in a huge number of ways.
Therefore its examples have been moved to a separate article [[ReNamer:Rules:Rearrange Examples|Rearrange Examples]].

[[Category:ReNamer]]

ReNamer:Rules:Case

2013-11-08T06:13:56Z

Narayan: /* Case Rule */

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Strip|next=ReNamer:Rules:Serialize}}

== Case Rule ==

[[Image:CaseRule.png|center]]

This rule changes the case of the filename. Options are: capitalize, to lower case, to upper case, invert case, and put only first letter capital (as in a sentence).

There is also an option to force case for specific text-fragments, such as CD, DVD, RF, etc. These fragments would not look natural in any other case (e.g. cd, dvd, rf), so the rule allows you to prevent changing the case of such terms in one stroke.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Case change
| Several options are offered.
*The case of each option itself illustrates how that option works. For example, '''Capitalize Every Word'''.

*'''Capitalize Every Word''' will first make all letters lowercase and then convert the first letter of each word into UPPERCASE.

*'''Capitalize AND Preserve''' will convert the first letter of each word into UPPERCASE; but will not affect the rest of the letters.

*'''all lower case''' will convert all letters to lowercase.

*'''ALL UPPERCASE''' will convert all letters to UPPERCASE.

*'''iNVERT cASE''' will change all capital letters to lowercase, and all lowercased letters to UPPERCASE.

*'''First letter capital''' will change only the first letter to UPPERCASE, and rest of the letters to lowercase. (Compare this with the '''Capitalize AND Preserve''' option above.)

* The '''(none of the above)''' option is provided to disable the case conversions listed above it, so you could independently use the options listed on the right side of the window. This allows you to convert the case of extension, or case-convert specific text fragments (see below).

|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.
|-
| Force case for fragments
|
This option forces the case of specified text-fragments (strings) in the file name.

Note: This check box is coupled with the box below it. (Enter the fragments in the box and then activate the option by selecting the check box.)

*You can set any case for the strings (ALLCAPS, Only first letter capitalized, lowercase, MixedCase, etc.)

*You can specify ''multiple'' strings at a time, each with its own case format. To separate the strings from each other, put a comma between them. (Note: In versions prior to v5.50, a space was used instead of a comma.) 

*The case for these strings will be set exactly as entered in the box, regardless of the options selected in '''Case change''' list.

Here are some typical examples of such strings:

{| class="wikitable"
|-
! Case
! Examples
|-
| ALLCAPS
| CD, DVD, TV, HTML, XML, C++, USA, GIMP
|-
| Only the First letter capitalized
| Java, India, English, Sunday, Easter, February
|-
| Mixed case
| OpenSUSE, OpenOffice, ReNamer

|}
|-
| Extension always upper case
| Forces the extension to uppercase.
'''Note:''' This setting overrides any other setting that can alter the extension. For example, consider a case where the '''all lowercase''' option is selected and the '''skip extension''' option is deselected. Logically, the extension should be converted into lowercase too. But if the '''Extension always upper case '''option is selected, the case of the extension will be converted to uppercase. This setting will override even the fragments case-conversion.

|-
| Extension always lower case
| Forces the extension to lowercase.
'''Note:''' This setting overrides any other setting that can alter the extension. For example, consider a case where the '''ALL UPPER CASE''' option is selected and the '''skip extension''' option is deselected. Logically, the extension should be converted into ALLCAPS. But if the '''Extension always lower case''' option is selected, the case of the extension will be converted to lowercase. This setting will override even the fragments case-conversion.

|}

[[Category:ReNamer]]

ReNamer:Pascal Script:Functions

2013-02-27T05:35:46Z

Narayan:

{{Go|up=ReNamer:Pascal Script|prev=ReNamer:Pascal Script:Types}}

ReNamer has many functions to manipulate the entities related to file names and do some more complex tasks for individual files. These entities may be derived from the existing filename, path, system date, meta tags from the file, strings entered by the user, etc. This functionality is available for use via the [[ReNamer:Rules:PascalScript|PascalScript rule]].

The difference between a "function" and a "procedure" is that while a function executes an algorithm and returns a value, a procedure just executes an algorithm without returning anything.

A common prefix '''Wide''' in the function name indicates that the function deals with [[Unicode]] strings (WideString). ReNamer has similar functions without '''Wide''' prefix, for processing '''ANSI''' strings. For example, '''ShowMessage''' and '''WideShowMessage''' procedures.

== Basic String Handling ==

{| class="wikitable"
|-
! Routine
! Remarks
|-
| procedure '''Insert'''(Source: String; var S: String; Index: Integer);
| Inserts the string '''S''' into string '''Source''' at position '''Index'''.
|-
| procedure '''Delete'''(var S: String; Index, Count: Integer);
| Deletes '''Count''' characters from the string '''S''', starting from position '''Index'''.
|-
| function '''Copy'''(S: String; Index, Count: Integer): String;
| Copies '''Count''' characters from string '''S''', starting at position '''Index''', and returns them as a new string.
|-
| function '''Pos'''(Substr: String; S: String): Integer;
| Returns the position of a string '''Substr''' in another string '''S'''.
|}

'''Note:''' Indexes of characters in strings are 1 based, so first character in string S would be S[1].

{{Top}}

== Length Management ==

{| class="wikitable"
|-
! Routine
! Remarks
|-
| procedure '''SetLength'''(var S: Array; NewLength: Integer);
| Sets the length of array variable '''S''' to '''NewLength'''.
|-
| procedure '''SetLength'''(var S: String; NewLength: Integer);
| Sets the length of string variable '''S''' to '''NewLength'''.
|-
| procedure '''SetLength'''(var S: WideString; NewLength: Integer);
| Sets the length of widestring '''S''' to '''NewLength'''.
|-
| function '''Length'''(const S: Array): Integer;
| Returns the length of array '''S ''' (number of elements).
|-
| function '''Length'''(const S: String): Integer;
| Returns the length of string '''S''' (number of characters).
|-
| function '''Length'''(const S: WideString): Integer;
| Returns the length of WideString '''S''' (number of characters).
|}

{{Top}}

== Unicode String Handling ==

{| class="wikitable"
|-
! Routine
! Remarks
|-
| procedure '''WideInsert'''(const Substr: WideString; var Dest: WideString; Index: Integer);
| Inserts '''Substr''' in '''Dest''' at position '''Index'''.
|-
| procedure '''WideDelete'''(var S: WideString; Index, Count: Integer);
| Deletes '''Count''' characters from '''S''', starting from the '''Index''' position.
|-
| procedure '''WideSetLength'''(var S: WideString; NewLength: Integer);
| Change the length of string '''S''' to a new length specified by '''NewLength'''. If new length is smaller than original, the string is truncated. If new length is greater than original, the string will be expanded but additional characters will not be initialized and can be anything.
|-
| function '''WideLength'''(const S: WideString): Integer;
| Returns the length of WideString '''S'''.
|-
| function '''WideCopy'''(const S: WideString; Index, Count: Integer): WideString;
| Returns '''Count''' characters from WideString '''S''', starting at position '''Index'''.
|-
| function '''WidePos'''(const SubStr, S: WideString): Integer;
| Find and occurrence of '''SubStr''' in '''S'''. Returns the position of first occurrence, or '''0''' if nothing was found.
|-
| function '''WidePosEx'''(const SubStr, S: WideString; Offset: Cardinal): Integer;
| Find and occurrence of '''SubStr''' in '''S''' but start searching from position specified by '''Offset'''. Returns the position of first occurrence, or '''0''' if nothing was found.
|-
| function '''WideUpperCase'''(const S: WideString): WideString;
| Returns the ALLCAPS version of the WideString '''S'''
|-
| function '''WideLowerCase'''(const S: WideString): WideString;
| Returns the lowercase version of the WideString '''S'''
|-
| function '''WideCompareStr'''(const S1, S2: WideString): Integer;
| Compares two WideStrings '''S1''' and '''S2''', case-sensitive, and returns an integer based on the result. The return value is less than 0 if S1 is less than S2, 0 if S1 equals S2, or greater than 0 if S1 is greater than S2.
|-
| function '''WideCompareText'''(const S1, S2: WideString): Integer;
| Compares two WideStrings '''S1''' and '''S2''', case-insensitive, and returns an integer based on the result. The return value is less than 0 if S1 is less than S2, 0 if S1 equals S2, or greater than 0 if S1 is greater than S2.
|-
| function '''WideSameText'''(const S1, S2: WideString): Boolean;
| Compares two WideStrings '''S1''' and '''S2''', case-insensitive. Returns TRUE if both are identical, otherwise returns FALSE.
|-
| function '''WideTextPos'''(const SubStr, S: WideString): Integer;
| Behaves like '''WidePos''' function, except text if processed in case-insensitive manner.
|-
| function '''WideTrim'''(const S: WideString): WideString;
| Removes leading and trailing spaces and control characters from the given string '''S'''.
|-
| function '''WideReplaceStr'''(const S, OldPattern, NewPattern: WideString): WideString;
| Returns the result of replacing on a string S, a string OldPattern (Case Sensitive), with a NewPattern.
|-
| function '''WideReplaceText'''(const S, OldPattern, NewPattern: WideString): WideString;
| Returns the result of replacing on a string S, a text OldPattern (Case Non-Sensitive), with a NewPattern.
|-
| function '''WideSplitString'''(const Input, Delimiter: WideString): TStringsArray;
|
Splits the '''Input''' wherever '''Delimiter''' occurs and returns an array that contains the split parts.

*The '''Delimiter''' itself can be a multi-character WideString. (Unlike the usual comma, hyphen or space that are used for this purpose)
*The split parts (returned as elements of the array) do not contain the '''Delimiter'''.

|-
|-
| function '''WideJoinStrings'''(const Strings: TStringsArray; const Delimiter: WideString): WideString;
| Joins all individual items from '''Strings''' into a single WideString, with '''Delimiter''' inserted between the joined items.
|-
| function '''WideCaseCapitalize'''(const S: WideString): WideString;
|
Returns the ''Sentence case'' version of the WideString '''S'''.

Only the first alphabetic character is capitalized. All other alphabetic characters are converted to lowercase. 

*If '''S''' begins with numeric characters, the first alphabetic character that follows will be capitalized.

|-
| function '''WideCaseInvert'''(const S: WideString): WideString;
| Inverts the case of all characters in the WideString '''S''' and returns the WideString. 
|}

{{Top}}

== Meta Tags Extraction ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''CalculateMetaTag'''(const FilePath: WideString; const MetaTagName String): String;
| Extracts and returns the value of a metatag specified by '''MetaTagName''' from the file specified by the complete absolute path '''FilePath'''.
|}

For example, to extract '''EXIF_Date''' tag from an image and set it to the filename, one can use something like this:
<source>
begin
FileName := CalculateMetaTag(FilePath, 'EXIF_Date');
end.
</source>

The full list of meta tags can be found in [[ReNamer:Meta Tags|Meta Tags]] article.

{{Top}}

== Regular Expressions ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''ReplaceRegEx'''(const Input, Find, Replace: WideString;const CaseSensitive, UseSubstitution: Boolean): WideString;
| Find-and-replace function using RegEx. Works like [[ReNamer:Rules:RegEx|RegEx rule]].

The parameters for this and next RegEx functions are:
* '''Input''' - The WideString that is input to the function.
* '''Find''' - RegEx pattern to be found (same as '''Expression''' field in the [[ReNamer:Rules:RegEx|RegEx rule]]).
* '''Replace''' - Replacement string (same as the '''Replace''' field in the [[ReNamer:Rules:RegEx|RegEx rule]]).
* '''CaseSensitive''' - Specifies whether to process in a case-sensitive mode.
* '''UseSubstitution''' - Determines whether use [[ReNamer:Regular Expressions#Backreferences|backreferences]] in the result.
|-
| function '''MatchesRegEx'''(const Input, Find: WideString;const CaseSensitive: Boolean): TStringsArray;
| Returns a list of RegEx matches as an array. Function returns an array of full matches, which matched the entire expression, not the sub-patterns. For example:
{| class="wikitable"
|-
! width="150" | Input
! width="100" | Find
! width="100" | Results
|-
| Ax1_-_Bx2---Cx3
| [A-Z]x\d
|
* Ax1
* Bx2
* Cx3
|-
| Ax1_-_Bx2---Cx3
| ([A-Z])x(\d)
|
* Ax1
* Bx2
* Cx3
|}
|-
| function '''SubMatchesRegEx'''(const Input, Find: WideString;const CaseSensitive: Boolean): TStringsArray;
| This function is very similar to '''MatchesRegEx''', but instead of returning full matches it will return an array of sub-expression matches for the '''first''' full match. For example:
{| class="wikitable"
|-
! width="150" | Input
! width="100" | Find
! width="100" | Results
|-
| Ax1_-_Bx2---Cx3
| [A-Z]x\d
| ''(empty)''
|-
| Ax1_-_Bx2---Cx3
| ([A-Z])x(\d)
|
* A
* 1
|}

In this way, it can easily be combined with '''MatchesRegEx''' function, to allow users to find all global matches, and then parse those matches through '''SubMatchesRegEx''' function to find individual sub-expression matches of each global match.
|}

{{Top}}

== Unicode Character Handling ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''IsWideCharUpper'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is in UPPERCASE.
|-
| function '''IsWideCharLower'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is in lowercase.
|-
| function '''IsWideCharDigit'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a digit (numeric character 0-9).
|-
| function '''IsWideCharSpace'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a white-space character, such as: space, form-feed, newline, carriage-return, tab and vertical-tab (characters classified as C1_SPACE).
|-
| function '''IsWideCharPunct'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a punctuation mark (characters classified as C1_PUNCT).
|-
| function '''IsWideCharCntrl'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a control character (characters classified as C1_CNTRL).
|-
| function '''IsWideCharBlank'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a blank, such as: space and tab (characters classified as C1_BLANK).
|-
| function '''IsWideCharXDigit'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a hexadecimal digit (0-9 or A-F).
|-
| function '''IsWideCharAlpha'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a alphanumeric character (a-z or A-Z).
|-
| function '''IsWideCharAlphaNumeric'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a alphanumeric character or a numeric character (a-z, A-Z or 0-9).
|-
| function '''WideCharUpper'''(const WC: WideChar): WideChar;
| Returns a UPPERCASE version of the input Unicode character. In case of non-alphabetic character, it returns the same character.
|-
| function '''WideCharLower'''(const WC: WideChar): WideChar;
| Returns a lowercase version of the input Unicode character. In case of non-alphabetic character, it returns the same character.
|}

'''Note:''' Character classifications, such as C1_UPPER, C1_LOWER, C1_DIGIT, C1_SPACE, C1_PUNCT, C1_CNTRL, C1_BLANK, C1_XDIGIT, C1_ALPHA - are part of Unicode definitions. More information regarding classification can be found on the internet. For example: [http://www.fileformat.info/info/unicode/ http://www.fileformat.info/info/unicode/].

{{Top}}

== Unicode Conversion ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideToAnsi'''(const WS: WideString): String;
| Converts a [[Unicode]] string to its [[ANSI]] version.
|-
| function '''AnsiToWide'''(const S: String): WideString;
| Converts a [[ANSI]] string to its [[Unicode]] version.
|-
| function '''UTF8Encode'''(const WS: WideString): String;
| Convert [[Unicode]] string to the [http://en.wikipedia.org/wiki/UTF-8 UTF-8] encoded string. Useful for storing Unicode strings in files, sometimes for compatibility reasons and sometimes to reduce the size of the file.
|-
| function '''UTF8Decode'''(const S: String): WideString;
| Convert [http://en.wikipedia.org/wiki/UTF-8 UTF-8] encoded string to its full [[Unicode]] representation.
|}

{{Top}}

== Basic Conversion ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''BoolToStr'''(B: Boolean): String;
| Convert boolean variable into a string. Returns '''True''' or '''False''' string.
|-
| function '''IntToStr'''(Value: Integer): String;
| Converts an integer to a string. The following assumptions are correct:
<div style="font-family: monospace">
* IntToStr(123) = '123'
* IntToStr(0123) = '123'
* IntToStr(123) <> '0123'
</div>
|-
| function '''StrToInt'''(const S: String): Integer;
| Converts a string to an integer. The following equalities are correct:
<div style="font-family: monospace">
* StrToInt('123') = 123
* StrToInt('123') = 0123
* StrToInt('0123') = 123
</div>
'''Warning:''' An error will occur if the parameter to this function cannot be converted to an integer!
|-
| function '''StrToIntDef'''(const S: String; const Default: Integer): Integer;
| Behaves like '''StrToInt''' function, but instead of producing an error on incorrect input function allows the '''Default''' value to be specified, which will be returned if the input cannot be converted to an integer.
|-
| function '''FloatToStr'''(Value: Extended): string;
| Converts supplied floating point value to its string representation, using default system format.
|-
| function '''StrToFloat'''(const S: string): Extended;
| Converts supplied string to a floating point value. '''Warning:''' An error will occur if the parameter to this function cannot be converted to a floating point value!
|-
| function '''StrToFloatDef'''(const S: string; const Default: Extended): Extended;
| Behaves like '''StrToFloat''' function, but instead of producing an error on incorrect input function allows the '''Default''' value to be specified, which will be returned if the input cannot be converted to a floating point value.
|-
| function '''FormatFloat'''(const Format: string; Value: Extended): string;
| Converts supplied floating point value to its string representation, using user specific '''Format'''. Format string may contain following specifiers:
{| class="wikitable"
! Specifier
! Represents
|-
| '''0''' (zero)
| Digit placeholder. If the value being formatted has a digit in the position where the "0" appears in the format string, then that digit is copied to the output string. Otherwise, a "0" is stored in that position in the output string.
|-
| '''#''' (hash)
| Digit placeholder. If the value being formatted has a digit in the position where the "#" appears in the format string, then that digit is copied to the output string. Otherwise, nothing is stored in that position in the output string.
|-
| '''.''' (dot)
| Decimal point. The first "." character in the format string determines the location of the decimal separator in the formatted value, any additional "." characters are ignored.
|-
| ''',''' (comma)
| Thousand separator. If the format string contains one or more "," characters, the output will have thousand separators inserted between each group of three digits to the left of the decimal point. The placement and number of "," characters in the format string does not affect the output.
|}
|-
| function '''DateToStr'''(D: TDateTime): String;
| Converts a date to a string, using system format for the short date, for example: '''dd/mm/yyyy'''.
|-
| function '''StrToDate'''(const S: String): TDateTime;
| Converts a date string to a proper TDateTime value, using system format for the short date, for example: '''dd/mm/yyyy'''.
|-
| function '''IntToHex'''(Value: Integer; Digits: Integer): String;
| Converts an integer to its hexadecimal representation. Here are samples:
<div style="font-family: monospace">
* IntToHex(1234, 1) = '4D2'
* IntToHex(1234, 8) = '000004D2'
</div>
|-
| function '''HexToInt'''(const HexNum: String): Integer;
| Converts a hexadecimal value to its decimal representation. '''Warning:''' An error will occur if the parameter to this function cannot be converted to an integer!
|-
| function '''HexToIntDef'''(const HexNum: String; Default: Integer): Integer;
| Behaves like '''HexToInt''' function, but instead of producing an error on incorrect input function allows the '''Default''' value to be specified, which will be returned if the input cannot be converted to an integer.
|-
| function '''Ord'''(X: Char): Byte;
| Return an ordinal value (byte representation) of a character.
|-
| function '''Chr'''(X: Byte): Char;
| Return a character by its ordinal value (byte representation).
|}

{{Top}}

== Date and Time ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''Date''': TDateTime;
| Returns the current system date.
|-
| function '''Time''': TDateTime;
| Returns the current system time.
|-
| function '''Now''': TDateTime;
| Returns the current system date and time.
|-
| function '''EncodeDate'''(Year, Month, Day: Word): TDateTime;
| Generates date value for the specified '''Year''', '''Month''', '''Day'''. Parameters must be within a valid date range: Year = 0..9999, Month = 1..12, Day = 1..31 (depending on month/year). An error will be raised if parameters are invalid.
|-
| function '''EncodeTime'''(Hour, Min, Sec, MSec: Word): TDateTime;
| Generates time value for the specified '''Hour''', '''Min''', '''Sec''', '''MSec'''. Parameters must be within a valid time range: Hour = 0..23, Min = 0..59, Sec = 0..59, MSec = 0..999. An error will be raised if parameters are invalid.
|-
| function '''TryEncodeDate'''(Year, Month, Day: Word; var Date: TDateTime): Boolean;
| Behaves exactly like '''EncodeDate''' function, except this function returns the TRUE or FALSE depending on the success of the operation. If operation was successful, function will return TRUE and the generated date value will be written in the '''Date''' variable.
|-
| function '''TryEncodeTime'''(Hour, Min, Sec, MSec: Word; var Time: TDateTime): Boolean;
| Behaves exactly like '''EncodeTime''' function, except this function returns the TRUE or FALSE depending on the success of the operation. If operation was successful, function will return TRUE and the generated time value will be written in the '''Time''' variable.
|-
| procedure '''DecodeDate'''(const DateTime: TDateTime; var Year, Month, Day: Word);
| Extracts '''Year''', '''Month''' and '''Day''' components from a given '''DateTime''' value.
|-
| procedure '''DecodeTime'''(const DateTime: TDateTime; var Hour, Min, Sec, MSec: Word);
| Extracts '''Hour''', '''Min''', '''Sec''' and '''MSec''' components from a given '''DateTime''' value.
|-
| function '''DayOfWeek'''(const DateTime: TDateTime): Word;
| Returns the day of the week (as an index) for the specified '''DateTime''' value. The indexes are: 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday.
|-
| function '''DateTimeToUnix'''(D: TDateTime): Int64;
| Converts '''D''' value of type '''TDateTime''' to a Unix timestamp.
|-
| function '''UnixToDateTime'''(U: Int64): TDateTime;
| Converts a Unix timestamp to a value of '''TDateTime''' type.
|-
| function '''FormatDateTime'''(const Fmt: String; D: TDateTime): String;
| This function provides rich formatting of a '''DateTime''' value into a string. [[ReNamer:Date and Time format|Date and time format]] is defined by the '''Fmt''' string.
|-
| function '''IncYear'''(const AValue: TDateTime; const ANumberOfYears: Integer): TDateTime;
| Increments a TDateTime variable by a number of years (plus or minus).
|-
| function '''IncMonth'''(const AValue: TDateTime; ANumberOfMonths: Integer): TDateTime;
| Increments a TDateTime variable by a number of months (plus or minus).
|-
| function '''IncWeek'''(const AValue: TDateTime; const ANumberOfWeeks: Integer): TDateTime;
| Increments a TDateTime variable by a number of weeks (plus or minus).
|-
| function '''IncDay'''(const AValue: TDateTime; const ANumberOfDays: Integer): TDateTime;
| Increments a TDateTime variable by a number of days (plus or minus).
|-
| function '''IncHour'''(const AValue: TDateTime; const ANumberOfHours: Int64): TDateTime;
| Increments a TDateTime variable by a number of hours (plus or minus).
|-
| function '''IncMinute'''(const AValue: TDateTime; const ANumberOfMinutes: Int64): TDateTime;
| Increments a TDateTime variable by a number of minutes (plus or minus).
|-
| function '''IncSecond'''(const AValue: TDateTime; const ANumberOfSeconds: Int64): TDateTime;
| Increments a TDateTime variable by a number of seconds (plus or minus).
|-
| function '''IncMilliSecond'''(const AValue: TDateTime; const ANumberOfMilliSeconds: Int64): TDateTime;
| Increments a TDateTime variable by a number of milliseconds (plus or minus).
|}

{{Top}}

== File Management ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideFileSize'''(const FileName: WideString): Int64;
| Returns the size of the file.
|-
| function '''WideFileExists'''(const FileName: WideString): Boolean;
| Check whether specified file exists. Returns TRUE if file exists, otherwise FALSE.
|-
| function '''WideDirectoryExists'''(const Directory: WideString): Boolean;
| Check whether specified directory exists. Returns TRUE if directory exists, otherwise FALSE.
|-
| function '''WideForceDirectories'''(Dir: WideString): Boolean;
| Makes sure that that all directories in the path exist. If they don't, function will try to create them, recursively. Returns TRUE if all folders exist or have been successfully created.
|-
| function '''WideCreateDir'''(const Dir: WideString): Boolean;
| Create specified directory (non-recursive). Returns TRUE on success, otherwise FALSE.
|-
| function '''WideDeleteFile'''(const FileName: WideString): Boolean;
| Delete physical file from the disk. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideRenameFile'''(const OldName, NewName: WideString): Boolean;
| Rename file from '''OldName''' to '''NewName'''. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideCopyFile'''(FromFile, ToFile: WideString; FailIfExists: Boolean): Boolean;
| Rename file from '''FromFile''' to '''ToFile'''. If '''FailIfExists''' flag is TRUE, file will not be copied when destination file already exists, otherwise, destination file will be overwritten. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideFileSearch'''(const Name, DirList: WideString): WideString;
| Search through the directories passed in '''DirList''' for a file named '''Name'''. DirList is a list of path names delimited by semicolons. If file matching Name is located, function returns a string specifying a path name for that file. If no matching file exists, function returns an empty string.
|-
| procedure '''WideScanDirForFiles'''(Dir: WideString; var Files: TStringsArray; const Recursive, IncludeHidden, IncludeSystem: Boolean; const Mask: WideString);
| You can get a list of the files inside a folder.
*'''Dir''': The folder you want to scan.
*'''Files''': Where the list of files is going to be saved.
*'''Recursive''': Do you want to scan the subfolders?
*'''IncludeHidden''': Do you want to list the hidden files?
*'''IncludeSystem''': Do you want to list the system files?
*'''Mask''': You can list everything ('*'), or only the files that contain some string (example: '*.txt').
|-
| procedure '''WideScanDirForFolders'''(Dir: WideString; var Folders: TStringsArray; const Recursive, IncludeHidden, IncludeSystem: Boolean);
| You can get a list of the folders inside other folder.
*'''Dir''': The folder you want to scan.
*'''Folders''': Where the list of folders is going to be saved.
*'''Recursive''': Do you want to scan the subfolders?
*'''IncludeHidden''': Do you want to list the hidden folders?
*'''IncludeSystem''': Do you want to list the system folders?
|}

{{Top}}

== File Name Utilities ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideExtractFilePath'''(const FileName: WideString): WideString;
| Returns the drive and directory portion from "FileName", including the trailing path delimiter, e.g. "C:\Folder\".
|-
| function '''WideExtractFileDir'''(const FileName: WideString): WideString;
| Returns the drive and directory portion from "FileName", excluding the trailing path delimiter, e.g. "C:\Folder".
|-
| function '''WideExtractFileDrive'''(const FileName: WideString): WideString;
| Returns the drive letter, e.g. "C:".
|-
| function '''WideExtractFileName'''(const FileName: WideString): WideString;
| Returns the filename with extension, e.g. "FileName.txt".
|-
| function '''WideExtractBaseName'''(const FileName: WideString): WideString;
| Returns the base name of the file, i.e. file name without extension and path components.

{|
! Input
! Output
|-
| Document.txt
| Document
|-
| C:\Folder\Document.txt
| Document
|}

|-
| function '''WideExtractFileExt'''(const FileName: WideString): WideString;
| Returns the file's extension with the dot, e.g. ".txt".
|-
| function '''WideChangeFileExt'''(const FileName, Extension: WideString): WideString;
| Replaces the original extension, and returns the new filename with extension, e.g. "FineName.txt" -> "FineName.pdf".
|-
| function '''WideStripExtension'''(const FileName: WideString): WideString;
| Strips off the extension from the filename, maintaining the path component unaffected.

{|
! Input
! Output
|-
| Document.txt
| Document
|-
| C:\Folder\Document.txt
| C:\Folder\Document
|}

|-
| function '''WideExpandFileName'''(const FileName: WideString): WideString;
| Converts the relative file name into a fully qualified path. This function does not verify that the resulting path refers to an existing file.
|-
| function '''WideExtractRelativePath'''(const BaseName, DestName: WideString): WideString;
| Creates a relative path to go from '''BaseName''' to '''DestName'''. For example:

{|
| '''BaseName:'''
| <nowiki>C:\Folder\FileName.txt</nowiki>
|-
| '''DestName:'''
| <nowiki>C:\Documents\Article.pdf</nowiki>
|-
| '''Result:'''
| <nowiki>..\Documents\Article.pdf</nowiki>
|}

|-
| function '''WideExtractShortPathName'''(const FileName: WideString): WideString;
| It converts a path into it's representation in DOS format.
|-
| function '''WideIncludeTrailingPathDelimiter'''(const S: WideString): WideString;
| With this function you can ensure that a path for a folder '''contains''' the path delimiter ("\") at the end of the path.
|-
| function '''WideExcludeTrailingPathDelimiter'''(const S: WideString): WideString;
| With this function you can ensure that a path for a file does '''not contain''' the path delimiter ("\") at the end of the path.
|-
| function '''WideSameFileName'''(const S1, S2: WideString): Boolean;
| Compares the filenames '''S1''' and '''S2''', and returns TRUE if they are identical.
|}

{{Top}}

== File Read/Write ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''FileReadFragment'''(const FileName: WideString; Start, Length: Integer): String;
| Starting at position '''Start''', read '''Length''' number of characters of the file '''FileName''' and return them as a string. '''Start''' is 0-based, so in order to start the fragment at the beginning of the file, set this parameter to 0 (zero).
|-
| function '''FileReadLine'''(const FileName: WideString; LineNum: Integer): String;
| Read a line from a file '''FileName''' specified by a line index '''LineNum'''. '''LineNum''' is 1 based, so to get the first line set this parameter to 1 (one). '''Note:''' This function is extremely inefficient and provided only for convenience!
|-
| function '''FileCountLines'''(const FileName: WideString): Integer;
| Count number of lines in the file. '''Note:''' This function is extremely inefficient and provided only for convenience!
|-
| function '''FileReadContent'''(const FileName: WideString): String;
| Return the entire content of the file as a String.
|-
| procedure '''FileWriteContent'''(const FileName: WideString; const Content: String);
| Write '''Content''' to the file. If target file already exists, it will be overwritten.
|-
| procedure '''FileAppendContent'''(const FileName: WideString; const Content: String);
| Append '''Content''' to the end of the file. If target file does not exist, it will be created.
|}

{{Top}}

== File Time ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''FileTimeModified'''(const FileName: WideString): TDateTime;
| Returns last modified time of the specified file.
|-
| function '''FileTimeCreated'''(const FileName: WideString): TDateTime;
| Returns creation time of the specified file.
|-
| function '''SetFileTimeCreated'''(const FileName: WideString; const DateTime: TDateTime): Boolean;
| Sets creation time for the specified file.
|-
| function '''SetFileTimeModified'''(const FileName: WideString; const DateTime: TDateTime): Boolean;
| Sets last modified time for the specified file.
|}

{{Top}}

== Process Execution ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''ShellOpenFile'''(const FileName: WideString): Boolean;
| Run (open) a file specified by '''FileName'''. Works like "Start > Run" command. Parameter does not have to be an executable file, it can by any file or protocol with assigned handler. For example, you can open a Word document or a web page, and associated application will be launched:
<div style="font-family: monospace">
* ShellOpenFile(<nowiki>'http://www.den4b.com/'</nowiki>);
* ShellOpenFile(<nowiki>'C:\Document.doc'</nowiki>);
</div>
|-
| function '''ExecuteProgram'''(const Command: String; WaitForProgram: Boolean): Cardinal;
| Execute a command line specified by parameter '''Command'''. Works like "Command Prompt". Parameter '''WaitForProgram''' allows you to specify whether the code needs to wait until the command (launched program) has finished executing.
|-
| function '''ExecConsoleApp'''(const CommandLine: String; out Output: String): Cardinal;
| Execute a command line specified by parameter '''CommandLine''' and record its standard output in the variable '''Output'''. Works like "Command Prompt". Should be used only for console style applications. Returns the exit code.
|}

{{Top}}

== Dialogs ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| procedure '''ShowMessage'''(const Msg: String);
| Show a simple dialog with the message specified by '''Msg''' parameter.
|-
| procedure '''WideShowMessage'''(const Msg: WideString);
| Same as '''ShowMessage''' function but parameter is Unicode text.
|-
| function '''DialogYesNo'''(const Msg: String): Boolean;
| Show a simple prompt with the message specified by '''Msg''' parameter and two button: Yes and No. Returns TRUE if user clicks Yes button, otherwise FALSE.
|-
| function '''WideDialogYesNo'''(const Msg: WideString): Boolean;
| Same as '''DialogYesNo''' function but parameter is WideString text.
|-
| function '''InputBox'''(const ACaption, APrompt, ADefault: String): String;
| Displays a simple dialog box with the given '''ACaption''' and '''APrompt''' message. It asks the user to enter data in a text box on the dialog. A '''ADefault''' value is displayed in the text box initially. If the user presses OK, the value from the text box is returned, otherwise '''ADefault''' value is returned.
|-
| function '''InputQuery'''(const ACaption, APrompt: String; var Value: String): Boolean;
| Operates similar to '''InputBox''' function. The default value and the value of the text box after the dialog is closed are transferred via the '''Value''' parameter. Function returns TRUE is user clicked OK, otherwise returns FALSE.
|-
| function '''WideInputBox'''(const ACaption, APrompt, ADefault: WideString): WideString;
| Same as '''InputBox''' function but operates on WideString text.
|-
| function '''WideInputQuery'''(const ACaption, APrompt: WideString; var Value: WideString): Boolean;
| Same as '''InputQuery''' function but operates on WideString text.
|}

{{Top}}

== Application ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''GetApplicationPath''': WideString;
| Return full path to the application, for example: "C:\Program Files\ReNamer\ReNamer.exe".
|-
| function '''GetApplicationParams''': TStringsArray;
| Return an array of command line parameters which were supplied to the application at launch.
|-
| function '''GetCurrentFileIndex''': Integer;
| Get index of the current file. Index ranges from '''1''' to '''GetTotalNumberOfFiles'''.
|-
| function '''GetTotalNumberOfFiles''': Integer;
| Get total number of files in the application.
|-
| function '''GetCurrentMarkedFileIndex''': Integer;
| Get index of the current file, counting only ''marked'' files. Index ranges from '''1''' to '''GetTotalNumberOfMarkedFiles'''.
|-
| function '''GetTotalNumberOfMarkedFiles''': Integer;
| Get total number of ''marked'' files in the application.
|}

{{Top}}

== System ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideGetCurrentDir''': WideString;
| Returns the current working directory.
|-
| function '''WideSetCurrentDir'''(const Dir: WideString): Boolean;
| Sets the current working directory to the directory specified by parameter '''Dir'''.
|-
| function '''WideGetTempPath''': WideString;
| Returns system defined temporary directory. If returned value is empty it means that temporary folder could not be determined.
|-
| function '''WideGetEnvironmentVar'''(const VarName: WideString): WideString;
| Returns an environment variable by its name. For example:
<source>
var
UserName, ComputerName: WideString;
begin
UserName := WideGetEnvironmentVar('USERNAME');
ComputerName := WideGetEnvironmentVar('COMPUTERNAME');
end.
</source>
|}

{{Top}}

== Miscellaneous ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| procedure '''Sleep'''(Milliseconds: Cardinal);
| Sleep (pause the execution) for specified number of '''Milliseconds'''.
|-
| procedure '''DivMod'''(Dividend: Integer; Divisor: Word; var Result, Remainder: Word);
| Perform integer division and fetch the remainder as well, all in one operation. '''Dividend''' is the integer into which you are dividing. '''Divisor''' is the value by which to divide '''Dividend'''. '''Result''' returns the result of the integer division. '''Remainder''' returns the remainder (the difference between Result * Divisor and Dividend).
|-
| procedure '''Randomize''';
| Prepares the random number generator.
'''Note:''' Should only be called once per application cycle, at the start of the process!
|-
| function '''RandomRange'''(const AFrom, ATo: Integer): Integer;
| Return a random integer number within the specified range from '''AFrom''' (inclusive) to '''ATo''' (non-inclusive).
|-
| function '''GetClipboardText''': WideString;
| Get the content of the the clipboard (text only).
|-
| procedure '''SetClipboardText'''(const S: WideString);
| Set the content of the the clipboard (text only).
|-
| function '''Base64Encode'''(const S: String): String;
| Encode string '''S''' into [http://en.wikipedia.org/wiki/Base64 Base64]. Useful for encoding binary data in order to minimize the likelihood of data being modified in transit through different systems, like email or internet.
|-
| function '''Base64Decode'''(const S: String): String;
| Decode [http://en.wikipedia.org/wiki/Base64 Base64] string;
|-
| function '''GetTickCount''': Cardinal;
| Retrieves the number of milliseconds that have elapsed since the system was started (up to 49.7 days, then timer resets). The precision of this timer is very limited.
|-
| function '''SizeOf'''(X): Integer;
| Pass a variable reference to determine the number of bytes used to represent the variable. Pass a type identifier to determine the number of bytes used to represent instances of that type.
|}

{{Top}}

[[Category:ReNamer]]
[[Category:Pascal Script]]

ReNamer:Main menu

2012-12-17T06:30:45Z

Narayan: /* Help menu */

In this appendix, all the menus and context menu options are described.

=== File menu ===
{| class="prettytable"
|-
! Menu option
! Keyboard Shortcut
! What it does...
|-
| New Project
| CTRL+N
| Create a new project. Clear all rules and files.
|-
| Undo
| SHFT+CTRL+Z
| If possible, reverses the effect of the last renaming operation.
|-
| Paste
| SHFT+CTRL+V
|
Pastes the selection of files from the clipboard into the '''Files''' pane. (We assume that you have already copied some files into the clipboard)

|-
| Add files
| F3
| Starts a window to select specific file(s) from any folder and add them to the '''Files''' pane.
|-
| Add folders
| F4
| Starts a window to add all files from a chosen folder (behavior depends on [[ReNamer:Menus for the Files pane#Filters_menu|Filter settings]])
|-
| Preview
| F5
| Manual preview (not required if ''auto-preview'' mode is on)
|-
| Rename
| F6
| Renames the file with a name shown in the '''New Name''' ('''New Path''') column in the '''Files''' pane.
|-
| Exit
| ALT+F4
| Closes the application
|}

=== Settings menu ===

{| class="prettytable" style="width: 714px; height: 518px;"
|-
! Menu option
! Keyboard Shortcut
! What it does...
|-
| All Settings
| F8
| See [[ReNamer:Program settings|'''Program settings''']] for details.
|-
| General
| 
| Shows the [[ReNamer:Program settings#General_settings|'''General''']] tab of the '''Settings''' dialog.
|-
| Preview
| 
| Shows the [[ReNamer:Program settings#Preview_settings|'''Preview''']] tab of the '''Settings''' dialog.
|-
| Rename
| 
| Shows the [[ReNamer:Program settings#Rename_settings|'''Rename''']] tab of the '''Settings''' dialog.
|-
| Meta tags
| 
| Shows the [[ReNamer:Program settings#Meta tags settings|'''Meta Tags''']] tab of the '''Settings''' dialog.

|-
| Miscellaneous
| 
| Shows the [[ReNamer:Program settings#Miscellaneous_settings|'''Miscellaneous''']] tab of the '''Settings''' dialog.
|-
| Filters
| CTRL+F
| Changes the default behavior when [[ReNamer:Adding files and folders#Adding_items_using_the_.27Add_Folders.27_button|adding folders]].
|}

=== Presets menu ===

'''Note:''' Presets are explained [[ReNamer:Using_presets|here]]

{| class="prettytable"
|-
! Menu option
! Keyboard Shortcut
! What it does...
|-
| Load
| 
|
Opens a submenu with a list of all available presets. Click on a preset to load its rules in the '''Rules''' pane. If the preset was saved with any filter settings, they will also be set.

'''Note:''' Be aware that all current rules will be lost. If you want to add a preset in the end of the current rules stack use [[ReNamer:Using_presets|'''Append preset''']] option from '''Preset Manager'''.

|-
| Save As...
| CTRL+S
| Saves the current preset.
|-
| Manage
| CTRL+M
|
Opens the [[ReNamer:Using_presets|'''Preset Manager''']] dialog.

|-
| Browse...
| 
| Browse to folder where presets are stored (via Windows Explorer).
|-
| Import...
| 
| Select presets from any folder in your file system, which you want to be copied to ReNamer's '''Presets''' folder.
|-
| Create links
| 
| The following window pops up:
[[Image:PresetLinksDialog.png|center]]

Shortcuts will be created for every available ''preset'' and placed in the selected folder. 

*If the '''Load with Preset''' option is selected, links will only open new ReNamer window with the preset loaded into '''Rules''' pane and files that where sent to the link loaded into '''Files''' pane. Now you can edit rules, delete or add some more rules, and finally rename the files. If the preset contained any filter settings, they will be applied to the files that where sent to the link.
*If the '''Rename with Preset''' option is selected, the linked preset will be loaded and all files which were sent to the link will be automatically renamed. 

For more information, please see [[ReNamer:Command Line|Command Line usage]]. 
WARNING: Be careful with the '''"Rename with Preset'''" option. It will rename files without asking for your confirmation!


|-
| Rescan
| 
| Scans the preset folder for new presets. Useful if you have manually modified the content of the presets folder as you don't have to restart ReNamer to use them.
|}

=== Help menu ===

{| class="prettytable"
|-
! Menu option
! Keyboard Shortcut
! What it does...
|-
| User Manual
| ALT+F1
| Opens User Manual file which is distributed with the application (PDF file).
|-
| Donate
| 
|
Takes you to the donation web page.
 
Although ReNamer is freeware, you could support the project with a small donation.

|-
| What's new
| 
|
Pops up a window like this:

[[Image:AboutWindow.png]]

You can check the latest changes here. 

|-
| About
| F1
| Pops up a window like this:
[[Image:WhatsNewWindow.png]] 

This screen provides you with general information about ReNamer, and contact details in case you are facing any difficulties that are not covered in this manual. 
A right click on the white header of the dialog will place ReNamer's version information to the clipboard.
 (Now you can paste it into your posts at the forum.)

|}

 

 
[[Category:ReNamer]]

ReNamer:Main menu

2012-12-17T06:30:04Z

Narayan: /* Help menu */

In this appendix, all the menus and context menu options are described.

=== File menu ===
{| class="prettytable"
|-
! Menu option
! Keyboard Shortcut
! What it does...
|-
| New Project
| CTRL+N
| Create a new project. Clear all rules and files.
|-
| Undo
| SHFT+CTRL+Z
| If possible, reverses the effect of the last renaming operation.
|-
| Paste
| SHFT+CTRL+V
|
Pastes the selection of files from the clipboard into the '''Files''' pane. (We assume that you have already copied some files into the clipboard)

|-
| Add files
| F3
| Starts a window to select specific file(s) from any folder and add them to the '''Files''' pane.
|-
| Add folders
| F4
| Starts a window to add all files from a chosen folder (behavior depends on [[ReNamer:Menus for the Files pane#Filters_menu|Filter settings]])
|-
| Preview
| F5
| Manual preview (not required if ''auto-preview'' mode is on)
|-
| Rename
| F6
| Renames the file with a name shown in the '''New Name''' ('''New Path''') column in the '''Files''' pane.
|-
| Exit
| ALT+F4
| Closes the application
|}

=== Settings menu ===

{| class="prettytable" style="width: 714px; height: 518px;"
|-
! Menu option
! Keyboard Shortcut
! What it does...
|-
| All Settings
| F8
| See [[ReNamer:Program settings|'''Program settings''']] for details.
|-
| General
| 
| Shows the [[ReNamer:Program settings#General_settings|'''General''']] tab of the '''Settings''' dialog.
|-
| Preview
| 
| Shows the [[ReNamer:Program settings#Preview_settings|'''Preview''']] tab of the '''Settings''' dialog.
|-
| Rename
| 
| Shows the [[ReNamer:Program settings#Rename_settings|'''Rename''']] tab of the '''Settings''' dialog.
|-
| Meta tags
| 
| Shows the [[ReNamer:Program settings#Meta tags settings|'''Meta Tags''']] tab of the '''Settings''' dialog.

|-
| Miscellaneous
| 
| Shows the [[ReNamer:Program settings#Miscellaneous_settings|'''Miscellaneous''']] tab of the '''Settings''' dialog.
|-
| Filters
| CTRL+F
| Changes the default behavior when [[ReNamer:Adding files and folders#Adding_items_using_the_.27Add_Folders.27_button|adding folders]].
|}

=== Presets menu ===

'''Note:''' Presets are explained [[ReNamer:Using_presets|here]]

{| class="prettytable"
|-
! Menu option
! Keyboard Shortcut
! What it does...
|-
| Load
| 
|
Opens a submenu with a list of all available presets. Click on a preset to load its rules in the '''Rules''' pane. If the preset was saved with any filter settings, they will also be set.

'''Note:''' Be aware that all current rules will be lost. If you want to add a preset in the end of the current rules stack use [[ReNamer:Using_presets|'''Append preset''']] option from '''Preset Manager'''.

|-
| Save As...
| CTRL+S
| Saves the current preset.
|-
| Manage
| CTRL+M
|
Opens the [[ReNamer:Using_presets|'''Preset Manager''']] dialog.

|-
| Browse...
| 
| Browse to folder where presets are stored (via Windows Explorer).
|-
| Import...
| 
| Select presets from any folder in your file system, which you want to be copied to ReNamer's '''Presets''' folder.
|-
| Create links
| 
| The following window pops up:
[[Image:PresetLinksDialog.png|center]]

Shortcuts will be created for every available ''preset'' and placed in the selected folder. 

*If the '''Load with Preset''' option is selected, links will only open new ReNamer window with the preset loaded into '''Rules''' pane and files that where sent to the link loaded into '''Files''' pane. Now you can edit rules, delete or add some more rules, and finally rename the files. If the preset contained any filter settings, they will be applied to the files that where sent to the link.
*If the '''Rename with Preset''' option is selected, the linked preset will be loaded and all files which were sent to the link will be automatically renamed. 

For more information, please see [[ReNamer:Command Line|Command Line usage]]. 
WARNING: Be careful with the '''"Rename with Preset'''" option. It will rename files without asking for your confirmation!


|-
| Rescan
| 
| Scans the preset folder for new presets. Useful if you have manually modified the content of the presets folder as you don't have to restart ReNamer to use them.
|}

=== Help menu ===

{| class="prettytable"
|-
! Menu option
! Keyboard Shortcut
! What it does...
|-
| User Manual
| ALT+F1
| Opens User Manual file which is distributed with the application (PDF file).
|-
| Donate
| 
|
Takes you to the donation web page.
 
Although ReNamer is freeware, you could support the project with a small donation.

|-
| What's new
| 
|
Pops up a window like this:

[[Image:AboutWindow.png]]

You can check the latest changes here. 
A right click on the white header of the dialog will place ReNamer's version information to the clipboard.
(Now you can paste it into your posts at the forum.)

|-
| About
| F1
| Pops up a window like this:
[[Image:WhatsNewWindow.png]] 

This screen provides you with general information about ReNamer, and contact details in case you are facing any difficulties that are not covered in this manual. 

|}

 

 
[[Category:ReNamer]]

ReNamer:Menus for the Files pane

2012-12-17T06:15:49Z

Narayan: /* Export menu */

{{Cleanup|
* Breakdown into separate articles, one for each main section/menu
* Clear formatting artifacts from rich editor
* Update linking from other articles}}

ReNamer has a menu bar between the '''Rules''' and '''Files''' panes [[Image:MenuStrip.png]].

This appendix describes options available from this menu.

== Files button ==

When you click on the [[Image:FilesButton.png]] button, the following list pops up:

<center>[[Image:FileMenu.png]]</center>

{| class="wikitable"
|-
| Analyze Name
| Opens [[ReNamer:Analyze|analysis window]], and loads the names of the selected files into it.
|-
| Edit New Name '''F2'''
| Starts manual editing of the selected filename.
|-
| [[ReNamer:Menus for the Files pane#Shell submenu|Shell]]
| Options for Windows shell operations.
|-
| [[ReNamer:Menus for the Files pane#Mark submenu|Mark]]
| Options for [[ReNamer:Adding_files_and_folders#Marking_and_Unmarking_the_files|marking]] specific items.
|-
| [[ReNamer:Menus for the Files pane#Clear submenu|Clear]]
| Options for [[ReNamer:Adding_files_and_folders#Marking_and_Unmarking_the_files|removing]] specific items from the '''Files''' pane.
|-
| [[ReNamer:Menus for the Files pane#Select submenu|Select]]
| Options for [[ReNamer:Adding_files_and_folders#Selecting_files|selecting]] specific items.
|-
| [[ReNamer:Menus for the Files pane#Move submenu|Move]]
| Options for moving specific items.
|-
| Remove selected items '''Del'''
| Remove selected items from the ReNamer's '''File''' pane. (This command does not delete the items from the disk.)
|}

This menu provides second-level options, as follows:

=== Shell submenu ===

<center>[[Image:ShellSubMenu.png]]</center>

{| class="wikitable"
|-
| Open File
| '''Enter'''
| Open the selected file using its default associated application.
|-
| Open with Notepad
| '''Shift+Enter'''
| Open the file with notepad. Useful when you want to see the raw data in the file. (When viewed this way, the file will not be displayed in its original formatting. It may not be easily readable.)
|-
| Open operating folder
| '''Ctrl+Enter'''
| Launch Windows Explorer and open the folder where the selected file is located. Highlight (select) the file in it.
|-
| File properties
| '''Alt+Enter'''
| Display the properties of the selected file. Typically, file size, dates (created/modified/accessed), comments, author, attributes (hidden, system, etc.)
|-
| Cut Files to clipboard
| '''Shift+Ctrl+X'''
| Cuts the selected file(s) to clipboard. '''Note:''' If you paste these files in Windows Explorer, all files will be moved to one folder, no matter where they were initially located.
|-
| Copy Files to clipboard
| '''Shift+Ctrl+C'''
| Copies selected file(s) to clipboard. '''Note:''' If you paste these files in Windows Explorer, all files will be copied to one folder, no matter where they were initially located.
|-
| Delete files to Recycle Bin
|
| Deletes the selected file(s) to Recycle Bin. (They can be recovered from the Recycle Bin.)
Note that if the file is too large for the Recycle Bin, Windows will warn you that it will not be put in Recycle Bin, but deleted permanently. If you confirm, the file is deleted permanently.

|}

There are 2 possible uses for '''Copy to clipboard''' and '''Cut to clipboard''' options:
* 3rd party application can retrieve that list of files from the clipboard (using Paste operation or Win API).
* Paste all files into a singe destination folder via Windows Explorer, even when files are scattered across different directories.

=== Mark submenu ===

<center>[[Image:MarkSubmenu.png]]</center>
'''Note'''''': '''Marking of files is explained [[ReNamer:Adding files and folders#Marking_and_Unmarking_the_files|here]]. 

{| class="prettytable"
|-
| Mark '''Shift+M'''
| Mark all selected files. If some files are already marked, they remain marked.
|-
| UnMark '''Shift+U'''
| Unmark all selected files. If some files are already unmarked, they remain unmarked.
|-
| Invert Marking '''Ins'''
| Marked files become unmarked, and vice versa.
|-
| Mark only changed (Inc. Case)
| [[ReNamer:Adding files and folders#Marking_and_Unmarking_the_files|Mark]] files that have been changed. Files that had just change of case (and nothing else) will also be marked. ("''Change of case''" means some letters are converted capital-to-small and/or small-to-capital)
|-
| Mark only changed (Exc. Case)
| [[ReNamer:Adding files and folders#Marking_and_Unmarking_the_files|Mark]] files that have been changed, but do not consider changes of case. ("''Change of case''" means some letters are converted capital-to-small and/or small-to-capital)
|-
| Mark only selected
| Mark files that are selected. If some unselected files are already marked, they will be unmarked.
|-
| Mark by Mask
| Pops up a Mask window:
[[Image:MarkByMask.png]]

Specify a mask pattern. All files that match this mask will be marked.

You can enter multiple masks (separating them with semicolon). If a file matches any of these masks, it will be marked.

|}

=== Clear submenu ===

<center>[[Image:ClearSubmenu.png]]</center>
'''Note''': The term "''Clear''" means remove from '''Files''' pane of ReNamer. 

{| class="prettytable"
|-
| Clear All
| Clear all files loaded in the pane.
|-
| Clear Renamed
| Clear all files which have been renamed just before this command. Note that even if some files are not affected by the rules, they are still regarded as renamed successfully.
Only files that failed to rename (those with an '''x''' mark) will remain in the pane.

|-
| Clear Failed
| Only files that failed to rename (those with an '''x''' mark) will be cleared.
All other files (including files whose names were not altered by the rules) will remain in the '''Files''' pane.

|-
| Clear Valid
| Clear files that have valid names after Preview (but haven't been renamed yet).
|-
| Clear Invalid
| Clear files that got invalid (causing conflicts, empty or with forbidden characters etc.) names after Preview (but before renaming).
|-
| Clear Marked
| Clear all marked files.
|-
| Clear Not Marked
| Clear all files that are not marked.
|-
| Clear Not Changed '''Ctrl+D'''
| Clear all files that haven't been changed by the Preview. This also includes all files that have their New Name field empty (eg. because they have been successfully renamed or haven't been previewed since last renaming operation).
|}

=== Select submenu ===

<center>[[Image:SelectSubmenu.png]]</center>
Note: Selection of files is explained [[ReNamer:Adding files and folders#Selecting_files|here]]. 

{| class="prettytable"
|-
| Select All'''  Ctrl+A'''
| All files in the pane will be selected.
|-
| Invert Selection'''  Ctrl+I'''
| Selected files become deselected, and vice versa.
|-
| Select by Name Length  '''Ctrl+L'''
| Pops up a window:
[[Image:SelectByFileNameLengthDialog.png]]

Specify the length of file name. Only files that exceed that length will be selected.

The length refers to the whole filename including dot and the extension.

'''Note''': A typical application is to check if the file can be put on a CD/DVD. The maximum length allowed in ISO 9660-compliant file-system is 64 characters. Longer file names are truncated when you burn a CD/DVD. It is difficult to correlate such files with their originals. To avoid such problems, shorten the names ''before'' burning the CD/DVD.

|-
| Select by Extension '''Ctrl+E'''
| Pops up a window:
[[Image:SelectByExtnDialog.png]]

Specify the extension (without the dot). All files having that extension will be selected.

You can enter multiple extensions (they must be separated by semicolons - not comma).

|-
| Select by Mask'''  Ctrl+M'''
| Pops up this window:
[[Image:SelectByMask.png]]

Specify the [[ReNamer:Masks|mask]]. All files matching that pattern will be selected. You can enter multiple masks (they must be separated by semicolons - not comma).

|}

=== Move submenu ===
<center>[[Image:MoveSubmenu.png]]</center>
 

{| class="prettytable"
|-
| Up '''Ctrl+Up'''
| Moves the selected file up. This is used to re-arrange files in the list.
It is easier to use the keyboard shortcut '''CTRL+UpArrow'''.

|-
| Down '''Ctrl+Down'''
| Moves the selected file down. This is used to re-arrange the files list.
It is easier to use the keyboard shortcut '''CTRL+DownArrow'''.

|}

== Filters menu ==

When you click on the [[Image:FiltersButton.png]] button, the '''Filters''' window pops up. It controls what gets added to the '''Files''' pane when you use the [[Image:AddFoldersButton.png]] button or [[ReNamer:Adding files and folders#Adding files using the Drag-and-drop method|Drag & Drop]] or [[ReNamer:Adding files and folders#Adding files using the copy-and-paste method |Copy & Paste]] methods. 

{| class="prettytable"
|-
| [[Image:FilterSettingsDialog.png]]
| The options work as follows:
{| class="prettytable"
|-
| <center>'''Option'''</center>
| <center>'''Effect'''</center>
|-
| Add files within folders
| When this option is selected, ReNamer scans the selected folders iteratively (including its subfolders), and loads all the files for renaming. If you want to rename only the folders (and not their contents), UNTICK this option, and select the '''Add folders as files''' checkbox.
|-
| Add folders as files
| If this option is selected, ReNamer treats a folder just like a file (not as a container that holds files and subfolders). So only the folder is loaded, and not the files in it. This is useful for renaming the folder itself.
|-
| Include subfolders
| Loads contents from all subfolders recursively. If this option is unselected, when you add a folder, its subfolders will be ignored.
|-
| Include hidden items
| To protect hidden items, deselect this option.
|-
| Include system items
| To protect files reserved for system (OS), deselect this option.
|-
| Skip root folders when added as files
| Works when the ''Add folders as files'' and ''Include subfolders'' options are selected. When it's on, ReNamer adds all the subfolders but not the root folder itself.
|-
| Masks
| All added files (or folders as files) must match specified [[ReNamer:Masks|mask(s)]]. For example, if you enter '''*.jpg;*.gif;*.png''' as masks, ReNamer will add only files with these extensions. Everything else will be filtered ''out''(not added to ReNamer).
|-
| Apply only to the file name
| Changes how the masks (see above) are applied.
For example, suppose you have file '''''C:\Folder\File.ext'''''. If ''this'' option is ON, only the filename part ('''''File.ext''''') will be checked against the mask(s). But if ''this'' option is OFF, the entire path ('''''C:\Folder\File.ext''''') will be checked against the mask(s).

|}

Press '''Save''' to save changes.

|}

'''Filters''' menu is also accessible from the '''Add Folder''' window. For details see [[ReNamer:Adding files and folders#Adding items using the 'Add Folders' button |Adding items using the 'Add Folders' button]] section.

== Export menu ==
When you click on the [[Image:ExportButton.png]] button, the following list pops up:

<center>[[Image:ExportMenu.png]]</center>

{| class="prettytable"
| Export file paths and undo paths
| Exports ''file paths'' and ''undo paths'' to the .csv (comma separated) or .txt (tab separated) file.

|-
| Export file paths and new names
| Exports ''file paths'' and ''new names'' to the .csv (comma separated) or .txt (tab separated) file.

|-
| Import file paths and new names
| Imports ''file paths'' and ''new names'' from the .csv (comma separated) or .txt (tab separated) file.

|-
| Import files from text-list or play-list
| Imports ''file paths'' from the .txt/.log file (one file per line) or .m3u/.pls playlist.

'''Note:''' It will load file paths into '''Files''' pane only if the file really exists on your file system.
|-
|Export as batch renaming file (Full paths)
|
|-
|Export as batch renaming file (Only names)
|
|-
| Export new names to clipboard
| Export ''new names'' to clipboard. One name per line.

|-
| Import new names from clipboard
| Imports ''new names'' from clipboard. Every name should be placed in a new line.

If there is less lines in the clipboard text than files in '''Files''' pane last files won't be renamed. 
If there is more lines in the clipboard text than files in '''Files''' pane, then last lines won't be used.
|-
| Export all columns to clipboard
| Exports ''all columns'' to clipboard as a tab separated text.
|}

== Options menu ==

When you click on the [[Image:OptionsButton.png]] button, the following list pops up:
<center>[[Image:OptionsMenu.png]]</center>
{| class="prettytable"
|-
| Autosize columns
| Auto-size all columns, to accommodate the longest entry in each column.
|-
| Validate new names
| Check if the new names are valid.
|-
| Fix conflicting new names
| Add incremental numbers as suffixes to avoid conflicts in names. For example, if a new name for a file is Name1, and if such a file already exists in the target folder, then a suffix (2) is added to the newly renamed file. If more than one files have such name conflicts, ReNamer uses incremental numbers (i.e. (2), (3)...) as suffixes to make sure that each file gets a unique name.
|-
| Highlight changed names
| Usually you load files only because you want to change their names. Yet, sometimes, some files escape all the rules you have loaded and remain unchanged. In such cases, you may want to know why that happened.
ReNamer can highlight files that are going to be changed. Now you can investigate the remaining files.

'''Note:''' ''Highlight changed names'' option works as a switch: it turns highlighting ON and OFF.

'''Tip:''' You can unmark the rules selectively and see the effect on the files. That will tell you which rules are working on which files. Once your analysis is over, you can mark all rules.

|-
| Analyze sample text
| It opens the [[ReNamer:Analyze|Analyze window]].
Thanks to that option you don't have to load files to the '''Files''' pane just to check if your rules work as desired. 
It is extremally useful when you want to help others on the forum.

*Enter any text that looks like your target files, and see whether the rules work as desired on that text.
*Edit the rules if the desired result is not achieved
*Once you are satisfied with the rules, apply them on the real files or post the set of rules on the forum.

'''Note:''' Analyze sample text won't be any help if the rules base on the files properties (and not only on the filename). Analyze tool won't be able eg. to extract Meta tag from the text in its window.

|-
| Apply rules to the clipboard
| When you choose this option your rules will be applied to the text in clipboard instead of files in the '''Files''' pane. This might be useful eg. when working with word processors that don't support RegEx'es.
|-
| Count marked and selected files '''Alt + I'''
| It pops up a window like this
<center>[[Image:Count_marked_selected.png]]</center>

where '''Total''' stands for total number of files loaded into the '''Files''' pane, and
'''Marked''' and '''Selected''' stand for number of marked and selected files respectively.

|}
[[Category:ReNamer]]

File:ExportMenu.png

2012-12-17T06:10:45Z

Narayan: uploaded a new version of "File:ExportMenu.png": * Added option to export files to a batch renaming file;

Export Menu

ReNamer:Rules:Case

2012-12-17T06:06:15Z

Narayan: /* Case Rule */

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Strip|next=ReNamer:Rules:Serialize}}

== Case Rule ==

[[Image:CaseRule.png|center]]

This rule changes the case of the filename. Options are: capitalize, to lower case, to upper case, invert case, and put only first letter capital (as in a sentence).

There is also an option to force case for specific text-fragments, such as CD, DVD, RF, etc. These fragments would not look natural in any other case (e.g. cd, dvd, rf), so the rule allows you to prevent changing the case of such terms in one stroke.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Case change
| Several options are offered.
*The case of each option itself illustrates how that option works. For example, '''Capitalise Every Word'''.

*'''Invert case''' will change all capital letters in the filename to lowercased ones, and all lowercased letters to capitalized ones.

*The '''(none of the above)''' option is provided to disable the case conversions listed on the left, so you could independently operate the two options listed on the right side.

|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.
|-
| Force case for fragments
|
This option forces the case of specified text-fragments (strings) in the file name.

Note: This check box is coupled with the box below it. (Enter the fragments in the box and then activate the option by selecting the check box.)

*You can set any case for the strings (ALLCAPS, Only first letter capitalized, lowercase, MixedCase, etc.)

*You can specify ''multiple'' strings at a time, each with its own case format. To separate the strings from each other, put a comma between them. (Note: In versions prior to v5.50, a space was used instead of a comma.) 

*The case for these strings will be set exactly as entered in the box, regardless of the options selected in '''Case change''' list.

Here are some typical examples of such strings:

{| class="wikitable"
|-
! Case
! Examples
|-
| ALLCAPS
| CD, DVD, TV, HTML, XML, C++, USA, GIMP
|-
| Only the First letter capitalized
| Java, India, English, Sunday, Easter, February
|-
| Mixed case
| OpenSUSE, OpenOffice, ReNamer

|}
|-
| Extension always upper case
| Forces the extension to uppercase.
'''Note:''' This setting overrides any other setting that can alter the extension. For example, consider a case where the '''all lowercase''' option is selected and the '''skip extension''' option is deselected. Logically, the extension should be converted into lowercase too. But if the '''Extension always upper case '''option is selected, the case of the extension will be converted to uppercase. This setting will override even the fragments case-conversion.

|-
| Extension always lower case
| Forces the extension to lowercase.
'''Note:''' This setting overrides any other setting that can alter the extension. For example, consider a case where the '''ALL UPPER CASE''' option is selected and the '''skip extension''' option is deselected. Logically, the extension should be converted into ALLCAPS. But if the '''Extension always lower case''' option is selected, the case of the extension will be converted to lowercase. This setting will override even the fragments case-conversion.

|}

[[Category:ReNamer]]

File:CaseRule.png

2012-12-17T06:02:22Z

Narayan: uploaded a new version of "File:CaseRule.png": Added "Extension always upper case" option to the Case rule

Case Rule

[[Category:ReNamer]]

File:PreviewSettingsDialog.png

2012-12-17T05:56:40Z

Narayan: uploaded a new version of "File:PreviewSettingsDialog.png": * Added "Fix conflicting new names on preview" option in the Settings; * A more detailed warning message for the real-time preview option;

Preview Settings Dialog

ReNamer:Program settings

2012-12-17T05:52:14Z

Narayan: /* Preview settings */

This appendix describes the settings that change ReNamer's behavior in various ways.

=== General settings ===
These settings are applicable to the ReNamer application.
<center>[[Image:GeneralSettingsDialog.png]]</center>
{| class="prettytable"
| Always on top (main window only)
| colspan="2" | Keeps the ReNamer window above the other windows.

This feature is useful when you are using the drag-and-drop method to add files from Windows Explorer. When you are working in Windows Explorer, the ReNamer window does not vanish below the Windows Explorer window.

|-
| Remember last position and size
| colspan="2" | ReNamer will retain the same size and position in the next session. You will not need to resize/re-position the ReNamer window each time you start it.

|-
| Remember sorting options (files table)
| colspan="2" | ReNamer will retain the file sorting order in the next session.

|-
| Save rules configuration on exit, load on start up
| colspan="2" | In the next session, ReNamer retains all rules that are currently loaded in the '''Rules''' pane. Useful if you use the same rules every time.

|-
| Always show non-main forms centered
| colspan="2" | All windows and dialog boxes (except the main window) appear in the center of the ReNamer window. You still may shift the new window, but when you close it and open again it will be opened in the center of ReNamer window. If the option is deselected window would reopen in its old position.

|-
| Use natural order sorting algorithm
| colspan="2" | ReNamer has two different types of sorting algorithms:
{| class="prettytable"
| <center>'''Order'''</center>
| <center>'''Example'''</center>
| <center>'''Remarks'''</center>

|-
| Natural
| <center>Name1.ext</center>

<center>Name2.ext</center>

<center>Name10.ext</center>

<center>Name20.ext</center>
| Numbers are sorted in their natural order.

|-
| Lexicographical
| <center>Name1.ext</center>

<center>Name10.ext</center>

<center>Name2.ext</center>

<center>Name20.ext</center>
| Sorts like in a dictionary. All entries are sorted based on characters' positions, counted from left.
|}
If this option is selected, filenames are sorted in '''Natural''' order; otherwise they are sorted in '''Lexicographical''' order.
|}

=== Preview settings ===
These settings are applicable only to the previewing.
<center>[[Image:PreviewSettingsDialog.png]]</center>

{| class="prettytable"
| Autosize table on change
| Each column resizes automatically to accommodate the longest name in it.

|-
| Auto preview on change of rules configurations
| Whenever a rule is added/deleted/edited, the preview refreshes automatically

|-
| Auto preview when new files are added
| Whenever a file is added, the preview refreshes automatically
|-
|Fix conflicting new names on preview
|If the new file names are going to conflict, then this option resolves the conflict by adding a suffix number in '''(n)''' format.
|-
| Validate new filenames on preview
| Raises a warning if new filenames are not valid:
* There are duplicates in the ''New path'' column
* ''New path'' contains forbidden characters
* ''New path'' is already taken by an existing file
* ''New path'' exceeds maximum length (256 characters)
|-
| Real-time update of the preview
| If this option is selected, when you click the '''Preview '''button, files will be updated one-by-one and displayed in the table. During the processing, ReNamer continues to accept any user inputs (mouse/keyboard).


WARNING: This option allows you to use mouse/keyboard even when the previous rules are being processed. This may lead to unpredictable behavior and consequences! Use this option with EXTREME CAUTION, only for cases when some heavy processing is done on each file, for example: using HASH functions or other types of content analysis.

If this option is deselected, when you click '''Preview''' button, ReNamer shows nothing till all files are processed; after which all files are displayed at once. During the processing, ReNamer will stop accepting any user inputs (mouse/keyboard). This mode is safe. '''For normal use, deselect this option!'''
|}

=== Rename settings ===
These settings are applicable to the renaming process.
<center>[[Image:RenameSettingsDialog.png]]</center>

ReNamer can boost your productivity by doing certain operations on its own. On the other hand, you may want to have the flexibility of choosing your options each time. So this panel lets you decide how to strike a balance!
{| class="prettytable"

|-
| Display message on successful rename
| colspan="2" | Deselect if you do not want a message each time.

(This setting is not applicable to the pop-up windows that show the error messages. Those windows are ''always'' shown.)

|-
| Close program after successful rename
| colspan="2" | Useful if you use ReNamer sparingly (rename once and close ReNamer.)

In case of problem, ReNamer stays open.

|-
| Clear rules list after rename
| colspan="2" | Useful if you use a different set of rules each time. This option will clear off the '''Rules''' pane automatically.

|-
| Clear files table on rename
| colspan="2" | Useful if you want to load another set of files for each new renaming.

Note that even files that were not renamed in the last round will get cleared off. So, '''deselect''' this option if you tend to rename your loaded files in 2-3 separate renaming operations.

'''NOTE:''' This will make '''Undo''' option unusable.

|-
| Clear renamed files on rename
| colspan="2" | Clears off the files once you have finished renaming them.

Note that the files that were not renamed will remain behind, so that you can apply a new set of rules to them.

Note that the currently ''marked'' set of rules may not change some file names (for example, if you want to insert a string at 10th position, and we have some files with shorter file names.) Even in such cases, the files are considered to be renamed.

'''NOTE:''' This will make '''Undo''' option unusable.

|-
| Overwrite files with new names
| colspan="2" | If there is a naming conflict as a result of renaming, the newly renamed files can overwrite the existing files with the same names automatically.

Note that the name conflict can occur with a file that exists in the same folder, but which is NOT loaded in ReNamer.

Note also that multiple files from the same folder may be renamed in such a way that most of them get overwritten in sequence. In the worst case, only the last file to be renamed will survive!


CAUTION: Your important files can be overwritten without your knowledge!


|-
| Must be successfully confirmed by user
| colspan="2" | (Applicable only when '''Overwrite files with new names''' option is selected):

{| class="prettytable"
| Selected
| ReNamer will pop up confirmation dialog for every file that is to be overwritten. The old file will be overwritten only if you confirm. (If the renamed file has no conflicts in its folder, ReNamer will rename it without asking for permission.).

|-
| Deselected
| If a renamed file has the same name as an existing file, ReNamer will overwrite the old file silently.


CAUTION: Your important files can be overwritten without your knowledge!


|}
|}

=== Meta tags settings ===

These settings are for meta-tags only.
<center>[[Image:MetaTagsSettingsDialog.png]]</center>
{| class="prettytable"
|-
| Meta tag support
| colspan="2" | Extracting meta-tags from files puts heavy demand on system resources. So if you do not need meta-tags, deselect this option. The system will become more responsive (not only ReNamer, but other applications as well.).
|-
| Date format
| colspan="2" | Sets the date format for ReNamer's use. (The selected date format will be used for naming files.) See [[ReNamer:Date_and_Time_format|Date-time format used in Meta tags]] to see available formats.
|-
| Preview
| colspan="2" | Tests the current date-time format, using current time.
|}

=== Miscellaneous settings ===
A general-purpose tab to provide all miscellaneous settings.
<center>[[Image:MiscSettingsDialog.png]]</center>

{| class="prettytable"
| Register preset extension (*.rnp)
| colspan="2" | Associate the .rnp extension with ReNamer.

|-
| Add to folders context menu
| colspan="2" | in Windows Explorer, a ReNamer option is added to the context menu for folders.

|-
| Add to Send to context menu
| colspan="2" | in Windows Explorer, a ReNamer option is added to the Send to... context menu.

|-
| Change text of "Drag your files here"
| colspan="2" | The lower pane of ReNamer will show your custom text when empty

|-
| Change text of "Click here to add a rule"
| colspan="2" | The upper pane of ReNamer will show your custom text when empty

|}
[[Category:ReNamer]]

ReNamer:Renaming folders

2012-09-11T17:37:14Z

Narayan:

[[ReNamer]] has several [[ReNamer:Filter settings|filter options]] which configure how added items (files and folders) are treated.

By default, folders are not added to the renaming list as items, instead, their contents are added to the renaming list. To rename the folders themselves, open [[ReNamer:Filter settings|filter settings]] and enable option "'''Add folders as files'''".

=== Extensions in Folders?===
Note that [[ReNamer:Skip extension|Skip extension]] option also affects folders. (If there are any periods in the name of a folder, the portion on the right side of the last period is treated as extension.

A typical example is folders that contain tutorials: '''01. Introduction''', '''02. Basics''', etc.)
Here, the words "01" and "02" are treated as names, and "introduction" and "Basics" are treated as extensions.

== Conflicting order ==

Renaming a folder also affects all of its content. Therefore renaming of folders requires a little more care.

A problem can occur if you try to rename folders and their content in a single run. Items in the renaming list are processed from top to bottom. The order of items in this case is extremely important for successful renaming.

'''Important:''' Parent folders must always appear below their contained items. This can be easily achieved by [[ReNamer:Sorting files|sorting items]] in descending order by the '''Folder''' or '''Path''' column.

If a parent folder is renamed first, the actual path for its contents changes instantly, with its new name. However, the subfolders and files contained in that folder are still listed in ReNamer with their old path. As a result, ReNamer is unable to find those items at the specified location, and therefore it cannot rename them.

For example, assume you have a folder named "C:\Folder" and a file named "C:\Folder\File" in it.
Assume also that you have listed '''Folder''' above '''File''' in ReNamer.
As soon as first '''Folder''' is renamed to '''New_Folder''', the path for '''File''' changes to '''C:\New_Folder\'''. However, the File is still listed in ReNAmer at its original location (with the '''C:\Folder\''' path). Thus ReNamer is unable to find '''File'''.

In other words, while the contained folder is renamed, the contents are not.

<center>
== Problem occurred ==
</center>

{| align="center"
! Preview
! Rename
|-
| [[Image:ReNamer Folder Rename Bad Before.png]]
| [[Image:ReNamer Folder Rename Bad After.png]]
|-
|colspan="2" align="center"| Items as they appear after they were added, no sorting.
|}

<center>
== Problem solved ==
</center>

{| align="center"
! Preview
! Rename
|-
| [[Image:ReNamer Folder Rename Good Before.png]]
| [[Image:ReNamer Folder Rename Good After.png]]
|-
|colspan="2" align="center"| Items after they were sorted in descending order by Folder column.
|}
[[Category:ReNamer]]

ReNamer:Analyze

2012-09-06T02:15:32Z

Narayan:

{{Up|ReNamer}}

When you select the '''Analyze tool''' option (or press SHFT+A), ReNamer launches a window, where you can enter any arbitrary text and apply rules entered in the '''Rules''' pane.

This is very useful to see the effect of the rules using dummy text (for example before using the '''Insert''' rule).
It also allows to check the positions of any character in the text just by pointing to it with keyboard or mouse. The appropriate data is displayed in the status bar of the window.

The text may be a filename (or multiple filenames) loaded from '''Files''' pane or any text manually created by user.

Let us see an example.

I had already added a single [[ReNamer:Rules:Insert|Insert Rule]] in the '''Rules''' pane of ReNamer. It was set to insert "''x''" (without the quotes) at the 3rd position.

Now I press SHFT+A.

A window pops up:

[[Image:AnalyzeDialog.png|center]]

In this window, I have entered some arbitrary text to show the effect of the rule. Notice how '''x''' is added at the 3rd character in each line.

In our example, I have moved the cursor to the 3rd position, and the status line at the bottom of the screenshot shows this position. That reassures me that the rule ''does'' insert an '''x''' at position-3. (My renaming will happen as planned.)

Now I can close this window and go ahead and [[ReNamer:Renaming_files|rename my files]].

The options in the window are as follows:

{| class="wikitable"
|-
! Line wrap
| Wraps a line if it exceeds the window's width. (note that the window's width can be adjusted by dragging its right border.)
|-
! Automatically apply rules
| You do not have to press the [[Image:ApplyRulesButton.png]] button.
|-
! Apply rules for each line
| Applies the rule to each line separately.

[[Category:ReNamer]]

ReNamer:Menus for the Files pane

2012-02-19T10:17:54Z

Narayan: /* Filters menu */

{{Cleanup|
* Breakdown into separate articles, one for each main section/menu
* Clear formatting artifacts from rich editor
* Update linking from other articles}}

ReNamer has a menu bar between the '''Rules''' and '''Files''' panes [[Image:MenuStrip.png]].

This appendix describes options available from this menu.

== Files button ==

When you click on the [[Image:FilesButton.png]] button, the following list pops up:

<center>[[Image:FileMenu.png]]</center>

{| class="wikitable"
|-
| Analyze Name
| Opens [[ReNamer:Analyze|analysis window]], and loads the names of the selected files into it.
|-
| Edit New Name '''F2'''
| Starts manual editing of the selected filename.
|-
| [[ReNamer:Menus for the Files pane#Shell submenu|Shell]]
| Options for Windows shell operations.
|-
| [[ReNamer:Menus for the Files pane#Mark submenu|Mark]]
| Options for [[ReNamer:Adding_files_and_folders#Marking_and_Unmarking_the_files|marking]] specific items.
|-
| [[ReNamer:Menus for the Files pane#Clear submenu|Clear]]
| Options for [[ReNamer:Adding_files_and_folders#Marking_and_Unmarking_the_files|removing]] specific items from the '''Files''' pane.
|-
| [[ReNamer:Menus for the Files pane#Select submenu|Select]]
| Options for [[ReNamer:Adding_files_and_folders#Selecting_files|selecting]] specific items.
|-
| [[ReNamer:Menus for the Files pane#Move submenu|Move]]
| Options for moving specific items.
|-
| Remove selected items '''Del'''
| Remove selected items from the ReNamer's '''File''' pane. (This command does not delete the items from the disk.)
|}

This menu provides second-level options, as follows:

=== Shell submenu ===

<center>[[Image:ShellSubMenu.png]]</center>

{| class="wikitable"
|-
| Open File
| '''Enter'''
| Open the selected file using its default associated application.
|-
| Open with Notepad
| '''Shift+Enter'''
| Open the file with notepad. Useful when you want to see the raw data in the file. (When viewed this way, the file will not be displayed in its original formatting. It may not be easily readable.)
|-
| Open operating folder
| '''Ctrl+Enter'''
| Launch Windows Explorer and open the folder where the selected file is located. Highlight (select) the file in it.
|-
| File properties
| '''Alt+Enter'''
| Display the properties of the selected file. Typically, file size, dates (created/modified/accessed), comments, author, attributes (hidden, system, etc.)
|-
| Cut Files to clipboard
| '''Shift+Ctrl+X'''
| Cuts the selected file(s) to clipboard. '''Note:''' If you paste these files in Windows Explorer, all files will be moved to one folder, no matter where they were initially located.
|-
| Copy Files to clipboard
| '''Shift+Ctrl+C'''
| Copies selected file(s) to clipboard. '''Note:''' If you paste these files in Windows Explorer, all files will be copied to one folder, no matter where they were initially located.
|-
| Delete files to Recycle Bin
|
| Deletes the selected file(s) to Recycle Bin. (They can be recovered from the Recycle Bin.)
Note that if the file is too large for the Recycle Bin, Windows will warn you that it will not be put in Recycle Bin, but deleted permanently. If you confirm, the file is deleted permanently.

|}

There are 2 possible uses for '''Copy to clipboard''' and '''Cut to clipboard''' options:
* 3rd party application can retrieve that list of files from the clipboard (using Paste operation or Win API).
* Paste all files into a singe destination folder via Windows Explorer, even when files are scattered across different directories.

=== Mark submenu ===

<center>[[Image:MarkSubmenu.png]]</center>
'''Note'''''': '''Marking of files is explained [[ReNamer:Adding files and folders#Marking_and_Unmarking_the_files|here]]. 

{| class="prettytable"
|-
| Mark '''Shift+M'''
| Mark all selected files. If some files are already marked, they remain marked.
|-
| UnMark '''Shift+U'''
| Unmark all selected files. If some files are already unmarked, they remain unmarked.
|-
| Invert Marking '''Ins'''
| Marked files become unmarked, and vice versa.
|-
| Mark only changed (Inc. Case)
| [[ReNamer:Adding files and folders#Marking_and_Unmarking_the_files|Mark]] files that have been changed. Files that had just change of case (and nothing else) will also be marked. ("''Change of case''" means some letters are converted capital-to-small and/or small-to-capital)
|-
| Mark only changed (Exc. Case)
| [[ReNamer:Adding files and folders#Marking_and_Unmarking_the_files|Mark]] files that have been changed, but do not consider changes of case. ("''Change of case''" means some letters are converted capital-to-small and/or small-to-capital)
|-
| Mark only selected
| Mark files that are selected. If some unselected files are already marked, they will be unmarked.
|-
| Mark by Mask
| Pops up a Mask window:
[[Image:MarkByMask.png]]

Specify a mask pattern. All files that match this mask will be marked.

You can enter multiple masks (separating them with semicolon). If a file matches any of these masks, it will be marked.

|}

=== Clear submenu ===

<center>[[Image:ClearSubmenu.png]]</center>
'''Note''': The term "''Clear''" means remove from '''Files''' pane of ReNamer. 

{| class="prettytable"
|-
| Clear All
| Clear all files loaded in the pane.
|-
| Clear Renamed
| Clear all files which have been renamed just before this command. Note that even if some files are not affected by the rules, they are still regarded as renamed successfully.
Only files that failed to rename (those with an '''x''' mark) will remain in the pane.

|-
| Clear Failed
| Only files that failed to rename (those with an '''x''' mark) will be cleared.
All other files (including files whose names were not altered by the rules) will remain in the '''Files''' pane.

|-
| Clear Valid
| Clear files that have valid names after Preview (but haven't been renamed yet).
|-
| Clear Invalid
| Clear files that got invalid (causing conflicts, empty or with forbidden characters etc.) names after Preview (but before renaming).
|-
| Clear Marked
| Clear all marked files.
|-
| Clear Not Marked
| Clear all files that are not marked.
|-
| Clear Not Changed '''Ctrl+D'''
| Clear all files that haven't been changed by the Preview. This also includes all files that have their New Name field empty (eg. because they have been successfully renamed or haven't been previewed since last renaming operation).
|}

=== Select submenu ===

<center>[[Image:SelectSubmenu.png]]</center>
Note: Selection of files is explained [[ReNamer:Adding files and folders#Selecting_files|here]]. 

{| class="prettytable"
|-
| Select All'''  Ctrl+A'''
| All files in the pane will be selected.
|-
| Invert Selection'''  Ctrl+I'''
| Selected files become deselected, and vice versa.
|-
| Select by Name Length  '''Ctrl+L'''
| Pops up a window:
[[Image:SelectByFileNameLengthDialog.png]]

Specify the length of file name. Only files that exceed that length will be selected.

The length refers to the whole filename including dot and the extension.

'''Note''': A typical application is to check if the file can be put on a CD/DVD. The maximum length allowed in ISO 9660-compliant file-system is 64 characters. Longer file names are truncated when you burn a CD/DVD. It is difficult to correlate such files with their originals. To avoid such problems, shorten the names ''before'' burning the CD/DVD.

|-
| Select by Extension '''Ctrl+E'''
| Pops up a window:
[[Image:SelectByExtnDialog.png]]

Specify the extension (without the dot). All files having that extension will be selected.

You can enter multiple extensions (they must be separated by semicolons - not comma).

|-
| Select by Mask'''  Ctrl+M'''
| Pops up this window:
[[Image:SelectByMask.png]]

Specify the [[ReNamer:Masks|mask]]. All files matching that pattern will be selected. You can enter multiple masks (they must be separated by semicolons - not comma).

|}

=== Move submenu ===
<center>[[Image:MoveSubmenu.png]]</center>
 

{| class="prettytable"
|-
| Up '''Ctrl+Up'''
| Moves the selected file up. This is used to re-arrange files in the list.
It is easier to use the keyboard shortcut '''CTRL+UpArrow'''.

|-
| Down '''Ctrl+Down'''
| Moves the selected file down. This is used to re-arrange the files list.
It is easier to use the keyboard shortcut '''CTRL+DownArrow'''.

|}

== Filters menu ==

When you click on the [[Image:FiltersButton.png]] button, the '''Filters''' window pops up. It controls what gets added to the '''Files''' pane when you use the [[Image:AddFoldersButton.png]] button or [[ReNamer:Adding files and folders#Adding files using the Drag-and-drop method|Drag & Drop]] or [[ReNamer:Adding files and folders#Adding files using the copy-and-paste method |Copy & Paste]] methods. 

{| class="prettytable"
|-
| [[Image:FilterSettingsDialog.png]]
| The options work as follows:
{| class="prettytable"
|-
| <center>'''Option'''</center>
| <center>'''Effect'''</center>
|-
| Add files within folders
| When this option is selected, ReNamer scans the selected folders iteratively (including its subfolders), and loads all the files for renaming. If you want to rename only the folders (and not their contents), UNTICK this option, and select the '''Add folders as files''' checkbox.
|-
| Add folders as files
| If this option is selected, ReNamer treats a folder just like a file (not as a container that holds files and subfolders). So only the folder is loaded, and not the files in it. This is useful for renaming the folder itself.
|-
| Include subfolders
| Loads contents from all subfolders recursively. If this option is unselected, when you add a folder, its subfolders will be ignored.
|-
| Include hidden items
| To protect hidden items, deselect this option.
|-
| Include system items
| To protect files reserved for system (OS), deselect this option.
|-
| Skip root folders when added as files
| Works when the ''Add folders as files'' and ''Include subfolders'' options are selected. When it's on, ReNamer adds all the subfolders but not the root folder itself.
|-
| Masks
| All added files (or folders as files) must match specified [[ReNamer:Masks|mask(s)]]. For example, if you enter '''*.jpg;*.gif;*.png''' as masks, ReNamer will add only files with these extensions. Everything else will be filtered ''out''(not added to ReNamer).
|-
| Apply only to the file name
| Changes how the masks (see above) are applied.
For example, suppose you have file '''''C:\Folder\File.ext'''''. If ''this'' option is ON, only the filename part ('''''File.ext''''') will be checked against the mask(s). But if ''this'' option is OFF, the entire path ('''''C:\Folder\File.ext''''') will be checked against the mask(s).

|}

Press '''Save''' to save changes.

|}

'''Filters''' menu is also accessible from the '''Add Folder''' window. For details see [[ReNamer:Adding files and folders#Adding items using the 'Add Folders' button |Adding items using the 'Add Folders' button]] section.

== Export menu ==
When you click on the [[Image:ExportButton.png]] button, the following list pops up:

<center>[[Image:ExportMenu.png]]</center>

{| class="prettytable"
| Export file paths and undo paths
| Exports ''file paths'' and ''undo paths'' to the .csv (comma separated) or .txt (tab separated) file.

|-
| Export file paths and new names
| Exports ''file paths'' and ''new names'' to the .csv (comma separated) or .txt (tab separated) file.

|-
| Import file paths and new names
| Imports ''file paths'' and ''new names'' from the .csv (comma separated) or .txt (tab separated) file.

|-
| Import files from text-list or play-list
| Imports ''file paths'' from the .txt/.log file (one file per line) or .m3u/.pls playlist.

'''Note:''' It will load file paths into '''Files''' pane only if the file really exists on your file system.
|-
| Export new names to clipboard
| Export ''new names'' to clipboard. One name per line.

|-
| Import new names from clipboard
| Imports ''new names'' from clipboard. Every name should be placed in a new line.

If there is less lines in the clipboard text than files in '''Files''' pane last files won't be renamed. 
If there is more lines in the clipboard text than files in '''Files''' pane, then last lines won't be used.
|-
| Export all columns to clipboard
| Exports ''all columns'' to clipboard as a tab separated text.
|}

== Options menu ==

When you click on the [[Image:OptionsButton.png]] button, the following list pops up:
<center>[[Image:OptionsMenu.png]]</center>
{| class="prettytable"
|-
| Autosize columns
| Auto-size all columns, to accommodate the longest entry in each column.
|-
| Validate new names
| Check if the new names are valid.
|-
| Fix conflicting new names
| Add incremental numbers as suffixes to avoid conflicts in names. For example, if a new name for a file is Name1, and if such a file already exists in the target folder, then a suffix (2) is added to the newly renamed file. If more than one files have such name conflicts, ReNamer uses incremental numbers (i.e. (2), (3)...) as suffixes to make sure that each file gets a unique name.
|-
| Highlight changed names
| Usually you load files only because you want to change their names. Yet, sometimes, some files escape all the rules you have loaded and remain unchanged. In such cases, you may want to know why that happened.
ReNamer can highlight files that are going to be changed. Now you can investigate the remaining files.

'''Note:''' ''Highlight changed names'' option works as a switch: it turns highlighting ON and OFF.

'''Tip:''' You can unmark the rules selectively and see the effect on the files. That will tell you which rules are working on which files. Once your analysis is over, you can mark all rules.

|-
| Analyze sample text
| It opens the [[ReNamer:Analyze|Analyze window]].
Thanks to that option you don't have to load files to the '''Files''' pane just to check if your rules work as desired. 
It is extremally useful when you want to help others on the forum.

*Enter any text that looks like your target files, and see whether the rules work as desired on that text.
*Edit the rules if the desired result is not achieved
*Once you are satisfied with the rules, apply them on the real files or post the set of rules on the forum.

'''Note:''' Analyze sample text won't be any help if the rules base on the files properties (and not only on the filename). Analyze tool won't be able eg. to extract Meta tag from the text in its window.

|-
| Apply rules to the clipboard
| When you choose this option your rules will be applied to the text in clipboard instead of files in the '''Files''' pane. This might be useful eg. when working with word processors that don't support RegEx'es.
|-
| Count marked and selected files '''Alt + I'''
| It pops up a window like this
<center>[[Image:Count_marked_selected.png]]</center>

where '''Total''' stands for total number of files loaded into the '''Files''' pane, and
'''Marked''' and '''Selected''' stand for number of marked and selected files respectively.

|}
[[Category:ReNamer]]

ReNamer:Rules:Extension

2012-02-14T02:20:08Z

Narayan: /* Extension Rule */

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Rearrange|next=ReNamer:Rules:Strip}}

== Extension Rule ==

<center>[[Image:ExtensionsRule.png]]</center>
This rule allows you to attach a new extension. It is useful when the extension of a file is missing (or if the file has a wrong extension). There is an option to find the correct extension based on the file's structure.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| New extension
| New extension that has to be added to the filename.

|-
| Append to the original filename
| If this option is selected, the new extension will be placed after the old extension.
If it is deselected (default option) the new extension will replace the old one.

|-
| Detect using binary signature
| Sometimes the extension of a file is missing. At other times it is wrong (e.g. some downloaded files get the '''aspx '''extension, although they may ''actually'' be '''zip '''or '''pdf''' files.)
One way to identify the file extension is by trial-and-error: Attach different extensions and try to open the file with its associated application. This is very tedious.

A far more efficient way is to compare the file's ''digital signature'' with the signatures of known file types and identify the file's type. This is done internally within ReNamer, so you do not have to know what a "digital signature" means, or the actual value of the signature for the given file.

Note that each extension has a range of signatures, and these ranges overlap. This means a given file's signature may match with the signature of several different extensions. In such cases, ReNamer shows the New filename with all matching extensions. For example, "fileName.wma|wmv|asf". ReNamer also pops up an error window (because the combined extension is invalid). Just read the suggested extensions and then try them out one by one. This method is still better compared to making wild guesses, because ReNamer suggests only 2-3 extensions.

For more accurate results, use [[ReNamer:Scripts:TrID|ReNamer with TrID script]], a specialized utility for identifying the file's real extension. Be aware that even TrID often suggests multiple extensions, and you still have to try them out.
|}

[[Category:ReNamer]]

ReNamer:Menus for the Files pane

2012-02-14T01:56:41Z

Narayan: /* Filters menu */

{{Cleanup|
* Breakdown into separate articles, one for each main section/menu
* Clear formatting artifacts from rich editor
* Update linking from other articles}}

ReNamer has a menu bar between the '''Rules''' and '''Files''' panes [[Image:MenuStrip.png]].

This appendix describes options available from this menu.

== Files button ==

When you click on the [[Image:FilesButton.png]] button, the following list pops up:

<center>[[Image:FileMenu.png]]</center>

{| class="wikitable"
|-
| Analyze Name
| Opens [[ReNamer:Analyze|analysis window]], and loads the names of the selected files into it.
|-
| Edit New Name '''F2'''
| Starts manual editing of the selected filename.
|-
| [[ReNamer:Menus for the Files pane#Shell submenu|Shell]]
| Options for Windows shell operations.
|-
| [[ReNamer:Menus for the Files pane#Mark submenu|Mark]]
| Options for [[ReNamer:Adding_files_and_folders#Marking_and_Unmarking_the_files|marking]] specific items.
|-
| [[ReNamer:Menus for the Files pane#Clear submenu|Clear]]
| Options for [[ReNamer:Adding_files_and_folders#Marking_and_Unmarking_the_files|removing]] specific items from the '''Files''' pane.
|-
| [[ReNamer:Menus for the Files pane#Select submenu|Select]]
| Options for [[ReNamer:Adding_files_and_folders#Selecting_files|selecting]] specific items.
|-
| [[ReNamer:Menus for the Files pane#Move submenu|Move]]
| Options for moving specific items.
|-
| Remove selected items '''Del'''
| Remove selected items from the ReNamer's '''File''' pane. (This command does not delete the items from the disk.)
|}

This menu provides second-level options, as follows:

=== Shell submenu ===

<center>[[Image:ShellSubMenu.png]]</center>

{| class="wikitable"
|-
| Open File
| '''Enter'''
| Open the selected file using its default associated application.
|-
| Open with Notepad
| '''Shift+Enter'''
| Open the file with notepad. Useful when you want to see the raw data in the file. (When viewed this way, the file will not be displayed in its original formatting. It may not be easily readable.)
|-
| Open operating folder
| '''Ctrl+Enter'''
| Launch Windows Explorer and open the folder where the selected file is located. Highlight (select) the file in it.
|-
| File properties
| '''Alt+Enter'''
| Display the properties of the selected file. Typically, file size, dates (created/modified/accessed), comments, author, attributes (hidden, system, etc.)
|-
| Cut Files to clipboard
| '''Shift+Ctrl+X'''
| Cuts the selected file(s) to clipboard. '''Note:''' If you paste these files in Windows Explorer, all files will be moved to one folder, no matter where they were initially located.
|-
| Copy Files to clipboard
| '''Shift+Ctrl+C'''
| Copies selected file(s) to clipboard. '''Note:''' If you paste these files in Windows Explorer, all files will be copied to one folder, no matter where they were initially located.
|-
| Delete files to Recycle Bin
|
| Deletes the selected file(s) to Recycle Bin. (They can be recovered from the Recycle Bin.)
Note that if the file is too large for the Recycle Bin, Windows will warn you that it will not be put in Recycle Bin, but deleted permanently. If you confirm, the file is deleted permanently.

|}

There are 2 possible uses for '''Copy to clipboard''' and '''Cut to clipboard''' options:
* 3rd party application can retrieve that list of files from the clipboard (using Paste operation or Win API).
* Paste all files into a singe destination folder via Windows Explorer, even when files are scattered across different directories.

=== Mark submenu ===

<center>[[Image:MarkSubmenu.png]]</center>
'''Note'''''': '''Marking of files is explained [[ReNamer:Adding files and folders#Marking_and_Unmarking_the_files|here]]. 

{| class="prettytable"
|-
| Mark '''Shift+M'''
| Mark all selected files. If some files are already marked, they remain marked.
|-
| UnMark '''Shift+U'''
| Unmark all selected files. If some files are already unmarked, they remain unmarked.
|-
| Invert Marking '''Ins'''
| Marked files become unmarked, and vice versa.
|-
| Mark only changed (Inc. Case)
| [[ReNamer:Adding files and folders#Marking_and_Unmarking_the_files|Mark]] files that have been changed. Files that had just change of case (and nothing else) will also be marked. ("''Change of case''" means some letters are converted capital-to-small and/or small-to-capital)
|-
| Mark only changed (Exc. Case)
| [[ReNamer:Adding files and folders#Marking_and_Unmarking_the_files|Mark]] files that have been changed, but do not consider changes of case. ("''Change of case''" means some letters are converted capital-to-small and/or small-to-capital)
|-
| Mark only selected
| Mark files that are selected. If some unselected files are already marked, they will be unmarked.
|-
| Mark by Mask
| Pops up a Mask window:
[[Image:MarkByMask.png]]

Specify a mask pattern. All files that match this mask will be marked.

You can enter multiple masks (separating them with semicolon). If a file matches any of these masks, it will be marked.

|}

=== Clear submenu ===

<center>[[Image:ClearSubmenu.png]]</center>
'''Note''': The term "''Clear''" means remove from '''Files''' pane of ReNamer. 

{| class="prettytable"
|-
| Clear All
| Clear all files loaded in the pane.
|-
| Clear Renamed
| Clear all files which have been renamed just before this command. Note that even if some files are not affected by the rules, they are still regarded as renamed successfully.
Only files that failed to rename (those with an '''x''' mark) will remain in the pane.

|-
| Clear Failed
| Only files that failed to rename (those with an '''x''' mark) will be cleared.
All other files (including files whose names were not altered by the rules) will remain in the '''Files''' pane.

|-
| Clear Valid
| Clear files that have valid names after Preview (but haven't been renamed yet).
|-
| Clear Invalid
| Clear files that got invalid (causing conflicts, empty or with forbidden characters etc.) names after Preview (but before renaming).
|-
| Clear Marked
| Clear all marked files.
|-
| Clear Not Marked
| Clear all files that are not marked.
|-
| Clear Not Changed '''Ctrl+D'''
| Clear all files that haven't been changed by the Preview. This also includes all files that have their New Name field empty (eg. because they have been successfully renamed or haven't been previewed since last renaming operation).
|}

=== Select submenu ===

<center>[[Image:SelectSubmenu.png]]</center>
Note: Selection of files is explained [[ReNamer:Adding files and folders#Selecting_files|here]]. 

{| class="prettytable"
|-
| Select All'''  Ctrl+A'''
| All files in the pane will be selected.
|-
| Invert Selection'''  Ctrl+I'''
| Selected files become deselected, and vice versa.
|-
| Select by Name Length  '''Ctrl+L'''
| Pops up a window:
[[Image:SelectByFileNameLengthDialog.png]]

Specify the length of file name. Only files that exceed that length will be selected.

The length refers to the whole filename including dot and the extension.

'''Note''': A typical application is to check if the file can be put on a CD/DVD. The maximum length allowed in ISO 9660-compliant file-system is 64 characters. Longer file names are truncated when you burn a CD/DVD. It is difficult to correlate such files with their originals. To avoid such problems, shorten the names ''before'' burning the CD/DVD.

|-
| Select by Extension '''Ctrl+E'''
| Pops up a window:
[[Image:SelectByExtnDialog.png]]

Specify the extension (without the dot). All files having that extension will be selected.

You can enter multiple extensions (they must be separated by semicolons - not comma).

|-
| Select by Mask'''  Ctrl+M'''
| Pops up this window:
[[Image:SelectByMask.png]]

Specify the [[ReNamer:Masks|mask]]. All files matching that pattern will be selected. You can enter multiple masks (they must be separated by semicolons - not comma).

|}

=== Move submenu ===
<center>[[Image:MoveSubmenu.png]]</center>
 

{| class="prettytable"
|-
| Up '''Ctrl+Up'''
| Moves the selected file up. This is used to re-arrange files in the list.
It is easier to use the keyboard shortcut '''CTRL+UpArrow'''.

|-
| Down '''Ctrl+Down'''
| Moves the selected file down. This is used to re-arrange the files list.
It is easier to use the keyboard shortcut '''CTRL+DownArrow'''.

|}

== Filters menu ==

When you click on the [[Image:FiltersButton.png]] button, the '''Filters''' window pops up. It controls what gets added to the '''Files''' pane when you use the [[Image:AddFoldersButton.png]] button or [[ReNamer:Adding files and folders#Adding files using the Drag-and-drop method|Drag & Drop]] or [[ReNamer:Adding files and folders#Adding files using the copy-and-paste method |Copy & Paste]] methods. 

{| class="prettytable"
|-
| [[Image:FilterSettingsDialog.png]]
| The options work as follows:
{| class="prettytable"
|-
| <center>'''Option'''</center>
| <center>'''Effect'''</center>
|-
| Add files within folders
| When this option is selected, ReNamer scans the selected folders iteratively (including its subfolders), and loads all the files for renaming. If you want to rename only the folders (and not their contents), UNTICK this option.
|-
| Add folders as files
| If this option is selected, ReNamer treats folder just like a file (not as a container that holds files and subfolders). So only the folder is loaded, and not the files in it. This is useful for renaming the folder itself.
|-
| Include subfolders
| Loads contents from all subfolders recursively.
|-
| Include hidden items
| To protect hidden items, deselect this option.
|-
| Include system items
| To protect files reserved for system (OS), deselect this option.
|-
| Skip root folders when added as files
| Works when the ''Add folders as files'' and ''Include subfolders'' options are selected. When it's on, ReNamer adds all the subfolders but not the root folder itself.
|-
| Masks
| All added files (or folders as files) must match specified [[ReNamer:Masks|mask(s)]]. For example, if you enter '''*.jpg;*.gif;*.png''' as masks, ReNamer will add only files with these extensions. Everything else will be filtered ''out''(not added to ReNamer).
|-
| Apply only to the file name
| Changes how the masks (see above) are applied.
For example, suppose you have file '''''C:\Folder\File.ext'''''. If ''this'' option is ON, only the filename part ('''''File.ext''''') will be checked against the mask(s). But if ''this'' option is OFF, the entire path ('''''C:\Folder\File.ext''''') will be checked against the mask(s).

|}

Press '''Save''' to save changes.

|}

'''Filters''' menu is also accessible from the '''Add Folder''' window. For details see [[ReNamer:Adding files and folders#Adding items using the 'Add Folders' button |Adding items using the 'Add Folders' button]] section.

== Export menu ==
When you click on the [[Image:ExportButton.png]] button, the following list pops up:

<center>[[Image:ExportMenu.png]]</center>

{| class="prettytable"
| Export file paths and undo paths
| Exports ''file paths'' and ''undo paths'' to the .csv (comma separated) or .txt (tab separated) file.

|-
| Export file paths and new names
| Exports ''file paths'' and ''new names'' to the .csv (comma separated) or .txt (tab separated) file.

|-
| Import file paths and new names
| Imports ''file paths'' and ''new names'' from the .csv (comma separated) or .txt (tab separated) file.

|-
| Import files from text-list or play-list
| Imports ''file paths'' from the .txt/.log file (one file per line) or .m3u/.pls playlist.

'''Note:''' It will load file paths into '''Files''' pane only if the file really exists on your file system.
|-
| Export new names to clipboard
| Export ''new names'' to clipboard. One name per line.

|-
| Import new names from clipboard
| Imports ''new names'' from clipboard. Every name should be placed in a new line.

If there is less lines in the clipboard text than files in '''Files''' pane last files won't be renamed. 
If there is more lines in the clipboard text than files in '''Files''' pane, then last lines won't be used.
|-
| Export all columns to clipboard
| Exports ''all columns'' to clipboard as a tab separated text.
|}

== Options menu ==

When you click on the [[Image:OptionsButton.png]] button, the following list pops up:
<center>[[Image:OptionsMenu.png]]</center>
{| class="prettytable"
|-
| Autosize columns
| Auto-size all columns, to accommodate the longest entry in each column.
|-
| Validate new names
| Check if the new names are valid.
|-
| Fix conflicting new names
| Add incremental numbers as suffixes to avoid conflicts in names. For example, if a new name for a file is Name1, and if such a file already exists in the target folder, then a suffix (2) is added to the newly renamed file. If more than one files have such name conflicts, ReNamer uses incremental numbers (i.e. (2), (3)...) as suffixes to make sure that each file gets a unique name.
|-
| Highlight changed names
| Usually you load files only because you want to change their names. Yet, sometimes, some files escape all the rules you have loaded and remain unchanged. In such cases, you may want to know why that happened.
ReNamer can highlight files that are going to be changed. Now you can investigate the remaining files.

'''Note:''' ''Highlight changed names'' option works as a switch: it turns highlighting ON and OFF.

'''Tip:''' You can unmark the rules selectively and see the effect on the files. That will tell you which rules are working on which files. Once your analysis is over, you can mark all rules.

|-
| Analyze sample text
| It opens the [[ReNamer:Analyze|Analyze window]].
Thanks to that option you don't have to load files to the '''Files''' pane just to check if your rules work as desired. 
It is extremally useful when you want to help others on the forum.

*Enter any text that looks like your target files, and see whether the rules work as desired on that text.
*Edit the rules if the desired result is not achieved
*Once you are satisfied with the rules, apply them on the real files or post the set of rules on the forum.

'''Note:''' Analyze sample text won't be any help if the rules base on the files properties (and not only on the filename). Analyze tool won't be able eg. to extract Meta tag from the text in its window.

|-
| Apply rules to the clipboard
| When you choose this option your rules will be applied to the text in clipboard instead of files in the '''Files''' pane. This might be useful eg. when working with word processors that don't support RegEx'es.
|-
| Count marked and selected files '''Alt + I'''
| It pops up a window like this
<center>[[Image:Count_marked_selected.png]]</center>

where '''Total''' stands for total number of files loaded into the '''Files''' pane, and
'''Marked''' and '''Selected''' stand for number of marked and selected files respectively.

|}
[[Category:ReNamer]]

ReNamer:Adding files and folders

2012-02-14T01:50:28Z

Narayan: /* Adding items using the 'Add Folders' button */

{{Go|up=ReNamer:Step-by-step|next=ReNamer:Managing rules}}

In this section, we will see how to place files and folders in ReNamer's working area (also called the '''Files pane'''). This consists of:

#Adding files and folders,
#Removing some files from the pane, and
#Changing the order of files in the pane.

ReNamer has multiple methods for these actions, as described below

=== Adding files using the 'Add Files' button ===

#Press the [[Image:AddFilesButton.png]] button. The following window pops up:
#:<center>[[Image:ReNamer Open Dialog.png]]</center>
#Navigate to the required folder and [[ReNamer:Adding files and folders#Selecting_files|select]] files.
#Press '''OK. '''The selected files are added to ReNamer's '''Files pane'''.
#Repeat steps 1-3 to load files from other folders (as required).

=== Adding items using the 'Add Folders' button ===

#To add all the files belonging to a folder, press the [[Image:AddFoldersButton.png]] button.
#:The following window pops up:
#:<center>[[Image:ReNamer Browse Dialog.png]]</center>
#:*When you select a node in the tree, all its sub-nodes are automatically selected. In other words, when you select a folder, its subfolders are automatically selected.
#:*By default, ReNamer adds all files from a folder, but ''not'' the folder itself. So if you want to rename the folder itself (and not its contents), then select this option using the [[ReNamer:Menus for the Files pane#Filters_menu|'''Filters''']].
#:*You can select any node from the tree. That means you can even select any/all drives on your computer!
#:*You can select multiple nodes at a time, by pressing '''CTRL''' first and then cliking on different nodes of the tree. All those nodes will be added at one stroke.
#If you want to add only certain items from the selected folder, set ReNamer's [[ReNamer:Menus for the Files pane#Filters_menu|'''Filters''']] by clicking on the [[Image:FilterSettingsButton.png]] button and then selecting different options. Depending on your selected options in this window, the '''Add folders''' window will add different items to ReNamer's '''Files pane'''.
#*You can also set the filters by clicking the [[Image:FiltersButton.png]] button (located above the '''Files pane''')
#Navigate to the desired folder and press the [[Image:AddFolderButton.png]]  button.

=== Adding files using the Drag-and-drop method ===

Select the files in any application and drag-and-drop them into ReNamer's '''Files pane'''.

*To drag-and-drop, click on your file selection with LMB. Without releasing the LMB, start moving the mouse. Now bring the mouse pointer over the ReNamer's '''Files pane''', and then release the LMB.
**If the ReNamer's window is not visible, first drag your selection onto ReNamer's task button [[Image:ReNamerTaskbarButton.png]] in Windows '''Task''' toolbar (located at the bottom of your screen). Wait for a couple of seconds without releasing the LMB. The ReNamer window pops up, and ''stays above the other applications' windows'' on your screen. Now you can move your mouse over the ReNamer window and drop your selection in its '''Files pane'''.
**You can also use the ReNamer's [[ReNamer:Program settings#General_settings|'''General settings''']] to keep its window above the other windows, so even when you are working in the other applications, the ReNamer window stays on top of the other applications' windows.

=== Adding files using the copy-and-paste method ===

Select the files in any application and press '''CTRL+C''' to copy them into the clipboard. Now switch to ReNamer and press '''SHIFT+CTRL+V'''.

Note that:

*Renamer does not use the usual keyboard shortcut '''CTRL+V'''.
*It is not necessary to click inside the '''Files''' pane for the ''paste'' operation.

=== Removing files or folders from pane ===

If you have added more files by mistake, you can remove them easily in just two steps:

#[[ReNamer:Adding files and folders#Selecting_files|Select]] the items
#Press the '''DEL''' key. (This only removes the files/folders from the ReNamer. It does not delete them from the disk!)

=== Changing the order of the files in the pane ===

Certain rules (e.g. the [[ReNamer:Rules:Serialize|Serialize Rule]]) act on the list of the files in "from-top-to-bottom" order (as opposed to acting on each file independently). In such cases, each file gets its name based on its position in the list. (For example, the ''n''th file in the list is named Track-n.mp3.)

Normally, the files are listed in the order you added them to the pane (the most recently added file goes to the bottom of the list). But you can change the position of the files in the list.

Just click on the file and drag it to the new position.

*You can [[ReNamer:Adding files and folders#Selecting_files|select]] multiple files and drag all of them ''as a group'' to the new position.

=== Sorting files in the files pane ===

You can also sort files in the '''Files pane''' by any column with just a click on the column title. The little triangle will show up to indicate the order of sorting. For more information have a look at the full article on [[ReNamer:Sorting files|sorting files]].

=== Selecting files ===

When a file is selected, its entire row is highlighted with blue background.

{| class="prettytable"
|-
| Selected file
| [[Image:SelectedFile.png]]
|-
| Unselected file
| [[Image:UnselectedFile.png]]
|}

ReNamer allows you to carry out specific operations on selected files.

You can select one or more files by the following methods:

#Click anywhere in the row except on the check box.
#*To select non-adjacent files, press '''CTRL''' and then click on individual rows.
#*To select files listed in adjacent rows, first click on the row at one end, then keep the '''SHFT''' pressed down, and click on the row at the other end.
#Draw a lasso (rectangle) with the mouse in the '''Files pane'''. All the rows touched by the rectangle are selected.
#*If you repeat these actions on an item, they toggle the selection status (selected-unselected).

When only one row is selected, use Up/Down arrow keys to change the selection to another row.

=== Marking and Unmarking the files ===

A file is marked by putting a tick in its check box [[Image:CheckedCheckbox.png]]. Conversely, it is unmarked by removing the tick [[Image:UncheckedCheckbox.png]].

ReNamer acts only on the ''marked'' files. An ''unmarked'' file is neither previewed nor renamed.

So unmarking a file is useful to exempt a file from renaming, ''without'' having to remove it from the '''Files pane'''.

To mark/unmark the files:

#Click on the check box.
#Select the files and press the '''Spacebar''' (on keyboard)

(Repeat of these actions on any item toggles its ''marked''/''unmarked'' status.)

Note that the ''marked''/''unmarked'' status of a file has no relation with its ''selected''/''unselected'' status.

[[Category:ReNamer]]

ReNamer:Regular Expressions

2011-02-23T03:00:58Z

Narayan:

{{Cleanup|
* Replace all span color highlights with custom '''hl-*''' classes found in [[MediaWiki:Common.css]].(krtek: probably already done)
* Replace all '''""''' (0x201C and 0x201D) quotes with normal '''""''' (0x22). (krtek: probably already done)
* Get rid of not needed <nowiki>'''</nowiki> wiki style bold around span '''hl-*''' classes, which are bold by definition (den4b: 40% done)
* Check for italized " (quotes) and make them normal. Especially ending quotes got italized or bolded.
* }}

Regular Expressions (RegEx) allow you to use precise search conditions, such as:

*Your search string ''must'' be located at the beginning (or at the end) of a line,
*The specified text must occur ''n'' times, etc.

RegEx expressions use $ . ^ { [ ( | ) * + ? \ characters (called ''metacharacters'') in various combinations to specify all these conditions.The search engine ''interprets'' these metacharacters, rather than finding a literal match for them.

The RegEx search expression is called a "'''''RegEx pattern"''''', because a single expression can match a large number of actual text that has the specified ''pattern.'' For example, the RegEx pattern b?t matches with '''bat''', '''bet''', '''bit''', '''bot''' and '''but''', etc.

Remember that RegEx strings are case-sensitive (The words cat, CAT, cAt, Cat, caT, cAT, CAt and CaT are not equivalent).

So our RegEx pattern b?t also matches with '''bAt''', '''bEt''', '''bIt''', '''bOt''' and '''bUt''', etc.

Also, note that even the digits (0-9) are "numeric characters" for RegEx.

So our RegEx pattern b?t also matches with '''b5t''', '''b7t''', etc.

In this section, the RegEx expressions (patterns) are shown in bold orange. The target strings (which are compared with the RegEx expression for a possible match) are shown in '''bold black'''. A part of the target text is color-coded to provide a clue as to why a certain part matches (green color), or does not match (red color)

=== Simple (literal) matches ===

When the search string does not contain any metacharacters, the RegEx engine works like "normal" search. (it tries to find an exact copy of the search string.) (This is also known as "literal match").

If you want to find a literal match for a metacharacter, put a backslash '''\''' ''before'' it. (The \ character is called "''escape character''", because it lets the metacharacter escape from its special duty, and lets it act as a normal character. Its combination with a metacharacter is called "''escape sequence''").

For example, metacharacter ^ matches the beginning of string, but \^ matches the character ^.

Note that the RegEx pattern \\ matches the character \.

{| class="wikitable"
|-
! RegEx pattern
! Matches
! Remarks
|-
| <center>foobar</center>
| <center>foobar</center>
| This RegEx pattern does not contain any metacharacters; so all characters are matched literally.
|-
| <center>\^FooBarPtr</center>
| <center>^FooBarPtr</center>
| The \^ escape sequence searches for the character '''^''' ''literally'' .
|}

=== Escape sequences ===

We already saw one use of escape sequence (above).

Specific escape sequences are interpreted as special conditions, as listed below.

{| class="wikitable"
|-
! RegEx pattern
! matches
|-
| <center>\xnn</center>
| Character represented by the hex code ''nn''
|-
| <center>\x{nnnn}</center>
| two bytes char with hex code nnnn (unicode)
|-
| <center>\t</center>
| tab (HT/TAB), same as \x09 (Hex 09)
|-
| <center>\n</center>
| new line (NL), same as \x0a (Hex 0a)
|-
| <center>\r</center>
| carriage return (CR), same as \x0d (Hex 0d)
|-
| <center>\f</center>
| form feed (FF), same as \x0c (Hex 0c)
|-
| <center>foo\x20bar</center>
| matches foo bar (note the space in the middle), but does ''not'' match '''foobar'''
|-
| <center>\tfoobar</center>
| matches foobar preceded by a tab (the tab is needed for the match)
|}

Note that the tab, new line, carriage return, and form feed are known as "white spaces". But RegEx can distinguish between them. This allows you to make high-precision searches.

=== Character Classes ===

A character class is a list of characters in square brackets [], which will match any one (and ''only one''-) character from the list.

Note that:

* The characters are not separated with a comma or a space.
* If you repeat any character in the list, it is considered only once (duplicates are ignored).
* A hyphen - is used to indicate range of characters.

{| class="wikitable"
|-
! RegEx Pattern
! Remarks
|-
| <center>[abdef]</center>
| Matches d, e, or f (only ''one'' character), but no other characters
|-
| <center>[c-m]</center>
| Matches any one (and only one) of the small alphabetical characters, from c to m
|-
| <center>[G-J]</center>
| Matches any one (and only one) of the capital alphabetical characters from G to J
|-
| <center>[a-zA-Z]</center>
| Matches any one (and only one) of the alphabetical characters (capital or small)
|-
| <center>[5-8]</center>
| Matches any one (and only one) of numerical characters from 5 to 8
|-
| <center>[\n-\x0D]</center>
|
Matches any one (and only one) of #10, #11, #12 or #13 (Note the use of [[ReNamer:Regular Expressions#Simple_.28literal.29_matches|escape sequence]] inside a class)

|}

There are some special conditions:

*If you do not want any of the characters in the specified class, then place ^ at the very beginning of the list (RegEx interprets that as "none of the characters listed in this class").
*If you want [ or ] itself to be a member of a class, put it at the start or end of the list, or create a [[ReNamer:Regular Expressions#Simple_.28literal.29_matches|escape sequence]] (by putting \ before it).

{| class="wikitable"
|-
! RegEx Pattern
! Remarks
|-
| <center>[-az]</center>
| matches '''a'','''''z''', and '''-''' '''(since '''–''' is put at the beginning, the escape sequence is not needed)
|-
| <center>[a\-z]</center>
| matches '''a'','''''z''', and '''-''' ''' (since '''–''' is ''not'' at the beginning/end, the escape sequence ''is'' needed)
|-
| <center>[^0-9]</center>
| matches any ''non-digit'' character
|-
| <center>[]-a]</center>
| matches any character from ''']''' to '''a'''. (since '''] '''is at the beginning, the escape sequence ''is'' ''not'' needed)
|-
| <center>foob[aeiou]r</center>
| Matches with '''foob'''''a'''''r''', '''foob'''''e'''''r,''' etc. but not '''foob'''''b'''''r''', '''foob'''''c'''''r''', etc.
|-
| <center>foob[^aeiou]r</center>
| Matches with '''foob'''''b'''''r''', '''foob'''''c'''''r''' etc. but not '''foob'''''a'''''r''', '''foob'''''e'''''r''', etc.
|}

@@@ The "]-a" example would need a clarification as to what is the natural sequence of characters, and where is a superset of all possible characters described?

=== Predefined Classes ===

Some of the character classes are used so often that RegEx has predefined escape sequences to represent them.

{| class="wikitable"
|-
! RegEx Pattern
! Remarks
|-
| <center>\w</center>
| an alphanumeric character, including an ''underscore'' ('''_''')
|-
| <center>\W</center>
| a non-alphanumeric character
|-
| <center>\d</center>
| a numeric character
|-
| <center>\D</center>
| a non-numeric character
|-
| <center>\s</center>
| any space (same as the [ \t\n\r\f] class)
|-
| <center>\S</center>
| a non space
|-
| <center>.</center>
| any character in line (the symbol is just a dot)
|}

Notice that the capitalized letter is used to negate (for example, compare \w with \W)

=== Word/Text Boundaries ===

A word boundary (\b) is a spot between two characters that has a \w on one side of it and a \W on the other side of it (in either order), counting the imaginary characters off the beginning and end of the string as matching a \W.

{| class="wikitable"
|-
! RegEx Pattern
! Remarks
|-
| <center>\b</center>
| word boundary
|-
| <center>\B</center>
| not word boundary
|-
| <center>\A</center>
| start of text (^ is an alternative)
|-
| <center>\Z</center>
| end of text ($ is an alternative)
|}

These markers are combined with the search string to specify where exactly you want the search string to be. For example, \bhis\b will search for a whole word '''his''', but will ignore t'''his''', '''his'''tory or whistle.

=== Iterators (Quantifiers) ===

Iterators (quantifiers) are meta-characters that specify how many times the ''preceding'' expression has to repeat, A typical example is to find a 3-to-5 digit number.

RegEx newbies often place the iterators ''after'' the character that needs to repeat. Just remember that RegEx syntax is exact opposite of the usual English syntax. So, instead of "''four dogs''", we would have to say "''dogs four''", RegEx-style.

Iterators can be 'Greedy' or 'Non-Greedy'. Greedy means the expression grabs as ''much'' matching text as possible. In contrast, the non-greedy expression tries to match as ''little'' as possible.

For example,

*when '''b+''' (a greedy expression) is applied to string '''abbbbc''', it returns '''bbbb''',
*but when '''b+? '''(a non-greedy expression) is applied to '''abbbbc''', it returns only '''b'''.

Note that a '''? '''attached to a greedy expression makes it non-greedy.

{| class="wikitable"
|-
! RegEx pattern
! Remarks
! Greedy?
! Remarks
|-
| <center>'''*'''</center>
| zero or more
| <center>Yes</center>
| equivalent to '''{0,}'''
|-
| <center>'''+'''</center>
| one or more
| <center>Yes</center>
| equivalent to '''{1,}'''
|-
| <center>'''?'''</center>
| zero or one
|
| equivalent to '''{0,1}'''
|-
| <center>'''{n}'''</center>
| exactly ''n'' times
| <center>Yes</center>
|
|-
| <center>'''{n,}'''</center>
| at least ''n'' times
| <center>Yes</center>
|
|-
| <center>'''{n,m}'''</center>
| at least ''n'' but not more than ''m'' times
| <center>Yes</center>
|
|-
| <center>'''*?'''</center>
| zero or more
| <center>No</center>
| equivalent to '''{0,}?'''
|-
| <center>'''+?'''</center>
| one or more
| <center>No</center>
| equivalent to '''{1,}?'''
|-
| <center>'''??'''</center>
| zero or one
| <center>No</center>
| equivalent to '''{0,1}?'''
|-
| <center>'''{n}?'''</center>
| exactly ''n'' times
| <center>No</center>
|
|-
| <center>'''{n,}?'''</center>
| at least ''n ''times
| <center>No</center>
|
|-
| <center>'''{n,m}?'''</center>
| at least ''n'' but not more than ''m'' times
| <center>No</center>
|
|}

Let us see some examples:

{| class="wikitable"
|-
! RegEx pattern
! Remarks
|-
| <center>'''foob.*r'''</center>
| matches '''foobar''', '''foobalkjdflkj9r''' and '''foobr'''
|-
| <center>'''foob.+r'''</center>
| matches '''foobar''', '''foobalkjdflkj9r''' but not '''foobr'''
|-
| <center>'''foob.?r'''</center>
| matches '''foobar,''' '''foobbr''' and '''foobr''' but not '''foobalkj9r'''
|-
| <center>'''fooba{2}r'''</center>
| matches '''foobaar'''
|-
| <center>'''fooba{2,}r'''</center>
| matches '''foobaar,''' '''foobaaar''', '''foobaaaar''' etc. but not '''foobar'''
|-
| <center>'''fooba{2,3}r'''</center>
| matches '''foobaar''', or '''foobaaar''' but not '''foobaaaar''' or '''foobar'''
|}

=== Alternatives ===

A RegEx expression can have multiple alternative characters or subexpressions. The metacharacter '''|''' is used to separate the alternatives.

For example, '''fee|fie|foe '''will match with '''fee''', '''fie''', or '''foe''' in the target string.

It is difficult to understand where each alternative starts and ends. This is why it is a common practice to include alternatives in parentheses, to make it easier to understand.

For example, '''fee|fie|foe '''can be written as '''f(e|i|o)e''', to make it easier to understand.

Alternatives are tried from left to right, so the first alternative found for which the entire expression matches, is the one that is chosen. For example, when matching '''foo|foot''' against '''barefoot,''' only the '''foo '''part will match, because that is the first alternative tried, and it successfully matches the target string. (This is important when you are capturing matched text using parentheses.)

{| class="wikitable"
|-
! RegEx Pattern
! Remarks
|-
| '''foo(bar|foo)'''
| matches '''foobar''' or '''foofoo'''
|}

Also remember that alternatives cannot be used inside a character class (square brackets), because '''|''' is interpreted as a literal within '''[]'''. That means '''[fee|fie|foe]''' is same as '''[feio|]'''. (The other characters are treated as duplicates, and ignored).

=== Subexpressions ===

Parts of any RegEx pattern can be enclosed in brackets (), just like using brackets in a mathematics formula. Each part that is enclosed in brackets is called a "''subexpression".''

The brackets serve two main purposes:

*Better readability, as in the mathematical formula '''a+(b+c).'''
*Make a functional group, as in the mathematical formula '''a(b+c).''' This group is evaluated first.

Let us see some examples:

{| class="wikitable"
|-
! RegEx Pattern
! Remarks
|-
| <center>'''(fee)|(fie)|(foe)'''</center>
| Much better readability than the equivalent RegEx pattern '''fee|fie|foe'''.
|-
| <center>'''(foobar){2,3}'''</center>
| Matches with the entire enclosed string '''foobar '''repeated 2 or 3 times'''.'''
(i.e., matches with '''foobarfoobar '''or '''foobarfoobarfoobar''') (The iterator acts on the entire subexpression. Compare with the example below!)

|-
| <center>'''foobar{2,3}'''</center>
| Matches with '''fooba''' followed by the character '''r '''repeated 2 or 3 times'''. '''(i.e., matches with foobarr or foobarrr) (The iterator acts only on the last character.)
|-
| '''foob([0-9]|a+)r'''
| matches only the character '''foob0r''', '''foob1r ''', '''foobar''', '''foobaar''', '''foobaaaar''', etc. (The subexpression is evaluated first.)
|}

=== Backreferences ===

You must have told (or heard-) jokes like this one:

"Two guys walk in a bar. The '''''first guy''''' says.... Then the '''''second guy''''' replies....".

Then you are already familiar with ''backreferences''!

A ''"backreference"'' is a ''numbered reference ''to a previously mentioned thing.

RegEx also has backreferences. Let us understand how backreferences are defined in RegEx.

The RegEx engine tries to find text that matches the ''whole'' RegEx pattern. If a matching text is found, the RegEx engine identifies the matching text for each of the subexpressions in the pattern.

At this stage, the RegEx engine gives numbers to these matching parts:

*The text that matches the ''entire'' RegEx expression takes the number '0'.
*The text matching any subexpression is given a number based on the position of that subexpression inside the pattern. In other words, text matching the ''n''th subexpression will take the number 'n'.

Now we use those numbers to refer to the entire pattern and/or subexpressions. (That is why these numbers are called '''"backreference"'''.)

The backreference to the ''n''th subexpression is written as '''\n'''.

The backreferences can be used to compose the RegEx pattern itself, as shown below:

{| class="wikitable"
|-
| <center>'''(.)\1+'''</center>
| matches '''aaaa '''and '''cc '''(any single character that is repeated twice or more)
|-
| <center>'''(.+)\1+'''</center>
| matches '''aaaa''', '''cc''', '''abababab''', '''123123'''
(a set of one or more characters, repeated twice or more)

(The character-sets are alternately colored '''blue''' and '''pink '''for easy identification. Observe how a RegEx pattern can match quite different text! )

|}

==== Substitution of text using backreference ====

The backreferences are also used in ''find-and-replace'' operations, to re-assemble new text from old.

*The expressions '''\1''' through '''\9''' serve as backreferences to the subexpressions found in the RegEx pattern. The expression '''\0 '''is used to represent the text that matches the whole RegEx pattern. These are used in the "find" part of the operation.
*The expressions '''$1''' through '''$9''' represent the actual text that matches the ''respective'' subexpressions.These are used in the "replace" part of the operation.
*The expressions '''$0''' refers to the whole original name. Note: it is not necessary to enclosed them in round brackets () for this use, $0 is just there.

The replacement text is typically a combination of-

*The text that matched the subexpressions, and
*Some new text.

Note that the RegEx pattern ''may'' have some parts that are not enclosed in (). (In other words, it may have parts that are not subexpressions.) Such parts are not used in the replacement text.

Here are some "find-and-replace" examples:

{| class="wikitable"
|-
! Expression
! Replace
! Description
|-
| <center>(.*) (.*)</center>
| <center>$2, $1</center>
| Switch two words around and put a comma after the resulting first word. Example: if input string is "John Smith", then output will be "Smith, John".
Notice that the replacement text also has additional literal text in the middle (comma and space).

|-
| <center>\b(\d{2})-(\d{2})-(\d{4})\b</center>
| <center>$3-$2-$1</center>
| Find date sequences in dd-mm-yyyy format and reverse them into yyyy-mm-dd format. (e.g. 25-10-2007 is converted to 2007-10-25).
'''Note''': This is not a very robust example, because \d can represent any digit in range of 0-9. That means sequences like 99-99-9999 also will match this pattern, resulting in a problem. This in fact shows that you need to be careful with RegEx patterns!

|-
| <center>\[.*?\]</center>
|
| Remove the contents of the [...] (square brackets), and the brackets too. (Replace with ''nothing'' means ''deleting''.)

|}

=== Limitations for binary data ===

One of the known limitation of RegEx engine when working with binary data is that the input string is not search beyond the first occurrence of NULL character (\x00). This would not affect file names because there are simply no NULL characters in them, but may affect parsing of binary content of files when working in [[ReNamer:Pascal Script|Pascal Script]] for example.

=== External links ===

* [http://www.regular-expressions.info/ www.regular-expressions.info]
** Excellent site devoted to regular expressions. Nicely structured and with many easy-to-understand examples.
* [http://www.regexpstudio.com/ www.regexpstudio.com]
** Freeware regular expressions library for Delphi.
[[Category:ReNamer]]

ReNamer:Pascal Script:Quick guide

2011-02-19T05:49:30Z

Narayan: /* Branching */

If you are not familiar with Pascal Scripting, first go through the excellent [http://www.taoyue.com/tutorials/pascal/contents.html tutorial] written by '''Tao Yue'''.

The following is a short overview of Pascal Script. 

== Basic pascal script ==

The structure of a basic script is as follows (keywords are shown in ALLCAPS bold):

{| class="wikitable" style="margin-left: auto; margin-right: auto"
|
'''CONST'''

:''<Constant declarations>''

'''TYPE'''

:''<Type declarations>''

'''VAR'''

:''<Variable declarations>''

'''BEGIN'''

:''<Executable statements>''

'''END.'''
|}

Note that:
* The main code must be within the '''begin''' and '''end.''' keywords.
* All statements in the script use the semicolon "''';'''" as terminator. Only the last statement ('''END.''') uses a dot as terminator.

== Control structures ==

All the typical control structures (building blocks) occurring in Pascal Script are described in the following table. The table shows a flow chart and Pascal Script code required to implement that logic. To compose your own [[ReNamer:Rules:PascalScript|PascalScript rule]], you can simply copy and paste the code and then edit it to finish your script.

In actual implementation, just substitute the following:

*Replace '''''<Condition>''''' with an actual Pascal statement that tests for a condition.
*Replace '''''<Action>''''' with code block that takes action relevant to the condition. There may be several statements. 

=== Branching ===

These structures are used to execute different blocks of code depending upon a condition.

{| class="prettytable"
|-
! Branching structure
! Pascal script
! Flowchart (Logic)
! Remarks
|-
! If-then
|
<pre>if <Condition> then
begin
<Action>
end;</pre>

| [[Image:PascalScriptIfThen.png|center]]
|
Execute the '''<Action>''' statement only if the '''<Condition>''' is met. Otherwise pass on the control to the next statement that follows the '''<Action>'''. 

|-
! If-then-else
|
<pre>if <Condition> then
begin
<Action-1>
end else
begin
<Action-2>
end;</pre>

| [[Image:PascalScriptIfThenElse.png|center]]
|
Two alternative actions are provided. 

If '''<Condition>''' is met, execute '''<Action-1>'''. Otherwise execute '''<Action-2>'''.

Thus one of these two '''<Actions>''' are definitely executed. 

After execution of the action, pass on the control to the next statement. 

|-
! case/switch (exclusive)
|
<pre>case X of
1:
begin
<Action-1>
Break;
end;
2:
begin
<Action-2>
Break

end;
else
begin
<Default Action>
end;
end;</pre>

| [[Image:PascalScriptCase.png|center]]
|
 This code structure has several '''<Action>''' blocks, each with its own condition.

*Any given '''<Action>''' block is executed only if its condition is met.
*One and only one '''<Action>''' is executed. After that, the control passes on to the next statement. (It does not check for the next condition.)
*The conditions are checked in the "top down" order. So even if the other conditions are also met, their '''<Actions>''' will never be executed.
*The code structure can optionally have a '''"Else" Action'''. It is executed if (and only if-) none of the conditions are met.

This is a generalized version of the '''if-then-else''' block (see second row above).

|-
! case/switch (fall-through)
|
<pre>case X of
1:
begin
<Action-1>
end;
2:
begin
<Action-2>
end;
else
begin
<Default Action>
end;
end;</pre>

| [[Image:PascalScriptCaseWithFallThrough.png|center]]
|
This is similar to the '''case '''structure above, but here, all the conditions are checked, and if any condition is met, the corresponding '''<Action>''' is executed. 

The code structure can optionally have a '''default''' action. If defined, this action is always executed, regardless of whether any of the conditions are met. After that, the control is passed to the next statement.

*In an extreme case, all of the '''<Actions> '''may be executed, including the '''''default''''' action.
*Execution of one '''<action>''' may affect whether a subsequent condition is met.

This structure is equivalent to a series of '''if-then''' blocks (see the first row), PLUS an optional '''<Default''' '''Action>''' block.

|}

=== Loops ===

Loops are used to execute a block of code iteratively till a certain condition is met.

{| class="prettytable"
|-
! Loops
! Pascal script
! Flowchart (Logic)
! Remarks
|-
! For To Do
| <pre>for I := X to Y do
begin
<Action>
end;</pre>
| [[Image:PascalScriptForLoop.png|center]]
| Execute the <Action> a certain number of times.
This example shows that the counter is incremented by 1, but it can be any statement that changes the value of the counter vaiable towards the target value.

Similarly, the decision block can have any logical expression with the counter.

Make sure that the exit condition is reached at some point of time; otherwise the loop will execute endlessly, and ReNamer will appear to be hung. 

|-
! While Do
| <pre>while <Condition> do
begin
<Action>
end;</pre>
| [[Image:PascalScriptWhileLoop.png|center]]
| Check for a condition and if it is met, execute the '''<Action>'''.
The loop is repeated till the condition is met. When the condition is not met, the loop is terminated and control passes to the next statement. Note that if the condition fails in the first-ever check, the '''<Action>''' may not be executed at all.

Make sure that the condition will fail at some point of time; otherwise the loop will execute endlessly, and ReNamer will appear to be hung.

Sometimes the condition is set to be always TRUE, and then a statement inside the '''<Action>''' block breaks the loop based on a different condition.(See the '''break '''command below) 

|-
! Repeat Until
| <pre>repeat
<Action>
until <Condition>;</pre>
| [[Image:PascalScriptRepeatUntilLoop.png|center]]
| This structure is similar to the '''While''' loop (see above). However, the only difference is that the '''<Action>''' is taken first and ''then'' the condition is checked. As a result, the '''<Action>''' is executed at least once. 
|-
! Break
| <pre>Break;</pre>
'''OR''' 
<pre>if <Condition> then Break;</pre>
| colspan="2" |
This statement is placed in any of the above loops to terminate the loop when a condition is met. Typically, it is used as the '''<Action>''' statement in a '''if-then''' block. This block is then embedded (nested) inside the other code block that is to be contionally terminated.

See the '''Case''' block [[ReNamer:Pascal_Script:Quick_guide#Branching|above]], which uses the '''break '''statement as integral part of its structure.

|-
! Continue
| <pre>Continue;</pre>
'''OR'''
<pre>if <Condition> then Continue;</pre>
| colspan="2" |
This statement is placed in any of the above loops to jump to the end of the current iteration, bypassing all the subsequent statements within the loop. However, the execution of the loop continues (the next iteration starts).

Typically, it is used as the '''<Action>''' statement in a '''if-then''' block. This block is then embedded (nested) inside the other code block, just before the statements that are to be skipped in the current iteration.

|-
! Exit
| <pre>Exit;</pre>
'''OR'''
<pre>if <Condition> then Exit;</pre>
| colspan="2" |
This statement is placed in any of the above loops to jump to the end of the current iteration, and also terminate the loop. The control passes to the next statement after the loop 

Typically, it is used as the '''<Action>''' statement in a '''if-then''' block that is embedded (nested) inside the other code block

|}
[[Category:ReNamer]]

ReNamer

2011-02-19T05:46:39Z

Narayan:

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool.

ReNamer offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, removing the content inside brackets, adding number sequences, changing file extensions, etc.

Advanced users can program their own algorithm using [[ReNamer:Rules:PascalScript|PascalScript]] rule.

ReNamer allows you to combine multiple renaming actions as a rule set, which can be saved, re-loaded, and edited. In addition, it can rename folders and process regular expressions. It can handle Unicode (non-English scripts).

ReNamer supports a variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==

{{Beta}}

{{Download book|Book:ReNamer_User_Manual|Get the latest version of this manual as PDF}}

*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

Shutter

2011-01-06T16:44:29Z

Narayan: /* User Manual */

[[Image:Shutter.png|thumb|250px]]

[[Shutter]] is a powerful and flexible multipurpose task-launcher.

Despite its name, its use is not limited to shutting down a program or the PC: Shutter can wait for one or more events and then execute a lot of diverse actions, such as-

*Launch specified application(s)
*Close specified application window(s)
*Kill specified application(s) even if they are running in system tray.
*Play a custom sound
*Display a message on screen
*Disconnect the dial-up modem
*Log out from Windows account,
*Lock the desktop or start a screensaver.
*Shut down the PC, reboot, hibernate, sleep, etc.

Apart from a user-friendly and easy-to-use interface, Shutter also offers the following options:

*You can create links on Desktop, to execute any of the supported actions directly from the desktop.
*You can use Shutter's '''Web Interface''' to remotely execute any action.

:You can also remotely see the run-time information about the computer: Logged In User, Up Time, List of Processes, Screenshot of a Desktop, plus Command Line Execution.

==User Manual==
Note that this manual describes the latest [http://www.den4b.com/?x=downloads&product=shutter beta].
As a result, if you are using the stable version of Shutter, you may not have some of the features described here.
Also, the screenshots shown here may be a little different from the interface you are using.

*[[Shutter:Quick Guide|Quick Guide]]
*[[Shutter:Workflow|Step-by-step]]
**[[Shutter:Events|Events]]
**[[Shutter:Logic|Interrelationship between Events]]
**[[Shutter:Actions|Actions]]
*[[Shutter:Options|Program options]]
*[[Shutter:Run as service|Run as service]]
*[[Shutter:Web Interface|Running remotely (Web interface)]]
*[[Shutter:Typical uses|Typical uses]]

[[Category:Shutter]]

ReNamer

2011-01-06T16:43:59Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==

{{Download book|Book:ReNamer_User_Manual|Get the latest version of this manual as PDF}}

Note that this manual describes the latest [http://www.den4b.com/?x=downloads&product=renamer beta]. As a result, if you are using the stable version of ReNamer, you may not have some of the features described here. Also, the screenshots shown here may be a little different from the interface you are using.

*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

Shutter

2011-01-06T04:55:29Z

Narayan: /* User Manual */

[[Image:Shutter.png|thumb|250px]]

[[Shutter]] is a powerful and flexible multipurpose task-launcher.

Despite its name, its use is not limited to shutting down a program or the PC: Shutter can wait for one or more events and then execute a lot of diverse actions, such as-

*Launch specified application(s)
*Close specified application window(s)
*Kill specified application(s) even if they are running in system tray.
*Play a custom sound
*Display a message on screen
*Disconnect the dial-up modem
*Log out from Windows account,
*Lock the desktop or start a screensaver.
*Shut down the PC, reboot, hibernate, sleep, etc.

Apart from a user-friendly and easy-to-use interface, Shutter also offers the following options:

*You can create links on Desktop, to execute any of the supported actions directly from the desktop.
*You can use Shutter's '''Web Interface''' to remotely execute any action.

:You can also remotely see the run-time information about the computer: Logged In User, Up Time, List of Processes, Screenshot of a Desktop, plus Command Line Execution.

==User Manual==
Note that this manual describes the latest [http://www.den4b.com/?x=downloads&product=shutter beta].
As a result, if you are using the stable version of Shutter, you may not have some of the features described here.
Also, the screenshots shown here may be a little different from the interface you see.

*[[Shutter:Quick Guide|Quick Guide]]
*[[Shutter:Workflow|Step-by-step]]
**[[Shutter:Events|Events]]
**[[Shutter:Logic|Interrelationship between Events]]
**[[Shutter:Actions|Actions]]
*[[Shutter:Options|Program options]]
*[[Shutter:Run as service|Run as service]]
*[[Shutter:Web Interface|Running remotely (Web interface)]]
*[[Shutter:Typical uses|Typical uses]]

[[Category:Shutter]]

Shutter

2011-01-06T04:54:47Z

Narayan: /* User Manual */

[[Image:Shutter.png|thumb|250px]]

[[Shutter]] is a powerful and flexible multipurpose task-launcher.

Despite its name, its use is not limited to shutting down a program or the PC: Shutter can wait for one or more events and then execute a lot of diverse actions, such as-

*Launch specified application(s)
*Close specified application window(s)
*Kill specified application(s) even if they are running in system tray.
*Play a custom sound
*Display a message on screen
*Disconnect the dial-up modem
*Log out from Windows account,
*Lock the desktop or start a screensaver.
*Shut down the PC, reboot, hibernate, sleep, etc.

Apart from a user-friendly and easy-to-use interface, Shutter also offers the following options:

*You can create links on Desktop, to execute any of the supported actions directly from the desktop.
*You can use Shutter's '''Web Interface''' to remotely execute any action.

:You can also remotely see the run-time information about the computer: Logged In User, Up Time, List of Processes, Screenshot of a Desktop, plus Command Line Execution.

==User Manual==
Note that this manual describes the latest [http://www.den4b.com/?x=downloads&product=shutter|beta].
As a result, if you are using the stable version of Shutter, you may not have some of the features described here.
Also, the screenshots shown here may be a little different from the interface you see.

*[[Shutter:Quick Guide|Quick Guide]]
*[[Shutter:Workflow|Step-by-step]]
**[[Shutter:Events|Events]]
**[[Shutter:Logic|Interrelationship between Events]]
**[[Shutter:Actions|Actions]]
*[[Shutter:Options|Program options]]
*[[Shutter:Run as service|Run as service]]
*[[Shutter:Web Interface|Running remotely (Web interface)]]
*[[Shutter:Typical uses|Typical uses]]

[[Category:Shutter]]

Shutter

2011-01-06T04:54:01Z

Narayan: /* User Manual */

[[Image:Shutter.png|thumb|250px]]

[[Shutter]] is a powerful and flexible multipurpose task-launcher.

Despite its name, its use is not limited to shutting down a program or the PC: Shutter can wait for one or more events and then execute a lot of diverse actions, such as-

*Launch specified application(s)
*Close specified application window(s)
*Kill specified application(s) even if they are running in system tray.
*Play a custom sound
*Display a message on screen
*Disconnect the dial-up modem
*Log out from Windows account,
*Lock the desktop or start a screensaver.
*Shut down the PC, reboot, hibernate, sleep, etc.

Apart from a user-friendly and easy-to-use interface, Shutter also offers the following options:

*You can create links on Desktop, to execute any of the supported actions directly from the desktop.
*You can use Shutter's '''Web Interface''' to remotely execute any action.

:You can also remotely see the run-time information about the computer: Logged In User, Up Time, List of Processes, Screenshot of a Desktop, plus Command Line Execution.

==User Manual==
Note that this manual describes the latest [beta|http://www.den4b.com/?x=downloads&product=shutter].
As a result, if you are using the stable version of Shutter, you may not have some of the features described here.
Also, the screenshots shown here may be a little different from the interface you see.

*[[Shutter:Quick Guide|Quick Guide]]
*[[Shutter:Workflow|Step-by-step]]
**[[Shutter:Events|Events]]
**[[Shutter:Logic|Interrelationship between Events]]
**[[Shutter:Actions|Actions]]
*[[Shutter:Options|Program options]]
*[[Shutter:Run as service|Run as service]]
*[[Shutter:Web Interface|Running remotely (Web interface)]]
*[[Shutter:Typical uses|Typical uses]]

[[Category:Shutter]]

Shutter

2011-01-06T04:53:20Z

Narayan:

[[Image:Shutter.png|thumb|250px]]

[[Shutter]] is a powerful and flexible multipurpose task-launcher.

Despite its name, its use is not limited to shutting down a program or the PC: Shutter can wait for one or more events and then execute a lot of diverse actions, such as-

*Launch specified application(s)
*Close specified application window(s)
*Kill specified application(s) even if they are running in system tray.
*Play a custom sound
*Display a message on screen
*Disconnect the dial-up modem
*Log out from Windows account,
*Lock the desktop or start a screensaver.
*Shut down the PC, reboot, hibernate, sleep, etc.

Apart from a user-friendly and easy-to-use interface, Shutter also offers the following options:

*You can create links on Desktop, to execute any of the supported actions directly from the desktop.
*You can use Shutter's '''Web Interface''' to remotely execute any action.

:You can also remotely see the run-time information about the computer: Logged In User, Up Time, List of Processes, Screenshot of a Desktop, plus Command Line Execution.

==User Manual==
Note that this manual describes the latest [http://www.den4b.com/?x=downloads&product=shutter|beta].
As a result, if you are using the stable version of Shutter, you may not have some of the features described here.
Also, the screenshots shown here may be a little different from the interface you see.

*[[Shutter:Quick Guide|Quick Guide]]
*[[Shutter:Workflow|Step-by-step]]
**[[Shutter:Events|Events]]
**[[Shutter:Logic|Interrelationship between Events]]
**[[Shutter:Actions|Actions]]
*[[Shutter:Options|Program options]]
*[[Shutter:Run as service|Run as service]]
*[[Shutter:Web Interface|Running remotely (Web interface)]]
*[[Shutter:Typical uses|Typical uses]]

[[Category:Shutter]]

Shutter

2011-01-06T04:50:07Z

Narayan: /* Topics */

[[Image:Shutter.png|thumb|250px]]

[[Shutter]] is a powerful and flexible multipurpose task-launcher.

Despite its name, its use is not limited to shutting down a program or the PC: Shutter can wait for one or more events and then execute a lot of diverse actions, such as-

*Launch specified application(s)
*Close specified application window(s)
*Kill specified application(s) even if they are running in system tray.
*Play a custom sound
*Display a message on screen
*Disconnect the dial-up modem
*Log out from Windows account,
*Lock the desktop or start a screensaver.
*Shut down the PC, reboot, hibernate, sleep, etc.

Apart from a user-friendly and easy-to-use interface, Shutter also offers the following options:

*You can create links on Desktop, to execute any of the supported actions directly from the desktop.
*You can use Shutter's '''Web Interface''' to remotely execute any action.

:You can also remotely see the run-time information about the computer: Logged In User, Up Time, List of Processes, Screenshot of a Desktop, plus Command Line Execution.

== Topics ==
Note that this manual describes the latest beta.As a result, if you are using the stable version of Shutter, you may not have some of the features described here.
Also, the screenshots shown here may be a little different from the interface you see.

*[[Shutter:Quick Guide|Quick Guide]]
*[[Shutter:Workflow|Step-by-step]]
**[[Shutter:Events|Events]]
**[[Shutter:Logic|Interrelationship between Events]]
**[[Shutter:Actions|Actions]]
*[[Shutter:Options|Program options]]
*[[Shutter:Run as service|Run as service]]
*[[Shutter:Web Interface|Running remotely (Web interface)]]
*[[Shutter:Typical uses|Typical uses]]

[[Category:Shutter]]

ReNamer

2011-01-06T02:15:04Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==

{{Download book|Book:ReNamer_User_Manual|Get the latest version of this manual as PDF}}

Note that this manual describes the latest [http://www.den4b.com/?x=downloads&product=renamer beta]. As a result, if you are using the stable version of ReNamer, you may not have some of the features described here. Also, the screenshots shown here may be a little different from the interface you see.

*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

ReNamer

2011-01-06T02:13:59Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==

{{Download book|Book:ReNamer_User_Manual|Get the latest version of this manual as PDF}}

Note that this manual describes the latest beta [[http://www.den4b.com/?x=downloads&product=renamer]]. As a result, if you are using the stable version of ReNamer, you may not have some of the features described here. Also, the screenshots shown here may be a little different from the interface you see.

*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

ReNamer

2011-01-06T02:13:31Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==

{{Download book|Book:ReNamer_User_Manual|Get the latest version of this manual as PDF}}

Note that this manual describes the latest beta[[http://www.den4b.com/?x=downloads&product=renamer]]. As a result, if you are using the stable version of ReNamer, you may not have some of the features described here. Also, the screenshots shown here may be a little different from the interface you see.

*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

ReNamer

2011-01-06T02:13:02Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==

{{Download book|Book:ReNamer_User_Manual|Get the latest version of this manual as PDF}}

Note that this manual describes the latest [[http://www.den4b.com/?x=downloads&product=renamer beta]]. As a result, if you are using the stable version of ReNamer, you may not have some of the features described here. Also, the screenshots shown here may be a little different from the interface you see.

*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

ReNamer

2011-01-06T02:12:07Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==

{{Download book|Book:ReNamer_User_Manual|Get the latest version of this manual as PDF}}

Note that this manual describes the latest beta [[http://www.den4b.com/?x=downloads&product=renamer]]. As a result, if you are using the stable version of ReNamer, you may not have some of the features described here. Also, the screenshots shown here may be a little different from the interface you see.

*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

ReNamer

2011-01-06T02:08:51Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==

{{Download book|Book:ReNamer_User_Manual|Get the latest version of this manual as PDF}}

Note that this manual describes the latest beta [[http://www.den4b.com/?x=downloads&product=renamer]]. The stable version of ReNamer may not have some of these features.

*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

ReNamer

2011-01-06T02:07:57Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==

{{Download book|Book:ReNamer_User_Manual|Get the latest version of this manual as PDF}}

Note that this manual describes the latest beta available [[http://www.den4b.com/?x=downloads&product=renamer|here]]. The stable version of ReNamer may not have some of these features.

*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

ReNamer

2011-01-06T02:07:17Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==

{{Download book|Book:ReNamer_User_Manual|Get the latest version of this manual as PDF}}

Note that this manual describes the latest beta available [[here|http://www.den4b.com/?x=downloads&product=renamer]]. The stable version of ReNamer may not have some of these features.

*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

ReNamer:Pascal Script:Functions

2010-12-31T02:19:07Z

Narayan:

{{Up|ReNamer:Pascal Script}}

ReNamer has many functions to manipulate the entities related to file names and do some more complex tasks for individual files. These entities may be derived from the existing filename, path, system date, meta tags from the file, strings entered by the user, etc. This functionality is available for use via the [[ReNamer:Rules:PascalScript|PascalScript rule]].

A common prefix '''Wide''' in the function name indicates that the function deals with [[Unicode]] strings (WideString). The prefix is used because there are similar functions which deal with '''ANSI''' strings and in some cases simply for internal consistency. For example: '''ShowMessage''' and '''WideShowMessage''' procedures.

== Basic String Handling ==

{| class="wikitable"
|-
! Routine
! Remarks
|-
| procedure '''Insert'''(Source: String; var S: String; Index: Integer);
| Inserts the string '''S''' into string '''Source''' at position '''Index'''.
|-
| procedure '''Delete'''(var S: String; Index, Count: Integer);
| Deletes '''Count''' characters from the string '''S''', starting from position '''Index'''.
|-
| function '''Copy'''(S: String; Index, Count: Integer): String;
| Copies '''Count''' characters from string '''S''', starting at position '''Index''', and returns them as a new string.
|-
| function '''Pos'''(Substr: String; S: String): Integer;
| Returns the position of a string '''Substr''' in another string '''S'''.
|}

'''Note:''' Indexes of characters in strings are 1 based, so first character in string S would be S[1].

== Length Management ==

{| class="wikitable"
|-
! Routine
! Remarks
|-
| procedure '''SetLength'''(var S: Array; NewLength: Integer);
| Sets the length of array variable '''S''' to '''NewLength'''.
|-
| procedure '''SetLength'''(var S: String; NewLength: Integer);
| Sets the length of string variable '''S''' to '''NewLength'''.
|-
| procedure '''SetLength'''(var S: WideString; NewLength: Integer);
| Sets the length of widestring '''S''' to '''NewLength'''.
|-
| function '''Length'''(const S: Array): Integer;
| Returns the length of array '''S ''' (number of elements).
|-
| function '''Length'''(const S: String): Integer;
| Returns the length of string '''S''' (number of characters).
|-
| function '''Length'''(const S: WideString): Integer;
| Returns the length of WideString '''S''' (number of characters).
|}

== Unicode String Handling ==

{| class="wikitable"
|-
! Routine
! Remarks
|-
| procedure '''WideInsert'''(const Substr: WideString; var Dest: WideString; Index: Integer);
| Inserts '''Substr''' in '''Dest''' at position '''Index'''.
|-
| procedure '''WideDelete'''(var S: WideString; Index, Count: Integer);
| Deletes '''Count''' characters from '''S''', starting from the '''Index''' position.
|-
| procedure '''WideSetLength'''(var S: WideString; NewLength: Integer);
| Change the length of string '''S''' to a new length specified by '''NewLength'''. If new length is smaller than original, the string is truncated. If new length is greater than original, the string will be expanded but additional characters will not be initialized and can be anything.
|-
| function '''WideLength'''(const S: WideString): Integer;
| Returns the length of WideString '''S'''.
|-
| function '''WideCopy'''(const S: WideString; Index, Count: Integer): WideString;
| Returns '''Count''' characters from WideString '''S''', starting at position '''Index'''.
|-
| function '''WidePos'''(const SubStr, S: WideString): Integer;
| Find and occurrence of '''SubStr''' in '''S'''. Returns the position of first occurrence, or '''0''' if nothing was found.
|-
| function '''WidePosEx'''(const SubStr, S: WideString; Offset: Cardinal): Integer;
| Find and occurrence of '''SubStr''' in '''S''' but start searching from position specified by '''Offset'''. Returns the position of first occurrence, or '''0''' if nothing was found.
|-
| function '''WideUpperCase'''(const S: WideString): WideString;
| Returns the ALLCAPS version of the WideString '''S'''
|-
| function '''WideLowerCase'''(const S: WideString): WideString;
| Returns the lowercase version of the WideString '''S'''
|-
| function '''WideCompareStr'''(const S1, S2: WideString): Integer;
| Compares two WideStrings '''S1''' and '''S2''', case-sensitive, and returns an integer based on the result. The return value is less than 0 if S1 is less than S2, 0 if S1 equals S2, or greater than 0 if S1 is greater than S2.
|-
| function '''WideCompareText'''(const S1, S2: WideString): Integer;
| Compares two WideStrings '''S1''' and '''S2''', case-insensitive, and returns an integer based on the result. The return value is less than 0 if S1 is less than S2, 0 if S1 equals S2, or greater than 0 if S1 is greater than S2.
|-
| function '''WideSameText'''(const S1, S2: WideString): Boolean;
| Compares two WideStrings '''S1''' and '''S2''', case-insensitive. Returns TRUE if both are identical, otherwise returns FALSE.
|-
| function '''WideTextPos'''(const SubStr, S: WideString): Integer;
| Behaves like '''WidePos''' function, except text if processed in case-insensitive manner.
|-
| function '''WideTrim'''(const S: WideString): WideString;
| Removes leading and trailing spaces and control characters from the given string '''S'''.
|-
| function '''WideReplaceStr'''(const S, OldPattern, NewPattern: WideString): WideString;
| Returns the result of replacing on a string S, a string OldPattern (Case Sensitive), with a NewPattern.
|-
| function '''WideReplaceText'''(const S, OldPattern, NewPattern: WideString): WideString;
| Returns the result of replacing on a string S, a text OldPattern (Case Non-Sensitive), with a NewPattern.
|-
| function '''WideSplitString'''(const Input, Delimiter: WideString): TStringsArray;
|
Splits the WideString '''Input '''wherever '''Delimiter''' occurs, and returns an array that contains the split parts.

*The '''Delimiter''' itself can be a multi-character WideString. (Unlike the usual comma, hyphen or space that is used for this purpose)
*The split parts (returned as elements of the array) do not contain the '''Delimiter''' WideString

|-
| function '''WideCaseCapitalize'''(const S: WideString): WideString;
|
Returns the ''Sentence case'' version of the WideString '''S'''.

Only the first alphabetic character is capitalized. All other alphabetic characters are converted to lowercase. 

*If '''S''' begins with numeric characters, the first alphabetic character that follows will be capitalized.

|-
| function '''WideCaseInvert'''(const S: WideString): WideString;
| Inverts the case of all characters in the WideString '''S''' and returns the WideString. 
|}

== Meta Tags Extraction ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''CalculateMetaTag'''(const FilePath: WideString; const MetaTagName String): String;
| Extracts and returns the value of a metatag specified by '''MetaTagName''' from the file specified by the complete absolute path '''FilePath'''.
|}

For example, to extract '''EXIF_Date''' tag from an image and set it to the filename, one can use something like this:
<source>
begin
FileName := CalculateMetaTag(FilePath, 'EXIF_Date');
end.
</source>

The full list of meta tags can be found in [[ReNamer:Meta Tags|Meta Tags]] article.

== Regular Expressions ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''ReplaceRegEx'''(const Input, Find, Replace: WideString;const CaseSensitive, UseSubstitution: Boolean): WideString;
| Find-and-replace function using RegEx. Works like [[ReNamer:Rules:RegEx|RegEx rule]].
|-
| function '''MatchesRegEx'''(const Input, Find: WideString;const CaseSensitive: Boolean): TStringsArray;
| Returns a list of RegEx matches as an array. Function returns an array of full matches, which matched the entire expression, not the sub-patterns.

For example, given the Input 'Ax1_-_Bx2---Cx3' and the function '''MatchesRegEx'''(Input, ''''([A-Z])x(\d)'''', False). What we get is [''''Ax1'''', ''''Bx2'''', ''''Cx3'''']. Being these the 3 full matches found on the Input.
|-
| function '''SubMatchesRegEx'''(const Input, Find: WideString;const CaseSensitive: Boolean): TStringsArray;
| This function is very similar to '''MatchesRegEx''', but instead of returning full expression matches it will return an array of sub-expression matches for the first full expression match.

For example, given the Input 'Ax1_-_Bx2---Cx3' and the function '''SubMatchesRegEx'''(Input, ''''([A-Z])x(\d)'''', False). What we get is [''''A'''', ''''1'''']. Being these the first sub-matches requested (two in this case).

In this way, it can easily be combined with '''MatchesRegEx''' function, to allow users to find all global matches, and then parse those matches through '''SubMatchesRegEx''' function to find individual sub-expression matches of each global match.
|}

General parameters of the functions:

* Input - The WideString that is input to the function.
* Find - RegEx pattern to be found (same as '''Expression''' field in the [[ReNamer:Rules:RegEx|RegEx rule]]).
* Replace - Replacement string (same as the '''Replace''' field in the [[ReNamer:Rules:RegEx|RegEx rule]]).
* CaseSensitive - Specifies whether to process in a case-sensitive mode.
* UseSubstitution - Determines whether use [[ReNamer:Regular Expressions#Backreferences|backreferences]] in the result.

== Unicode Character Handling ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''IsWideCharUpper'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is in UPPERCASE.
|-
| function '''IsWideCharLower'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is in lowercase.
|-
| function '''IsWideCharDigit'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a digit (numeric character 0-9).
|-
| function '''IsWideCharSpace'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a white-space character, such as: space, form-feed, newline, carriage-return, tab and vertical-tab (characters classified as C1_SPACE).
|-
| function '''IsWideCharPunct'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a punctuation mark (characters classified as C1_PUNCT).
|-
| function '''IsWideCharCntrl'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a control character (characters classified as C1_CNTRL).
|-
| function '''IsWideCharBlank'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a blank, such as: space and tab (characters classified as C1_BLANK).
|-
| function '''IsWideCharXDigit'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a hexadecimal digit (0-9 or A-F).
|-
| function '''IsWideCharAlpha'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a alphanumeric character (a-z or A-Z).
|-
| function '''IsWideCharAlphaNumeric'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a alphanumeric character or a numeric character (a-z, A-Z or 0-9).
|-
| function '''WideCharUpper'''(const WC: WideChar): WideChar;
| Returns a UPPERCASE version of the input Unicode character. In case of non-alphabetic character, it returns the same character.
|-
| function '''WideCharLower'''(const WC: WideChar): WideChar;
| Returns a lowercase version of the input Unicode character. In case of non-alphabetic character, it returns the same character.
|}

'''Note:''' Character classifications, such as C1_UPPER, C1_LOWER, C1_DIGIT, C1_SPACE, C1_PUNCT, C1_CNTRL, C1_BLANK, C1_XDIGIT, C1_ALPHA - are part of Unicode definitions. More information regarding classification can be found on the internet. For example: [http://www.fileformat.info/info/unicode/ http://www.fileformat.info/info/unicode/].

== Unicode Conversion ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideToAnsi'''(const WS: WideString): String;
| Converts a [[Unicode]] string to its [[ANSI]] version.
|-
| function '''AnsiToWide'''(const S: String): WideString;
| Converts a [[ANSI]] string to its [[Unicode]] version.
|-
| function '''UTF8Encode'''(const WS: WideString): String;
| Convert [[Unicode]] string to the [http://en.wikipedia.org/wiki/UTF-8 UTF-8] encoded string. Useful for storing Unicode strings in files, sometimes for compatibility reasons and sometimes to reduce the size of the file.
|-
| function '''UTF8Decode'''(const S: String): WideString;
| Convert [http://en.wikipedia.org/wiki/UTF-8 UTF-8] encoded string to its full [[Unicode]] representation.
|}

== Basic Conversion ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''BoolToStr'''(B: Boolean): String;
| Convert boolean variable into a string. Returns '''True''' or '''False''' string.
|-
| function '''IntToStr'''(Value: Integer): String;
| Converts an integer to a string. The following assumptions are correct:
<div style="font-family: monospace">
* IntToStr(123) = '123'
* IntToStr(0123) = '123'
* IntToStr(123) <> '0123'
</div>
|-
| function '''StrToInt'''(const S: String): Integer;
| Converts a string to an integer. The following equalities are correct:
<div style="font-family: monospace">
* StrToInt('123') = 123
* StrToInt('123') = 0123
* StrToInt('0123') = 123
</div>
'''Warning:''' An error will occur if the parameter to this function cannot be converted to an integer!
|-
| function '''StrToIntDef'''(const S: String; const Default: Integer): Integer;
| Behaves like '''StrToInt''' function, but instead of producing an error on incorrect input function allows the '''Default''' value to be specified, which will be returned if the input cannot be converted to an integer.
|-
| function '''FloatToStr'''(Value: Extended): string;
| Converts supplied floating point value to its string representation, using default system format.
|-
| function '''StrToFloat'''(const S: string): Extended;
| Converts supplied string to a floating point value. '''Warning:''' An error will occur if the parameter to this function cannot be converted to a floating point value!
|-
| function '''StrToFloatDef'''(const S: string; const Default: Extended): Extended;
| Behaves like '''StrToFloat''' function, but instead of producing an error on incorrect input function allows the '''Default''' value to be specified, which will be returned if the input cannot be converted to a floating point value.
|-
| function '''FormatFloat'''(const Format: string; Value: Extended): string;
| Converts supplied floating point value to its string representation, using user specific '''Format'''. Format string may contain following specifiers:
{| class="wikitable"
! Specifier
! Represents
|-
| '''0''' (zero)
| Digit placeholder. If the value being formatted has a digit in the position where the "0" appears in the format string, then that digit is copied to the output string. Otherwise, a "0" is stored in that position in the output string.
|-
| '''#''' (hash)
| Digit placeholder. If the value being formatted has a digit in the position where the "#" appears in the format string, then that digit is copied to the output string. Otherwise, nothing is stored in that position in the output string.
|-
| '''.''' (dot)
| Decimal point. The first "." character in the format string determines the location of the decimal separator in the formatted value, any additional "." characters are ignored.
|-
| ''',''' (comma)
| Thousand separator. If the format string contains one or more "," characters, the output will have thousand separators inserted between each group of three digits to the left of the decimal point. The placement and number of "," characters in the format string does not affect the output.
|}
|-
| function '''DateToStr'''(D: TDateTime): String;
| Converts a date to a string, using system format for the short date, for example: '''dd/mm/yyyy'''.
|-
| function '''StrToDate'''(const S: String): TDateTime;
| Converts a date string to a proper TDateTime value, using system format for the short date, for example: '''dd/mm/yyyy'''.
|-
| function '''IntToHex'''(Value: Integer; Digits: Integer): String;
| Converts an integer to its hexadecimal representation. Here are samples:
<div style="font-family: monospace">
* IntToHex(1234, 1) = '4D2'
* IntToHex(1234, 8) = '000004D2'
</div>
|-
| function '''HexToInt'''(const HexNum: String): Integer;
| Converts a hexadecimal value to its decimal representation. '''Warning:''' An error will occur if the parameter to this function cannot be converted to an integer!
|-
| function '''HexToIntDef'''(const HexNum: String; Default: Integer): Integer;
| Behaves like '''HexToInt''' function, but instead of producing an error on incorrect input function allows the '''Default''' value to be specified, which will be returned if the input cannot be converted to an integer.
|-
| function '''Ord'''(X: Char): Byte;
| Return an ordinal value (byte representation) of a character.
|-
| function '''Chr'''(X: Byte): Char;
| Return a character by its ordinal value (byte representation).
|}

== Date and Time ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''Date''': TDateTime;
| Returns the current system date.
|-
| function '''Time''': TDateTime;
| Returns the current system time.
|-
| function '''Now''': TDateTime;
| Returns the current system date and time.
|-
| function '''EncodeDate'''(Year, Month, Day: Word): TDateTime;
| Generates date value for the specified '''Year''', '''Month''', '''Day'''. Parameters must be within a valid date range: Year = 0..9999, Month = 1..12, Day = 1..31 (depending on month/year). An error will be raised if parameters are invalid.
|-
| function '''EncodeTime'''(Hour, Min, Sec, MSec: Word): TDateTime;
| Generates time value for the specified '''Hour''', '''Min''', '''Sec''', '''MSec'''. Parameters must be within a valid time range: Hour = 0..23, Min = 0..59, Sec = 0..59, MSec = 0..999. An error will be raised if parameters are invalid.
|-
| function '''TryEncodeDate'''(Year, Month, Day: Word; var Date: TDateTime): Boolean;
| Behaves exactly like '''EncodeDate''' function, except this function returns the TRUE or FALSE depending on the success of the operation. If operation was successful, function will return TRUE and the generated date value will be written in the '''Date''' variable.
|-
| function '''TryEncodeTime'''(Hour, Min, Sec, MSec: Word; var Time: TDateTime): Boolean;
| Behaves exactly like '''EncodeTime''' function, except this function returns the TRUE or FALSE depending on the success of the operation. If operation was successful, function will return TRUE and the generated time value will be written in the '''Time''' variable.
|-
| procedure '''DecodeDate'''(const DateTime: TDateTime; var Year, Month, Day: Word);
| Extracts '''Year''', '''Month''' and '''Day''' components from a given '''DateTime''' value.
|-
| procedure '''DecodeTime'''(const DateTime: TDateTime; var Hour, Min, Sec, MSec: Word);
| Extracts '''Hour''', '''Min''', '''Sec''' and '''MSec''' components from a given '''DateTime''' value.
|-
| function '''DayOfWeek'''(const DateTime: TDateTime): Word;
| Returns the day of the week (as an index) for the specified '''DateTime''' value. The indexes are: 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday.
|-
| function '''DateTimeToUnix'''(D: TDateTime): Int64;
| Converts '''D''' value of type '''TDateTime''' to a Unix timestamp.
|-
| function '''UnixToDateTime'''(U: Int64): TDateTime;
| Converts a Unix timestamp to a value of '''TDateTime''' type.
|-
| function '''FormatDateTime'''(const Fmt: String; D: TDateTime): String;
| This function provides rich formatting of a '''DateTime''' value into a string. [[ReNamer:Date and Time format|Date and time format]] is defined by the '''Fmt''' string.
|-
| function '''IncYear'''(const AValue: TDateTime; const ANumberOfYears: Integer): TDateTime;
| Increments a TDateTime variable by a number of years (plus or minus).
|-
| function '''IncMonth'''(const AValue: TDateTime; ANumberOfMonths: Integer): TDateTime;
| Increments a TDateTime variable by a number of months (plus or minus).
|-
| function '''IncWeek'''(const AValue: TDateTime; const ANumberOfWeeks: Integer): TDateTime;
| Increments a TDateTime variable by a number of weeks (plus or minus).
|-
| function '''IncDay'''(const AValue: TDateTime; const ANumberOfDays: Integer): TDateTime;
| Increments a TDateTime variable by a number of days (plus or minus).
|-
| function '''IncHour'''(const AValue: TDateTime; const ANumberOfHours: Int64): TDateTime;
| Increments a TDateTime variable by a number of hours (plus or minus).
|-
| function '''IncMinute'''(const AValue: TDateTime; const ANumberOfMinutes: Int64): TDateTime;
| Increments a TDateTime variable by a number of minutes (plus or minus).
|-
| function '''IncSecond'''(const AValue: TDateTime; const ANumberOfSeconds: Int64): TDateTime;
| Increments a TDateTime variable by a number of seconds (plus or minus).
|-
| function '''IncMilliSecond'''(const AValue: TDateTime; const ANumberOfMilliSeconds: Int64): TDateTime;
| Increments a TDateTime variable by a number of milliseconds (plus or minus).
|}

== File Management ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideFileSize'''(const FileName: WideString): Int64;
| Returns the size of the file.
|-
| function '''WideFileExists'''(const FileName: WideString): Boolean;
| Check whether specified file exists. Returns TRUE if file exists, otherwise FALSE.
|-
| function '''WideDirectoryExists'''(const Directory: WideString): Boolean;
| Check whether specified directory exists. Returns TRUE if directory exists, otherwise FALSE.
|-
| function '''WideForceDirectories'''(Dir: WideString): Boolean;
| Makes sure that that all directories in the path exist. If they don't, function will try to create them, recursively. Returns TRUE if all folders exist or have been successfully created.
|-
| function '''WideCreateDir'''(const Dir: WideString): Boolean;
| Create specified directory (non-recursive). Returns TRUE on success, otherwise FALSE.
|-
| function '''WideDeleteFile'''(const FileName: WideString): Boolean;
| Delete physical file from the disk. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideRenameFile'''(const OldName, NewName: WideString): Boolean;
| Rename file from '''OldName''' to '''NewName'''. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideCopyFile'''(FromFile, ToFile: WideString; FailIfExists: Boolean): Boolean;
| Rename file from '''FromFile''' to '''ToFile'''. If '''FailIfExists''' flag is TRUE, file will not be copied when destination file already exists, otherwise, destination file will be overwritten. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideFileSearch'''(const Name, DirList: WideString): WideString;
| Search through the directories passed in '''DirList''' for a file named '''Name'''. DirList is a list of path names delimited by semicolons. If file matching Name is located, function returns a string specifying a path name for that file. If no matching file exists, function returns an empty string.
|-
| function '''WideGetCurrentDir''': WideString;
| Returns the current working directory.
|-
| function '''WideSetCurrentDir'''(const Dir: WideString): Boolean;
| Sets the current working directory to the directory specified by parameter '''Dir'''.
|-
| procedure '''WideScanDirForFiles'''(Dir: WideString; var Files: TStringsArray; const Recursive, IncludeHidden, IncludeSystem: Boolean; const Mask: WideString);
| You can get a list of the files inside a folder.
*'''Dir''': The folder you want to scan.
*'''Files''': Where the list of files is going to be saved.
*'''Recursive''': Do you want to scan the subfolders?
*'''IncludeHidden''': Do you want to list the hidden files?
*'''IncludeSystem''': Do you want to list the system files?
*'''Mask''': You can list everything ('*'), or only the files that contain some string (example: '*.txt').
|-
| procedure '''WideScanDirForFolders'''(Dir: WideString; var Folders: TStringsArray; const Recursive, IncludeHidden, IncludeSystem: Boolean);
| You can get a list of the folders inside other folder.
*'''Dir''': The folder you want to scan.
*'''Folders''': Where the list of folders is going to be saved.
*'''Recursive''': Do you want to scan the subfolders?
*'''IncludeHidden''': Do you want to list the hidden folders?
*'''IncludeSystem''': Do you want to list the system folders?
|}

== File Name Utilities ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideExtractFilePath'''(const FileName: WideString): WideString;
| Returns the entire path of the file (starting from the drive letter)
|-
| function '''WideExtractFileDir'''(const FileName: WideString): WideString;
| Returns the folder in which the file is located.
|-
| function '''WideExtractFileDrive'''(const FileName: WideString): WideString;
| Returns the drive letter (e.g. 'C:').
|-
| function '''WideExtractFileName'''(const FileName: WideString): WideString;
| Returns the filename with extension. (e.g. "FileName.txt")
|-
| function '''WideExtractBaseName'''(const FileName: WideString): WideString;
| Returns only the file' base name (but not the dot or extension). (e.g. "FileName")
|-
| function '''WideExtractFileExt'''(const FileName: WideString): WideString;
| Returns the file's extension with the dot (e.g. ".txt")
|-
| function '''WideChangeFileExt'''(const FileName, Extension: WideString): WideString;
| Replaces the original extension, and returns the new filename with extension. (e.g. "FineName.txt" -> "FineName.pdf")
|-
| function '''WideStripExtension'''(const FileName: WideString): WideString;
| Strips off the extension from the filename. Returns the striped string.
|-
| function '''WideExpandFileName'''(const FileName: WideString): WideString;
| Converts the relative file name into a fully qualified path. This function does not verify that the resulting path refers to an existing file.
|-
| function '''WideExtractRelativePath'''(const BaseName, DestName: WideString): WideString;
| Creates a relative path to go from '''BaseName''' to '''DestName'''. For example:

{|
| '''BaseName:'''
| <nowiki>C:\Folder\FileName.txt</nowiki>
|-
| '''DestName:'''
| <nowiki>C:\Documents\Article.pdf</nowiki>
|-
| '''Result:'''
| <nowiki>..\Documents\Article.pdf</nowiki>
|}

|-
| function '''WideExtractShortPathName'''(const FileName: WideString): WideString;
| It converts a path into it's representation in DOS format.
|-
| function '''WideIncludeTrailingPathDelimiter'''(const S: WideString): WideString;
| By this function you can ensure that a path from a file does '''not contain''' the path delimiter ('\') at the end of the path.
|-
| function '''WideExcludeTrailingPathDelimiter'''(const S: WideString): WideString;
| By this function you can ensure that a path from a folder '''contains''' the path delimiter ('\') at the end of the path.
|-
| function '''WideSameFileName'''(const S1, S2: WideString): Boolean;
| Compares the filenames '''S1''' and '''S2''', and returns TRUE if they are identical.
|-
| function '''WideGetEnvironmentVar'''(const VarName: WideString): WideString;
| Returns an environment variable by its name. For example:
<source>
var
UserName, ComputerName: WideString;
begin
UserName := WideGetEnvironmentVar('USERNAME');
ComputerName := WideGetEnvironmentVar('COMPUTERNAME');
end.
</source>
|}

== File Read/Write ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''FileReadFragment'''(const FileName: WideString; Start, Length: Integer): String;
| Starting at position '''Start''', read '''Length''' number of characters of the file '''FileName''' and return them as a string. '''Start''' is 0-based, so in order to start the fragment at the beginning of the file, set this parameter to 0 (zero).
|-
| function '''FileReadLine'''(const FileName: WideString; LineNum: Integer): String;
| Read a line from a file '''FileName''' specified by a line index '''LineNum'''. '''LineNum''' is 1 based, so to get the first line set this parameter to 1 (one). '''Note:''' This function is extremely inefficient and provided only for convenience!
|-
| function '''FileCountLines'''(const FileName: WideString): Integer;
| Count number of lines in the file. '''Note:''' This function is extremely inefficient and provided only for convenience!
|-
| function '''FileReadContent'''(const FileName: WideString): String;
| Return the entire content of the file as a String.
|-
| procedure '''FileWriteContent'''(const FileName: WideString; const Content: String);
| Write '''Content''' to the file. If target file already exists, it will be overwritten.
|-
| procedure '''FileAppendContent'''(const FileName: WideString; const Content: String);
| Append '''Content''' to the end of the file. If target file does not exist, it will be created.
|}

== File Time ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''FileTimeModified'''(const FileName: WideString): TDateTime;
| Returns last modified time of the specified file.
|-
| function '''FileTimeCreated'''(const FileName: WideString): TDateTime;
| Returns creation time of the specified file.
|-
| function '''SetFileTimeCreated'''(const FileName: WideString; const DateTime: TDateTime): Boolean;
| Sets creation time for the specified file.
|-
| function '''SetFileTimeModified'''(const FileName: WideString; const DateTime: TDateTime): Boolean;
| Sets last modified time for the specified file.
|}

== Process Execution ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''ShellOpenFile'''(const FileName: WideString): Boolean;
| Run (open) a file specified by '''FileName'''. Works like "Start > Run" command. Parameter does not have to be an executable file, it can by any file or protocol with assigned handler. For example, you can open a Word document or a web page, and associated application will be launched:
<div style="font-family: monospace">
* ShellOpenFile(<nowiki>'http://www.den4b.com/'</nowiki>);
* ShellOpenFile(<nowiki>'C:\Document.doc'</nowiki>);
</div>
|-
| function '''ExecuteProgram'''(const Command: String; WaitForProgram: Boolean): Cardinal;
| Execute a command line specified by parameter '''Command'''. Works like "Command Prompt". Parameter '''WaitForProgram''' allows you to specify whether the code needs to wait until the command (launched program) has finished executing.
|-
| function '''ExecConsoleApp'''(const CommandLine: String; out Output: String): Cardinal;
| Execute a command line specified by parameter '''CommandLine''' and record its standard output in the variable '''Output'''. Works like "Command Prompt". Should be used only for console style applications. Returns the exit code.
|}

== Dialogs ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| procedure '''ShowMessage'''(const Msg: String);
| Show a simple dialog with the message specified by '''Msg''' parameter.
|-
| procedure '''WideShowMessage'''(const Msg: WideString);
| Same as '''ShowMessage''' function but parameter is Unicode text.
|-
| function '''DialogYesNo'''(const Msg: String): Boolean;
| Show a simple prompt with the message specified by '''Msg''' parameter and two button: Yes and No. Returns TRUE if user clicks Yes button, otherwise FALSE.
|-
| function '''WideDialogYesNo'''(const Msg: WideString): Boolean;
| Same as '''DialogYesNo''' function but parameter is WideString text.
|-
| function '''InputBox'''(const ACaption, APrompt, ADefault: String): String;
| Displays a simple dialog box with the given '''ACaption''' and '''APrompt''' message. It asks the user to enter data in a text box on the dialog. A '''ADefault''' value is displayed in the text box initially. If the user presses OK, the value from the text box is returned, otherwise '''ADefault''' value is returned.
|-
| function '''InputQuery'''(const ACaption, APrompt: String; var Value: String): Boolean;
| Operates similar to '''InputBox''' function. The default value and the value of the text box after the dialog is closed are transferred via the '''Value''' parameter. Function returns TRUE is user clicked OK, otherwise returns FALSE.
|-
| function '''WideInputBox'''(const ACaption, APrompt, ADefault: WideString): WideString;
| Same as '''InputBox''' function but operates on WideString text.
|-
| function '''WideInputQuery'''(const ACaption, APrompt: WideString; var Value: WideString): Boolean;
| Same as '''InputQuery''' function but operates on WideString text.
|}

== Other Routines ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| procedure '''Sleep'''(Milliseconds: Cardinal);
| Sleep (pause the execution) for specified number of '''Milliseconds'''.
|-
| procedure '''DivMod'''(Dividend: Integer; Divisor: Word; var Result, Remainder: Word);
| Perform integer division and fetch the remainder as well, all in one operation. '''Dividend''' is the integer into which you are dividing. '''Divisor''' is the value by which to divide '''Dividend'''. '''Result''' returns the result of the integer division. '''Remainder''' returns the remainder (the difference between Result * Divisor and Dividend).
|-
| procedure '''Randomize''';
| Prepares the random number generator. Should only be called once per application cycle.
|-
| function '''RandomRange'''(const AFrom, ATo: Integer): Integer;
| Return a random integer number within the specified '''AFrom'''..'''ATo''' (inclusive) range.
|-
| function '''GetClipboardText''': WideString;
| Get the content of the the clipboard (text only).
|-
| procedure '''SetClipboardText'''(const S: WideString);
| Set the content of the the clipboard (text only).
|-
| function '''Base64Encode'''(const S: String): String;
| Encode string '''S''' into [http://en.wikipedia.org/wiki/Base64 Base64]. Useful for encoding binary data in order to minimize the likelihood of data being modified in transit through different systems, like email or internet.
|-
| function '''Base64Decode'''(const S: String): String;
| Decode [http://en.wikipedia.org/wiki/Base64 Base64] string;
|-
| function '''GetTickCount''': Cardinal;
| Retrieves the number of milliseconds that have elapsed since the system was started (up to 49.7 days, then timer resets). The precision of this timer is very limited.
|-
| function '''SizeOf'''(X): Integer;
| Pass a variable reference to determine the number of bytes used to represent the variable. Pass a type identifier to determine the number of bytes used to represent instances of that type.
|}

[[Category:ReNamer]]
[[Category:Pascal Script]]

ReNamer:Rules:Delete

2010-10-16T07:29:56Z

Narayan: /* Delete Rule */

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Insert|next=ReNamer:Rules:Remove}}

== Delete Rule ==

<center>[[Image:DeleteRule.png]]</center>

This rule will delete all characters located between the '''From''' and the '''Until ''' positions. Optionally, it can delete from the specified position till the end of the name.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| From
| From which character-position you want to start the deletion.
Select from the following options:
*The starting position (count starts from 1)
*The delimiter from where the deletion starts.
**The delimiter can be a single character or even a string.
**Typically ''', . / ( ) -''' and space are used as delimiters.

|-
| Until
| Till which point you want to delete:
Select from the following options:
*Count: Specify how many characters to be deleted, starting from the FROM position.
*Delete till a specified delimiter is reached.
**You can use two different delimiters in '''From '''and '''Until''' sections.
**The delimiter can be a single character or even a string.
**Typically ''', . / ( ) -''' and space are used as delimiters.
*Delete all characters till the end.

|-
| Skip extension
| If this check box is unselected, the extension will be included in the rule.
|-
| Right-to-left
| If you select this option, ReNamer counts the position from the extreme right. (The '''From ''' and '''Until''' positions switch places.)
*When this option is selected, the "till the end" option in '''Until''' deletes all characters on the left (what we regard as the ''beginning'' of the name)
For example, to keep only the four characters on the right side of the name (and delete all the rest of the characters on the left), use:
{|
! From
! Until
|-
| Position 5
| Till the end
|}

|-
| Do not remove delimiters
| If you select this option, the delimiters themselves will be retained.
*If you have used two different delimiters in '''From '''and '''Until''' sections, ''both'' of them will be retained.

|}

[[Category:ReNamer]]

ReNamer:Rules:Delete

2010-10-16T07:12:07Z

Narayan: /* Delete Rule */

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Insert|next=ReNamer:Rules:Remove}}

== Delete Rule ==

<center>[[Image:DeleteRule.png]]</center>

This rule will delete all characters located between the '''From''' and the '''Until ''' positions. Optionally, it can delete from the specified position till the end of the name.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| From
| From which character-position you want to start the deletion.
Select from the following options:
*The starting position (count starts from 1)
*The delimiter from where the deletion starts.
**The delimiter can be a single character or even a string.
**Typically ''', . / ( ) -''' and space are used as delimiters.

|-
| Until
| Till which point you want to delete:
Select from the following options:
* Count: How many characters to be deleted, starting with the START position.
*Delete till a specified delimiter is reached.
**The delimiter can be a single character or even a string.
**Typically ''', . / ( ) -''' and space are used as delimiters.

Same as above. In addition, you have the '''''till the end''''' option.
*You can use two different delimiters in '''From '''and '''Until''' sections.

|-
| Skip extension
| If this check box is unselected, the extension will be included in the rule.
|-
| Right-to-left
| If you select this option, ReNamer counts the position from the extreme right. (The '''From ''' and '''Until''' positions switch places.)
*When this option is selected, the "till the end" option in '''Until''' deletes all characters on the left (what we regard as the ''beginning'' of the name)
For example, to keep only the four characters on the right side of the name (and delete all the rest of the characters on the left), use:
{|
! From
! Until
|-
| Position 5
| Till the end
|}

|-
| Do not remove delimiters
| Will retain the delimiters
*If you have used two different delimiters in '''From '''and '''Until''' sections, ''both'' of them will be retained.

|}

[[Category:ReNamer]]

ReNamer:Rules:Delete

2010-10-16T07:11:09Z

Narayan: /* Delete Rule */

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Insert|next=ReNamer:Rules:Remove}}

== Delete Rule ==

<center>[[Image:DeleteRule.png]]</center>

This rule will delete all characters located between the '''From''' and the '''Until ''' positions. Optionally, it can delete from the specified position till the end of the name.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| From
| From which character-position you want to start the deletion.
Select from the following options:
*The starting position (count starts from 1)
*The delimiter from where the deletion starts.
The delimiter can be a single character or even a string.
** Typically ''', . / ( ) -''' and space are used as delimiters.

|-
| Until
| Till which point you want to delete:
Select from the following options:
* Count: How many characters to be deleted, starting with the START position.
*Delete till a specified delimiter is reached.
The delimiter can be a single character or even a string.
** Typically ''', . / ( ) -''' and space are used as delimiters.

Same as above. In addition, you have the '''''till the end''''' option.
*You can use two different delimiters in '''From '''and '''Until''' sections.

|-
| Skip extension
| If this check box is unselected, the extension will be included in the rule.
|-
| Right-to-left
| If you select this option, ReNamer counts the position from the extreme right. (The '''From ''' and '''Until''' positions switch places.)
*When this option is selected, the "till the end" option in '''Until''' deletes all characters on the left (what we regard as the ''beginning'' of the name)
For example, to keep only the four characters on the right side of the name (and delete all the rest of the characters on the left), use:
{|
! From
! Until
|-
| Position 5
| Till the end
|}

|-
| Do not remove delimiters
| Will retain the delimiters
*If you have used two different delimiters in '''From '''and '''Until''' sections, ''both'' of them will be retained.

|}

[[Category:ReNamer]]

File:Book Open Small.png

2010-10-02T07:48:40Z

Narayan: uploaded a new version of "File:Book Open Small.png"

[[Category:Farm-Fresh Web Icons]]

File:Book Open Small.png

2010-10-02T07:44:36Z

Narayan: uploaded a new version of "File:Book Open Small.png": Reverted to version as of 09:15, 27 September 2010

[[Category:Farm-Fresh Web Icons]]

File:Book Open Small.png

2010-10-02T07:43:43Z

Narayan: uploaded a new version of "File:Book Open Small.png"

[[Category:Farm-Fresh Web Icons]]

Book:ReNamer User Manual

2010-09-28T04:28:55Z

Narayan:

{{saved_book}}

== ReNamer User Manual ==

:[[ReNamer]]
:[[ReNamer:Introduction|Introduction]]
:[[ReNamer:Quick Guide|Quick Guide]]
:[[ReNamer:Step-by-step|Step-by-step]]
:[[ReNamer:Adding files and folders|Adding files and folders]]
:[[ReNamer:Managing rules|Managing Rules]]
:[[ReNamer:Previewing files|Previewing Files]]
:[[ReNamer:Renaming files|Renaming Files]]
:[[ReNamer:Using the Rules|Using the Rules]]
:[[ReNamer:Rules|Overview of Rules]]
:[[ReNamer:Rules:Insert|Insert Rule]]
:[[ReNamer:Rules:Delete|Delete Rule]]
:[[ReNamer:Rules:Remove|Remove Rule]]
:[[ReNamer:Rules:Replace|Replace Rule]]
:[[ReNamer:Rules:Rearrange|Rearrange Rule]]
:[[ReNamer:Rules:Rearrange_Examples|Rearrange Rule Examples]]
:[[ReNamer:Rules:Extension|Extension Rule]]
:[[ReNamer:Rules:Strip|Strip Rule]]
:[[ReNamer:Rules:Case|Case Rule]]
:[[ReNamer:Rules:Serialize|Serialize Rule]]
:[[ReNamer:Rules:CleanUp|CleanUp Rule]]
:[[ReNamer:Rules:Translit|Translit Rule]]
:[[ReNamer:Rules:RegEx|RegEx Rule]]
:[[ReNamer:Rules:PascalScript|PascalScript Rule]]
:[[ReNamer:Rules:UserInput|UserInput Rule]]
;Appendices
:[[ReNamer:Using presets|Using Presets]]
:[[ReNamer:Manual editing|Manual Editing]]
:[[ReNamer:Analyze|Analyze]]
:[[ReNamer:Program settings|Program settings]]
:[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and Keyboard Shortcuts]]
:[[ReNamer:Menus for the Files pane|Menus for the Files Pane]]
:[[ReNamer:Context menus|Context Menus]]
:[[ReNamer:Date and Time format|Date and Time Format]]
:[[ReNamer:Binary Signatures|Binary Signatures]]
:[[ReNamer:Meta Tags|Meta Tags]]
:[[ReNamer:Analyze|Analyze]]
:[[ReNamer:Regular Expressions|Regular Expressions]]
:[[ReNamer:Pascal Script|Pascal Script]]
:[[ReNamer:Pascal Script:Quick guide|Quick Guide]]
:[[ReNamer:Pascal Script:Types|Types]]
:[[ReNamer:Pascal Script:Functions|Functions]]
:[[ReNamer:Pascal_Script#Script cookbook|PascalScript Cookbook]]
:[[ReNamer:Scripts|PascalScripts]]
:[[ReNamer:Command Line|Using ReNamer in Command Line Mode]]
:[[ReNamer:Sorting files|Sorting Files]]
:[[ReNamer:Masks|Masks]]
:[[ReNamer:Renaming folders|Renaming Folders]]
:[[ReNamer:Renaming to another folder|Renaming to Another Folder and Binning]]
:[[ReNamer:Failed renaming|Failed Renaming]]
:[[ReNamer:Validation|Validation of New Names]]

[[Category:Books]]
[[Category:ReNamer]]

ReNamer

2010-09-27T02:25:13Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==
[http://www.den4b.com/w/index.php?title=Special:Book&bookcmd=render_collection&colltitle=Book:ReNamer_User_Manual&writer=rl Get the latest version of this manual as pdf]
*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]

ReNamer

2010-09-27T02:17:18Z

Narayan: /* User Manual */

[[Image:ReNamer.png|thumb|250px]]

[[ReNamer]] is a very powerful and flexible file renaming tool, which offers all the standard renaming procedures, including prefixes, suffixes, replacements, case changes, as well as removing contents of brackets, adding number sequences, changing file extensions, etc. For advanced users, there is a [[ReNamer:Rules:PascalScript|PascalScript]] rule, which let users program their very own renaming rule. Program allows you to combine multiple renaming actions as a rule set, applying each action in a logical sequence, which can be saved, loaded, and managed within the program. In addition, it has an ability to rename folders, process regular expressions, Unicode capable, and supports variety of meta tags, such as: [http://en.wikipedia.org/wiki/ID3 ID3v1], [http://en.wikipedia.org/wiki/ID3 ID3v2], [http://en.wikipedia.org/wiki/EXIF EXIF], [http://en.wikipedia.org/wiki/Object_Linking_and_Embedding OLE], [http://msdn.microsoft.com/en-us/library/ms779636.aspx AVI], [http://en.wikipedia.org/wiki/MD5 MD5], [http://en.wikipedia.org/wiki/CRC32 CRC32], [http://en.wikipedia.org/wiki/SHA1 SHA1] and many more.

== User Manual ==
[http://www.den4b.com/w/index.php?title=Special:Book&bookcmd=render_collection&colltitle=Book:ReNamer_User_Manual&writer=rl Get the latest version of this manual]
*[[ReNamer:Introduction|Introduction]]
*[[ReNamer:Quick Guide|Quick Guide]]
*[[ReNamer:Step-by-step|Step-by-step]]
**[[ReNamer:Adding files and folders|Adding files and folders]]
**[[ReNamer:Managing rules|Managing rules]]
**[[ReNamer:Previewing files|Previewing files]]
**[[ReNamer:Renaming files|Renaming files]]
*[[ReNamer:Using the Rules|Using the Rules]]
**[[ReNamer:Rules|Overview]]
**[[ReNamer:Rules:Insert|Insert]]
**[[ReNamer:Rules:Delete|Delete]]
**[[ReNamer:Rules:Remove|Remove]]
**[[ReNamer:Rules:Replace|Replace]]
**[[ReNamer:Rules:Rearrange|Rearrange]] ([[ReNamer:Rules:Rearrange Examples|Examples]])
**[[ReNamer:Rules:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
*[[ReNamer:Using presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]

== Appendices ==

*[[ReNamer:Program settings|Program settings]]
*[[ReNamer:Main Menu and keyboard shortcuts|Main Menu and keyboard shortcuts]]
*[[ReNamer:Menus for the Files pane|Menus for the Files pane]]
*[[ReNamer:Context menus|Context menus]]
*[[ReNamer:Date and Time format|Date and Time format]]
*[[ReNamer:Binary Signatures|Binary Signatures]]
*[[ReNamer:Meta Tags|Meta Tags]]
*[[ReNamer:Analyze|Analyze dialog]]
*[[ReNamer:Regular Expressions|Regular Expressions]]
*[[ReNamer:Pascal Script|Pascal Script]]
**[[ReNamer:Pascal Script:Quick guide|Quick guide]]
**[[ReNamer:Pascal Script:Types|Types]]
**[[ReNamer:Pascal Script:Functions|Functions]]
**[[ReNamer:Pascal_Script#Script cookbook|Script cookbook]]
**[[ReNamer:Scripts|Scripts]]
*[[ReNamer:Command Line|Command Line]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder (or sorting files into multiple folders)]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]

[[Category:ReNamer]]