den4b Wiki - User contributions [en]

ReNamer:Long paths

2022-08-09T14:06:38Z

Stefan: very > vary

{{Up|ReNamer}}

== Introduction ==

The maximum length of paths and file/folder names is limited in every mainstream operating system and file system. The exact limits can vary significantly between systems.

For example, in Windows 10 and earlier versions the maximum path length is limited to '''260 characters''' (MAX_PATH constant). In contrast, Linux imposes a limit of '''4096 bytes''' for full paths and '''255 bytes''' for file names. Older systems imposed even stricter limits, like [https://en.wikipedia.org/wiki/DOS DOS] with '''80 characters''' limit for full paths and only '''12 characters''' (8.3 format) for file names.

Fortunately, this issue is slowly but surely getting addressed, in one way or another. We will also discuss ways of working around some of these limitations.

== Long paths in Windows ==

Modern versions of Windows operating system have an alternative file path specification mechanism which overcomes the '''260 characters''' limitation.

Let's take a conventional file path:

<pre>C:\Very\Long\Path</pre>

To convert a path to a "long path" specification, we just need to prepend it with <code>\\?\</code>, as follows:

<pre>\\?\C:\Very\Long\Path</pre>

This effectively raises the maximum length of file paths to '''32,767 characters'''.

However, there are other potential culprits:

* This only raises a limitation imposed by the Windows operating system, while other limitations imposed by file systems may still apply.
* The support for long paths also depends on capabilities of individual applications.

== Long paths in ReNamer ==

ReNamer normally operates with conventional file paths, but it can also handle the "long path" specification if such was provided.

The standard ''Add Files'' and ''Add Folders'' dialogs cannot handle long paths yet. However, you can use the ''Add Paths'' dialog from the main menu or ''Export/Import'' menu options.

== Truncating long paths ==

The limitation of the maximum file path can make files inaccessible by some applications, including even the ''Windows File Explorer''.

A common workaround is to truncate long paths. The truncation can be performed with the help of [[ReNamer:Rules:PascalScript|Pascal Script]] and [[ReNamer:Rules:RegEx|Regular Expressions]] rules.

== References ==

* [https://docs.microsoft.com/windows/win32/fileio/naming-a-file Windows: Naming Files, Paths, and Namespaces]
* [https://docs.microsoft.com/windows/win32/fileio/maximum-file-path-limitation Windows: Maximum Path Length Limitation]
* [https://en.wikipedia.org/wiki/Comparison_of_file_systems#Limits Wikipedia: Comparison of file systems and limits]

[[Category:ReNamer]]

ReNamer:Export menu

2022-05-05T05:54:42Z

Stefan:

{{Up|ReNamer}}

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

[[Image:ExportMenu.png|frame|none]]

{| class="wikitable"
! Option
! Description

|-
| Export file paths and undo paths
| Exports ''path\current-file-names'' and ''undo paths'' (after renaming) to the .csv (comma separated) or .txt (tab separated) file.

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

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

|-
| Import files from text-list or play-list
| Imports ''path\current-file-names'' 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 paths to clipboard
| Export full original paths of all files to the clipboard.

|-
| Export all columns to clipboard
| Exports ''all columns'' to clipboard as a tab separated text.
|}

[[Category:ReNamer]]

ReNamer:Export menu

2022-05-04T05:56:44Z

Stefan:

{{Up|ReNamer}}

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

[[Image:ExportMenu.png|frame|none]]

{| class="wikitable"
! Option
! Description

|-
| Export file paths and undo paths
| Exports ''path\current-file-names'' and ''undo paths'' (after renaming) to the .csv (comma separated) or .txt (tab separated) file.

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

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

|-
| Import files from text-list or play-list
| Imports ''path\current-file-names'' 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 file paths to clipboard
| Export full original paths of all files to the clipboard.

|-
| Export all columns to clipboard
| Exports ''all columns'' to clipboard as a tab separated text.
|}

[[Category:ReNamer]]

ReNamer:TOC

2020-07-27T05:19:44Z

Stefan: Added "Padding"-rule

{{Beta}}

{{Open book|Book:ReNamer_User_Manual|Open the book and download the manual as a PDF}}

{| class="wikitable"
!colspan="3"| Table of Contents
|-
|valign="top"|
*[[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 presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]
* Menus and settings
**[[ReNamer:Program settings|Program settings]]
**[[ReNamer:Main menu|Main menu]]
**[[ReNamer:Rules menu|Rules menu]]
**[[ReNamer:Files menu|Files menu]]
**[[ReNamer:Files header menu|Files header menu]]
**[[ReNamer:Filter settings|Filter settings]]
**[[ReNamer:Export menu|Export menu]]
**[[ReNamer:Options menu|Options menu]]
**[[ReNamer:Menus for the Files pane|Menus for the Files pane]]

|valign="top"|
*[[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:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:Randomize|Randomize]]
**[[ReNamer:Rules:Padding|Padding]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
**[[ReNamer:Rules:ReformatDate|ReformatDate]]

|valign="top"|
*[[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 mode]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]
*[[ReNamer:Skip extension|Skip extension]]
*[[ReNamer:Examples of Rules|Examples of rules]]
*[[ReNamer:Rules:Rearrange Examples|Examples of Rearrange rule]]
|}

[[Category:ReNamer]]
[[Category:TOC]]

ReNamer:Rules:Rearrange

2020-05-22T05:42:59Z

Stefan: ...if an delimiter match at the very end ...

{{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).
*The same is true if an delimiter match at the very end of the name, the resultant $n contains nothing.

'''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:Replace

2020-05-11T12:09:41Z

Stefan: Adjusted the separator ( | > *|* ) in the example at the bottom

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

== Replace Rule ==

[[Image:ReplaceRule.png|center]]

This rule removes the specified string from the name and replaces it with another string. It has options to replace the first occurrence, the last occurrence, or all the occurrences. You can replace multiple strings at a time. You can create a pattern with wildcards, so that any string that matches the pattern will be removed.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Find
| Enter the string to be replaced.
*You can enter multiple strings at a time. They will be searched & replaced in the order as they appear. Press the + button to insert a separator between two strings. Instead of pressing this button, you can also enter '''*|*''' from the keyboard.
*If the name does not contain the specified string, the rule will not act on it.
*If the name contains more than one of these strings, it will replace them according to the Occurrences parameter.

|-
| [[Image:PlusButton.png]] button
| Inserts a separator ('''*|*''') sequence between two delimiter entries. (You can directly type'''*|*'''
You can use this button in the '''Replace''' box also. In that case, the nthe entry in the '''Find''' box is replaced by the nths entry in the '''Replace''' box. (e.g. A -->A', B -->B' etc.) }

|-
| Replace
| Enter strings that will replace the "Find" strings.
*Note that the number of strings (separated with '''*|*''') in "Find" and "Replace" boxes should be the same. If there is more strings in the "Find" box than in the "Replace" box the spare strings will be removed (replaced with an empty string). If there is more strings in the "Replace" box, the spare strings will be ignored.

|-
| Insert meta tag
[[Image:ReNamer Insert Meta Tag Button.png]]

| Click the button to see a list of [[ReNamer:Meta Tags|meta-tags]].
|-
| Occurrences
| In case that strings occur more than once in the filename, specify which occurrences should be replaced. (Options are: ''first only'', ''last only'', or ''all'')
|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.
|-
| Case sensitive
| Will only remove a specified string from the name if the case matches exactly.
|-
| Interpret symbols as wild cards
| Treat certain symbols as [[#Wildcards|Wildcards]] for matching simple patterns (similar to [[ReNamer:Regular Expressions|Regular Expressions]]).

|}

=== Wildcards ===

{| class="wikitable"
|-
! Wildcard
! Represents
! Example
|-
| <center>*</center>
| any number of characters (including numbers, space, underscores, etc.).
| '''abc*''' equals '''abc''' followed by 0 or more characters.
|-
| <center>?</center>
| Any single character (including numbers, space, underscores, etc.)
| '''ab?d''' equals '''abcd''', '''ab1d''', '''ab d''', '''ab_d''', etc.
|-
| <center>[]</center>
| Brackets enclose a set of characters, any one of which may match a single character at that position.
| '''foo[ab]ar '''equals '''fooaar''' and '''foobar'''
|-
| <center>-</center>
| (only within a pair of brackets) denotes a range of characters.
| '''foo[a-z]ar '''equals '''fooaar''', '''foobar,''' '''foocar,''' '''foodar,''' etc.
|}

== Beware of conflicting replacements ==

If you enter multiple find and replace strings they will be executed as multiple Replace rules, so first string will go first and only after replacing all (or first, or last) occurrences of that string the second string in the Find box will be searched & replaced.

{|
|

{| class="wikitable"
! Find
! Replace
|-
| A*{{Pipe}}*B
| B*{{Pipe}}*A
|}

|

{| class="wikitable"
! Name
! New Name
|-
| ABBA.mp3
| AAAA.mp3
|}

|}

You may expect the new name to be <tt>BAAB.mp3</tt>, but it's not. This happens because first all <tt>A</tt>'s are replaced with <tt>B</tt>'s (we get <tt>BBBB.mp3</tt>) and only then all <tt>B</tt>'s are replaced with <tt>A</tt>'s (and the final result is <tt>AAAA.mp3</tt>).

If you need to apply character-to-character mappings you should use [[ReNamer:Rules:Translit|Translit rule]].

[[Category:ReNamer]]

ReNamer:Rules:CSV-Import

2020-04-25T14:07:47Z

Stefan:

See Export menu 
There is an "Import file names from text-list (CSV or TXT)" option: 
> Imports file paths and new names from the .csv (comma separated) or .txt (tab separated) file. 
http://www.den4b.com/wiki/ReNamer:Export_menu 

 

 

== Example ==

From http://www.den4b.com/forum/viewtopic.php?pid=10917#p10917

You can save your excel file in CSV format (comma delimited), and then use ReNamer's import/export options, such as "Import file paths and new names". 
Note that you will need to have a full file path in the first column, otherwise ReNamer won't know where to find the file. 
If the cell contains spaces, commas or quotation marks, then the cell value must be en-quoted and inner quotation marks escaped properly. 
 
For example: 
"C:\My Folder\My Old File.txt","My New File.txt" 
"C:\My Folder\My Old File 2.txt","My second New File.txt" 
"C:\My Folder\My Old File 3.txt","My Another New File.txt" 
 
See this article for more examples: 
https://en.wikipedia.org/wiki/Comma-separated_values#Basic_rules 
 
You may need to select a different variation of the CSV format when saving from Excel, to get properly en-quoted and escaped cell values. 
 
ReNamer since v7.1.0.2 Beta handles unquoted values appropriately, so you don't need to manually enquote all values any more.

ReNamer:Rules:CSV-Import

2020-04-25T09:59:13Z

Stefan:

See Export menu 
There is an "Import file names from text-list (CSV or TXT)" option: 
> Imports file paths and new names from the .csv (comma separated) or .txt (tab separated) file. 
http://www.den4b.com/wiki/ReNamer:Export_menu 

 

 

You can save your excel file in CSV format (comma delimited), and then use ReNamer's import/export options, such as "Import file paths and new names". 
 
Note that you will need to have a full file path in the first column, otherwise ReNamer won't know where to find the file. 
 
If the cell contains spaces, commas or quotation marks, then the cell value must be en-quoted and inner quotation marks escaped properly. 
 
For example: 
"C:\My Folder\My Old File.txt","My New File.txt" 
"C:\My Folder\My Old File 2.txt","My second New File.txt" 
"C:\My Folder\My Old File 3.txt","My Another New File.txt" 
 
See this article for more examples: 
https://en.wikipedia.org/wiki/Comma-separated_values#Basic_rules 
 
You may need to select a different variation of the CSV format when saving from Excel, to get properly en-quoted and escaped cell values. 
 
ReNamer v7.1.0.2 Beta handles unquoted values appropriately, so you don't need to manually enquote all values any more.

ReNamer:TOC

2020-04-25T09:28:33Z

Stefan: Added hint to CSV-Import

{{Beta}}

{{Open book|Book:ReNamer_User_Manual|Open the book and download the manual as a PDF}}

{| class="wikitable"
!colspan="3"| Table of Contents
|-
|valign="top"|
*[[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 presets|Using presets]]
*[[ReNamer:Analyze|Analyze window]]
*[[ReNamer:Manual editing|Manual editing]]
* Menus and settings
**[[ReNamer:Program settings|Program settings]]
**[[ReNamer:Main menu|Main menu]]
**[[ReNamer:Rules menu|Rules menu]]
**[[ReNamer:Files menu|Files menu]]
**[[ReNamer:Files header menu|Files header menu]]
**[[ReNamer:Filter settings|Filter settings]]
**[[ReNamer:Export menu|Export menu]]
**[[ReNamer:Options menu|Options menu]]
**[[ReNamer:Menus for the Files pane|Menus for the Files pane]]

|valign="top"|
*[[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:Extension|Extension]]
**[[ReNamer:Rules:Strip|Strip]]
**[[ReNamer:Rules:Case|Case]]
**[[ReNamer:Rules:Serialize|Serialize]]
**[[ReNamer:Rules:Randomize|Randomize]]
**[[ReNamer:Rules:CleanUp|CleanUp]]
**[[ReNamer:Rules:Translit|Translit]]
**[[ReNamer:Rules:RegEx|RegEx]]
**[[ReNamer:Rules:PascalScript|PascalScript]]
**[[ReNamer:Rules:UserInput|UserInput]]
**[[ReNamer:Rules:ReformatDate|ReformatDate]]
**[[ReNamer:Rules:CSV-Import|CSV-Import]]

|valign="top"|
*[[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 mode]]
*[[ReNamer:Sorting files|Sorting files]]
*[[ReNamer:Masks|Using masks]]
*[[ReNamer:Renaming folders|Renaming folders]]
*[[ReNamer:Renaming to another folder|Renaming to another folder]]
*[[ReNamer:Failed renaming|Failed renaming]]
*[[ReNamer:Validation|Validation]]
*[[ReNamer:Skip extension|Skip extension]]
*[[ReNamer:Examples of Rules|Examples of rules]]
*[[ReNamer:Rules:Rearrange Examples|Examples of Rearrange rule]]
|}

[[Category:ReNamer]]
[[Category:TOC]]

ReNamer:Rules:CSV-Import

2020-04-25T09:24:54Z

Stefan: Created page with "See Export menu There is an "Import file names from text-list (CSV or TXT)" option: > Imports file paths and new names from the .csv (comma separated) or .txt (tab sep..."

ReNamer:Rules:UserInput

2020-04-25T09:18:19Z

Stefan:

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:PascalScript|next=ReNamer:Rules:ReformatDate}}
__NOTOC__
[[Image:UserInputRule.png|center]]

This rule replaces the original filenames with the names taken from the list. (The ''n''th line in the list serves as the new name for the ''n''th file in the '''Files''' pane.)

Naturally, the list should contain names for all the files loaded in the '''Files''' pane.

*If the list is shorter, then some of the files will not be renamed.
*If the list is longer, some of the names will remain unused (but all files in the '''Files''' pane will be renamed).

There are three ways to create the list:

#Click in the pane, and manually type the list (one name per line).
#Copy the list from any application to your clipboard. Switch to ReNamer. Click in the '''UserInput''' pane and press '''CTRL+V''', right-click and select '''Paste''' or choose the '''Load from clipboard''' from [[Image:UserInputOptionsButton.png]] menu).
#Load a list from the text file (available from [[Image:UserInputOptionsButton.png]] menu).

The optional parameters are as follows:

{| class="wikitable"
! Parameter
! Description
|-
| Insert in front of the current name
| Inserts the name before the file name.
|-
| Insert after the current name
| Inserts the name ''after'' the current name. The actual position depends on the '''Skip extension''' option.
|-
| Replace the current name
| Replaces the existing filename with the new name.
The effect on extension depends on the '''''Skip extension''''' option:
|-
| Skip extension
|
*If the option is selected, the extension is ignored and user input strings will affect only the base name of files.
*If the option is deselected, user input strings will replace entire filename, ''including'' the extension, or will be added ''after'' the old extension (if the '''Insert after the current name''' option is selected).
|}

== Alternatives ==
See Export menu 
There is an "Import file names from text-list (CSV or TXT)" option 
http://www.den4b.com/wiki/ReNamer:Export_menu

== Examples ==

For example, if you have this three files:
* Old name 1
* Old name 2
* Old name 3

Then your list of new names should contain exactly three lines like:
* New name for old name 1
* new name for old name 2
* New name for old name 3

==== Example 1 ====

File list is longer then the list of new names:

{| class="wikitable"
! File name
! List of new names
|-
| One.txt
| First.txt
|-
| Two.txt
| Second.txt
|-
| Three.txt
| Third.txt
|-
| Four.txt
| ''(will not be renamed)''
|}

==== Example 2 ====

List of new names is longer then the file list:

{| class="wikitable"
! File name
! List of new names
|-
| One.txt
| First.txt
|-
| Two.txt
| Second.txt
|-
| Three.txt
| Third.txt
|-
| ''(not used)''
| Fourth.txt
|}

==== Example 3 ====

Missed item in the list of new names can cause incorrect ordering:

{| class="wikitable"
! File name
! List of new names
|-
| One.txt
| First.txt
|-
| Two.txt
| Third.txt
|-
| Three.txt
| Fourth.txt
|-
| Four.txt
| Fifth.txt
|}

[[Category:ReNamer]]

ReNamer:Rules

2020-04-25T09:16:31Z

Stefan: Added hint for CSV-Import

{{Go|up=ReNamer}}

== Overview of Rules ==

ReNamer has an extensive set of rules. These rules can be combined together, in a logical sequence, to perform nearly any thinkable operation with the filename. You can also [[ReNamer:Manual editing|manually edit]] the name of any file.

The table below lists all rules, with a brief description of each rule. The subsequent chapters provide more details for each rule (follow the links).

{| class="wikitable"
|-
! Rules
! Description
|-
| [[ReNamer:Rules:Insert|Insert]]
| Insert the specified text into the filename: as prefix, as suffix, at the specified position, before- or after the specified text. There is also an option to insert meta tags into the filename.
|-
| [[ReNamer:Rules:Delete|Delete]]
| Delete a portion of the filename, usually defined by character positions: from the specified position, from the occurrence of the specified delimiter, until the specified number of characters, until occurrence of the specified delimiter or till the end. This rule can be set to process the filename in a right-to-left manner.
|-
| [[ReNamer:Rules:Remove|Remove]]
| Remove the specified text from the filename: first, last or all occurrences. Optionally, wildcards can be used within this rule, to remove masked text fragments.
|-
| [[ReNamer:Rules:Replace|Replace]]
| This rule is very much like the '''Remove '''rule (above). It has similar options, except that instead of removing the text fragments, it will replace them with the specified text.
|-
| [[ReNamer:Rules:Rearrange|Rearrange]]
| Chop up the existing file name using any delimiter or position and reuse any/all of the parts in any order to compose a new name.Add your strings, or use the meta tags extracted from the file to compose the new name. 
|-
| [[ReNamer:Rules:Extension|Extension]]
| Change extension of files to the specified extension, or to the extension automatically detected through the internal database of binary signatures.
|-
| [[ReNamer:Rules:Strip|Strip]]
| Strip all occurrences of the specified characters from the filename. This rule has predefined character sets, like digits, symbols, brackets, but you can also define your own character set.
|-
| [[ReNamer:Rules:Case|Case]]
| Change the case of the filename: capitalize each word, to lower case, to upper case, invert case, or capitalize only the first letter and force the rest to lowercase (as in a sentence). There is also an option to force case for the manually entered fragments, for example: CD, DVD, India, ReNamer, etc.
|-
| [[ReNamer:Rules:Serialize|Serialize]]
| Add incremental numbers to put filenames into an order.
|-
| [[ReNamer:Rules:Randomize|Randomize]]
| Add randomly generated sequences into filenames.
|-
| [[ReNamer:Rules:CleanUp|CleanUp]]
| Cleanup filenames from (or for) commonly used naming conventions for Internet, peer-to-peer networks, and other resources.
|-
| [[ReNamer:Rules:Translit|Translit]]
| Transliterate Non-English characters from different languages into their English/Latin representation. Useful for preparing files for network storage and transfer. Several transliteration maps are built in, and you can define your own maps.
|-
| [[ReNamer:Rules:RegEx|RegEx]]
|
RegEx (=Regular Expressions) is used for complex pattern/expression matching and replacing operations. Although it may look complex at first, you can learn it quite easily, using the guide provided in this manual!

|-
| [[ReNamer:Rules:PascalScript|PascalScript]]
| Scripting allows programming-aware users to code their own renaming rule using predefined set of functions. This rule uses Pascal/Delphi programming syntax and conventions. Extremely powerful feature in the right hands.
|-
| [[ReNamer:Rules:UserInput|UserInput]]
| Rule that simply sets the new names of the files to the names entered in a list (one name per line).
|-
| [[ReNamer:Rules:ReformatDate|ReformatDate]]
| Change format of date/time values in the filename.
|-
| [[ReNamer:Rules:CSV-Import|CSV-Import]]
| Import file names from text-list (CSV or TXT).
|}

[[Category:ReNamer]]

ReNamer:Rules:UserInput

2020-04-21T08:56:55Z

Stefan: Added an hint for Export menu > Import from CSV

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:PascalScript|next=ReNamer:Rules:ReformatDate}}
__NOTOC__
[[Image:UserInputRule.png|center]]

This rule replaces the original filenames with the names taken from the list. (The ''n''th line in the list serves as the new name for the ''n''th file in the '''Files''' pane.)

Naturally, the list should contain names for all the files loaded in the '''Files''' pane.

*If the list is shorter, then some of the files will not be renamed.
*If the list is longer, some of the names will remain unused (but all files in the '''Files''' pane will be renamed).

There are three ways to create the list:

#Click in the pane, and manually type the list (one name per line).
#Copy the list from any application to your clipboard. Switch to ReNamer. Click in the '''UserInput''' pane and press '''CTRL+V''', right-click and select '''Paste''' or choose the '''Load from clipboard''' from [[Image:UserInputOptionsButton.png]] menu).
#Load a list from the text file (available from [[Image:UserInputOptionsButton.png]] menu).

The optional parameters are as follows:

{| class="wikitable"
! Parameter
! Description
|-
| Insert in front of the current name
| Inserts the name before the file name.
|-
| Insert after the current name
| Inserts the name ''after'' the current name. The actual position depends on the '''Skip extension''' option.
|-
| Replace the current name
| Replaces the existing filename with the new name.
The effect on extension depends on the '''''Skip extension''''' option:
|-
| Skip extension
|
*If the option is selected, the extension is ignored and user input strings will affect only the base name of files.
*If the option is deselected, user input strings will replace entire filename, ''including'' the extension, or will be added ''after'' the old extension (if the '''Insert after the current name''' option is selected).
|}

== Alternatives ==
See Export menu 
There is an "Import files from text-list CSV TXT" option 
http://www.den4b.com/wiki/ReNamer:Export_menu

== Examples ==

For example, if you have this three files:
* Old name 1
* Old name 2
* Old name 3

Then your list of new names should contain exactly three lines like:
* New name for old name 1
* new name for old name 2
* New name for old name 3

==== Example 1 ====

File list is longer then the list of new names:

{| class="wikitable"
! File name
! List of new names
|-
| One.txt
| First.txt
|-
| Two.txt
| Second.txt
|-
| Three.txt
| Third.txt
|-
| Four.txt
| ''(will not be renamed)''
|}

==== Example 2 ====

List of new names is longer then the file list:

{| class="wikitable"
! File name
! List of new names
|-
| One.txt
| First.txt
|-
| Two.txt
| Second.txt
|-
| Three.txt
| Third.txt
|-
| ''(not used)''
| Fourth.txt
|}

==== Example 3 ====

Missed item in the list of new names can cause incorrect ordering:

{| class="wikitable"
! File name
! List of new names
|-
| One.txt
| First.txt
|-
| Two.txt
| Third.txt
|-
| Three.txt
| Fourth.txt
|-
| Four.txt
| Fifth.txt
|}

[[Category:ReNamer]]

ReNamer:Rules:RegEx

2019-03-13T09:33:37Z

Stefan: Added "BackReference explanations"

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Translit|next=ReNamer:Rules:PascalScript}}

[[Image:RegExRule.png|center]]

This rule finds text that matches the specified RegEx pattern, and replaces it with another string. RegEx is short for '''Regular Expressions''', which stands for special syntax for describing search and replace patterns. Regular Expressions are very powerful and they are ''really'' worth learning. The [[ReNamer:Regular Expressions|RegEx syntax]] is explained in the appendix.

'''Note:''' The [http://www.regexpstudio.com/ TRegExpr] RegEx engine used by ReNamer is a little different from the standard [http://perldoc.perl.org/perlre.html PERL RegEx] or [http://msdn.microsoft.com/en-us/library/6wzad2b2(VS.85).aspx Windows RegEx]. You may check the correct syntax in [[ReNamer:Regular Expressions|Regular Expressions]] section.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Expression
| RegEx pattern to match or find.
|-
| Replace
| RegEx pattern that replaces the found pattern.
|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.
|-
| Case-sensitive
| If this option is selected, ReNamer will search for the text in ''case-sensitive'' manner.
|}

A simple set of commonly used RegEx syntax patterns is provided in the hint menu:

[[File:RegExRuleSyntaxHint.png]]

'''Tip:''' ReNamer users have posted many RegEx patterns at the [http://www.den4b.com/forum/ User Forum]. You can copy and use them.
 
 
== BackReference ==
Replace-Hint: Use $1...$9 to reference subexpressions.
 
 
'$n' refers to 'BackReference' of RegularExpression search&replace, 
where you can group a search pattern in parentheses (...) 
and reuse --what was matched and stored-- later on in replacement. 
 
'$n' would then be used in form of '$1', '$2', '$3',... and so on till '$9', 
counting the opening parentheses '(' from the left of the search string. 
Counting '(' from the left includes nested parentheses: ( 1 xxx (2 dd)(3 ff)) 
 
 
Example on string "Vacation 2019.ext" 
Search Expression: "^(\w+) (\d+)\.(\w\w\w)" 
Replace: "$2 - $1.$3 
Results in: "2019 - Vacation.ext" 
 
A little bit to complicated, as you also could use "[x]Skip Extension", instead of "\.(\w\w\w)" and .$3, 
but just for example that may be fine to have something to explain. 
 
 
In this simple constellation this will work fine, and the two parts are swapped and a hyphen is added in between as we told in the replacement. 
For more complex issues you may make yourself more familiar with the RegularExpression syntax (see links above), or ask for help in the forum. 
 
 
Please note that replacement with both '$1' and digit '0' ( '$10' ) could be troublesome, as the engine may look for a tenth subexpression. 
Maybe use a workaround like '$1_0' and replace the underscore in a second step. 
 
 
There is also a second meaning/use of 'BackReference' in an Search expression: "(The )$1" for to search for two successively 'The 's.
 
 
 
 
[[Category:ReNamer]]

ReNamer:Rules:Replace

2019-03-13T09:11:04Z

Stefan: Added "Use '$n' as 'Backreferences'"

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

== Replace Rule ==

[[Image:ReplaceRule.png|center]]

This rule removes the specified string from the name and replaces it with another string. It has options to replace the first occurrence, the last occurrence, or all the occurrences. You can replace multiple strings at a time. You can create a pattern with wildcards, so that any string that matches the pattern will be removed.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Find
| Enter the string to be replaced.
*You can enter multiple strings at a time. They will be searched & replaced in the order as they appear. Press the + button to insert a separator between two strings. Instead of pressing this button, you can also enter '''*|*''' from the keyboard.
*If the name does not contain the specified string, the rule will not act on it.
*If the name contains more than one of these strings, it will replace them according to the Occurrences parameter.

|-
| [[Image:PlusButton.png]] button
| Inserts a separator ('''*|*''') sequence between two delimiter entries. (You can directly type'''*|*'''
You can use this button in the '''Replace''' box also. In that case, the nthe entry in the '''Find''' box is replaced by the nths entry in the '''Replace''' box. (e.g. A -->A', B -->B' etc.) }

|-
| Replace
| Enter strings that will replace the "Find" strings.
*Note that the number of strings (separated with '''*|*''') in "Find" and "Replace" boxes should be the same. If there is more strings in the "Find" box than in the "Replace" box the spare strings will be removed (replaced with an empty string). If there is more strings in the "Replace" box, the spare strings will be ignored.

|-
| Insert meta tag
[[Image:ReNamer Insert Meta Tag Button.png]]

| Click the button to see a list of [[ReNamer:Meta Tags|meta-tags]].
|-
| Occurrences
| In case that strings occur more than once in the filename, specify which occurrences should be replaced. (Options are: ''first only'', ''last only'', or ''all'')
|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.
|-
| Case sensitive
| Will only remove a specified string from the name if the case matches exactly.
|-
| Interpret symbols as wild cards
| Treat certain symbols as [[#Wildcards|Wildcards]] for matching simple patterns (similar to [[ReNamer:Regular Expressions|Regular Expressions]]).

|}

=== Wildcards ===

{| class="wikitable"
|-
! Wildcard
! Represents
! Example
|-
| <center>*</center>
| any number of characters (including numbers, space, underscores, etc.).
| '''abc*''' equals '''abc''' followed by 0 or more characters.
|-
| <center>?</center>
| Any single character (including numbers, space, underscores, etc.)
| '''ab?d''' equals '''abcd''', '''ab1d''', '''ab d''', '''ab_d''', etc.
|-
| <center>[]</center>
| Brackets enclose a set of characters, any one of which may match a single character at that position.
| '''foo[ab]ar '''equals '''fooaar''' and '''foobar'''
|-
| <center>-</center>
| (only within a pair of brackets) denotes a range of characters.
| '''foo[a-z]ar '''equals '''fooaar''', '''foobar,''' '''foocar,''' '''foodar,''' etc.
|}

==== Use '$n' as 'Backreferences' ====

Use what is found by wildcards in replacement with '$n' as 'Backreferences'
 
 
If you search with wildcards '?' or '*', you can use what is found in search, in the replacement by using '$n' variables. 
The 'n' in '$n' represents the counter as digit, counted from the left as you have used wildcards. 
For the first used wildcard it's '$1' in the replacement, for the second it's '$2'... 
 
 
For example 
on "ReNamer.exe", 
Find: r?n* 
Replace: -$1-$2- 
[x] Interpret symbols as wild cards 
will result in: "-e-amer-.exe" 
 
Explanation: 
the '?' will find the first 'e' of "ReNamer" (as searched between 'r' and 'n'), 
and the '*' find the rest after the 'n' till the end, resulting in 'amer'. 
 
 
On "Vacation 2019.txt" 
Find: * * 
Replace: $2 - $1 
[x] Interpret symbols as wild cards 
will result in "2019 - Vacation.txt" 
 
Explanation: 
the '*' will find any amount of signs and store them in $1, 
but stops on next space, as we wanted to find a space next, 
followed by another '*', now stored in $2. 
 
 
In this simple constellation this will work fine, and the two parts are swapped 
and a hyphen is added in between as we told so in the replacement. 
 
For more complex issues you may better use a full featured RegularExpression rule.
 
 
 
 

== Beware of conflicting replacements ==

If you enter multiple find and replace strings they will be executed as multiple Replace rules, so first string will go first and only after replacing all (or first, or last) occurrences of that string the second string in the Find box will be searched & replaced.

{|
|

{| class="wikitable"
! Find
! Replace
|-
| A{{Pipe}}B
| B{{Pipe}}A
|}

|

{| class="wikitable"
! Name
! New Name
|-
| ABBA.mp3
| AAAA.mp3
|}

|}

You may expect the new name to be <tt>BAAB.mp3</tt>, but it's not. This happens because first all <tt>A</tt>'s are replaced with <tt>B</tt>'s (we get <tt>BBBB.mp3</tt>) and only then all <tt>B</tt>'s are replaced with <tt>A</tt>'s (and the final result is <tt>AAAA.mp3</tt>).

If you need to apply character-to-character mappings you should use [[ReNamer:Rules:Translit|Translit rule]].

[[Category:ReNamer]]

ReNamer:Pascal Script:Functions

2019-01-06T09:10:23Z

Stefan: Add example to WideCopy()

{{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 '''WideDeleteRight'''(var S: WideString; Index, Count: Integer);
| Delete '''Count''' characters from '''S''', starting from the '''Index''' position from the end and counting towards the start.

''Added in v6.0.0.9 Alpha.''
|-
| 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 '''S''', starting at position '''Index'''. (Index is zero based) Example: myVarFirst4Signs:=WideCopy(FileName,0,4);
|-
| function '''WideCopyRight'''(const S: WideString; Index, Count: Integer): WideString;
| Returns '''Count''' characters from '''S''', starting at position '''Index''' from the end and counting towards the start.

''Added in v6.0.0.9 Alpha.''
|-
| 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 '''WideTextPosEx'''(const SubStr, S: WideString; Offset: Cardinal): Integer;
| Behaves like '''WidePosEx''' function, except text if processed in case-insensitive manner.

''Added in v6.6.0.1 Beta.''
|-
| function '''WideTrim'''(const S: WideString): WideString;
| Removes leading and trailing spaces and control characters from the given string '''S'''.
|-
| function '''WideTrimChars'''(const S, CharsToTrim: WideString): WideString;
| Remove characters that occur in '''CharsToTrim''' from the beginning and the end of '''S'''.

''Added in v6.0.0.9 Alpha.''
|-
| function '''WideTrimCharsLeft'''(const S, CharsToTrim: WideString): WideString;
| Remove characters that occur in '''CharsToTrim''' from the beginning of '''S'''.

''Added in v6.0.0.9 Alpha.''
|-
| function '''WideTrimCharsRight'''(const S, CharsToTrim: WideString): WideString;
| Remove characters that occur in '''CharsToTrim''' from the end of '''S'''.

''Added in v6.0.0.9 Alpha.''
|-
| function '''WideReverseString'''(const S: WideString): WideString;
| Return a reversed version of string '''S''', i.e. reverse the order of characters.

''Added in v6.7.0.4 Beta.''
|-
| function '''WideRepeatString'''(const S: WideString; Count: Integer): WideString;
| Repeat a string a number of times. ''Added in v6.9.0.3 Beta.''

|-
| function '''WideReplaceStr'''(const S, OldPattern, NewPattern: WideString): WideString;
| Return a result of a ''case-sensitive'' replacement of all occurrences of '''OldPattern''' with '''NewPattern''' in a string '''S'''.

|-
| function '''WideReplaceText'''(const S, OldPattern, NewPattern: WideString): WideString;
| Return a result of a ''case-insensitive'' replacement of all occurrences of '''OldPattern''' with '''NewPattern''' in a string '''S'''.
|-
| function '''WideSplitString'''(const Input, Delimiter: WideString): TWideStringArray;
|
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: TWideStringArray; const Delimiter: WideString): WideString;
| Joins all individual items from '''Strings''' into a single WideString, with '''Delimiter''' inserted between the joined items.

|-
| function '''WideCaseSentence'''(const S: WideString): WideString;
| Returns a ''Sentence case'' version of parameter '''S'''.

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

''Added in v6.0.0.3 Alpha''.
|-
| function '''WideCaseCapitalize'''(const S: WideString): WideString;
|
Returns the ''Title case'' version of parameter '''S'''.

First letter of every word is capitalized. All other alphabetic characters are converted to lowercase.

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

{{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 '''IsWideWordBoundaryLeft'''(const Subject: WideString; CharPosition: Integer): Boolean;
| Check if a character at the specified position is on a word boundary to the left.

Conditions that qualify as word boundaries to the left of character:
# If first character and is a word character.
# Between word and not a word character.

''Added in v6.6.0.1 Beta.''
|-
| function '''IsWideWordBoundaryRight'''(const Subject: WideString; CharPosition: Integer): Boolean;
| Check if a character at the specified position is on a word boundary to the right.

Conditions that qualify as word boundaries to the right of character:
# If last character and is a word character.
# Between word and not a word character.

''Added in v6.6.0.1 Beta.''
|-
| 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.
|-
| function '''WideChr'''(Code: Word): WideChar;
| Create a Unicode character from a code point. ''Added in v6.9.0.3 Beta.''
|}

'''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.
|}

== Console Output Conversion ==

OEM-defined character set is commonly used in the output of console applications.

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''OemToAnsi'''(const S: String): String;
| Convert OEM string into an ANSI string. ''Added in v6.6.0.2 Beta.''
|-
| function '''OemToWide'''(const S: String): WideString;
| Convert OEM string into a WideString. ''Added in v6.6.0.2 Beta.''
|-
| function '''AnsiToOem'''(const S: String): String;
| Convert ANSI string into an OEM string. ''Added in v6.6.0.2 Beta.''
|-
| function '''WideToOem'''(const S: WideString): String;
| Convert WideString into an OEM string. ''Added in v6.6.0.2 Beta.''
|}

{{Top}}

== Basic Conversion ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''BoolToStr'''(B: Boolean): String;
| Convert boolean variable into a string. Returns "''True''" or "''False''" string value.
|-
| 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>
Note: Be cautious of supplying ''Int64'' type as a parameter as it will be type casted to ''Integer'', which significantly reduces the range of possible values (refer to [[ReNamer:Pascal Script:Types|Types]] for more information). You can use '''FormatFloat''' function to convert ''Int64'' values to a string without a loss of range.
|-
| function '''Int64ToStr'''(Value: Int64): String;
| Same as '''IntToStr''' but takes in ''Int64'' typed parameter.
|-
| 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 '''StrToInt64'''(const S: String): Int64;
| Same as '''StrToInt''' but returns ''Int64'' typed result.
|-
| 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 '''StrToInt64Def'''(const S: String; Default: Int64): Int64;
| Same as '''StrToIntDef''' but operates with ''Int64'' type.
|-
| function '''TryStrToInt'''(const S: String; out Value: Integer): Boolean;
| Converts a string to an integer, but does not throw an error when invalid string is supplied, unlike '''StrToInt'''. Returns ''False'' if conversion operation has failed.
|-
| 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'''. Check [[#Floating point format specifiers|floating point format specifiers]] below for more information.
|-
| 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).
|}

=== Floating point format specifiers ===

{| class="wikitable"
! Specifier
! Represents
|-
| <tt>0</tt> (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.
|-
| <tt>#</tt> (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.
|-
| <tt>.</tt> (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.
|-
| <tt>,</tt> (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.
|}

{{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 '''EncodeDateTime'''(Year, Month, Day, Hour, Minute, Second, MilliSecond: Word): TDateTime;
| Generates date-time value for the specified components of date and time. Similar to '''EncodeDate''' and '''EncodeTime'''. ''Added in v6.2.0.5 Beta.''
|-
| function '''TryEncodeDate'''(Year, Month, Day: Word; var Date: TDateTime): Boolean;
| Behaves exactly like '''EncodeDate''' function, except this function returns ''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 ''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.
|-
| function '''TryEncodeDateTime'''(Year, Month, Day, Hour, Minute, Second, MilliSecond: Word; out ADateTime: TDateTime): Boolean;
| Behaves exactly like '''EncodeDateTime''' function, except this function returns ''TRUE'' or ''FALSE'' depending on the success of the operation. If operation was successful, function will return ''TRUE'' and the generated date-time value will be written in the '''ADateTime''' variable. ''Added in v6.2.0.5 Beta.''
|-
| 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.
|-
| procedure '''DecodeDateTime'''(const DateTime: TDateTime; out Year, Month, Day, Hour, Minute, Second, MilliSecond: Word);
| Similar to '''DecodeDate''' and '''DecodeTime''' but extracts both date and time components at once. ''Added in v6.2.0.5 Beta.''
|-
| function '''ComposeDateTime'''(const Date, Time: TDateTime): TDateTime;
| Combine date and time components into a single date-time value. ''Added in v6.2.0.5 Beta.''
|-
| 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).
|-
| function '''SecondSpan'''(const ANow, AThen: TDateTime): Double;
| Calculate the approximate number of seconds between two date-time values. ''Added in v6.2.0.5 Beta.''
|-
| function '''DayOfWeek'''(const DateTime: TDateTime): Word;
| Returns the day number of the week. Returned values: 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday, 7 = Sunday. ''Before v6.1 this function used to return 1=Sunday to 7=Saturday.''
|-
| function '''DayOfMonth'''(const DateTime: TDateTime): Word;
| Returns the day number of the month. ''Added in v6.1.''
|-
| function '''DayOfYear'''(const DateTime: TDateTime): Word;
| Returns the day number of the year. ''Added in v6.1.''
|-
| function '''WeekOfMonth'''(const DateTime: TDateTime): Word;
| Returns the week number of the month. ''Added in v6.1.''
|-
| function '''WeekOfYear'''(const DateTime: TDateTime): Word;
| Returns the week number of the year. ''Added in v6.1.''
|}

{{Top}}

== File Management ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideFileSize'''(const FileName: WideString): Int64;
| Returns the size of the file in bytes. If file does not exist "-1" is returned. The return value is of type ''Int64'' which can store the maximum file size of 9,223,372,036,854,775,807 bytes.
|-
| 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'''(const 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 '''WideRemoveDir'''(const Dir: WideString): Boolean;
| Remove a directory, if it is empty. Returns TRUE on success, otherwise FALSE.

''Added in v6.4.0.1 Beta.''
|-
| function '''WideDeleteFile'''(const FileName: WideString): Boolean;
| Delete physical file from the disk. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideDeleteToRecycleBin'''(const FileName: WideString): Boolean;
| Delete file or folder by placing it into the Recycle Bin. Returns TRUE on success, otherwise FALSE.

'''Note:''' You must provide a full path to delete the file to the Recycle Bin (a quirk of Windows API).

''Added in v6.4.0.1 Beta.''
|-
| function '''WideRenameFile'''(const OldName, NewName: WideString): Boolean;
| Rename file from '''OldName''' to '''NewName'''. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideCopyFile'''(const 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'''(const Dir: WideString; var Files: TWideStringArray; 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''': List only the files which match a [[ReNamer:Masks|wildcard mask]], or specify an empty string to list all files.
|-
| procedure '''WideScanDirForFolders'''(const Dir: WideString; var Folders: TWideStringArray; 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 FileName1, FileName2: WideString): Boolean;
| Compares the filenames '''FileName1''' and '''FileName2''', and returns ''TRUE'' if they are considered to be same.

Note that filenames on Windows platform are case insensitive for comparison purposes, but case preserving when creating new files.

''Added in v6.7.0.4 Beta.''
|-
| function '''WideMatchesMask'''(const FileName, Mask: WideString): Boolean;
| Check if '''FileName''' matches a [[ReNamer:Masks|wildcard mask]] '''Mask'''. Return ''TRUE'' if matches, otherwise ''FALSE''.

For example, a mask <code>*.txt</code> matches files with a <code>.txt</code> extension.

''Added in v6.7.0.4 Beta.''
|-
| function '''WideMatchesMaskList'''(const FileName, MaskList: WideString): Boolean;
| Check if '''FileName''' matches any of the [[ReNamer:Masks|wildcard masks]] listed in '''MaskList'''. The list of masks is separated by semicolons (";"). Return ''TRUE'' if matches, otherwise ''FALSE''.

For example, a mask list <code>*.txt;*.doc</code> matches files with a <code>.txt</code> or <code>.doc</code> extension.

''Added in v6.7.0.4 Beta.''
|}

{{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 '''FileReadLines'''(const FileName: WideString): TAnsiStringArray;
| Read all lines from a file '''FileName'''. ''Added in v5.74.4 Beta.''
|-
| 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.
|-
| function '''FileReadText'''(const FileName: WideString): WideString;
| Read text from a file, performing automatic text encoding handling. ''Added in v6.6.0.6 Beta.''
|-
| function '''FileReadTextLines'''(const FileName: WideString): TWideStringArray;
| Read lines of text from a file, performing automatic text encoding handling. ''Added in v6.7.0.1 Beta.''
|}

Note: Automatic text encoding handling is based on [https://en.wikipedia.org/wiki/Byte_order_mark byte order mark] (BOM) and supports UTF-8, UTF-16BE and UTF-16LE. If no BOM found then text is interpreted as ANSI encoding.

{{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}}

== Meta Tags Extraction ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''CalculateMetaTag'''(const FilePath: WideString; const MetaTagName: String): WideString;
| Extracts and returns the value of a meta tag specified by '''MetaTagName''' from the file specified by the complete absolute path '''FilePath'''. ''Return type changed from String to WideString in v5.74.4 Beta.''
|-
| function '''CalculateMetaTagFormat'''(const FilePath: WideString; const MetaTagName, DateTimeFormat: String): WideString;
| Same as '''CalculateMetaTag''' except an additional parameter '''DateTimeFormat''' is provided to specify custom Date/Time format to be used instead of the application's default setting. ''Added in v5.74.4 Beta.''
|}

For example, to extract '''EXIF_Date''' tag from an image and set it to the filename using the default date/time formatting:
<syntaxhighlight lang="pascal">
begin
FileName := CalculateMetaTag(FilePath, 'EXIF_Date');
end.
</syntaxhighlight>

The full list of meta tags can be found in [[ReNamer:Meta Tags|Meta Tags]] article. For help with date/time formatting refer to [[ReNamer:Date and Time format|Date and Time format]].

{{Top}}

== Regular Expressions ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''IsMatchingRegEx'''(const Input, Pattern: WideString; const CaseSensitive: Boolean): Boolean;
| Check for a match against a RegEx pattern. ''Added in v5.74.4 Beta.''
|-
| 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): TWideStringArray;
| 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): TWideStringArray;
| 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}}

== 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:
* <tt><nowiki>ShellOpenFile('http://www.den4b.com/');</nowiki></tt>
* <tt><nowiki>ShellOpenFile('C:\Document.doc');</nowiki></tt>

'''Beware:''' This function will evaluate the command for the appropriate way of execution which may sometimes lead to unexpected results. For example when executing ''ShellOpenFile('notepad')'' it could actually run a ''Windows Notepad'' application normally located in "''C:\Windows\notepad.exe''", or some other "''notepad.exe''" file located on the search path (''%PATH%''), or even open "''notepad''" folder located in the current working directory.
|-
| function '''ExecuteProgram'''(const Command: String; WaitForProgram: Boolean): Cardinal;
| Execute a command specified by '''Command''' parameter. Parameter '''WaitForProgram''' allows you to specify whether the code needs to wait until the command (launched program) has finished executing.
|-
| function '''ExecuteProgramShow'''(const Command: String; WaitForProgram: Boolean; ShowWindowFlag: Word): Cardinal;
| Execute a command specified by '''Command''' parameter. '''WaitForProgram''' parameter allows you to specify whether the code needs to wait until the command (launched program) has finished executing. '''ShowWindowFlag''' parameter controls how the window is to be shown.

Commonly used values for '''ShowWindowFlag''' parameter:
* 0 = Hide the window.
* 1 = Activate and display the window.
* 2 = Activate the window and display it minimized.
* 3 = Activate the window and display it maximized.
* 4 = Display the window, but do not activate it.
* 7 = Display the window minimized, but do not activate it.
* More information: [http://msdn.microsoft.com/en-us/library/windows/desktop/ms633548(v=vs.85).aspx ShowWindow Windows API function].

''Added in v5.75.3 Beta.''
|-
| function '''ExecConsoleApp'''(const CommandLine: String; out Output: String): Cardinal;
| Execute a command line specified by '''CommandLine''' parameter and capture its standard output in the '''Output''' variable. This function should be used only for console style applications. Returns the exit code.

Console application output uses OEM-defined character set by default, unless application itself changes its output code page. '''OemToAnsi''' and '''OemToWide''' functions can be used to convert OEM output.

Prior to ''v6.6.0.2 Beta'', OEM to ANSI conversion was automatically applied to the console output. As of ''v6.6.0.2 Beta'', the console output is returned "as is" without any modifications, so to prevent corruption of binary or non-OEM encoded output.
|}

{{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''': TWideStringArray;
| 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.
|-
| function '''GetAllFiles''': TWideStringArray;
| Get file paths of all available files. ''Added in v5.74.2 Beta.''
|-
| function '''GetMarkedFiles''': TWideStringArray;
| Get file paths of all marked files. ''Added in v5.74.2 Beta.''
|}

{{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:
<syntaxhighlight lang="pascal">
var
UserName, ComputerName: WideString;
begin
UserName := WideGetEnvironmentVar('USERNAME');
ComputerName := WideGetEnvironmentVar('COMPUTERNAME');
end.
</syntaxhighlight>
|}

{{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 '''RandomFloat''': Extended;
| Return a random floating point value between 0.0 (including) and 1.0 (excluding). ''Added in v6.2.0.8 Beta.''
|-
| function '''RandomBoolean''': Boolean;
| Return a random boolean value, either ''True'' or ''False''. ''Added in v6.2.0.8 Beta.''
|-
| function '''RandomString'''(Len: Integer; const Chars: String): String;
| Generate a random string of length '''Len''' using characters selected at random from a string '''Chars'''. ''Added in v6.7.0.4 Beta.''
|-
| function '''MinInt'''(const A, B: Integer): Integer;
| Return the smallest of two values '''A''' and '''B''' of ''Integer'' type. ''Added in v6.2.0.8 Beta.''
|-
| function '''MinInt64'''(const A, B: Int64): Int64;
| Return the smallest of two values '''A''' and '''B''' of ''Int64'' type. ''Added in v6.2.0.8 Beta.''
|-
| function '''MinFloat'''(const A, B: Extended): Extended;
| Return the smallest of two values '''A''' and '''B''' of ''Extended'' type. ''Added in v6.2.0.8 Beta.''
|-
| function '''MaxInt'''(const A, B: Integer): Integer;
| Return the largest of two values '''A''' and '''B''' of ''Integer'' type. ''Added in v6.2.0.8 Beta.''
|-
| function '''MaxInt64'''(const A, B: Int64): Int64;
| Return the largest of two values '''A''' and '''B''' of ''Int64'' type. ''Added in v6.2.0.8 Beta.''
|-
| function '''MaxFloat'''(const A, B: Extended): Extended;
| Return the largest of two values '''A''' and '''B''' of ''Extended'' type. ''Added in v6.2.0.8 Beta.''
|-
| 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] encoded string.
|-
| function '''URLDecode'''(const Str: String; UsePlusAsSpace: Boolean): WideString;
| Decode URL encoded string. All occurrences of ''%XX'' hex format are decoded, then entire string is decoded from UTF8.

Optionally, plus signs ("+") can be interpreted as white space by enabling '''UsePlusAsSpace''' parameter, for compatibility with some encoders such as in [http://php.net/manual/en/function.urlencode.php PHP].

''Added in v5.74.4 Beta. UsePlusAsSpace parameter added in v6.7.0.1 Beta.''
|-
| function '''URLEncode'''(const Str: WideString; UsePlusAsSpace: Boolean): String;
| Encode string using URL encoding. Input string is encoded with UTF8, then all characters except digits and Latin letters are encoded in ''%XX'' hex format.

Optionally, white spaces can be encoded as plus signs ("+") by enabling '''UsePlusAsSpace''' parameter, for compatibility with some decoders such as in [http://php.net/manual/en/function.urldecode.php PHP].

''Added in v5.74.4 Beta.''
|-
| 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:Rules:Rearrange Examples

2018-08-30T19:10:22Z

Stefan: /* Example 1 */

{{Go|prev=ReNamer:Rules:Rearrange}}

[[ReNamer:Rules:Rearrange|Rearrange rule]] can be used in many ways. Few examples are given below.

For simplicity's sake, we have split examples into two sections: [[#Basic usage|Basic usage]] (typical needs of beginners) and [[#Advanced usage|Advanced usage]] (for the power users).

== Basic usage ==

=== Example 1 ===

'''Task:''' Swap parts of name.

{| class="wikitable"
|-
! From:
! To:
|-
| Artist - Title.mp3
| Title - Artist.mp3
|}

'''Settings:'''

Split using: (o)Delimiter 
" - " (without the quotes) 

New pattern: $2 - $1 
[X] Skip Extensions

Explanation: We split the string at the hyphen (dash or minus sign -) or whatever you use to separate Artist from Title 
Now, all signs before the dash are stored in variable $1, all after are put in var $2. 
Because we want to swap this parts, we simple swap the vars in the output, the "New Pattern": $2 $1 
And since this rule removes the used delimiter, we add it on our own: "$2 - $1", or use an new delimiter as e.g.: "$2_-_$1"

=== Example 2 ===

'''Task:''' Insert text before the original name.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring Ring 
| ABBA - Ring Ring
|-
| The winner takes it all 
| ABBA -The winner takes it all
|}

'''Settings:'''

Delimiter: none (leave blank) 

New order/pattern: ABBA - $0

'''Remarks:  '''is same as the '''[[ReNamer:Rules:Insert|Insert]] '''rule. 

=== Example 3 ===

'''Task:''' Insert text before and after the original name.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring Ring 
| ABBA- Ring Ring (Live)
|-
| The winner takes it all 
| ABBA-The winner takes it all (Live) 
|}

'''Settings:'''

Delimiter: none (leave blank)

New order/pattern: ABBA- $0 (Live)

'''Remarks:''' is same as using the '''[[ReNamer:Rules:Insert|Insert]]''' rule twice (one for adding the prefix, and another for adding the suffix).

=== Example 4 ===

'''Task:''' Switch the words, and remove the comma between them.

{| class="wikitable"
|-
! From:
! To:
|-
| King, Stephen
| Stephen King
|-
| Cook, Robin
| Robin Cook
|-
| Pride and Prejudice, The
| The Pride and Prejudice
|}

'''Settings:'''

Delimiter: ", " (without the quotes)

New Order: $2 $1

=== Example 5 ===

'''Task:''' Move a word to a new position.

{| class="wikitable"
|-
! From:
! To:
|-
| Words sample 1234 07-07-07
| 1234 Words sample 07-07-07
|}

'''Settings:'''

Delimiter: " " (only a space, without the quotes)

New Order: $3 $1 $2 $4

=== Example 6 ===

'''Task:''' Get rid of the numbers, hyphen and space at the beginning.

{| class="wikitable"
|-
! From:
! To:
|-
| 01 - Afilename.zip
| Afilename.zip
|-
| 002 - Bfilename.zip
| Bfilename.zip
|-
| 0003 - Cfilename.zip
| Cfilename.zip
|}

'''Settings:'''

Delimiter: "- " (without the quotes)

New Order: $2

'''Remarks:'''

#Note that the delimiter contains a space. If only a hyphen is used as delimiter, then a space would be left out in the beginning of the name, which you would have to trim separately.
#The '''Delete''' rule also would work (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the truncated names.

=== Example 7 ===

'''Task: '''Move the first part to the end.

{| class="wikitable"
|-
! From:
! To:
|-
| TEST.aaa.bbb.100.ext
| aaa.bbb.100.TEST.ext
|}

'''Setting:'''

Delimiter: "." (without the quotes)

New Order: $2.$3.$4.$1 

=== Example 8 ===

'''Task: '''Move the artist's name from end to the beginning, and change the name format.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring ring_ABBA.mp3
| ABBA - Ring Ring.mp3
|-
| Material girl_Madonna.mp3
| Madonna - Material girl mp3
|}

'''Settings:'''

Delimiter: "_" (without the quotes)

New Order: $2 - $1

=== Example 9 ===

'''Task:''' Move the numbers to the beginning.

{| class="wikitable"
|-
! From:
! To:
|-
| DSC_0001-1.jpg
| 1-DSC_0001.jpg
|-
| DSC_0001-2.jpg
| 2-DSC_0001.jpg
|-
| DSC_0001-10.jpg
| 10-DSC_0001.jpg
|}

'''Settings:'''

Delimiter: "-" (without the quotes)

New Order: $2-$1

=== Example 10 ===

'''Task:''' Insert "sent_" before the last 3 digits.

{| class="wikitable"
|-
! From:
! To:
|-
| family_001.jpg
| family_sent_001.jpg
|-
| work_023.jpg
| work_sent_023.jpg
|-
| friend_098.jpg
| friend_sent_098.jpg
|}

'''Settings:'''

Delimiter: "_" (without the quotes)

New Order: $1_sent_$2

'''Remarks:'''

The '''Insert''' rule also would work (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the names.

=== Example 11 ===

'''Task:''' Remove the name of the artist (delete text until hyphen).

{| class="wikitable"
|-
! From:
! To:
|-
| Sting - All This Time.mp3
| All This Time.mp3
|}

'''Settings:'''

Delimiter: "- " (without the quotes)

New Order: $2

'''Remarks:'''

#Note the space after the hyphen. If we use just a "-" as delimiter, the second token would be left with a space in front, which we will have to trim separately.
#Even the '''Delete''' rule would have worked (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the new name.

=== Example 12 ===

'''Task:''' Remove the track numbers (and any separator symbol after that) from the beginning of the filenames:

{| class="wikitable"
|-
! From:
! To:
|-
| 08. Madonna - Like A Prayer.wma
| rowspan="3" | Madonna - Like A Prayer.wma
|-
| 08.-Madonna - Like A Prayer.wma
|-
| 08 Madonna - Like A Prayer.wma
|}

'''Settings:'''

Delimiter: "Madonna" (without the quotes)

New Order: Madonna$2

'''Remarks: '''

We chose the string "Madonna" as delimiter because it does not occur anywhere else in the names. The unwanted characters on the left are assigned to token $1, which we will not omit in the new name. However, there is an undesired side-effect: ReNamer removes "Madonna" string from the token $2 because it is the delimiter. Therefore, we have to manually add that missing string "Madonna" to $2, to restore the names.

=== Example 13 ===

'''Task:''' Move the number to front, and remove the square brackets.

{| class="wikitable"
|-
! From:
! To:
|-
| Name XXX [0001].jpg
| 0001 - Name XXX.jpg
|}

'''Settings:'''

Delimiter: " [|]" (without the quotes)

New Order: $2 - $1

'''Remarks:'''

# The "|" (vertical pipe) character is used to separate the two delimiters.
# The second delimiter "]" will not produce a token. It is included only to remove it from the new name.

=== Example 14 ===

'''Task:''' Add composer name and duration to an mp3 file, as prefix and suffix, respectively.

{| class="wikitable"
|-
! From:
! To:
|-
| Eine kleine Nachtmusik.mp3
| Mozart - Eine kleine Nachtmusik (6.37).mp3
|-
| Don Giovanni.mp3
| Mozart - Don Giovanni (4.5).mp3
|}

'''Settings:'''

Positions: 1

New Order: Mozart - $2 (:Audio_Duration:)

'''Remarks:'''

#This can also be done by using the '''Insert''' rule. However, you have to use that rule twice (once for prefix and the second time for the suffix). On the other hand, the '''Rearrange''' rule allows you to add both in a single stroke. Besides, you can see the structure of the new name.
#When the original name is sliced at position 1, there is no characters on the left side; so the $1 token is a blank. The ''entire'' name is copied into the $2 token. This is a great trick to compose new name using the ''whole'' original name.

=== Example 15 ===

'''Task:''' Swap parts of name at fixed position.

{| class="wikitable"
|-
! From:
! To:
|-
| BusinessRawReport1.doc 
| RawReport1, Business.doc
|-
| BusinessRawReport2.doc 
| RawReport2, Business.doc
|-
| BusinessRawReport3.doc 
| RawReport3, Business.doc
|}

'''Settings:'''

Split using: (o)Positions 
"9" (without the quotes) 

New pattern: $2, $1 
[X] Skip Extensions

'''Remarks:'''
Since we didn't have an real delimiter here, we simply split at an position within the string, here e.g. at char number 9: 
BusinessRawReport1.doc 
123456789

So all before 9th char is put in variable $1, and all from char number 9 till end of string is put in var $2. 
That means: $1 holds 'Business' and $2 holds 'RawReport1'. (Note that we skip the extension, so we don't have to deal with it) 
Now we compose our new string, the output pattern, just as we like it to be: '$2, $1'

-

You can also use more then one delimiter or position:
{| class="wikitable"
|-
! From:
! To:
|-
| BusinessRawReport1.doc 
| Raw Business Report1.doc
|}

'''Settings:'''

Split using: (o)Positions 
"9|12" (without the quotes) 

New pattern: $2 $1 $3 
[X] Skip Extensions

'''Remarks:'''

BusinessRawReport1.doc 
123456789 
123456789012

$1 holds 'Business' 
$2 holds 'Raw' 
$3 holds 'Report1'

== Advanced usage ==

=== Example 1 ===

'''Task:''' Remove the string from the file name.

{| class="wikitable"
|-
! From:
! To:
|-
| Artist - Title [Time 4 02 Cold] [2004].mpg
| Artist - Title [2004].mpg
|}

'''Settings:'''

Delimiter: " [T|d] " (without the quotes)

New Order: $1 $3

'''Remarks:'''

#The '''|''' character separates the two delimiters.
#Notice that we have included spaces in the delimiters, so that they do not end up as part of the tokens.
#We have selected two ''different'' delimiters to represent the beginning and the end of the string we want to remove. Thus '''''whatever''''' lies between the two delimiters is converted into a token. This token is then omitted in the new name. This works just like using wildcards for the string (or a RegEx pattern).

=== Example 2 ===

'''Task:''' The file names contain artist name, album name and track name. Sort them into separate folders as follows:

#Create a separate folder for each artist.
#For each artist, create a subfolder for each album.
#Move each file in the corresponding folder.

{| class="wikitable"
|-
! From:
! To:
|-
| Title - Artist (Album).mp3
| D:\Artist\Album\Title.mp3
|}

'''Settings:'''

Delimiter: " - | (|)" (without the quotes)

New pattern: D:\$2\$3\$1

'''Remarks:'''

#Note that the delimiters contain spaces and symbols, so that only text remains in the tokens.
#The last delimiter ) does not produce a token. It is added just to strip the closing bracket from the last token.
#Instead of '''D:''' a relative path (such as '''..\..\''') can be added to the front.

=== Example 3 ===

'''Task: '''Sort digital photos in different folders based on the '''Date taken''' for each photo.

'''Note:''' Many people call this operation "binning", because we segregate the items into separate bins based on some criteria. (most people associate the word "Sorting" with "rearranging the files in ascending/descending order, without moving them to other folders")

{| class="wikitable"
|-
! From:
! To:
|-
| DSC_0001.jpg
| D:\photos\trip\2009_10_21\DSC_0001.jpg
|-
| DSC_0002.jpg
| D:\photos\trip\2009_10_21\DSC_0002.jpg
|-
| DSC_0003.jpg
| D:\photos\trip\2009_10_25\DSC_0003.jpg
|}

'''Settings:'''

Delimiter: - (none)

New pattern: D:\photos\trip\:EXIF_Date:\$0

'''Remarks:'''

#Note that this EXIF data is contained in the meta tag of each photo, not in the file name.
#The meta tag ''':EXIF_Date:''' is replaced by the actual '''date taken''' for each photo. Thus all photos taken on the same date will be moved to the same folder.
#The actual name of the folder would depend on the [[ReNamer:Program settings#Meta_tags_settings|Date and Time format settings]].

=== Example 4 ===

'''Task:''' Delete the last part of the base name (but the extension should remain). Note that the file names have different lengths, so you cannot slice the name at a particular position. The names have a different depths also (number of segments separated by dots).

{| class="wikitable"
|-
! From:
! To:
|-
| title.text1.text2.extension
| title.text1.extension
|-
| title.text1.text2.text3.extension
| title.text1.text2.extension
|}

'''Setting:''' The solution requires a stack of two different rules, as shown below:

1. '''Replace''' Rule

Find: "." (without the quotes)

Replace: "#" (without the quotes)

Check "[X] Last" to find and replace last occurrence of an dot only. 
Check "[X] Skip Extension" to not replace the file/extension separator as last dot.

(this is a temporary change; which will be eliminated in the second step)

2. '''Rearrange''' rule

Delimiter: "#" (without the quotes)

New Order: $1

'''Remarks:'''

We had to do this indirectly because the '''Rearrange''' rule cannot pick only the last dot as delimiter; and ignore the other dots. So we used a trick: we first changed the last dot into another character (using the '''Replace''' rule), and then use that new character as delimiter in the '''Rearrange''' rule.

=== Example 5 ===

'''Task:''' Swap parts with more then one of the same delimiter

{| class="wikitable"
|-
! From:
! To:
|-
| I. Author - Book title - True story.pdf
| Book title - True story (I. Author).pdf
|-
| I. Author - Book title.pdf
| Book title (I. Author).pdf
|}

First exchange the first occurrence of the delimiter by an completely other sign, e.g. # 
* Add an "Replace" Rule 
* Replace First " - " with "#", [X] Skip Extension 

So we got
{| class="wikitable"
|-
! From:
! To:
|-
| I. Author # Book title - True story.pdf
| Book title - True story (I. Author).pdf
|-
| I. Author # Book title.pdf
| Book title (I. Author).pdf
|}

Now use
'''Settings:'''

Split using: (o)Delimiter 
" # " (without the quotes) 

New pattern: $2 ($1) 
[X] Skip Extensions

'''Remarks:'''
Since this rule removes the used delimiter, we don't have to take care about them in the output.

=== Example 6 ===

'''Task:''' Keep only the last part of a file name:

{| class="wikitable"
|-
! From:
! To:
|-
| title text1 text2.txt
| text2.txt
|-
| title text1 text2 text3.txt
| text3.txt
|}

'''Settings:'''

Split using: (o)Delimiter " " (space, without the quotes)

New pattern: $-1 [X] Skip Extensions

'''Task:''' Keep only the second last part of a file name:

{| class="wikitable"
|-
! From:
! To:
|-
| title text1 text2.txt
| text1.txt
|-
| title text1 text2 text3.txt
| text2.txt
|}

'''Settings:'''

Split using: (o)Delimiter " " (space, without the quotes)

New pattern: $-2 [X] Skip Extensions

'''Remarks:''' Since $-1 and $-2 count the tokens from the right (from the end), we will get the same result even if the name is longer.

=== Example 7 ===

'''Task:''' Sort files with same names (but different extensions) into separate subfolder.            Typically, training websites provide such sets of files for each episode/lecture/lesson, etc. (video, handout, homework, etc.)             When you download these files, they are in a single folder. ReNamer helps you in sorting them into separate folders. 

We will see two different variations here: 

'''Variation-1:''' '''The subfolder name is same as the base name of the files.''' 

{| class="wikitable"
|-
! From:
! To:
|-
|
Episode 001.pdf Episode 001.mp4 

Episode 002.pdf Episode 002.mp4 

|
Episode 001\Episode 001.pdf Episode 001\Episode 001.mp4

Episode 002\Episode 002.pdf Episode 002\Episode 002.mp4

|}

'''Settings:'''

 Split using: - (Leave blank)  New pattern: $0\$0  [X] Skip Extensions

'''Remarks''': 

1. All files having the same base name will be sorted into a common subfolder. 2. ReNamer will create these subfolders in the current folder. 

 

'''Variation-2:''' '''The subfolder name is different as compared to the base name of the files.''' 

{| class="wikitable"
|-
! From:
! To:
|-
|
Handout 001.pdf Lesson 001.mp4 

Handout 002.pdf Lesson 002.mp4 

|
Part 001\Handout.pdf Part 001\Lesson.mp4

Part 002\Handout.pdf Part 002\Lesson.mp4

|}

'''Settings:'''

 Split using:" " (space, without the quotes)  New pattern: Part $2\$1  [X] Skip Extensions

'''Remarks''': 

1. All files having the same ''number'' will be sorted into a common subfolder. 2. ReNamer will create these subfolders in the current folder 3. The "Part " is a literal string. (note the space at the end) 

== Split by positions ==

=== Example 1 ===
<PRE>
FROM:
FECAAFC2309C055D7E7D61C4C669F9C0.dat
That is:
0 1 2 3 4 5 6 7 8 9101112131415
FE CA AF C2 30 9C 05 5D 7E7D61C4C669F9C0

TO:
C2AFCAFE9C305D057E7D61C4C669F9C0.dat
That is:
3 2 1 0 5 4 7 6 8 9101112131415
C2 AF CA FE 9C 30 5D 05 7E7D61C4C669F9C0
</PRE>
USE:
Rearrange rule: 
If you enter position n, ReNamer will chop the n-th character and all characters beyond that in a separate piece. 
Split by positions: 3|5|7|9|11|13|15|17 
New pattern: $4$3$2$1$6$5$8$7$9 
Skip extension: YES 

=== Example 2 ===

 

FROM: 
ABCDEFGHI 

TO: 
AB 

Split by positions: 3 
New pattern: $1 

Explanation: 
3 = Store everything before position 3 in variable $1 

- - -

FROM: 
ABCDEFGHI 

TO: 
AB-AB-AB 

Split by positions: 3 
New pattern: $1-$1-$1 
3 = Store everything before position 3 in variable $1 

- - -

FROM: 
ABCDEFGHI 

TO: 
AB - CD (EFGHI) 

Split by positions: 3|5 
New pattern: $1 - $2 ($3) 

Explanation: 
3 = Store everything before position 3 in variable $1 
5 = Everything starting at pos. 3 till before pos. 5 in variable $2 
Store the rest (silently) in $3 
AB CD EFGHI 
12 34 56789 

- - -

FROM: 
ABCDEFGHI 

TO: 
ABC - DEF - GHI 

Split by positions: 4|7|10 
New pattern: $1-$2-$3 

Explanation: 
4 = Store everything before position 4 in variable $1 
7 = Everything starting at the last position (4) till before pos. 7 in variable $2 
Everything starting at pos. 10 till the end in variable $3 (that ReNamer would do for us too) 
ABC DEF GHI 
123 456 789 

- - -

FROM: 
ABCDEFGHI 

TO: 
ABCD GHI 

Split by positions: 5|7|555 
New pattern: $1 $3 

Explanation: 
5 = Store everything before position 5 in variable $1 
7 = Everything starting at pos. 5 till before pos. 7 in variable $2 
555 = Everything starting at the last position till the end in variable $3 
Please note that we have dropped var '$2' in the 'New pattern'. 
ABCD EF GHI 
1234 56 789 

- - -

FROM: 
ABCDEFGHI 

TO: 
GHI (EF) A BC D 

Split by positions: 2|4|5|7|999 
New pattern: $5 ($4) $1 $2 $3 

Explanation: 
2 = Store everything before position 2 in variable $1 
4 = Everything starting at the last position (2) till before pos. 4 in variable $2 
5 = Everything starting at the last position pos. till pos.5 in $3 
7 = Everything starting at the last position pos. till pos.7 in $4 
999 = Everything starting at the last position till the end in variable $5 
Please note that we have rearranged (switched) the output vars in the 'New pattern'. 
A BC D EF GHI 
1 23 4 56 789 

 
[[Category:ReNamer]]

ReNamer:Rules:Rearrange Examples

2018-08-30T08:04:04Z

Stefan: /* Example 1 */

{{Go|prev=ReNamer:Rules:Rearrange}}

[[ReNamer:Rules:Rearrange|Rearrange rule]] can be used in many ways. Few examples are given below.

For simplicity's sake, we have split examples into two sections: [[#Basic usage|Basic usage]] (typical needs of beginners) and [[#Advanced usage|Advanced usage]] (for the power users).

== Basic usage ==

=== Example 1 ===

'''Task:''' Swap parts of name.

{| class="wikitable"
|-
! From:
! To:
|-
| Artist - Title.mp3
| Title - Artist.mp3
|}

'''Settings:'''

Split using: (o)Delimiter 
" - " (without the quotes) 

New pattern: $2 - $1 
[X] Skip Extensions

Explanation: We split the string at the hyphen (dash or minus sign -) or whatever you use to separate Artist from Title 
Now, all signs before the dash are stored in variable $1, all after are put in var $2. 
Because we want to swap this parts, we simple swap the vars in the output, the "New Pattern": $2 $1 
And since this rule removes the used delimiter, we add it on our own: "$2 - $1", or use an new delimiter as e.g.: "$2_-_$1"

=== Example 2 ===

'''Task:''' Insert text before the original name.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring Ring 
| ABBA - Ring Ring
|-
| The winner takes it all 
| ABBA -The winner takes it all
|}

'''Settings:'''

Delimiter: none (leave blank) 

New order/pattern: ABBA - $0

'''Remarks:  '''is same as the '''[[ReNamer:Rules:Insert|Insert]] '''rule. 

=== Example 3 ===

'''Task:''' Insert text before and after the original name.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring Ring 
| ABBA- Ring Ring (Live)
|-
| The winner takes it all 
| ABBA-The winner takes it all (Live) 
|}

'''Settings:'''

Delimiter: none (leave blank)

New order/pattern: ABBA- $0 (Live)

'''Remarks:''' is same as using the '''[[ReNamer:Rules:Insert|Insert]]''' rule twice (one for adding the prefix, and another for adding the suffix).

=== Example 4 ===

'''Task:''' Switch the words, and remove the comma between them.

{| class="wikitable"
|-
! From:
! To:
|-
| King, Stephen
| Stephen King
|-
| Cook, Robin
| Robin Cook
|-
| Pride and Prejudice, The
| The Pride and Prejudice
|}

'''Settings:'''

Delimiter: ", " (without the quotes)

New Order: $2 $1

=== Example 5 ===

'''Task:''' Move a word to a new position.

{| class="wikitable"
|-
! From:
! To:
|-
| Words sample 1234 07-07-07
| 1234 Words sample 07-07-07
|}

'''Settings:'''

Delimiter: " " (only a space, without the quotes)

New Order: $3 $1 $2 $4

=== Example 6 ===

'''Task:''' Get rid of the numbers, hyphen and space at the beginning.

{| class="wikitable"
|-
! From:
! To:
|-
| 01 - Afilename.zip
| Afilename.zip
|-
| 002 - Bfilename.zip
| Bfilename.zip
|-
| 0003 - Cfilename.zip
| Cfilename.zip
|}

'''Settings:'''

Delimiter: "- " (without the quotes)

New Order: $2

'''Remarks:'''

#Note that the delimiter contains a space. If only a hyphen is used as delimiter, then a space would be left out in the beginning of the name, which you would have to trim separately.
#The '''Delete''' rule also would work (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the truncated names.

=== Example 7 ===

'''Task: '''Move the first part to the end.

{| class="wikitable"
|-
! From:
! To:
|-
| TEST.aaa.bbb.100.ext
| aaa.bbb.100.TEST.ext
|}

'''Setting:'''

Delimiter: "." (without the quotes)

New Order: $2.$3.$4.$1 

=== Example 8 ===

'''Task: '''Move the artist's name from end to the beginning, and change the name format.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring ring_ABBA.mp3
| ABBA - Ring Ring.mp3
|-
| Material girl_Madonna.mp3
| Madonna - Material girl mp3
|}

'''Settings:'''

Delimiter: "_" (without the quotes)

New Order: $2 - $1

=== Example 9 ===

'''Task:''' Move the numbers to the beginning.

{| class="wikitable"
|-
! From:
! To:
|-
| DSC_0001-1.jpg
| 1-DSC_0001.jpg
|-
| DSC_0001-2.jpg
| 2-DSC_0001.jpg
|-
| DSC_0001-10.jpg
| 10-DSC_0001.jpg
|}

'''Settings:'''

Delimiter: "-" (without the quotes)

New Order: $2-$1

=== Example 10 ===

'''Task:''' Insert "sent_" before the last 3 digits.

{| class="wikitable"
|-
! From:
! To:
|-
| family_001.jpg
| family_sent_001.jpg
|-
| work_023.jpg
| work_sent_023.jpg
|-
| friend_098.jpg
| friend_sent_098.jpg
|}

'''Settings:'''

Delimiter: "_" (without the quotes)

New Order: $1_sent_$2

'''Remarks:'''

The '''Insert''' rule also would work (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the names.

=== Example 11 ===

'''Task:''' Remove the name of the artist (delete text until hyphen).

{| class="wikitable"
|-
! From:
! To:
|-
| Sting - All This Time.mp3
| All This Time.mp3
|}

'''Settings:'''

Delimiter: "- " (without the quotes)

New Order: $2

'''Remarks:'''

#Note the space after the hyphen. If we use just a "-" as delimiter, the second token would be left with a space in front, which we will have to trim separately.
#Even the '''Delete''' rule would have worked (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the new name.

=== Example 12 ===

'''Task:''' Remove the track numbers (and any separator symbol after that) from the beginning of the filenames:

{| class="wikitable"
|-
! From:
! To:
|-
| 08. Madonna - Like A Prayer.wma
| rowspan="3" | Madonna - Like A Prayer.wma
|-
| 08.-Madonna - Like A Prayer.wma
|-
| 08 Madonna - Like A Prayer.wma
|}

'''Settings:'''

Delimiter: "Madonna" (without the quotes)

New Order: Madonna$2

'''Remarks: '''

We chose the string "Madonna" as delimiter because it does not occur anywhere else in the names. The unwanted characters on the left are assigned to token $1, which we will not omit in the new name. However, there is an undesired side-effect: ReNamer removes "Madonna" string from the token $2 because it is the delimiter. Therefore, we have to manually add that missing string "Madonna" to $2, to restore the names.

=== Example 13 ===

'''Task:''' Move the number to front, and remove the square brackets.

{| class="wikitable"
|-
! From:
! To:
|-
| Name XXX [0001].jpg
| 0001 - Name XXX.jpg
|}

'''Settings:'''

Delimiter: " [|]" (without the quotes)

New Order: $2 - $1

'''Remarks:'''

# The "|" (vertical pipe) character is used to separate the two delimiters.
# The second delimiter "]" will not produce a token. It is included only to remove it from the new name.

=== Example 14 ===

'''Task:''' Add composer name and duration to an mp3 file, as prefix and suffix, respectively.

{| class="wikitable"
|-
! From:
! To:
|-
| Eine kleine Nachtmusik.mp3
| Mozart - Eine kleine Nachtmusik (6.37).mp3
|-
| Don Giovanni.mp3
| Mozart - Don Giovanni (4.5).mp3
|}

'''Settings:'''

Positions: 1

New Order: Mozart - $2 (:Audio_Duration:)

'''Remarks:'''

#This can also be done by using the '''Insert''' rule. However, you have to use that rule twice (once for prefix and the second time for the suffix). On the other hand, the '''Rearrange''' rule allows you to add both in a single stroke. Besides, you can see the structure of the new name.
#When the original name is sliced at position 1, there is no characters on the left side; so the $1 token is a blank. The ''entire'' name is copied into the $2 token. This is a great trick to compose new name using the ''whole'' original name.

=== Example 15 ===

'''Task:''' Swap parts of name at fixed position.

{| class="wikitable"
|-
! From:
! To:
|-
| BusinessRawReport1.doc 
| RawReport1, Business.doc
|-
| BusinessRawReport2.doc 
| RawReport2, Business.doc
|-
| BusinessRawReport3.doc 
| RawReport3, Business.doc
|}

'''Settings:'''

Split using: (o)Positions 
"9" (without the quotes) 

New pattern: $2, $1 
[X] Skip Extensions

'''Remarks:'''
Since we didn't have an real delimiter here, we simply split at an position within the string, here e.g. at char number 9: 
BusinessRawReport1.doc 
123456789

So all before 9th char is put in variable $1, and all from char number 9 till end of string is put in var $2. 
That means: $1 holds 'Business' and $2 holds 'RawReport1'. (Note that we skip the extension, so we don't have to deal with it) 
Now we compose our new string, the output pattern, just as we like it to be: '$2, $1'

-

You can also use more then one delimiter or position:
{| class="wikitable"
|-
! From:
! To:
|-
| BusinessRawReport1.doc 
| Raw Business Report1.doc
|}

'''Settings:'''

Split using: (o)Positions 
"9|12" (without the quotes) 

New pattern: $2 $1 $3 
[X] Skip Extensions

'''Remarks:'''

BusinessRawReport1.doc 
123456789 
123456789012

$1 holds 'Business' 
$2 holds 'Raw' 
$3 holds 'Report1'

== Advanced usage ==

=== Example 1 ===

'''Task:''' Remove the string from the file name.

{| class="wikitable"
|-
! From:
! To:
|-
| Artist - Title [Time 4 02 Cold] [2004].mpg
| Artist - Title [2004].mpg
|}

'''Settings:'''

Delimiter: " [T|d] " (without the quotes)

New Order: $1 $3

'''Remarks:'''

#The '''|''' character separates the two delimiters.
#Notice that we have included spaces in the delimiters, so that they do not end up as part of the tokens.
#We have selected two ''different'' delimiters to represent the beginning and the end of the string we want to remove. Thus '''''whatever''''' lies between the two delimiters is converted into a token. This token is then omitted in the new name. This works just like using wildcards for the string (or a RegEx pattern).

=== Example 2 ===

'''Task:''' The file names contain artist name, album name and track name. Sort them into separate folders as follows:

#Create a separate folder for each artist.
#For each artist, create a subfolder for each album.
#Move each file in the corresponding folder.

{| class="wikitable"
|-
! From:
! To:
|-
| Title - Artist (Album).mp3
| D:\Artist\Album\Title.mp3
|}

'''Settings:'''

Delimiter: " - | (|)" (without the quotes)

New pattern: D:\$2\$3\$1

'''Remarks:'''

#Note that the delimiters contain spaces and symbols, so that only text remains in the tokens.
#The last delimiter ) does not produce a token. It is added just to strip the closing bracket from the last token.
#Instead of '''D:''' a relative path (such as '''..\..\''') can be added to the front.

=== Example 3 ===

'''Task: '''Sort digital photos in different folders based on the '''Date taken''' for each photo.

'''Note:''' Many people call this operation "binning", because we segregate the items into separate bins based on some criteria. (most people associate the word "Sorting" with "rearranging the files in ascending/descending order, without moving them to other folders")

{| class="wikitable"
|-
! From:
! To:
|-
| DSC_0001.jpg
| D:\photos\trip\2009_10_21\DSC_0001.jpg
|-
| DSC_0002.jpg
| D:\photos\trip\2009_10_21\DSC_0002.jpg
|-
| DSC_0003.jpg
| D:\photos\trip\2009_10_25\DSC_0003.jpg
|}

'''Settings:'''

Delimiter: - (none)

New pattern: D:\photos\trip\:EXIF_Date:\$0

'''Remarks:'''

#Note that this EXIF data is contained in the meta tag of each photo, not in the file name.
#The meta tag ''':EXIF_Date:''' is replaced by the actual '''date taken''' for each photo. Thus all photos taken on the same date will be moved to the same folder.
#The actual name of the folder would depend on the [[ReNamer:Program settings#Meta_tags_settings|Date and Time format settings]].

=== Example 4 ===

'''Task:''' Delete the last part of the base name (but the extension should remain). Note that the file names have different lengths, so you cannot slice the name at a particular position. The names have a different depths also (number of segments separated by dots).

{| class="wikitable"
|-
! From:
! To:
|-
| title.text1.text2.extension
| title.text1.extension
|-
| title.text1.text2.text3.extension
| title.text1.text2.extension
|}

'''Setting:''' The solution requires a stack of two different rules, as shown below:

1. '''Replace''' Rule

Find: "." (without the quotes)

Replace: "#" (without the quotes)

Check "[X] Last" to find and replace last occurrence of an dot only. 
Check "[X] Skip Extension" to not replace the file/extension separator as last dot.

(this is a temporary change; which will be eliminated in the second step)

2. '''Rearrange''' rule

Delimiter: "#" (without the quotes)

New Order: $1

'''Remarks:'''

We had to do this indirectly because the '''Rearrange''' rule cannot pick only the last dot as delimiter; and ignore the other dots. So we used a trick: we first changed the last dot into another character (using the '''Replace''' rule), and then use that new character as delimiter in the '''Rearrange''' rule.

=== Example 5 ===

'''Task:''' Swap parts with more then one of the same delimiter

{| class="wikitable"
|-
! From:
! To:
|-
| I. Author - Book title - True story.pdf
| Book title - True story (I. Author).pdf
|-
| I. Author - Book title.pdf
| Book title (I. Author).pdf
|}

First exchange the first occurrence of the delimiter by an completely other sign, e.g. # 
* Add an "Replace" Rule 
* Replace First " - " with "#", [X] Skip Extension 

So we got
{| class="wikitable"
|-
! From:
! To:
|-
| I. Author # Book title - True story.pdf
| Book title - True story (I. Author).pdf
|-
| I. Author # Book title.pdf
| Book title (I. Author).pdf
|}

Now use
'''Settings:'''

Split using: (o)Delimiter 
" # " (without the quotes) 

New pattern: $2 ($1) 
[X] Skip Extensions

'''Remarks:'''
Since this rule removes the used delimiter, we don't have to take care about them in the output.

=== Example 6 ===

'''Task:''' Keep only the last part of a file name:

{| class="wikitable"
|-
! From:
! To:
|-
| title text1 text2.txt
| text2.txt
|-
| title text1 text2 text3.txt
| text3.txt
|}

'''Settings:'''

Split using: (o)Delimiter " " (space, without the quotes)

New pattern: $-1 [X] Skip Extensions

'''Task:''' Keep only the second last part of a file name:

{| class="wikitable"
|-
! From:
! To:
|-
| title text1 text2.txt
| text1.txt
|-
| title text1 text2 text3.txt
| text2.txt
|}

'''Settings:'''

Split using: (o)Delimiter " " (space, without the quotes)

New pattern: $-2 [X] Skip Extensions

'''Remarks:''' Since $-1 and $-2 count the tokens from the right (from the end), we will get the same result even if the name is longer.

=== Example 7 ===

'''Task:''' Sort files with same names (but different extensions) into separate subfolder.            Typically, training websites provide such sets of files for each episode/lecture/lesson, etc. (video, handout, homework, etc.)             When you download these files, they are in a single folder. ReNamer helps you in sorting them into separate folders. 

We will see two different variations here: 

'''Variation-1:''' '''The subfolder name is same as the base name of the files.''' 

{| class="wikitable"
|-
! From:
! To:
|-
|
Episode 001.pdf Episode 001.mp4 

Episode 002.pdf Episode 002.mp4 

|
Episode 001\Episode 001.pdf Episode 001\Episode 001.mp4

Episode 002\Episode 002.pdf Episode 002\Episode 002.mp4

|}

'''Settings:'''

 Split using: - (Leave blank)  New pattern: $0\$0  [X] Skip Extensions

'''Remarks''': 

1. All files having the same base name will be sorted into a common subfolder. 2. ReNamer will create these subfolders in the current folder. 

 

'''Variation-2:''' '''The subfolder name is different as compared to the base name of the files.''' 

{| class="wikitable"
|-
! From:
! To:
|-
|
Handout 001.pdf Lesson 001.mp4 

Handout 002.pdf Lesson 002.mp4 

|
Part 001\Handout.pdf Part 001\Lesson.mp4

Part 002\Handout.pdf Part 002\Lesson.mp4

|}

'''Settings:'''

 Split using:" " (space, without the quotes)  New pattern: Part $2\$1  [X] Skip Extensions

'''Remarks''': 

1. All files having the same ''number'' will be sorted into a common subfolder. 2. ReNamer will create these subfolders in the current folder 3. The "Part " is a literal string. (note the space at the end) 

== Split by positions ==

=== Example 1 ===

FROM: 
FECAAFC2309C055D7E7D61C4C669F9C0.dat 
0 1 2 3 4 5 6 7 8 9101112131415 
FE CA AF C2 30 9C 05 5D 7E7D61C4C669F9C0 

TO: 
C2AFCAFE9C305D057E7D61C4C669F9C0.dat 
3 2 1 0 5 4 7 6 8 9101112131415 
C2 AF CA FE 9C 30 5D 05 7E7D61C4C669F9C0 

USE:
Rearrange rule: 
If you enter position n, ReNamer will chop the n-th character and all characters beyond that in a separate piece. 
Split by positions: 3|5|7|9|11|13|15|17 
New pattern: $4$3$2$1$6$5$8$7$9 
Skip extension: YES 

=== Example 2 ===

 

FROM: 
ABCDEFGHI 

TO: 
AB 

Split by positions: 3 
New pattern: $1 

Explanation: 
3 = Store everything before position 3 in variable $1 

- - -

FROM: 
ABCDEFGHI 

TO: 
AB-AB-AB 

Split by positions: 3 
New pattern: $1-$1-$1 
3 = Store everything before position 3 in variable $1 

- - -

FROM: 
ABCDEFGHI 

TO: 
AB - CD (EFGHI) 

Split by positions: 3|5 
New pattern: $1 - $2 ($3) 

Explanation: 
3 = Store everything before position 3 in variable $1 
5 = Everything starting at pos. 3 till before pos. 5 in variable $2 
Store the rest (silently) in $3 
AB CD EFGHI 
12 34 56789 

- - -

FROM: 
ABCDEFGHI 

TO: 
ABC - DEF - GHI 

Split by positions: 4|7|10 
New pattern: $1-$2-$3 

Explanation: 
4 = Store everything before position 4 in variable $1 
7 = Everything starting at the last position (4) till before pos. 7 in variable $2 
Everything starting at pos. 10 till the end in variable $3 (that ReNamer would do for us too) 
ABC DEF GHI 
123 456 789 

- - -

FROM: 
ABCDEFGHI 

TO: 
ABCD GHI 

Split by positions: 5|7|555 
New pattern: $1 $3 

Explanation: 
5 = Store everything before position 5 in variable $1 
7 = Everything starting at pos. 5 till before pos. 7 in variable $2 
555 = Everything starting at the last position till the end in variable $3 
Please note that we have dropped var '$2' in the 'New pattern'. 
ABCD EF GHI 
1234 56 789 

- - -

FROM: 
ABCDEFGHI 

TO: 
GHI (EF) A BC D 

Split by positions: 2|4|5|7|999 
New pattern: $5 ($4) $1 $2 $3 

Explanation: 
2 = Store everything before position 2 in variable $1 
4 = Everything starting at the last position (2) till before pos. 4 in variable $2 
5 = Everything starting at the last position pos. till pos.5 in $3 
7 = Everything starting at the last position pos. till pos.7 in $4 
999 = Everything starting at the last position till the end in variable $5 
Please note that we have rearranged (switched) the output vars in the 'New pattern'. 
A BC D EF GHI 
1 23 4 56 789 

 
[[Category:ReNamer]]

ReNamer:Rules:Rearrange Examples

2018-08-30T08:03:26Z

Stefan: /* Example 2 */

{{Go|prev=ReNamer:Rules:Rearrange}}

[[ReNamer:Rules:Rearrange|Rearrange rule]] can be used in many ways. Few examples are given below.

For simplicity's sake, we have split examples into two sections: [[#Basic usage|Basic usage]] (typical needs of beginners) and [[#Advanced usage|Advanced usage]] (for the power users).

== Basic usage ==

=== Example 1 ===

'''Task:''' Swap parts of name.

{| class="wikitable"
|-
! From:
! To:
|-
| Artist - Title.mp3
| Title - Artist.mp3
|}

'''Settings:'''

Split using: (o)Delimiter 
" - " (without the quotes) 

New pattern: $2 - $1 
[X] Skip Extensions

Explanation: We split the string at the hyphen (dash or minus sign -) or whatever you use to separate Artist from Title 
Now, all signs before the dash are stored in variable $1, all after are put in var $2. 
Because we want to swap this parts, we simple swap the vars in the output, the "New Pattern": $2 $1 
And since this rule removes the used delimiter, we add it on our own: "$2 - $1", or use an new delimiter as e.g.: "$2_-_$1"

=== Example 2 ===

'''Task:''' Insert text before the original name.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring Ring 
| ABBA - Ring Ring
|-
| The winner takes it all 
| ABBA -The winner takes it all
|}

'''Settings:'''

Delimiter: none (leave blank) 

New order/pattern: ABBA - $0

'''Remarks:  '''is same as the '''[[ReNamer:Rules:Insert|Insert]] '''rule. 

=== Example 3 ===

'''Task:''' Insert text before and after the original name.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring Ring 
| ABBA- Ring Ring (Live)
|-
| The winner takes it all 
| ABBA-The winner takes it all (Live) 
|}

'''Settings:'''

Delimiter: none (leave blank)

New order/pattern: ABBA- $0 (Live)

'''Remarks:''' is same as using the '''[[ReNamer:Rules:Insert|Insert]]''' rule twice (one for adding the prefix, and another for adding the suffix).

=== Example 4 ===

'''Task:''' Switch the words, and remove the comma between them.

{| class="wikitable"
|-
! From:
! To:
|-
| King, Stephen
| Stephen King
|-
| Cook, Robin
| Robin Cook
|-
| Pride and Prejudice, The
| The Pride and Prejudice
|}

'''Settings:'''

Delimiter: ", " (without the quotes)

New Order: $2 $1

=== Example 5 ===

'''Task:''' Move a word to a new position.

{| class="wikitable"
|-
! From:
! To:
|-
| Words sample 1234 07-07-07
| 1234 Words sample 07-07-07
|}

'''Settings:'''

Delimiter: " " (only a space, without the quotes)

New Order: $3 $1 $2 $4

=== Example 6 ===

'''Task:''' Get rid of the numbers, hyphen and space at the beginning.

{| class="wikitable"
|-
! From:
! To:
|-
| 01 - Afilename.zip
| Afilename.zip
|-
| 002 - Bfilename.zip
| Bfilename.zip
|-
| 0003 - Cfilename.zip
| Cfilename.zip
|}

'''Settings:'''

Delimiter: "- " (without the quotes)

New Order: $2

'''Remarks:'''

#Note that the delimiter contains a space. If only a hyphen is used as delimiter, then a space would be left out in the beginning of the name, which you would have to trim separately.
#The '''Delete''' rule also would work (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the truncated names.

=== Example 7 ===

'''Task: '''Move the first part to the end.

{| class="wikitable"
|-
! From:
! To:
|-
| TEST.aaa.bbb.100.ext
| aaa.bbb.100.TEST.ext
|}

'''Setting:'''

Delimiter: "." (without the quotes)

New Order: $2.$3.$4.$1 

=== Example 8 ===

'''Task: '''Move the artist's name from end to the beginning, and change the name format.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring ring_ABBA.mp3
| ABBA - Ring Ring.mp3
|-
| Material girl_Madonna.mp3
| Madonna - Material girl mp3
|}

'''Settings:'''

Delimiter: "_" (without the quotes)

New Order: $2 - $1

=== Example 9 ===

'''Task:''' Move the numbers to the beginning.

{| class="wikitable"
|-
! From:
! To:
|-
| DSC_0001-1.jpg
| 1-DSC_0001.jpg
|-
| DSC_0001-2.jpg
| 2-DSC_0001.jpg
|-
| DSC_0001-10.jpg
| 10-DSC_0001.jpg
|}

'''Settings:'''

Delimiter: "-" (without the quotes)

New Order: $2-$1

=== Example 10 ===

'''Task:''' Insert "sent_" before the last 3 digits.

{| class="wikitable"
|-
! From:
! To:
|-
| family_001.jpg
| family_sent_001.jpg
|-
| work_023.jpg
| work_sent_023.jpg
|-
| friend_098.jpg
| friend_sent_098.jpg
|}

'''Settings:'''

Delimiter: "_" (without the quotes)

New Order: $1_sent_$2

'''Remarks:'''

The '''Insert''' rule also would work (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the names.

=== Example 11 ===

'''Task:''' Remove the name of the artist (delete text until hyphen).

{| class="wikitable"
|-
! From:
! To:
|-
| Sting - All This Time.mp3
| All This Time.mp3
|}

'''Settings:'''

Delimiter: "- " (without the quotes)

New Order: $2

'''Remarks:'''

#Note the space after the hyphen. If we use just a "-" as delimiter, the second token would be left with a space in front, which we will have to trim separately.
#Even the '''Delete''' rule would have worked (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the new name.

=== Example 12 ===

'''Task:''' Remove the track numbers (and any separator symbol after that) from the beginning of the filenames:

{| class="wikitable"
|-
! From:
! To:
|-
| 08. Madonna - Like A Prayer.wma
| rowspan="3" | Madonna - Like A Prayer.wma
|-
| 08.-Madonna - Like A Prayer.wma
|-
| 08 Madonna - Like A Prayer.wma
|}

'''Settings:'''

Delimiter: "Madonna" (without the quotes)

New Order: Madonna$2

'''Remarks: '''

We chose the string "Madonna" as delimiter because it does not occur anywhere else in the names. The unwanted characters on the left are assigned to token $1, which we will not omit in the new name. However, there is an undesired side-effect: ReNamer removes "Madonna" string from the token $2 because it is the delimiter. Therefore, we have to manually add that missing string "Madonna" to $2, to restore the names.

=== Example 13 ===

'''Task:''' Move the number to front, and remove the square brackets.

{| class="wikitable"
|-
! From:
! To:
|-
| Name XXX [0001].jpg
| 0001 - Name XXX.jpg
|}

'''Settings:'''

Delimiter: " [|]" (without the quotes)

New Order: $2 - $1

'''Remarks:'''

# The "|" (vertical pipe) character is used to separate the two delimiters.
# The second delimiter "]" will not produce a token. It is included only to remove it from the new name.

=== Example 14 ===

'''Task:''' Add composer name and duration to an mp3 file, as prefix and suffix, respectively.

{| class="wikitable"
|-
! From:
! To:
|-
| Eine kleine Nachtmusik.mp3
| Mozart - Eine kleine Nachtmusik (6.37).mp3
|-
| Don Giovanni.mp3
| Mozart - Don Giovanni (4.5).mp3
|}

'''Settings:'''

Positions: 1

New Order: Mozart - $2 (:Audio_Duration:)

'''Remarks:'''

#This can also be done by using the '''Insert''' rule. However, you have to use that rule twice (once for prefix and the second time for the suffix). On the other hand, the '''Rearrange''' rule allows you to add both in a single stroke. Besides, you can see the structure of the new name.
#When the original name is sliced at position 1, there is no characters on the left side; so the $1 token is a blank. The ''entire'' name is copied into the $2 token. This is a great trick to compose new name using the ''whole'' original name.

=== Example 15 ===

'''Task:''' Swap parts of name at fixed position.

{| class="wikitable"
|-
! From:
! To:
|-
| BusinessRawReport1.doc 
| RawReport1, Business.doc
|-
| BusinessRawReport2.doc 
| RawReport2, Business.doc
|-
| BusinessRawReport3.doc 
| RawReport3, Business.doc
|}

'''Settings:'''

Split using: (o)Positions 
"9" (without the quotes) 

New pattern: $2, $1 
[X] Skip Extensions

'''Remarks:'''
Since we didn't have an real delimiter here, we simply split at an position within the string, here e.g. at char number 9: 
BusinessRawReport1.doc 
123456789

So all before 9th char is put in variable $1, and all from char number 9 till end of string is put in var $2. 
That means: $1 holds 'Business' and $2 holds 'RawReport1'. (Note that we skip the extension, so we don't have to deal with it) 
Now we compose our new string, the output pattern, just as we like it to be: '$2, $1'

-

You can also use more then one delimiter or position:
{| class="wikitable"
|-
! From:
! To:
|-
| BusinessRawReport1.doc 
| Raw Business Report1.doc
|}

'''Settings:'''

Split using: (o)Positions 
"9|12" (without the quotes) 

New pattern: $2 $1 $3 
[X] Skip Extensions

'''Remarks:'''

BusinessRawReport1.doc 
123456789 
123456789012

$1 holds 'Business' 
$2 holds 'Raw' 
$3 holds 'Report1'

== Advanced usage ==

=== Example 1 ===

'''Task:''' Remove the string from the file name.

{| class="wikitable"
|-
! From:
! To:
|-
| Artist - Title [Time 4 02 Cold] [2004].mpg
| Artist - Title [2004].mpg
|}

'''Settings:'''

Delimiter: " [T|d] " (without the quotes)

New Order: $1 $3

'''Remarks:'''

#The '''|''' character separates the two delimiters.
#Notice that we have included spaces in the delimiters, so that they do not end up as part of the tokens.
#We have selected two ''different'' delimiters to represent the beginning and the end of the string we want to remove. Thus '''''whatever''''' lies between the two delimiters is converted into a token. This token is then omitted in the new name. This works just like using wildcards for the string (or a RegEx pattern).

=== Example 2 ===

'''Task:''' The file names contain artist name, album name and track name. Sort them into separate folders as follows:

#Create a separate folder for each artist.
#For each artist, create a subfolder for each album.
#Move each file in the corresponding folder.

{| class="wikitable"
|-
! From:
! To:
|-
| Title - Artist (Album).mp3
| D:\Artist\Album\Title.mp3
|}

'''Settings:'''

Delimiter: " - | (|)" (without the quotes)

New pattern: D:\$2\$3\$1

'''Remarks:'''

#Note that the delimiters contain spaces and symbols, so that only text remains in the tokens.
#The last delimiter ) does not produce a token. It is added just to strip the closing bracket from the last token.
#Instead of '''D:''' a relative path (such as '''..\..\''') can be added to the front.

=== Example 3 ===

'''Task: '''Sort digital photos in different folders based on the '''Date taken''' for each photo.

'''Note:''' Many people call this operation "binning", because we segregate the items into separate bins based on some criteria. (most people associate the word "Sorting" with "rearranging the files in ascending/descending order, without moving them to other folders")

{| class="wikitable"
|-
! From:
! To:
|-
| DSC_0001.jpg
| D:\photos\trip\2009_10_21\DSC_0001.jpg
|-
| DSC_0002.jpg
| D:\photos\trip\2009_10_21\DSC_0002.jpg
|-
| DSC_0003.jpg
| D:\photos\trip\2009_10_25\DSC_0003.jpg
|}

'''Settings:'''

Delimiter: - (none)

New pattern: D:\photos\trip\:EXIF_Date:\$0

'''Remarks:'''

#Note that this EXIF data is contained in the meta tag of each photo, not in the file name.
#The meta tag ''':EXIF_Date:''' is replaced by the actual '''date taken''' for each photo. Thus all photos taken on the same date will be moved to the same folder.
#The actual name of the folder would depend on the [[ReNamer:Program settings#Meta_tags_settings|Date and Time format settings]].

=== Example 4 ===

'''Task:''' Delete the last part of the base name (but the extension should remain). Note that the file names have different lengths, so you cannot slice the name at a particular position. The names have a different depths also (number of segments separated by dots).

{| class="wikitable"
|-
! From:
! To:
|-
| title.text1.text2.extension
| title.text1.extension
|-
| title.text1.text2.text3.extension
| title.text1.text2.extension
|}

'''Setting:''' The solution requires a stack of two different rules, as shown below:

1. '''Replace''' Rule

Find: "." (without the quotes)

Replace: "#" (without the quotes)

Check "[X] Last" to find and replace last occurrence of an dot only. 
Check "[X] Skip Extension" to not replace the file/extension separator as last dot.

(this is a temporary change; which will be eliminated in the second step)

2. '''Rearrange''' rule

Delimiter: "#" (without the quotes)

New Order: $1

'''Remarks:'''

We had to do this indirectly because the '''Rearrange''' rule cannot pick only the last dot as delimiter; and ignore the other dots. So we used a trick: we first changed the last dot into another character (using the '''Replace''' rule), and then use that new character as delimiter in the '''Rearrange''' rule.

=== Example 5 ===

'''Task:''' Swap parts with more then one of the same delimiter

{| class="wikitable"
|-
! From:
! To:
|-
| I. Author - Book title - True story.pdf
| Book title - True story (I. Author).pdf
|-
| I. Author - Book title.pdf
| Book title (I. Author).pdf
|}

First exchange the first occurrence of the delimiter by an completely other sign, e.g. # 
* Add an "Replace" Rule 
* Replace First " - " with "#", [X] Skip Extension 

So we got
{| class="wikitable"
|-
! From:
! To:
|-
| I. Author # Book title - True story.pdf
| Book title - True story (I. Author).pdf
|-
| I. Author # Book title.pdf
| Book title (I. Author).pdf
|}

Now use
'''Settings:'''

Split using: (o)Delimiter 
" # " (without the quotes) 

New pattern: $2 ($1) 
[X] Skip Extensions

'''Remarks:'''
Since this rule removes the used delimiter, we don't have to take care about them in the output.

=== Example 6 ===

'''Task:''' Keep only the last part of a file name:

{| class="wikitable"
|-
! From:
! To:
|-
| title text1 text2.txt
| text2.txt
|-
| title text1 text2 text3.txt
| text3.txt
|}

'''Settings:'''

Split using: (o)Delimiter " " (space, without the quotes)

New pattern: $-1 [X] Skip Extensions

'''Task:''' Keep only the second last part of a file name:

{| class="wikitable"
|-
! From:
! To:
|-
| title text1 text2.txt
| text1.txt
|-
| title text1 text2 text3.txt
| text2.txt
|}

'''Settings:'''

Split using: (o)Delimiter " " (space, without the quotes)

New pattern: $-2 [X] Skip Extensions

'''Remarks:''' Since $-1 and $-2 count the tokens from the right (from the end), we will get the same result even if the name is longer.

=== Example 7 ===

'''Task:''' Sort files with same names (but different extensions) into separate subfolder.            Typically, training websites provide such sets of files for each episode/lecture/lesson, etc. (video, handout, homework, etc.)             When you download these files, they are in a single folder. ReNamer helps you in sorting them into separate folders. 

We will see two different variations here: 

'''Variation-1:''' '''The subfolder name is same as the base name of the files.''' 

{| class="wikitable"
|-
! From:
! To:
|-
|
Episode 001.pdf Episode 001.mp4 

Episode 002.pdf Episode 002.mp4 

|
Episode 001\Episode 001.pdf Episode 001\Episode 001.mp4

Episode 002\Episode 002.pdf Episode 002\Episode 002.mp4

|}

'''Settings:'''

 Split using: - (Leave blank)  New pattern: $0\$0  [X] Skip Extensions

'''Remarks''': 

1. All files having the same base name will be sorted into a common subfolder. 2. ReNamer will create these subfolders in the current folder. 

 

'''Variation-2:''' '''The subfolder name is different as compared to the base name of the files.''' 

{| class="wikitable"
|-
! From:
! To:
|-
|
Handout 001.pdf Lesson 001.mp4 

Handout 002.pdf Lesson 002.mp4 

|
Part 001\Handout.pdf Part 001\Lesson.mp4

Part 002\Handout.pdf Part 002\Lesson.mp4

|}

'''Settings:'''

 Split using:" " (space, without the quotes)  New pattern: Part $2\$1  [X] Skip Extensions

'''Remarks''': 

1. All files having the same ''number'' will be sorted into a common subfolder. 2. ReNamer will create these subfolders in the current folder 3. The "Part " is a literal string. (note the space at the end) 

== Split by positions ==

=== Example 1 ===

FROM:
FECAAFC2309C055D7E7D61C4C669F9C0.dat
0 1 2 3 4 5 6 7 8 9101112131415
FE CA AF C2 30 9C 05 5D 7E7D61C4C669F9C0

TO:
C2AFCAFE9C305D057E7D61C4C669F9C0.dat
3 2 1 0 5 4 7 6 8 9101112131415
C2 AF CA FE 9C 30 5D 05 7E7D61C4C669F9C0

USE:
Rearrange rule: 
If you enter position n, ReNamer will chop the n-th character and all characters beyond that in a separate piece. 
Split by positions: 3|5|7|9|11|13|15|17 
New pattern: $4$3$2$1$6$5$8$7$9 
Skip extension: YES 

=== Example 2 ===

 

FROM: 
ABCDEFGHI 

TO: 
AB 

Split by positions: 3 
New pattern: $1 

Explanation: 
3 = Store everything before position 3 in variable $1 

- - -

FROM: 
ABCDEFGHI 

TO: 
AB-AB-AB 

Split by positions: 3 
New pattern: $1-$1-$1 
3 = Store everything before position 3 in variable $1 

- - -

FROM: 
ABCDEFGHI 

TO: 
AB - CD (EFGHI) 

Split by positions: 3|5 
New pattern: $1 - $2 ($3) 

Explanation: 
3 = Store everything before position 3 in variable $1 
5 = Everything starting at pos. 3 till before pos. 5 in variable $2 
Store the rest (silently) in $3 
AB CD EFGHI 
12 34 56789 

- - -

FROM: 
ABCDEFGHI 

TO: 
ABC - DEF - GHI 

Split by positions: 4|7|10 
New pattern: $1-$2-$3 

Explanation: 
4 = Store everything before position 4 in variable $1 
7 = Everything starting at the last position (4) till before pos. 7 in variable $2 
Everything starting at pos. 10 till the end in variable $3 (that ReNamer would do for us too) 
ABC DEF GHI 
123 456 789 

- - -

FROM: 
ABCDEFGHI 

TO: 
ABCD GHI 

Split by positions: 5|7|555 
New pattern: $1 $3 

Explanation: 
5 = Store everything before position 5 in variable $1 
7 = Everything starting at pos. 5 till before pos. 7 in variable $2 
555 = Everything starting at the last position till the end in variable $3 
Please note that we have dropped var '$2' in the 'New pattern'. 
ABCD EF GHI 
1234 56 789 

- - -

FROM: 
ABCDEFGHI 

TO: 
GHI (EF) A BC D 

Split by positions: 2|4|5|7|999 
New pattern: $5 ($4) $1 $2 $3 

Explanation: 
2 = Store everything before position 2 in variable $1 
4 = Everything starting at the last position (2) till before pos. 4 in variable $2 
5 = Everything starting at the last position pos. till pos.5 in $3 
7 = Everything starting at the last position pos. till pos.7 in $4 
999 = Everything starting at the last position till the end in variable $5 
Please note that we have rearranged (switched) the output vars in the 'New pattern'. 
A BC D EF GHI 
1 23 4 56 789 

 
[[Category:ReNamer]]

ReNamer:Rules:Rearrange Examples

2018-08-30T07:56:03Z

Stefan:

{{Go|prev=ReNamer:Rules:Rearrange}}

[[ReNamer:Rules:Rearrange|Rearrange rule]] can be used in many ways. Few examples are given below.

For simplicity's sake, we have split examples into two sections: [[#Basic usage|Basic usage]] (typical needs of beginners) and [[#Advanced usage|Advanced usage]] (for the power users).

== Basic usage ==

=== Example 1 ===

'''Task:''' Swap parts of name.

{| class="wikitable"
|-
! From:
! To:
|-
| Artist - Title.mp3
| Title - Artist.mp3
|}

'''Settings:'''

Split using: (o)Delimiter 
" - " (without the quotes) 

New pattern: $2 - $1 
[X] Skip Extensions

Explanation: We split the string at the hyphen (dash or minus sign -) or whatever you use to separate Artist from Title 
Now, all signs before the dash are stored in variable $1, all after are put in var $2. 
Because we want to swap this parts, we simple swap the vars in the output, the "New Pattern": $2 $1 
And since this rule removes the used delimiter, we add it on our own: "$2 - $1", or use an new delimiter as e.g.: "$2_-_$1"

=== Example 2 ===

'''Task:''' Insert text before the original name.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring Ring 
| ABBA - Ring Ring
|-
| The winner takes it all 
| ABBA -The winner takes it all
|}

'''Settings:'''

Delimiter: none (leave blank) 

New order/pattern: ABBA - $0

'''Remarks:  '''is same as the '''[[ReNamer:Rules:Insert|Insert]] '''rule. 

=== Example 3 ===

'''Task:''' Insert text before and after the original name.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring Ring 
| ABBA- Ring Ring (Live)
|-
| The winner takes it all 
| ABBA-The winner takes it all (Live) 
|}

'''Settings:'''

Delimiter: none (leave blank)

New order/pattern: ABBA- $0 (Live)

'''Remarks:''' is same as using the '''[[ReNamer:Rules:Insert|Insert]]''' rule twice (one for adding the prefix, and another for adding the suffix).

=== Example 4 ===

'''Task:''' Switch the words, and remove the comma between them.

{| class="wikitable"
|-
! From:
! To:
|-
| King, Stephen
| Stephen King
|-
| Cook, Robin
| Robin Cook
|-
| Pride and Prejudice, The
| The Pride and Prejudice
|}

'''Settings:'''

Delimiter: ", " (without the quotes)

New Order: $2 $1

=== Example 5 ===

'''Task:''' Move a word to a new position.

{| class="wikitable"
|-
! From:
! To:
|-
| Words sample 1234 07-07-07
| 1234 Words sample 07-07-07
|}

'''Settings:'''

Delimiter: " " (only a space, without the quotes)

New Order: $3 $1 $2 $4

=== Example 6 ===

'''Task:''' Get rid of the numbers, hyphen and space at the beginning.

{| class="wikitable"
|-
! From:
! To:
|-
| 01 - Afilename.zip
| Afilename.zip
|-
| 002 - Bfilename.zip
| Bfilename.zip
|-
| 0003 - Cfilename.zip
| Cfilename.zip
|}

'''Settings:'''

Delimiter: "- " (without the quotes)

New Order: $2

'''Remarks:'''

#Note that the delimiter contains a space. If only a hyphen is used as delimiter, then a space would be left out in the beginning of the name, which you would have to trim separately.
#The '''Delete''' rule also would work (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the truncated names.

=== Example 7 ===

'''Task: '''Move the first part to the end.

{| class="wikitable"
|-
! From:
! To:
|-
| TEST.aaa.bbb.100.ext
| aaa.bbb.100.TEST.ext
|}

'''Setting:'''

Delimiter: "." (without the quotes)

New Order: $2.$3.$4.$1 

=== Example 8 ===

'''Task: '''Move the artist's name from end to the beginning, and change the name format.

{| class="wikitable"
|-
! From:
! To:
|-
| Ring ring_ABBA.mp3
| ABBA - Ring Ring.mp3
|-
| Material girl_Madonna.mp3
| Madonna - Material girl mp3
|}

'''Settings:'''

Delimiter: "_" (without the quotes)

New Order: $2 - $1

=== Example 9 ===

'''Task:''' Move the numbers to the beginning.

{| class="wikitable"
|-
! From:
! To:
|-
| DSC_0001-1.jpg
| 1-DSC_0001.jpg
|-
| DSC_0001-2.jpg
| 2-DSC_0001.jpg
|-
| DSC_0001-10.jpg
| 10-DSC_0001.jpg
|}

'''Settings:'''

Delimiter: "-" (without the quotes)

New Order: $2-$1

=== Example 10 ===

'''Task:''' Insert "sent_" before the last 3 digits.

{| class="wikitable"
|-
! From:
! To:
|-
| family_001.jpg
| family_sent_001.jpg
|-
| work_023.jpg
| work_sent_023.jpg
|-
| friend_098.jpg
| friend_sent_098.jpg
|}

'''Settings:'''

Delimiter: "_" (without the quotes)

New Order: $1_sent_$2

'''Remarks:'''

The '''Insert''' rule also would work (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the names.

=== Example 11 ===

'''Task:''' Remove the name of the artist (delete text until hyphen).

{| class="wikitable"
|-
! From:
! To:
|-
| Sting - All This Time.mp3
| All This Time.mp3
|}

'''Settings:'''

Delimiter: "- " (without the quotes)

New Order: $2

'''Remarks:'''

#Note the space after the hyphen. If we use just a "-" as delimiter, the second token would be left with a space in front, which we will have to trim separately.
#Even the '''Delete''' rule would have worked (in ''right-to-left ''mode). But the '''Rearrange''' rule also allows you to add any string to the new name.

=== Example 12 ===

'''Task:''' Remove the track numbers (and any separator symbol after that) from the beginning of the filenames:

{| class="wikitable"
|-
! From:
! To:
|-
| 08. Madonna - Like A Prayer.wma
| rowspan="3" | Madonna - Like A Prayer.wma
|-
| 08.-Madonna - Like A Prayer.wma
|-
| 08 Madonna - Like A Prayer.wma
|}

'''Settings:'''

Delimiter: "Madonna" (without the quotes)

New Order: Madonna$2

'''Remarks: '''

We chose the string "Madonna" as delimiter because it does not occur anywhere else in the names. The unwanted characters on the left are assigned to token $1, which we will not omit in the new name. However, there is an undesired side-effect: ReNamer removes "Madonna" string from the token $2 because it is the delimiter. Therefore, we have to manually add that missing string "Madonna" to $2, to restore the names.

=== Example 13 ===

'''Task:''' Move the number to front, and remove the square brackets.

{| class="wikitable"
|-
! From:
! To:
|-
| Name XXX [0001].jpg
| 0001 - Name XXX.jpg
|}

'''Settings:'''

Delimiter: " [|]" (without the quotes)

New Order: $2 - $1

'''Remarks:'''

# The "|" (vertical pipe) character is used to separate the two delimiters.
# The second delimiter "]" will not produce a token. It is included only to remove it from the new name.

=== Example 14 ===

'''Task:''' Add composer name and duration to an mp3 file, as prefix and suffix, respectively.

{| class="wikitable"
|-
! From:
! To:
|-
| Eine kleine Nachtmusik.mp3
| Mozart - Eine kleine Nachtmusik (6.37).mp3
|-
| Don Giovanni.mp3
| Mozart - Don Giovanni (4.5).mp3
|}

'''Settings:'''

Positions: 1

New Order: Mozart - $2 (:Audio_Duration:)

'''Remarks:'''

#This can also be done by using the '''Insert''' rule. However, you have to use that rule twice (once for prefix and the second time for the suffix). On the other hand, the '''Rearrange''' rule allows you to add both in a single stroke. Besides, you can see the structure of the new name.
#When the original name is sliced at position 1, there is no characters on the left side; so the $1 token is a blank. The ''entire'' name is copied into the $2 token. This is a great trick to compose new name using the ''whole'' original name.

=== Example 15 ===

'''Task:''' Swap parts of name at fixed position.

{| class="wikitable"
|-
! From:
! To:
|-
| BusinessRawReport1.doc 
| RawReport1, Business.doc
|-
| BusinessRawReport2.doc 
| RawReport2, Business.doc
|-
| BusinessRawReport3.doc 
| RawReport3, Business.doc
|}

'''Settings:'''

Split using: (o)Positions 
"9" (without the quotes) 

New pattern: $2, $1 
[X] Skip Extensions

'''Remarks:'''
Since we didn't have an real delimiter here, we simply split at an position within the string, here e.g. at char number 9: 
BusinessRawReport1.doc 
123456789

So all before 9th char is put in variable $1, and all from char number 9 till end of string is put in var $2. 
That means: $1 holds 'Business' and $2 holds 'RawReport1'. (Note that we skip the extension, so we don't have to deal with it) 
Now we compose our new string, the output pattern, just as we like it to be: '$2, $1'

-

You can also use more then one delimiter or position:
{| class="wikitable"
|-
! From:
! To:
|-
| BusinessRawReport1.doc 
| Raw Business Report1.doc
|}

'''Settings:'''

Split using: (o)Positions 
"9|12" (without the quotes) 

New pattern: $2 $1 $3 
[X] Skip Extensions

'''Remarks:'''

BusinessRawReport1.doc 
123456789 
123456789012

$1 holds 'Business' 
$2 holds 'Raw' 
$3 holds 'Report1'

== Advanced usage ==

=== Example 1 ===

'''Task:''' Remove the string from the file name.

{| class="wikitable"
|-
! From:
! To:
|-
| Artist - Title [Time 4 02 Cold] [2004].mpg
| Artist - Title [2004].mpg
|}

'''Settings:'''

Delimiter: " [T|d] " (without the quotes)

New Order: $1 $3

'''Remarks:'''

#The '''|''' character separates the two delimiters.
#Notice that we have included spaces in the delimiters, so that they do not end up as part of the tokens.
#We have selected two ''different'' delimiters to represent the beginning and the end of the string we want to remove. Thus '''''whatever''''' lies between the two delimiters is converted into a token. This token is then omitted in the new name. This works just like using wildcards for the string (or a RegEx pattern).

=== Example 2 ===

'''Task:''' The file names contain artist name, album name and track name. Sort them into separate folders as follows:

#Create a separate folder for each artist.
#For each artist, create a subfolder for each album.
#Move each file in the corresponding folder.

{| class="wikitable"
|-
! From:
! To:
|-
| Title - Artist (Album).mp3
| D:\Artist\Album\Title.mp3
|}

'''Settings:'''

Delimiter: " - | (|)" (without the quotes)

New pattern: D:\$2\$3\$1

'''Remarks:'''

#Note that the delimiters contain spaces and symbols, so that only text remains in the tokens.
#The last delimiter ) does not produce a token. It is added just to strip the closing bracket from the last token.
#Instead of '''D:''' a relative path (such as '''..\..\''') can be added to the front.

=== Example 3 ===

'''Task: '''Sort digital photos in different folders based on the '''Date taken''' for each photo.

'''Note:''' Many people call this operation "binning", because we segregate the items into separate bins based on some criteria. (most people associate the word "Sorting" with "rearranging the files in ascending/descending order, without moving them to other folders")

{| class="wikitable"
|-
! From:
! To:
|-
| DSC_0001.jpg
| D:\photos\trip\2009_10_21\DSC_0001.jpg
|-
| DSC_0002.jpg
| D:\photos\trip\2009_10_21\DSC_0002.jpg
|-
| DSC_0003.jpg
| D:\photos\trip\2009_10_25\DSC_0003.jpg
|}

'''Settings:'''

Delimiter: - (none)

New pattern: D:\photos\trip\:EXIF_Date:\$0

'''Remarks:'''

#Note that this EXIF data is contained in the meta tag of each photo, not in the file name.
#The meta tag ''':EXIF_Date:''' is replaced by the actual '''date taken''' for each photo. Thus all photos taken on the same date will be moved to the same folder.
#The actual name of the folder would depend on the [[ReNamer:Program settings#Meta_tags_settings|Date and Time format settings]].

=== Example 4 ===

'''Task:''' Delete the last part of the base name (but the extension should remain). Note that the file names have different lengths, so you cannot slice the name at a particular position. The names have a different depths also (number of segments separated by dots).

{| class="wikitable"
|-
! From:
! To:
|-
| title.text1.text2.extension
| title.text1.extension
|-
| title.text1.text2.text3.extension
| title.text1.text2.extension
|}

'''Setting:''' The solution requires a stack of two different rules, as shown below:

1. '''Replace''' Rule

Find: "." (without the quotes)

Replace: "#" (without the quotes)

Check "[X] Last" to find and replace last occurrence of an dot only. 
Check "[X] Skip Extension" to not replace the file/extension separator as last dot.

(this is a temporary change; which will be eliminated in the second step)

2. '''Rearrange''' rule

Delimiter: "#" (without the quotes)

New Order: $1

'''Remarks:'''

We had to do this indirectly because the '''Rearrange''' rule cannot pick only the last dot as delimiter; and ignore the other dots. So we used a trick: we first changed the last dot into another character (using the '''Replace''' rule), and then use that new character as delimiter in the '''Rearrange''' rule.

=== Example 5 ===

'''Task:''' Swap parts with more then one of the same delimiter

{| class="wikitable"
|-
! From:
! To:
|-
| I. Author - Book title - True story.pdf
| Book title - True story (I. Author).pdf
|-
| I. Author - Book title.pdf
| Book title (I. Author).pdf
|}

First exchange the first occurrence of the delimiter by an completely other sign, e.g. # 
* Add an "Replace" Rule 
* Replace First " - " with "#", [X] Skip Extension 

So we got
{| class="wikitable"
|-
! From:
! To:
|-
| I. Author # Book title - True story.pdf
| Book title - True story (I. Author).pdf
|-
| I. Author # Book title.pdf
| Book title (I. Author).pdf
|}

Now use
'''Settings:'''

Split using: (o)Delimiter 
" # " (without the quotes) 

New pattern: $2 ($1) 
[X] Skip Extensions

'''Remarks:'''
Since this rule removes the used delimiter, we don't have to take care about them in the output.

=== Example 6 ===

'''Task:''' Keep only the last part of a file name:

{| class="wikitable"
|-
! From:
! To:
|-
| title text1 text2.txt
| text2.txt
|-
| title text1 text2 text3.txt
| text3.txt
|}

'''Settings:'''

Split using: (o)Delimiter " " (space, without the quotes)

New pattern: $-1 [X] Skip Extensions

'''Task:''' Keep only the second last part of a file name:

{| class="wikitable"
|-
! From:
! To:
|-
| title text1 text2.txt
| text1.txt
|-
| title text1 text2 text3.txt
| text2.txt
|}

'''Settings:'''

Split using: (o)Delimiter " " (space, without the quotes)

New pattern: $-2 [X] Skip Extensions

'''Remarks:''' Since $-1 and $-2 count the tokens from the right (from the end), we will get the same result even if the name is longer.

=== Example 7 ===

'''Task:''' Sort files with same names (but different extensions) into separate subfolder.            Typically, training websites provide such sets of files for each episode/lecture/lesson, etc. (video, handout, homework, etc.)             When you download these files, they are in a single folder. ReNamer helps you in sorting them into separate folders. 

We will see two different variations here: 

'''Variation-1:''' '''The subfolder name is same as the base name of the files.''' 

{| class="wikitable"
|-
! From:
! To:
|-
|
Episode 001.pdf Episode 001.mp4 

Episode 002.pdf Episode 002.mp4 

|
Episode 001\Episode 001.pdf Episode 001\Episode 001.mp4

Episode 002\Episode 002.pdf Episode 002\Episode 002.mp4

|}

'''Settings:'''

 Split using: - (Leave blank)  New pattern: $0\$0  [X] Skip Extensions

'''Remarks''': 

1. All files having the same base name will be sorted into a common subfolder. 2. ReNamer will create these subfolders in the current folder. 

 

'''Variation-2:''' '''The subfolder name is different as compared to the base name of the files.''' 

{| class="wikitable"
|-
! From:
! To:
|-
|
Handout 001.pdf Lesson 001.mp4 

Handout 002.pdf Lesson 002.mp4 

|
Part 001\Handout.pdf Part 001\Lesson.mp4

Part 002\Handout.pdf Part 002\Lesson.mp4

|}

'''Settings:'''

 Split using:" " (space, without the quotes)  New pattern: Part $2\$1  [X] Skip Extensions

'''Remarks''': 

1. All files having the same ''number'' will be sorted into a common subfolder. 2. ReNamer will create these subfolders in the current folder 3. The "Part " is a literal string. (note the space at the end) 

== Split by positions ==

=== Example 1 ===

FROM:
FECAAFC2309C055D7E7D61C4C669F9C0.dat
0 1 2 3 4 5 6 7 8 9101112131415
FE CA AF C2 30 9C 05 5D 7E7D61C4C669F9C0

TO:
C2AFCAFE9C305D057E7D61C4C669F9C0.dat
3 2 1 0 5 4 7 6 8 9101112131415
C2 AF CA FE 9C 30 5D 05 7E7D61C4C669F9C0

USE:
Rearrange rule: 
If you enter position n, ReNamer will chop the n-th character and all characters beyond that in a separate piece. 
Split by positions: 3|5|7|9|11|13|15|17 
New pattern: $4$3$2$1$6$5$8$7$9 
Skip extension: YES 

=== Example 2 ===

 

 
[[Category:ReNamer]]

ReNamer:Pascal Script:Reuse variable

2014-08-10T18:24:00Z

Stefan: cleaned up the modifications

{{Cleanup|This page is work in process! I want to clean up this page later. If you want to help please do so. -- [[User:Stefan|Stefan]]}}

If you want to store a variable to reuse the value later you can read here a few tips.

For examples you can store the last used path, folder or file name or parts of them. Also you may want to store an index number, or perhaps a list of the original file names. There are several techniques to store variable values, feel free to choose the one that suits you.

== File Approach ==

First we take a look on the file approach.

We use simple plain text files to store the variable.

=== Utilized Function ===

The ReNamer PascalScript functions to write and read text files are:

<source>
FileWriteContent( "FileName" , "Content" );
FileAppendContent( "FileName" , "Content" );

FileReadContent("FileName");
FileCountLines("FileName");
FileReadLine( "FileName" , LineNum );
</source>

For "FileName" you can just use a name without a path to store the file into the ReNamer folder. 
Example:
<source>
FileWriteContent( "FileName.txt" , "Content" );
FileWriteContent( ".\FileName.txt" , "Content" );
</source>

To use an full path to your ReNamer folder use the ReNamer PascalScript function "GetApplicationPath" 
Example:
<source>
FileWriteContent( WideExtractFilePath(GetApplicationPath) + "FileName.txt" , "Content" );
</source>

You can use your private temp (temporary) folder in your profile 
by using the ReNamer PascalScript function "WideGetTempPath" 
Example:
<source>
FileWriteContent( WideGetTempPath + "FileName.txt" , "Content" );
</source>

Also you can access all system environment variables by using "WideGetEnvironmentVar" 
Example:
<source>
UserName := WideGetEnvironmentVar('USERNAME');
</source>

=== Script examples ===

==== Store one value to one dedicated file ====

First rule in rule list: 
(GET stored variable 'LastFolder')
<source>
var
LastFold:string;

begin
if(GetCurrentFileIndex=1)then
if(WideFileExists(WideGetTempPath + 'den4b_LastFolder.txt')) then
LastFold := FileReadContent(WideGetTempPath +'den4b_LastFolder.txt');

//check if it works:
ShowMessage(LastFold);
end.
</source>

Other rules here in between 
- 
- 
- 

Last rule in rule list: 
(SET variable 'LastFolder' to stored for later reuse)
<source>
var
ParentFold:string;

begin
if(GetCurrentFileIndex=GetTotalNumberOfFiles)then
begin
ParentFold := CalculateMetaTag(FilePath, 'File_FolderName');
FileWriteContent(WideGetTempPath + 'den4b_LastFolder.txt', ParentFold);
end;

//check if it works:
ExecuteProgram('notepad ' + WideGetTempPath + 'den4b_LastFolder.txt',false);
end.
</source>

====Store more then one value into a common file====

Note this approach is to cumbersome for real use. 
Better use dedicated file for each var/value (see above).

We can also use FileAppendContent(); to add "NAME=VALUE" pairs to an single file 
and a routine to read the lines of that common vars.txt.

Here just as proof of concept:

Last rule in rule list: 
(add a line with "NAME=VALUE" pair)
FileAppendContent('den4b_vars.txt','LastFolder=' + ParentF + #13#10);

This 'den4b_vars.txt' could look now like:
LastIndex=10
LastString=Vacation 2013
LastFolder=Translits

Other rules here in between 
- 
- 
- 

To get the wanted value i would use a code like this:

First rule in rule list: 
- read the vars.txt 
- split into lines 
- split line into 'name' and 'value' 
- check if 'name' is a wanted var name, if yes get the value 

<source>
var
vars,v:string;
Lines,CurrLine:TStringsArray;
i:integer;

begin
if(GetCurrentFileIndex=1)then
begin
if( WideFileExists('.\den4b_vars.txt') ) then
begin
vars := FileReadContent('.\den4b_vars.txt');
ShowMessage('complete content:'+#10+vars);
Lines:= WideSplitString(vars, #13#10);
if( length(Lines) > 0 ) then
begin
for i:=0 to length(Lines)-1 do
begin
CurrLine := WideSplitString(Lines[i],'=');
v := CurrLine[0];
//ShowMessage(v);
if ( WideCompareText( v, 'LastIndex' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastFolder' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastString' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
end;
end;
end;
end;
end.
</source>

== Registry Approach ==

=== Not recommended ! ===

Not recommended !

<source>
var
ECAreturn:string;

begin
// Add your code here

//Store/Write/Set:
ExecuteProgram('reg add HKCU\Software\den4b /v TestName1 /t REG_SZ /d "Test value 1" /f', true);

//Load/Read/Get:
ExecConsoleApp('reg query HKCU\Software\den4b /v TestName1', ECAreturn);
ShowMessage(ECAreturn);
// Result:
//
// ! REG.EXE VERSION 3.0
//
// HKEY_CURRENT_USER\Software\den4b
// TestName1 REG_SZ Test value 1
//

//>---more code needed here to extract the value "Test value 1"---<
end.
</source>

== Clipboard Approach ==

<source>
var
vLastExtension, vCurrentExtension: WideString;
begin
// At start, load stored data //Load/Read/Get:
vLastExtension := GetClipboardText;
// Add here some error handling and cleanup code for vLastExtension
//if Length(vLastExtension) > 4 then Exit;
//
// Add your code here and use content of var vLastExtension
vCurrentExtension := WideExtractFileExt(FileName);
if vCurrentExtension <> vLastExtension then
.....
//
//
//
// At the end store the wanted data //Store/Write/Set:
SetClipboardText(vCurrentExtension);
end.
</source>

ReNamer:Pascal Script:Reuse variable

2014-08-10T18:14:03Z

Stefan: "Clipboard Approach" examples updated to smtg more meaningful

{{Cleanup|This page is work in process! I want to clean up this page later. If you want to help please do so. -- [[User:Stefan|Stefan]]}}

If you want to store a variable to reuse the value later you can read here a few tips.

For examples you can store the last used path, folder or file name or parts of them. Also you may want to store an index number, or perhaps a list of the original file names. There are several techniques to store variable values, feel free to choose the one that suits you.

== File Approach ==

First we take a look on the file approach.

We use simple plain text files to store the variable.

=== Utilized Function ===

The ReNamer PascalScript functions to write and read text files are:

<source>
FileWriteContent( "FileName" , "Content" );
FileAppendContent( "FileName" , "Content" );

FileReadContent("FileName");
FileCountLines("FileName");
FileReadLine( "FileName" , LineNum );
</source>

For "FileName" you can just use a name without a path to store the file into the ReNamer folder. 
Example:
<source>
FileWriteContent( "FileName.txt" , "Content" );
FileWriteContent( ".\FileName.txt" , "Content" );
</source>

To use an full path to your ReNamer folder use the ReNamer PascalScript function "GetApplicationPath" 
Example:
<source>
FileWriteContent( WideExtractFilePath(GetApplicationPath) + "FileName.txt" , "Content" );
</source>

You can use your private temp (temporary) folder in your profile 
by using the ReNamer PascalScript function "WideGetTempPath" 
Example:
<source>
FileWriteContent( WideGetTempPath + "FileName.txt" , "Content" );
</source>

Also you can access all system environment variables by using "WideGetEnvironmentVar" 
Example:
<source>
UserName := WideGetEnvironmentVar('USERNAME');
</source>

=== Script examples ===

==== Store one value to one dedicated file ====

First rule in rule list: 
(GET stored variable 'LastFolder')
<source>
var
LastFold:string;

begin
if(GetCurrentFileIndex=1)then
if(WideFileExists(WideGetTempPath + 'den4b_LastFolder.txt')) then
LastFold := FileReadContent(WideGetTempPath +'den4b_LastFolder.txt');

//check if it works:
ShowMessage(LastFold);
end.
</source>

Other rules here in between 
- 
- 
- 

Last rule in rule list: 
(SET variable 'LastFolder' to stored for later reuse)
<source>
var
ParentFold:string;

begin
if(GetCurrentFileIndex=GetTotalNumberOfFiles)then
begin
ParentFold := CalculateMetaTag(FilePath, 'File_FolderName');
FileWriteContent(WideGetTempPath + 'den4b_LastFolder.txt', ParentFold);
end;

//check if it works:
ExecuteProgram('notepad ' + WideGetTempPath + 'den4b_LastFolder.txt',false);
end.
</source>

====Store more then one value into a common file====

Note this approach is to cumbersome for real use. 
Better use dedicated file for each var/value (see above).

We can also use FileAppendContent(); to add "NAME=VALUE" pairs to an single file 
and a routine to read the lines of that common vars.txt.

Here just as proof of concept:

Last rule in rule list: 
(add a line with "NAME=VALUE" pair)
FileAppendContent('den4b_vars.txt','LastFolder=' + ParentF + #13#10);

This 'den4b_vars.txt' could look now like:
LastIndex=10
LastString=Vacation 2013
LastFolder=Translits

Other rules here in between 
- 
- 
- 

To get the wanted value i would use a code like this:

First rule in rule list: 
- read the vars.txt 
- split into lines 
- split line into 'name' and 'value' 
- check if 'name' is a wanted var name, if yes get the value 

<source>
var
vars,v:string;
Lines,CurrLine:TStringsArray;
i:integer;

begin
if(GetCurrentFileIndex=1)then
begin
if( WideFileExists('.\den4b_vars.txt') ) then
begin
vars := FileReadContent('.\den4b_vars.txt');
ShowMessage('complete content:'+#10+vars);
Lines:= WideSplitString(vars, #13#10);
if( length(Lines) > 0 ) then
begin
for i:=0 to length(Lines)-1 do
begin
CurrLine := WideSplitString(Lines[i],'=');
v := CurrLine[0];
//ShowMessage(v);
if ( WideCompareText( v, 'LastIndex' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastFolder' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastString' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
end;
end;
end;
end;
end.
</source>

== Registry Approach ==

=== Not recommended ! ===

Not recommended !

<source>
var
ECAreturn:string;

begin
// Add your code here

//Store/Write/Set:
ExecuteProgram('reg add HKCU\Software\den4b /v TestName1 /t REG_SZ /d "Test value 1" /f', true);

//Load/Read/Get:
ExecConsoleApp('reg query HKCU\Software\den4b /v TestName1', ECAreturn);
ShowMessage(ECAreturn);
// Result:
//
// ! REG.EXE VERSION 3.0
//
// HKEY_CURRENT_USER\Software\den4b
// TestName1 REG_SZ Test value 1
//

//>---more code needed here to extract the value "Test value 1"---<
end.
</source>

== Clipboard Approach ==

//Store/Write/Set:
<source>
var
vCurrentExtension: WideString;
begin
// Add your code here:
vCurrentExtension:= WideExtractFileExt(FileName);
//
//
//
// At the end store the wanted data:
SetClipboardText(vCurrentExtension);
end.
</source>

//Load/Read/Get:
<source>
var
vLastExtension, vCurrentExtension: WideString;
begin
// At start load stored data:
vLastExtension := GetClipboardText;
// Add your code here and use content of var vLastExtension
//
vCurrentExtension := WideExtractFileExt(FileName);
if vCurrentExtension <> vLastExtension then
.....
//
end.
</source>

ReNamer:Using presets

2014-01-15T07:02:04Z

Stefan:

{{Up|ReNamer}}

A "preset" is a set of rules that is saved with a user-defined name. It can optionally save the [[ReNamer:Menus for the Files pane#Filters_menu|Filter setting]] also.

You can save frequently used sets of rules as presets, and load them instantly. This saves you a lot of time. Without the presets, you would have to compose the same set of rules each time you start the program. You can create an unlimited number of presets, but in practice, you would normally need about 4-5 presets.

== Shortcuts ==

ReNamer automatically assigns keyboard shortcuts to presets, so that they can be loaded into the '''Rules''' pane with least effort. Shortcuts have the following form: '''CTRL+1''', '''CTRL+2''', etc. Unfortunately, there are only 9 shortcuts available, one for every digit from 1 to 9.

Presets are sorted in alphabetic order. You can manipulate the order of the presets by renaming them. If you want some specific preset to always appear at the top, you can insert an exclamation mark "'''!'''" (or some other symbol that is at the top of the sorting order) in front of the preset name. If you have several presets that you want to push to the top, you can prefix them with something like this: "'''!1'''", "'''!2'''", "'''!3'''", etc.

== Managing Presets ==

=== Save a preset ===

# Create a list of rules ([[ReNamer:Managing rules|Managing rules]]).
# Set the required [[ReNamer:Menus for the Files pane#Filters_menu|Filter settings]] (optional).
# Press '''CTRL+S''', or use the '''Presets > Save As''' menu option.
# A window pops up: [[Image:SavePresetDialog.png|center]]
# Enter a new name in the '''Name''' box, or select one of the existing presets listed below to overwrite it.
# Put a tick in the check box if you want to save the current filter settings.
# Press the '''Save''' button. The preset is saved.

'''Note:''' At any point of time, you can abort the process by pressing '''ESC''' or closing the window.

=== Load an existing preset ===

You can load any of the presets by pressing its shortcut ('''CTRL+1''', etc. see above). If you do not remember the shortcuts, use the '''Preset > Load''' menu to see the master list of all existing presets and select a preset from that list.The selected preset is loaded.

=== Append an existing preset to current set of rules ===

You can append any of the presets to the end of the current rules stack. To do it, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to append and then press the [[Image:Append_preset_button.png]] button.
# Close the '''Preset Manager''' window.

=== Delete an existing preset ===

Sometimes you may not need a preset any longer. To delete it, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to delete and then press '''DEL''' key or the [[Image:PresetDeleteButton.png]] button.
# Close the '''Preset Manager''' window.

=== Rename a preset ===

To rename a preset, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The Preset manager window pops up.
# Select the preset you want to rename and then press '''F2''' or the [[Image:RenamePresetButton.png]] button.
# The following dialog pops up: [[Image:RenamePresetDialog.png|center]]
# Edit the name (or enter a new name), and press '''OK''' or '''ENTER'''.

To abort the process at any time, press '''ESC''' or close the window.

=== Edit a preset ===

The preset manager can show the contents of a preset (i.e., settings of all rules and filters) as editable text. You can simply edit the rules and filters by changing the text.

To edit a preset, follow these steps:

# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to edit and then press '''F4''' or the [[Image:EditPresetButton.png]] button.
# A warning pops up: [[Image:EditPresetWarning.png|center]]
# Click on '''Yes'''. A Notepad (text editor) window pops up with the selected preset: [[Image:PresetEditWindow.png|center]]
#: Notice that:
#:* This window shows the preset name in the title bar, and all settings (rules and filters).
#:* In each rule, the parameters are shown in '''ParameterName:ParameterValue '''format.
#:* All such pairs are separated by a semicolon (''';''').
# Edit the settings and then close the file. A confirmation dialog pops up. [[Image:SaveChangedmpFileDialog.png|center]]
# Click on '''Yes'''. Now the preset is edited.

=== Copy a preset ===

You may want to duplicate an existing preset and create a variation by editing it (or just take a backup of the preset before experimenting with it).

To duplicate a preset, follow these steps:

# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to duplicate and then press the [[Image:CopyPresetButton.png]] button.
# A duplicate copy of the preset is created.
# Now go ahead and edit the original present (or its copy).
# Finally close the '''Presets Manager''' window.
 
 
== Backup / Transfer Presets ==
 
Presets are stored as plain text files, stored by default in a folder called Presets. 
On default, this Presets folder is in the same folder as the ReNamer.exe, 
but it could be stored in your Windows user profile too. 
 
You can simple tell by launching ReNamer and open the Presets Manager: "Presets > Manage..." (Ctrl+P) 
On the top you will see the path to the presets folder (see pictures above). 
 
There is also a menu item "Presets > Browse..." which will open WinExplorer with that folder in view. 
 
But please note; with older versions of ReNamer on Vista/Win7 that may not bring you to the right path, 
since Windows with enabled UAC (search the forum) will lie to us and redirect paths. 
In such case just take a quick look into this redirection folders of Windows: 
"C:\Users\<yourName>\AppData\Local\VirtualStore\Program Files (x86)\ReNamer\Presets\*.rnp" 
"C:\Users\<yourName>\AppData\Local\VirtualStore\Program Files\ReNamer\Presets\*.rnp" 
or for Germans: "C:\Benutzer\<DeinName>\AppData\..." 
 
To backup or transfer this stored presets to an another location or PC, just copy that *.rnp files and you are done. 
 
[[Category:ReNamer]]

ReNamer:Using presets

2014-01-15T06:51:33Z

Stefan:

{{Up|ReNamer}}

A "preset" is a set of rules that is saved with a user-defined name. It can optionally save the [[ReNamer:Menus for the Files pane#Filters_menu|Filter setting]] also.

You can save frequently used sets of rules as presets, and load them instantly. This saves you a lot of time. Without the presets, you would have to compose the same set of rules each time you start the program. You can create an unlimited number of presets, but in practice, you would normally need about 4-5 presets.

== Shortcuts ==

ReNamer automatically assigns keyboard shortcuts to presets, so that they can be loaded into the '''Rules''' pane with least effort. Shortcuts have the following form: '''CTRL+1''', '''CTRL+2''', etc. Unfortunately, there are only 9 shortcuts available, one for every digit from 1 to 9.

Presets are sorted in alphabetic order. You can manipulate the order of the presets by renaming them. If you want some specific preset to always appear at the top, you can insert an exclamation mark "'''!'''" (or some other symbol that is at the top of the sorting order) in front of the preset name. If you have several presets that you want to push to the top, you can prefix them with something like this: "'''!1'''", "'''!2'''", "'''!3'''", etc.

== Managing Presets ==

=== Save a preset ===

# Create a list of rules ([[ReNamer:Managing rules|Managing rules]]).
# Set the required [[ReNamer:Menus for the Files pane#Filters_menu|Filter settings]] (optional).
# Press '''CTRL+S''', or use the '''Presets > Save As''' menu option.
# A window pops up: [[Image:SavePresetDialog.png|center]]
# Enter a new name in the '''Name''' box, or select one of the existing presets listed below to overwrite it.
# Put a tick in the check box if you want to save the current filter settings.
# Press the '''Save''' button. The preset is saved.

'''Note:''' At any point of time, you can abort the process by pressing '''ESC''' or closing the window.

=== Load an existing preset ===

You can load any of the presets by pressing its shortcut ('''CTRL+1''', etc. see above). If you do not remember the shortcuts, use the '''Preset > Load''' menu to see the master list of all existing presets and select a preset from that list.The selected preset is loaded.

=== Append an existing preset to current set of rules ===

You can append any of the presets to the end of the current rules stack. To do it, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to append and then press the [[Image:Append_preset_button.png]] button.
# Close the '''Preset Manager''' window.

=== Delete an existing preset ===

Sometimes you may not need a preset any longer. To delete it, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to delete and then press '''DEL''' key or the [[Image:PresetDeleteButton.png]] button.
# Close the '''Preset Manager''' window.

=== Rename a preset ===

To rename a preset, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The Preset manager window pops up.
# Select the preset you want to rename and then press '''F2''' or the [[Image:RenamePresetButton.png]] button.
# The following dialog pops up: [[Image:RenamePresetDialog.png|center]]
# Edit the name (or enter a new name), and press '''OK''' or '''ENTER'''.

To abort the process at any time, press '''ESC''' or close the window.

=== Edit a preset ===

The preset manager can show the contents of a preset (i.e., settings of all rules and filters) as editable text. You can simply edit the rules and filters by changing the text.

To edit a preset, follow these steps:

# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to edit and then press '''F4''' or the [[Image:EditPresetButton.png]] button.
# A warning pops up: [[Image:EditPresetWarning.png|center]]
# Click on '''Yes'''. A Notepad (text editor) window pops up with the selected preset: [[Image:PresetEditWindow.png|center]]
#: Notice that:
#:* This window shows the preset name in the title bar, and all settings (rules and filters).
#:* In each rule, the parameters are shown in '''ParameterName:ParameterValue '''format.
#:* All such pairs are separated by a semicolon (''';''').
# Edit the settings and then close the file. A confirmation dialog pops up. [[Image:SaveChangedmpFileDialog.png|center]]
# Click on '''Yes'''. Now the preset is edited.

=== Copy a preset ===

You may want to duplicate an existing preset and create a variation by editing it (or just take a backup of the preset before experimenting with it).

To duplicate a preset, follow these steps:

# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to duplicate and then press the [[Image:CopyPresetButton.png]] button.
# A duplicate copy of the preset is created.
# Now go ahead and edit the original present (or its copy).
# Finally close the '''Presets Manager''' window.
 
 
== Backup / Transfer Presets ==
 
Presets are stored as plain text files, stored by default in a folder called Presets. 
On default, this Presets folder is in the same folder as the ReNamer.exe, 
but it could be stored in your Windows user profile too. 
 
You can simple tell by launching ReNamer and open the Presets Manager: "Presets > Manage..." (Ctrl+P) 
On the top you will see the path to the presets folder (see pictures above). 
 
There is also a menu item "Presets > Browse..." which will open WinExplorer with that folder in view. 
 
To backup or transfer this stored presets to an another location or PC, just copy that *.rnp files and you are done. 
 
[[Category:ReNamer]]

ReNamer:Using presets

2014-01-15T06:49:57Z

Stefan:

{{Up|ReNamer}}

A "preset" is a set of rules that is saved with a user-defined name. It can optionally save the [[ReNamer:Menus for the Files pane#Filters_menu|Filter setting]] also.

You can save frequently used sets of rules as presets, and load them instantly. This saves you a lot of time. Without the presets, you would have to compose the same set of rules each time you start the program. You can create an unlimited number of presets, but in practice, you would normally need about 4-5 presets.

== Shortcuts ==

ReNamer automatically assigns keyboard shortcuts to presets, so that they can be loaded into the '''Rules''' pane with least effort. Shortcuts have the following form: '''CTRL+1''', '''CTRL+2''', etc. Unfortunately, there are only 9 shortcuts available, one for every digit from 1 to 9.

Presets are sorted in alphabetic order. You can manipulate the order of the presets by renaming them. If you want some specific preset to always appear at the top, you can insert an exclamation mark "'''!'''" (or some other symbol that is at the top of the sorting order) in front of the preset name. If you have several presets that you want to push to the top, you can prefix them with something like this: "'''!1'''", "'''!2'''", "'''!3'''", etc.

== Managing Presets ==

=== Save a preset ===

# Create a list of rules ([[ReNamer:Managing rules|Managing rules]]).
# Set the required [[ReNamer:Menus for the Files pane#Filters_menu|Filter settings]] (optional).
# Press '''CTRL+S''', or use the '''Presets > Save As''' menu option.
# A window pops up: [[Image:SavePresetDialog.png|center]]
# Enter a new name in the '''Name''' box, or select one of the existing presets listed below to overwrite it.
# Put a tick in the check box if you want to save the current filter settings.
# Press the '''Save''' button. The preset is saved.

'''Note:''' At any point of time, you can abort the process by pressing '''ESC''' or closing the window.

=== Load an existing preset ===

You can load any of the presets by pressing its shortcut ('''CTRL+1''', etc. see above). If you do not remember the shortcuts, use the '''Preset > Load''' menu to see the master list of all existing presets and select a preset from that list.The selected preset is loaded.

=== Append an existing preset to current set of rules ===

You can append any of the presets to the end of the current rules stack. To do it, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to append and then press the [[Image:Append_preset_button.png]] button.
# Close the '''Preset Manager''' window.

=== Delete an existing preset ===

Sometimes you may not need a preset any longer. To delete it, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to delete and then press '''DEL''' key or the [[Image:PresetDeleteButton.png]] button.
# Close the '''Preset Manager''' window.

=== Rename a preset ===

To rename a preset, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The Preset manager window pops up.
# Select the preset you want to rename and then press '''F2''' or the [[Image:RenamePresetButton.png]] button.
# The following dialog pops up: [[Image:RenamePresetDialog.png|center]]
# Edit the name (or enter a new name), and press '''OK''' or '''ENTER'''.

To abort the process at any time, press '''ESC''' or close the window.

=== Edit a preset ===

The preset manager can show the contents of a preset (i.e., settings of all rules and filters) as editable text. You can simply edit the rules and filters by changing the text.

To edit a preset, follow these steps:

# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to edit and then press '''F4''' or the [[Image:EditPresetButton.png]] button.
# A warning pops up: [[Image:EditPresetWarning.png|center]]
# Click on '''Yes'''. A Notepad (text editor) window pops up with the selected preset: [[Image:PresetEditWindow.png|center]]
#: Notice that:
#:* This window shows the preset name in the title bar, and all settings (rules and filters).
#:* In each rule, the parameters are shown in '''ParameterName:ParameterValue '''format.
#:* All such pairs are separated by a semicolon (''';''').
# Edit the settings and then close the file. A confirmation dialog pops up. [[Image:SaveChangedmpFileDialog.png|center]]
# Click on '''Yes'''. Now the preset is edited.

=== Copy a preset ===

You may want to duplicate an existing preset and create a variation by editing it (or just take a backup of the preset before experimenting with it).

To duplicate a preset, follow these steps:

# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to duplicate and then press the [[Image:CopyPresetButton.png]] button.
# A duplicate copy of the preset is created.
# Now go ahead and edit the original present (or its copy).
# Finally close the '''Presets Manager''' window.
 
 
== Backup / Transfer Presets ==
 
Presets are stored in plain text files, stored by default in a folder called Presets. 
On default, this Presets folder is in the same folder as the ReNamer.exe, 
but it could be stored in your Windows user profile too. 
 
You can simple tell by launching ReNamer and open the Presets Manager: "Presets > Manage..." (Ctrl+P) 
On the top you will see the path to the presets folder (see pictures above). 
 
There is also a menu item "Presets > Browse..." which will open WinExplorer with that folder in view. 
 
To backup or transfer this stored presets to an another location or PC, just copy that *.rnp files and you are done. 
 
[[Category:ReNamer]]

ReNamer:Using presets

2014-01-15T06:48:35Z

Stefan:

{{Up|ReNamer}}

A "preset" is a set of rules that is saved with a user-defined name. It can optionally save the [[ReNamer:Menus for the Files pane#Filters_menu|Filter setting]] also.

You can save frequently used sets of rules as presets, and load them instantly. This saves you a lot of time. Without the presets, you would have to compose the same set of rules each time you start the program. You can create an unlimited number of presets, but in practice, you would normally need about 4-5 presets.

== Shortcuts ==

ReNamer automatically assigns keyboard shortcuts to presets, so that they can be loaded into the '''Rules''' pane with least effort. Shortcuts have the following form: '''CTRL+1''', '''CTRL+2''', etc. Unfortunately, there are only 9 shortcuts available, one for every digit from 1 to 9.

Presets are sorted in alphabetic order. You can manipulate the order of the presets by renaming them. If you want some specific preset to always appear at the top, you can insert an exclamation mark "'''!'''" (or some other symbol that is at the top of the sorting order) in front of the preset name. If you have several presets that you want to push to the top, you can prefix them with something like this: "'''!1'''", "'''!2'''", "'''!3'''", etc.

== Managing Presets ==

=== Save a preset ===

# Create a list of rules ([[ReNamer:Managing rules|Managing rules]]).
# Set the required [[ReNamer:Menus for the Files pane#Filters_menu|Filter settings]] (optional).
# Press '''CTRL+S''', or use the '''Presets > Save As''' menu option.
# A window pops up: [[Image:SavePresetDialog.png|center]]
# Enter a new name in the '''Name''' box, or select one of the existing presets listed below to overwrite it.
# Put a tick in the check box if you want to save the current filter settings.
# Press the '''Save''' button. The preset is saved.

'''Note:''' At any point of time, you can abort the process by pressing '''ESC''' or closing the window.

=== Load an existing preset ===

You can load any of the presets by pressing its shortcut ('''CTRL+1''', etc. see above). If you do not remember the shortcuts, use the '''Preset > Load''' menu to see the master list of all existing presets and select a preset from that list.The selected preset is loaded.

=== Append an existing preset to current set of rules ===

You can append any of the presets to the end of the current rules stack. To do it, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to append and then press the [[Image:Append_preset_button.png]] button.
# Close the '''Preset Manager''' window.

=== Delete an existing preset ===

Sometimes you may not need a preset any longer. To delete it, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to delete and then press '''DEL''' key or the [[Image:PresetDeleteButton.png]] button.
# Close the '''Preset Manager''' window.

=== Rename a preset ===

To rename a preset, follow these steps:
# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The Preset manager window pops up.
# Select the preset you want to rename and then press '''F2''' or the [[Image:RenamePresetButton.png]] button.
# The following dialog pops up: [[Image:RenamePresetDialog.png|center]]
# Edit the name (or enter a new name), and press '''OK''' or '''ENTER'''.

To abort the process at any time, press '''ESC''' or close the window.

=== Edit a preset ===

The preset manager can show the contents of a preset (i.e., settings of all rules and filters) as editable text. You can simply edit the rules and filters by changing the text.

To edit a preset, follow these steps:

# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to edit and then press '''F4''' or the [[Image:EditPresetButton.png]] button.
# A warning pops up: [[Image:EditPresetWarning.png|center]]
# Click on '''Yes'''. A Notepad (text editor) window pops up with the selected preset: [[Image:PresetEditWindow.png|center]]
#: Notice that:
#:* This window shows the preset name in the title bar, and all settings (rules and filters).
#:* In each rule, the parameters are shown in '''ParameterName:ParameterValue '''format.
#:* All such pairs are separated by a semicolon (''';''').
# Edit the settings and then close the file. A confirmation dialog pops up. [[Image:SaveChangedmpFileDialog.png|center]]
# Click on '''Yes'''. Now the preset is edited.

=== Copy a preset ===

You may want to duplicate an existing preset and create a variation by editing it (or just take a backup of the preset before experimenting with it).

To duplicate a preset, follow these steps:

# Press '''CTRL+M''' or use the '''Presets > Manage''' menu option.
# The '''Presets manager''' window pops up: [[Image:PresetsManager.png|center]]
# Select the preset you want to duplicate and then press the [[Image:CopyPresetButton.png]] button.
# A duplicate copy of the preset is created.
# Now go ahead and edit the original present (or its copy).
# Finally close the '''Presets Manager''' window.
 
 
== Backup / Transfer Presets ==
 
Presets are stored in plain text files, stored by default in a folder called Presets. 
On default, this Presets folder is in the same folder as the ReNamer.exe, 
but it could be stored in your Windows user profile too. 
 
You can simple tell by launching ReNamer and open the Presets Manager "Presets > Manage..." (Ctrl+P) 
On the top you will see the path to the presets folder (see pictures above). 
 
There is also a menu item "Presets > Browse..." which will open WinExplorer with that folder in view. 
 
To backup or transfer this stored presets to an another location or PC, just copy that *rnp files and you are done. 
 
[[Category:ReNamer]]

ReNamer:Pascal Script:Reuse variable

2013-01-27T18:00:35Z

Stefan: corrected two mistakes. + Thanks Denis for help!

{{Cleanup|This page is work in process! I want to clean up this page later. If you want to help please do so. -- [[User:Stefan|Stefan]]}}

If you want to store a variable to reuse the value later you can read here a few tips.

For examples you can store the last used path, folder or file name or parts of them. Also you may want to store an index number, or perhaps a list of the original file names. There are several techniques to store variable values, feel free to choose the one that suits you.

== File Approach ==

First we take a look on the file approach.

We use simple plain text files to store the variable.

=== Utilized Function ===

The ReNamer PascalScript functions to write and read text files are:

<source>
FileWriteContent( "FileName" , "Content" );
FileAppendContent( "FileName" , "Content" );

FileReadContent("FileName");
FileCountLines("FileName");
FileReadLine( "FileName" , LineNum );
</source>

For "FileName" you can just use a name without a path to store the file into the ReNamer folder. 
Example:
<source>
FileWriteContent( "FileName.txt" , "Content" );
FileWriteContent( ".\FileName.txt" , "Content" );
</source>

To use an full path to your ReNamer folder use the ReNamer PascalScript function "GetApplicationPath" 
Example:
<source>
FileWriteContent( WideExtractFilePath(GetApplicationPath) + "FileName.txt" , "Content" );
</source>

You can use your private temp (temporary) folder in your profile 
by using the ReNamer PascalScript function "WideGetTempPath" 
Example:
<source>
FileWriteContent( WideGetTempPath + "FileName.txt" , "Content" );
</source>

Also you can access all system environment variables by using "WideGetEnvironmentVar" 
Example:
<source>
UserName := WideGetEnvironmentVar('USERNAME');
</source>

=== Script examples ===

==== Store one value to one dedicated file ====

First rule in rule list: 
(GET stored variable 'LastFolder')
<source>
var
LastFold:string;

begin
if(GetCurrentFileIndex=1)then
if(WideFileExists(WideGetTempPath + 'den4b_LastFolder.txt')) then
LastFold := FileReadContent(WideGetTempPath +'den4b_LastFolder.txt');

//check if it works:
ShowMessage(LastFold);
end.
</source>

Other rules here in between 
- 
- 
- 

Last rule in rule list: 
(SET variable 'LastFolder' to stored for later reuse)
<source>
var
ParentFold:string;

begin
if(GetCurrentFileIndex=GetTotalNumberOfFiles)then
begin
ParentFold := CalculateMetaTag(FilePath, 'File_FolderName');
FileWriteContent(WideGetTempPath + 'den4b_LastFolder.txt', ParentFold);
end;

//check if it works:
ExecuteProgram('notepad ' + WideGetTempPath + 'den4b_LastFolder.txt',false);
end.
</source>

====Store more then one value into a common file====

Note this approach is to cumbersome for real use. 
Better use dedicated file for each var/value (see above).

We can also use FileAppendContent(); to add "NAME=VALUE" pairs to an single file 
and a routine to read the lines of that common vars.txt.

Here just as proof of concept:

Last rule in rule list: 
(add a line with "NAME=VALUE" pair)
FileAppendContent('den4b_vars.txt','LastFolder=' + ParentF + #13#10);

This 'den4b_vars.txt' could look now like:
LastIndex=10
LastString=Vacation 2013
LastFolder=Translits

Other rules here in between 
- 
- 
- 

To get the wanted value i would use a code like this:

First rule in rule list: 
- read the vars.txt 
- split into lines 
- split line into 'name' and 'value' 
- check if 'name' is a wanted var name, if yes get the value 

<source>
var
vars,v:string;
Lines,CurrLine:TStringsArray;
i:integer;

begin
if(GetCurrentFileIndex=1)then
begin
if( WideFileExists('.\den4b_vars.txt') ) then
begin
vars := FileReadContent('.\den4b_vars.txt');
ShowMessage('complete content:'+#10+vars);
Lines:= WideSplitString(vars, #13#10);
if( length(Lines) > 0 ) then
begin
for i:=0 to length(Lines)-1 do
begin
CurrLine := WideSplitString(Lines[i],'=');
v := CurrLine[0];
//ShowMessage(v);
if ( WideCompareText( v, 'LastIndex' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastFolder' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastString' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
end;
end;
end;
end;
end.
</source>

== Registry Approach ==

=== Not recommended ! ===

Not recommended !

<source>
var
ECAreturn:string;

begin
// Add your code here

//Store/Write/Set:
ExecuteProgram('reg add HKCU\Software\den4b /v TestName1 /t REG_SZ /d "Test value 1" /f', true);

//Load/Read/Get:
ExecConsoleApp('reg query HKCU\Software\den4b /v TestName1', ECAreturn);
ShowMessage(ECAreturn);
// Result:
//
// ! REG.EXE VERSION 3.0
//
// HKEY_CURRENT_USER\Software\den4b
// TestName1 REG_SZ Test value 1
//

//>---more code needed here to extract the value "Test value 1"---<
end.
</source>

== Clipboard Approach ==

<source>
var
Data: WideString;
begin
SetClipboardText('Sample Data');
Data := GetClipboardText;
end.
</source>

ReNamer:Pascal Script:Reuse variable

2013-01-27T13:47:39Z

Stefan: corrected two pasted text to make more sense together

== --- This page is work in process! --- ==

currently i just collect here a few information and POC proof of concept code.

I want to clean up this page later.

If you want to help please do so.

== Set/Get or Write/Read or Save/Load variable values ==

If you want to store a variable to reuse the value later you can read here a few tips.

For examples you can store the last used path, folder or file name or parts of them. 
Also you may want to store an index number, or perhaps a list of the original file names.
 
 
 

There are two main techniques to store variable values: use the registry or use a temporary file on disc.

== the file approach ==

First we take a look on the file approach.

We use simple plain text files to store the variable.

=== utilized function ===

The ReNamer PascalScript functions to write and read text files are:
<source>
FileWriteContent( "FileName" , "Content" );
FileAppendContent( "FileName" , "Content" );

FileReadContent("FileName");
FileCountLines("FileName");
FileReadLine( "FileName" , LineNum );
</source>

For "FileName" you can just use a name without a path to store the file into the ReNamer folder. 
Example:
<source>
FileWriteContent( "FileName.txt" , "Content" );
FileWriteContent( ".\FileName.txt" , "Content" );
</source>

To use an full path to your ReNamer folder use the ReNamer PascalScript function "GetApplicationPath" 
Example:
<source>
FileWriteContent( WideExtractFilePath(GetApplicationPath) + "FileName.txt" , "Content" );
</source>

You can use your private temp (temporary) folder in your profile 
by using the ReNamer PascalScript function "WideGetTempPath" 
Example:
<source>
FileWriteContent( WideGetTempPath + "FileName.txt" , "Content" );
</source>

Also you can access all system environment variables by using "WideGetEnvironmentVar" 
Example:
<source>
UserName := WideGetEnvironmentVar('USERNAME');
</source>

=== script examples ===

==== Store one value to one dedicated file ====

First rule in rule list: 
(GET stored variable 'LastFolder')
<source>
var
LastFold:string;

begin
if(GetCurrentFileIndex=1)then
if(WideFileExists(WideGetTempPath +'\den4b_LastFolder.txt')) then
LastFold := FileReadContent(WideGetTempPath +'den4b_LastFolder.txt');

//check if it works:
ShowMessage(LastFold);
end.
</source>

Other rules here in between 
- 
- 
- 

Last rule in rule list: 
(SET variable 'LastFolder' to stored for later reuse)
<source>
var
ParentFold:string;

begin
if(GetCurrentFileIndex=GetTotalNumberOfFiles)then
begin
ParentFold := CalculateMetaTag(FilePath, 'File_FolderName');
FileWriteContent(WideGetTempPath + 'den4b_LastFolder.txt', ParentFold);
end;

//check if it works:
ExecuteProgram('notepad ' + WideGetTempPath + 'den4b_LastFolder.txt',false);
end.
</source>

====Store more then one value into a common file====

Note this approach is to cumbersome for real use. 
Better use dedicated file for each var/value (see above).

We can also use FileAppendContent(); to add "NAME=VALUE" pairs to an single file 
and a routine to read the lines of that common vars.txt.

Here just as proof of concept:

Last rule in rule list: 
(add a line with "NAME=VALUE" pair)
FileAppendContent('den4b_vars.txt','LastFolder=' + ParentF + #13#10);

This 'den4b_vars.txt' could look now like:
LastIndex=10
LastString=Vacation 2013
LastFolder=Translits

Other rules here in between 
- 
- 
- 

To get the wanted value i would use a code like this:

First rule in rule list: 
- read the vars.txt 
- split into lines 
- split line into 'name' and 'value' 
- check if 'name' is a wanted var name, if yes get the value 

var
vars,v:string;
Lines,CurrLine:TStringsArray;
i:integer;

begin
if(GetCurrentFileIndex=1)then
begin
if( WideFileExists('.\den4b_vars.txt') ) then
begin
vars := FileReadContent('.\den4b_vars.txt');
ShowMessage('complete content:'+#10+vars);
Lines:= WideSplitString(vars, #13#10);
if( length(Lines) > 0 ) then
begin
for i:=0 to length(Lines)-1 do
begin
CurrLine := WideSplitString(Lines[i],'=');
v := CurrLine[0];
//ShowMessage(v);
if ( WideCompareText( v, 'LastIndex' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastFolder' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastString' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
end;
end;
end;
end;
end.

== the registry approach ==

=== Not recommended ! ===

Not recommended !

var
ECAreturn:string;

begin
// Add your code here

//Store/Write/Set:
ExecuteProgram('reg add HKCU\Software\den4b /v TestName1 /t REG_SZ /d "Test value 1" /f', true);

//Load/Read/Get:
ExecConsoleApp('reg query HKCU\Software\den4b /v Test6', ECAreturn);
ShowMessage(ECAreturn);
// Result:
//
// ! REG.EXE VERSION 3.0
//
// HKEY_CURRENT_USER\Software\den4b
// TestName1 REG_SZ Test value 1
//

//>---more code needed here to extract the value "Test value 1"---<
end.

== the clipboard approach ==
=== no tested yet ===
SetClipboardText( "content" );

varClip := GetClipboardText;

-# end

ReNamer:Pascal Script:Reuse variable

2013-01-27T13:44:29Z

Stefan: added placeholder for the clipboard approach

== --- This page is work in process! --- ==

currently i just collect here a few information and POC proof of concept code.

I want to clean up this page later.

If you want to help please do so.

== Set/Get or Write/Read or Save/Load variable values ==

If you want to store a variable to reuse the value later you can read here a few tips.

For examples you can store the last used path, folder or file name or parts of them. 
Also you may want to store an index number, or perhaps a list of the original file names.
 
 
 

There are two main techniques to store variable values: use the registry or use a temporary file on disc.

== the file approach ==

First we take a look on the file approach.

We use simple plain text files to store the variable.

=== utilized function ===

The ReNamer PascalScript functions to write and read text files are:
<source>
FileWriteContent( "FileName" , "Content" );
FileAppendContent( "FileName" , "Content" );

FileReadContent("FileName");
FileCountLines("FileName");
FileReadLine( "FileName" , LineNum );
</source>

For "FileName" you can just use a name without a path to store the file into the ReNamer folder. 
Example:
<source>
FileWriteContent( "FileName.txt" , "Content" );
FileWriteContent( ".\FileName.txt" , "Content" );
</source>

To use an full path to your ReNamer folder use the ReNamer PascalScript function "GetApplicationPath" 
Example:
<source>
FileWriteContent( WideExtractFilePath(GetApplicationPath) + "FileName.txt" , "Content" );
</source>

You can use your private temp (temporary) folder in your profile 
by using the ReNamer PascalScript function "WideGetTempPath" 
Example:
<source>
FileWriteContent( WideGetTempPath + "FileName.txt" , "Content" );
</source>

Also you can access all system environment variables by using "WideGetEnvironmentVar" 
Example:
<source>
UserName := WideGetEnvironmentVar('USERNAME');
</source>

=== script examples ===

==== Store one value to one dedicated file ====

First rule in rule list: 
(GET stored variable 'LastFolder')
<source>
var
LastFold:string;

begin
if(GetCurrentFileIndex=1)then
if(WideFileExists(WideGetTempPath +'\den4b_LastFolder.txt')) then
LastFold := FileReadContent(WideGetTempPath +'den4b_LastFolder.txt');

//check if it works:
ShowMessage(LastFold);
end.
</source>

Other rules here in between 
- 
- 
- 

Last rule in rule list: 
(SET variable 'LastFolder' to stored for later reuse)
<source>
var
ParentFold:string;

begin
if(GetCurrentFileIndex=GetTotalNumberOfFiles)then
begin
ParentFold := CalculateMetaTag(FilePath, 'File_FolderName');
FileWriteContent(WideGetTempPath + 'den4b_LastFolder.txt', ParentFold);
end;

//check if it works:
ExecuteProgram('notepad ' + WideGetTempPath + 'den4b_LastFolder.txt',false);
end.
</source>

====Store more then one value into a common file====

Note this approach is to cumbersome for real use. 
Better use dedicated file for each var/value (see above).

We can also use FileAppendContent(); to add "NAME=VALUE" pairs to an single file 
and a routine to read the lines of that common vars.txt.

Here just as proof of concept:

Last rule in rule list: 
(add a line with "NAME=VALUE" pair)
FileAppendContent('den4b_vars.txt','LastFolder=' + ParentF + #13#10);

This 'den4b_vars.txt' could look now like:
LastIndex=10
LastString=Vacation 2013
LastFolder=Translits

Other rules here in between 
- 
- 
- 

To get the wanted value i would use a code like this:

First rule in rule list: 
- read the vars.txt 
- split into lines 
- split line into 'name' and 'value' 
- check if 'name' is a wanted var name, if yes get the value 

var
vars,v:string;
Lines,CurrLine:TStringsArray;
i:integer;

begin
if(GetCurrentFileIndex=1)then
begin
if( WideFileExists('.\den4b_vars.txt') ) then
begin
vars := FileReadContent('.\den4b_vars.txt');
ShowMessage('complete content:'+#10+vars);
Lines:= WideSplitString(vars, #13#10);
if( length(Lines) > 0 ) then
begin
for i:=0 to length(Lines)-1 do
begin
CurrLine := WideSplitString(Lines[i],'=');
v := CurrLine[0];
//ShowMessage(v);
if ( WideCompareText( v, 'LastIndex' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastFolder' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastString' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
end;
end;
end;
end;
end.

== the registry approach ==

=== Not recommended ! ===

Not recommended !

var
ECAreturn:string;

begin
// Add your code here

//Store/Write/Set:
ExecuteProgram('reg add HKCU\Software\den4b /v TestName1 /t REG_SZ /d "Test value 1" /f', true);

//Load/Read/Get:
ExecConsoleApp('reg query HKCU\Software\den4b /v Test6', ECAreturn);
ShowMessage(ECAreturn);
//
// ! REG.EXE VERSION 3.0
//
// HKEY_CURRENT_USER\Software\den4b
// Test6 REG_SZ gut
//
//>---more code needed here to extract the value---<
end.

== the clipboard approach ==
=== no tested yet ===
SetClipboardText( "content" );

varClip := GetClipboardText;

-# end

ReNamer:Pascal Script

2013-01-27T13:37:43Z

Stefan: Add link at tips to page "ReNamer:Scripts:Reuse variable"

{{Up|ReNamer}}

The [[ReNamer:Rules:PascalScript|PascalScript Rule]] in [[ReNamer]] uses Pascal Script component to allow users to program their own renaming rule.

To master Pascal Script, follow these steps:

# Learn the basic syntax and concepts of Pascal Script
# Understand the specific variables, procedures and functions that are defined within ReNamer
# Learn how to use these variables/functions/procedures in scripts

Let us see these steps in more details.

== Learn the basics ==

To learn the basics of Pascal Script, please refer to the [[ReNamer:Pascal Script:Quick guide|Pascal Script Quick Guide]].

== Types and functions ==

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

*[[ReNamer:Pascal Script:Types|Types]]
*[[ReNamer:Pascal Script:Functions|Procedures and functions]]

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

== Script cookbook ==

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

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

# [[ReNamer:Pascal Script:FileName|How to rename a file (using the FileName variable)]]
# [[ReNamer:Pascal Script:FileName Utilities|How to skip extention (basic FileName utilities)]]
# [[ReNamer:Pascal Script:WideUpperCase|How to convert the filename to ALLCAPS (the WideUpperCase function)]]
# [[ReNamer:Pascal Script:Unicode String Handling Routines|How to operate on words (Unicode string-handling routines)]]
# [[ReNamer:Pascal Script:Basic Conversion Routines|How to serialize files (basic conversion routines)]]
# [[ReNamer:Pascal Script:Initialization of variables|How to initialize variables]]
# [[ReNamer:Pascal Script:Dialogs|How to create interactive dialogs]]
# [[ReNamer:Pascal Script:FilePath|How to work with folders and paths (FilePath constant)]]
# [[ReNamer:Pascal Script:Break script execution|How to break the script execution]]
# [[ReNamer:Pascal Script:Read file content|How to read file content]]
# [[ReNamer:Pascal Script:Import functions|How to import functions]]
# [[ReNamer:Pascal Script:SplitPath|How to split file path into parts (folders, base, extension)]]

== Scripts repository ==

* Official [[ReNamer:Scripts|Scripts Repository]].
* The [http://www.den4b.com/forum/ Forum] contains several ready scripts.

Study them and adopt them for your purpose.

== Tips ==

A few quick tips:

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

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

'''Warning:''' Some of the functions are able to alter your file system (create new folders, move files, etc.). So use them with caution! Remember that scripts are executed during Preview (NOT Rename) operation. So you let the script alter your system by pressing Preview or having Auto Preview on.

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

* [[ReNamer:Scripts:Reuse variable‎|See tips how to Store/Load Set/Get Write/Read variable for later reuse]]

== External links ==

* [http://www.remobjects.com/ps RemObjects Pascal Script]
: Developers of the Pascal Script component.
* [http://www.delphibasics.co.uk/ Delphi Basics]
: Help and reference for the fundamentals of the Delphi/Pascal language.

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

ReNamer:Pascal Script:Reuse variable

2013-01-27T13:28:59Z

Stefan: Add example to use single file to store many vars/values

== --- This page is work in process! --- ==

currently i just collect here a few information and POC proof of concept code.

I want to clean up this page later.

If you want to help please do so.

== Set/Get or Write/Read or Save/Load variable values ==

If you want to store a variable to reuse the value later you can read here a few tips.

For examples you can store the last used path, folder or file name or parts of them. 
Also you may want to store an index number, or perhaps a list of the original file names.
 
 
 

There are two main techniques to store variable values: use the registry or use a temporary file on disc.

== the file approach ==

First we take a look on the file approach.

We use simple plain text files to store the variable.

=== utilized function ===

The ReNamer PascalScript functions to write and read text files are:
<source>
FileWriteContent( "FileName" , "Content" );
FileAppendContent( "FileName" , "Content" );

FileReadContent("FileName");
FileCountLines("FileName");
FileReadLine( "FileName" , LineNum );
</source>

For "FileName" you can just use a name without a path to store the file into the ReNamer folder. 
Example:
<source>
FileWriteContent( "FileName.txt" , "Content" );
FileWriteContent( ".\FileName.txt" , "Content" );
</source>

To use an full path to your ReNamer folder use the ReNamer PascalScript function "GetApplicationPath" 
Example:
<source>
FileWriteContent( WideExtractFilePath(GetApplicationPath) + "FileName.txt" , "Content" );
</source>

You can use your private temp (temporary) folder in your profile 
by using the ReNamer PascalScript function "WideGetTempPath" 
Example:
<source>
FileWriteContent( WideGetTempPath + "FileName.txt" , "Content" );
</source>

Also you can access all system environment variables by using "WideGetEnvironmentVar" 
Example:
<source>
UserName := WideGetEnvironmentVar('USERNAME');
</source>

=== script examples ===

==== Store one value to one dedicated file ====

First rule in rule list: 
(GET stored variable 'LastFolder')
<source>
var
LastFold:string;

begin
if(GetCurrentFileIndex=1)then
if(WideFileExists(WideGetTempPath +'\den4b_LastFolder.txt')) then
LastFold := FileReadContent(WideGetTempPath +'den4b_LastFolder.txt');

//check if it works:
ShowMessage(LastFold);
end.
</source>

Other rules here in between 
- 
- 
- 

Last rule in rule list: 
(SET variable 'LastFolder' to stored for later reuse)
<source>
var
ParentFold:string;

begin
if(GetCurrentFileIndex=GetTotalNumberOfFiles)then
begin
ParentFold := CalculateMetaTag(FilePath, 'File_FolderName');
FileWriteContent(WideGetTempPath + 'den4b_LastFolder.txt', ParentFold);
end;

//check if it works:
ExecuteProgram('notepad ' + WideGetTempPath + 'den4b_LastFolder.txt',false);
end.
</source>

====Store more then one value into a common file====

Note this approach is to cumbersome for real use. 
Better use dedicated file for each var/value (see above).

We can also use FileAppendContent(); to add "NAME=VALUE" pairs to an single file 
and a routine to read the lines of that common vars.txt.

Here just as proof of concept:

Last rule in rule list: 
(add a line with "NAME=VALUE" pair)
FileAppendContent('den4b_vars.txt','LastFolder=' + ParentF + #13#10);

This 'den4b_vars.txt' could look now like:
LastIndex=10
LastString=Vacation 2013
LastFolder=Translits

Other rules here in between 
- 
- 
- 

To get the wanted value i would use a code like this:

First rule in rule list: 
- read the vars.txt 
- split into lines 
- split line into 'name' and 'value' 
- check if 'name' is a wanted var name, if yes get the value 

var
vars,v:string;
Lines,CurrLine:TStringsArray;
i:integer;

begin
if(GetCurrentFileIndex=1)then
begin
if( WideFileExists('.\den4b_vars.txt') ) then
begin
vars := FileReadContent('.\den4b_vars.txt');
ShowMessage('complete content:'+#10+vars);
Lines:= WideSplitString(vars, #13#10);
if( length(Lines) > 0 ) then
begin
for i:=0 to length(Lines)-1 do
begin
CurrLine := WideSplitString(Lines[i],'=');
v := CurrLine[0];
//ShowMessage(v);
if ( WideCompareText( v, 'LastIndex' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastFolder' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
if ( WideCompareText( v, 'LastString' ) =0) then
ShowMessage( v + ' has value ' + CurrLine[1] );
end;
end;
end;
end;
end.

== the registry approach ==

=== Not recommended ! ===

Not recommended !

var
ECAreturn:string;

begin
// Add your code here

//Store/Write/Set:
ExecuteProgram('reg add HKCU\Software\den4b /v TestName1 /t REG_SZ /d "Test value 1" /f', true);

//Load/Read/Get:
ExecConsoleApp('reg query HKCU\Software\den4b /v Test6', ECAreturn);
ShowMessage(ECAreturn);
//
// ! REG.EXE VERSION 3.0
//
// HKEY_CURRENT_USER\Software\den4b
// Test6 REG_SZ gut
//
//>---more code needed here to extract the value---<
end.

-# end

ReNamer:Pascal Script:Reuse variable

2013-01-27T12:56:16Z

Stefan: just clean up a bit

== This page is work in process!==

If you want to store a variable to reuse the value later you can read here a few tips.

For examples you can store the last used path, folder or file name or parts of them. 
Also you may want to store an index number, or perhaps a list of the original file names.
 
 
 

There are two main techniques to store variable values: use the registry or use a temporary file on disc.

==First we take a look on the file approach.==

We use simple plain text files to store the variable.

The ReNamer PascalScript functions to write and read text files are:
<source>
FileWriteContent( "FileName" , "Content" );
FileAppendContent( "FileName" , "Content" );

FileReadContent("FileName");
FileCountLines("FileName");
FileReadLine( "FileName" , LineNum );
</source>

For "FileName" you can just use a name without a path to store the file into the ReNamer folder. 
Example:
<source>
FileWriteContent( "FileName.txt" , "Content" );
FileWriteContent( ".\FileName.txt" , "Content" );
</source>

To use an full path to your ReNamer folder use the ReNamer PascalScript function "GetApplicationPath" 
Example:
<source>
FileWriteContent( WideExtractFilePath(GetApplicationPath) + "FileName.txt" , "Content" );
</source>

You can use your private temp (temporary) folder in your profile 
by using the ReNamer PascalScript function "WideGetTempPath" 
Example:
<source>
FileWriteContent( WideGetTempPath + "FileName.txt" , "Content" );
</source>

Also you can access all system environment variables by using "WideGetEnvironmentVar" 
Example:
<source>
UserName := WideGetEnvironmentVar('USERNAME');
</source>

== PascalScript rule examples ==

First rule in rule list: 
(GET stored variable 'LastFolder')
<source>
var
LastFold:string;

begin
if(GetCurrentFileIndex=1)then
if(WideFileExists(WideGetTempPath +'\den4b_LastFolder.txt')) then
LastFold := FileReadContent(WideGetTempPath +'den4b_LastFolder.txt');

//check if it works:
ShowMessage(LastFold);
end.
</source>

Other rules here in between 
- 
- 
- 

Last rule in rule list: 
(SET variable 'LastFolder' to stored for later reuse)
<source>
var
ParentFold:string;

begin
if(GetCurrentFileIndex=GetTotalNumberOfFiles)then
begin
ParentFold := CalculateMetaTag(FilePath, 'File_FolderName');
FileWriteContent(WideGetTempPath + 'den4b_LastFolder.txt', ParentFold);
end;

//check if it works:
ExecuteProgram('notepad ' + WideGetTempPath + 'den4b_LastFolder.txt',false);
end.
</source>

-#

ReNamer:Pascal Script:Reuse variable

2013-01-27T12:49:28Z

Stefan: First content collection - work in process

== This page is work in process!==

If you want to store a variable to reuse the value later you can read here a few tips.

For examples you can store the last used path, folder or file name or parts of them.
Also you may want to store an index number, or perhaps a list of the original file names.

There are two main techniques to store variable values: use the registry or use a temporary file on disc.

First we take a look on the file approach.

We use simple plain text files to store the variable.

The ReNamer PascalScript functions to write and read text files are:

FileWriteContent( "FileName" , "Content" );
FileAppendContent( "FileName" , "Content" );

FileReadContent("FileName");
FileCountLines("FileName");
FileReadLine( "FileName" , LineNum );

For "FileName" you can just use a name without a path to store the file into the ReNamer folder.
Example:
FileWriteContent( "FileName.txt" , "Content" );
FileWriteContent( ".\FileName.txt" , "Content" );

To use an full path to your ReNamer folder use the ReNamer PascalScript function "GetApplicationPath"
Example:
FileWriteContent( WideExtractFilePath(GetApplicationPath) + "FileName.txt" , "Content" );

You can use your private temp (temporary) folder in your profile
by using the ReNamer PascalScript function "WideGetTempPath"
Example:
FileWriteContent( WideGetTempPath + "FileName.txt" , "Content" );

Also you can access all system environment variables by using "WideGetEnvironmentVar"
Example:
UserName := WideGetEnvironmentVar('USERNAME');

== PascalScript rule examples ==

First rule in rule list:
(GET stored variable 'LastFolder')
<source>
var
LastFold:string;

begin
if(GetCurrentFileIndex=1)then
if(WideFileExists(WideGetTempPath +'\den4b_LastFolder.txt')) then
LastFold := FileReadContent(WideGetTempPath +'den4b_LastFolder.txt');

//check if it works:
ShowMessage(LastFold);
end.
</source>

Last rule in rule list:
(SET variable 'LastFolder' to stored for later reuse)
<source>
var
ParentFold:string;

begin
if(GetCurrentFileIndex=GetTotalNumberOfFiles)then
begin
ParentFold := CalculateMetaTag(FilePath, 'File_FolderName');
FileWriteContent(WideGetTempPath + 'den4b_LastFolder.txt', ParentFold);
end;

//check if it works:
ExecuteProgram('notepad ' + WideGetTempPath + '\den4b_LastFolder.txt',false);
end.
</source>

#

ReNamer:Scripts

2013-01-27T12:09:14Z

Stefan: Add link to Get/Set variable page

{{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.
|-
| [[ReNamer:Scripts:Reuse variable|Reuse variable]]
| See techniques to store/set and to read/get variable.
|}

== 3rd party libraries ==

{| 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
|}

== 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.
|}

[[Category:ReNamer]]

ReNamer

2012-08-16T08:25:49Z

Stefan: Changes some wording about "Menus for the Files pane" for better finding

[[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}}

{{Open book|Book:ReNamer_User_Manual|Open the book and download this manual as a 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|Files Pane Menu (Files Filters Export Options)]]
*[[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]]
*[[ReNamer:Skip extension|Skip extension]]

[[Category:ReNamer]]

ReNamer:Rules:UserInput

2011-10-11T15:19:24Z

Stefan: little modification on my examples

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:PascalScript}}

[[Image:UserInputRule.png|center]]

This rule replaces the original filenames with the names taken from the list. (The ''n''th line in the list serves as the new name for the ''n''th file in the '''Files''' pane.)

Naturally, the list should contain names for all the files loaded in the '''Files''' pane.

*If the list is shorter, then some of the files will not be renamed.
*If the list is longer, some of the names will remain unused (but all files in the '''Files''' pane will be renamed).

There are three ways to create the list:

#Click in the pane, and manually type the list (one name per line).
#Copy the list from any application to your clipboard. Switch to ReNamer. Click in the '''UserInput''' pane and press '''CTRL+V''', right-click and select '''Paste''' or choose the '''Load from clipboard''' from [[Image:UserInputOptionsButton.png]] menu).
#Load a list from the text file (available from [[Image:UserInputOptionsButton.png]] menu).

The optional parameters are as follows:

{| class="wikitable"
! Parameter
! Description
|-
| Insert in front of the current name
| Inserts the name before the file name.
|-
| Insert after the current name
| Inserts the name ''after'' the current name. The actual position depends on the '''Skip extension''' option.
|-
| Replace the current name
| Replaces the existing filename with the new name.
The effect on extension depends on the '''''Skip extension''''' option:
|-
| Skip extension
|
*If the option is selected, the extension is ignored and user input strings will affect only the base name of files.
*If the option is deselected, user input strings will replace entire filename, ''including'' the extension, or will be added ''after'' the old extension (if the '''Insert after the current name''' option is selected).
|}

==Example and warning==

Warning 
The list of new names must exactly match the list of current files, one-by-one.
{| class="wikitable"
! Current Name column
! your NewName-list
|-
| Old name 1
| new name for old name 1
|-
| Old name 2
| new name for old name 2
|-
| Old name 3
| new name for old name 3
|}

Or in other words: the amount of items in your NewName list should match the current amount of items in the Name column. (see example below for clarifying)

Hint: Your NewName list must only contain the new names! 
Not the old names too, as maybe seen with other renamers like "old|new" or "old=new" or like that.

For example, if you have this three files: 
Old name 1 
Old name 2 
Old name 3 

then your NewName list should contain exactly three lines like: 
new name for old name 1 
new name for old name 2 
new name for old name 3 

Examples for clarifying: 

Example 1 
File list (Current Name) is longer then new name list:
{| class="wikitable"
! Name column
! NewName-list
|-
| One.txt
| First.txt
|-
| Two.txt
| Second.txt
|-
| Three.txt
| Third.txt
|-
| Four.txt
| <will not be renamed>
|}

Example 2 
New name list is longer then file list:
{| class="wikitable"
! Name column
! NewName-list
|-
| One.txt
| First.txt
|-
| Two.txt
| Second.txt
|-
| Three.txt
| Third.txt
|-
| <unused>
| Fourth.txt
|}

Example 3 
TAKE CARE! 
Missed item in new name list; your file names will get messed-up:
{| class="wikitable"
! Name column
! NewName-list
|-
| One.txt
| First.txt
|-
| Two.txt
| Third.txt
|-
| Three.txt
| Fourth.txt
|-
| Four.txt
| Fifth.txt
|}

[[Category:ReNamer]]

ReNamer:Rules:UserInput

2011-10-11T06:22:01Z

Stefan: Added Examples

{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:PascalScript}}

[[Image:UserInputRule.png|center]]

This rule replaces the original filenames with the names taken from the list. (The ''n''th line in the list serves as the new name for the ''n''th file in the '''Files''' pane.)

Naturally, the list should contain names for all the files loaded in the '''Files''' pane.

*If the list is shorter, then some of the files will not be renamed.
*If the list is longer, some of the names will remain unused (but all files in the '''Files''' pane will be renamed).

There are three ways to create the list:

#Click in the pane, and manually type the list (one name per line).
#Copy the list from any application to your clipboard. Switch to ReNamer. Click in the '''UserInput''' pane and press '''CTRL+V''', right-click and select '''Paste''' or choose the '''Load from clipboard''' from [[Image:UserInputOptionsButton.png]] menu).
#Load a list from the text file (available from [[Image:UserInputOptionsButton.png]] menu).

The optional parameters are as follows:

{| class="wikitable"
! Parameter
! Description
|-
| Insert in front of the current name
| Inserts the name before the file name.
|-
| Insert after the current name
| Inserts the name ''after'' the current name. The actual position depends on the '''Skip extension''' option.
|-
| Replace the current name
| Replaces the existing filename with the new name.
The effect on extension depends on the '''''Skip extension''''' option:
|-
| Skip extension
|
*If the option is selected, the extension is ignored and user input strings will affect only the base name of files.
*If the option is deselected, user input strings will replace entire filename, ''including'' the extension, or will be added ''after'' the old extension (if the '''Insert after the current name''' option is selected).
|}

==Example and warning==

Warning 
The list of new names must exactly match the list of current files, one-by-one.
{| class="wikitable"
! Current Name
! Name list
|-
| Old name 1
| new name for old name 1
|-
| Old name 2
| new name for old name 2
|-
| Old name 3
| new name for old name 3
|}

Hint: The new name list must only contain the new names! 
Not the old names too, as maybe seen with other renamers like "old|new" or "old=new" or like that.

Examples 
File list (Current Name) is longer then new name list:
{| class="wikitable"
! Current Name
! Name list
|-
| One.txt
| First.txt
|-
| Two.txt
| Second.txt
|-
| Three.txt
| Third.txt
|-
| Four.txt
| <will not be renamed>
|}

New name list is longer then file list:
{| class="wikitable"
! Current Name
! Name list
|-
| One.txt
| First.txt
|-
| Two.txt
| Second.txt
|-
| Three.txt
| Third.txt
|-
| <unused>
| Fourth.txt
|}

TAKE CARE! 
Missed item in new name list; your file names will get messed-up:
{| class="wikitable"
! Current Name
! Name list
|-
| One.txt
| First.txt
|-
| Two.txt
| Third.txt
|-
| Three.txt
| Fourth.txt
|-
| Four.txt
| Fifth.txt
|}

[[Category:ReNamer]]

ReNamer:Pascal Script:SplitPath

2011-08-18T08:29:13Z

Stefan: Corrected again an mistake (arrrrggh)

{{Cleanup}}

Find an overview of all build-in functions there >> [[ReNamer:Pascal_Script:Functions#File_Name_Utilities|File Name Utilities]].

Here on this page we show you only the needed functions to extract parts 
of the file name and how to use them in an PascalScript for ReNamer.
 

We like to show you this on an example file name 
"C:\GreatGrand\GrandParent\ParentFolder\file.ext"
 
 
 

First, there are the always available variables 'FilePath' and 'FileName' 
You don't have to declare ('var' / 'dim') or initialize ('var="";') this variables. 
Just use them, they are always there for you.

{| class="wikitable"
|-
! Variable
! provides
|-
| FilePath
| C:\GreatGrand\GrandParent\ParentFolder\file.ext
|-
| FileName
| file.ext
|}
Use this e.g. like: 
<source>
var
vExt: WideString;
begin
vExt := WideExtractFileExt(FilePath);
FileName := FileName + '.backup' + vExt;
end.
</source>
 
 
And there are this functions to extract parts: 

{| class="wikitable"
|-
! Function
! provides
|-
| WideExtractFilePath
| C:\GreatGrand\GrandParent\ParentFolder\
|-
| WideExtractFileDir
| C:\GreatGrand\GrandParent\ParentFolder
|-
| WideExtractFileDrive
| C:\
|-
| WideExtractFileName
| file.ext
|-
| WideExtractBaseName
| file
|-
| WideExtractFileExt
| .ext (dot included)
|}
 
You can fill an variable with the extracted part first 
Use this e.g. like: 
<source>
var
vPath, vDir, vDrive, vName, vBase, vExt, vE: WideString;
vOUT: WideString;
begin

//extract the parts and store them into an var each:
vPath := WideExtractFilePath(FilePath);
vDir := WideExtractFileDir(FilePath);
vDrive := WideExtractFileDrive(FilePath);
vName := WideExtractFileName(FilePath);
vBase := WideExtractBaseName(FilePath);
vExt := WideExtractFileExt(FilePath);

// Test output as MsgBox:
vOUT := 'Default build-in vars:' + #13#10
+ 'FilePath >>> ' + FilePath + #13#10
+ 'FileName >>> ' + FileName + #13#10
+ #13#10
+ 'Extracted by using functions:' + #13#10
+ 'WideExtractFilePath >>> ' + vPath + #13#10
+ 'WideExtractFileDir >>> ' + vDir + #13#10
+ 'WideExtractFileDrive >>> ' + vDrive + #13#10
+ 'WideExtractFileName >>> ' + vName + #13#10
+ 'WideExtractBaseName >>> ' + vBase + #13#10
+ 'WideExtractFileExt >>> ' + vExt;
ShowMessage( vOUT );
end.
</source>
Or just use the function 'on the fly', without using an var first 
Use this e.g. like: 
<source>
begin
FileName := FileName + '_backup' + WideExtractFileExt(FilePath);
end.
</source>
 
 
---------------------
 

But this functions didn't gave all possibilities to split an full path into all wanted parts. 
You have to know how to handle this functions and/or use own code to achieve what you want. 
 
Here are some code snippets for this issue: 
 
First we show you an 'trick' seen by Denis: 
Here we extract the path first "WideExtractFileDir(FilePath)" 
and then extract the last part, which is normal the filename, but here the parent folder "WideExtractFileName(...)" 
 
You can even use this trick more then once: 
 
(Here for our example "C:\GreatGrand\GrandParent\ParentFolder\file.ext") 
{| class="wikitable"
|-
! nested Functions
! provides the folder
|-
| WideExtractFileName(WideExtractFileDir(FilePath));
| ParentFolder
|-
| WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
| GrandParent
|-
| WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
| GreatGrand
|}
 
Use this like: 
<source>
var
ParentFolder, GrandParent, GreatGrandParent: WideString;
begin
ParentFolder := WideExtractFileName(WideExtractFileDir(FilePath));
GrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
GreatGrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
FileName := GreatGrandParent + '-' + GrandParent + '-' + ParentFolder + '-' + FileName;
end.
</source>
 
 
Other tricks: 
 
To get the extension without the dot use something like: 
<source>
vExt := WideReplaceStr(WideExtractFileExt(FilePath), '.', '');
</source>
Or showing this as step by step: 
<source>
vExt := WideExtractFileExt(FilePath);
vExt := WideReplaceStr( vExt, '.', '');
</source>
 

---------------------
 

Here is an another way to get the name of an parent folder of an path 
by splitting the path at the back slash into an array of 'Folders'. 
 
We use 
Folders: TStringsArray; 
"Folders := WideSplitString( WideExtractFileDir(FilePath), at sign '\')" 
 
to get the elements of such an path. 
Then we can access each level of parent folders 
by referring to the right element in the array. 
Note that an array start counting at '0' 
And if you try to access an array element that is not there, 
you will get an error message "Exception: Out Of Range". 
 
Again for our example "C:\GreatGrand\GrandParent\ParentFolder\file.ext" 
there are 4 elements in the array, counting from '0' to '3' 
{| class="wikitable"
|-
! Array level
! provides
|-
| Folders[0]
| C:
|-
| Folders[1]
| GreatGrand
|-
| Folders[2]
| GrandParent
|-
| Folders[3]
| ParentFolder
|}
If you not know how deep the folder hierarchy is, you may want to count from the right. 
Therefor we can utilize the max. amount of elements in an array. We use the 'Length' attribute here. 
"Length(Folders)" is '4'. But Folders[4] is for our example path "Out Of Range". 
That is why we use "Length(Folders) -1" to get '3'. 
So to get the last element in array use "Folders[ Length(Folders) -1 ]", which is here the same as "Folders[ 3 ]" 
And so we can use '-1' (4 -1 = 3) till '-4' (4 -4 = 0) for our example path. (remember: we have 4 elements, from '0' to '3'.)

{| class="wikitable"
|-
! Array level
! provides the folder
|-
| Folders[Length(Folders)-1]
| ParentFolder
|-
| Folders[Length(Folders)-2]
| GrandParent
|-
| Folders[Length(Folders)-3]
| GreatGrand
|-
| Folders[Length(Folders)-4]
| C:
|}

 
Use this like: 
<source>
var
Folders: TStringsArray;
oldPath, ParentFolder, GrandParentFolder, GrandGrandParentFolder, TopMostFolder, SecondTopMostFolder: WideString;

begin
// Get parts of the current file path:
oldPath := WideExtractFileDir(FilePath);
Folders := WideSplitString(oldPath, '\');
TopMostFolder := Folders[1];
SecondTopMostFolder := Folders[2];
GrandGrandParentFolder := Folders[Length(Folders)-3];
GrandParentFolder := Folders[Length(Folders)-2];
ParentFolder := Folders[Length(Folders)-1];

FileName := SecondTopMostFolder + '-' + GrandParentFolder + '-' + ParentFolder + '-' + FileName;
end.
</source>

Tip: 
You can use ShowMessage() like MsgBox to be prompte what the elements contains: 
<source>
ShowMessage('Debug: ' + Folders[1] + ' # ' + Folders[Length(Folders)-1] );
</source>

To loop trough each element of an part (e.g. to check if an given folder exists) 
you may take an look at this example:
<source>
var
I: Integer; Parts: TStringsArray;
begin
//function WideSplitString(const Input, Delimiter: WideString): TStringsArray;
Parts := WideSplitString(FilePath, '\');
for I:=0 to Length(Parts)-1 do
begin
// access each part via Parts[i]
end;
end.
</source>
 
---------------------
 

And you could use Regular Expression to extract the parts of an part:
<source>
Parent := ReplaceRegEx(FilePath, '.+\\(.+)\\.+', '$1', False, True);
GrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+', '$1', False, True);
GrandGrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+\\.+', '$1', False, True);
</source>

But note that RegEx is slow by its nature. But then you will see this first for more then thousand files ;-)

 
---------------------
 

You can also use Meta Tags to extract e.g. the parent folder:
<source>
ParentFolder := CalculateMetaTag(FilePath, ':File_FolderName:');
</source>

See 'Insert' Rule and click there at 'Insert Meta Tag'

 
---------------------
 

File name

To split the file name 
into parts at an given delimiter 
we can use f.ex.:

E.g. for 
FROM: 
"my fav artist - title album song.mp3" 
TO: 
"My Fav Artist - Title album song.mp3" 
Use: 
We split the file name at the dash and then modify the case different for the part before, and the part after the dash. 
<source>
var
Delimiter, Extension, Part1, Part2, Part2Char1, Part2Rest: WideString;
PosOfDelimiter: Integer;
begin
Delimiter := '-';
PosOfDelimiter := Pos(Delimiter, FileName);

if (PosOfDelimiter > 0) then
begin
Extension := WideExtractFileExt(FileName)
Part1 := WideCopy(WideExtractBaseName(FileName), 1, PosOfDelimiter -2 );
Part2 := WideCopy(WideExtractBaseName(FileName), PosOfDelimiter +2, Length(FileName) );
Part2Char1 := WideCopy(Part2, 1, 1 );
Part2Rest := WideCopy(Part2, 2, Length(Part2) -1 );

//ShowMessage('Debug: #' + Part1 + '#' + Part2 + '#' + Part2Char1 + '#' + Part2Rest + '#');

FileName := WideCaseCapitalize(Part1)
+ ' ' + Delimiter + ' '
+ WideUpperCase(Part2Char1) + WideLowerCase(Part2Rest)
+ WideUpperCase(Extension);
end;
end.
</source>

To split an file name with regular expression you can use something like this: 
Note that you have to adjust the RegEx by your needs, according to your real file names.
<source>
var
Parts: TStringsArray;
begin
Parts := SubMatchesRegEx(WideExtractBaseName(FileName), '(.)(.+_)(.+_)(.+)', FALSE);
If (Length(Parts) <=0) then exit;

FileName := WideUpperCase(Parts[0]) + Parts[1] + WideUpperCase(Parts[2]) + Parts[3] + WideExtractFileExt(FileName);
end.
</source>

Here we are using RegEx and WideCopy() to split an string into parts. 
 
For an example file name like 
"Dzenan Loncarevic - 2009 - 10 - Laura (Bonus).mp3" 
our message will look like: 
"Dzenan Loncarevic - 2009 - 10 - # Laura (Bonus).mp3"
<source>
var
Parts: TStringsArray;
Base, Part1, Part2: WideString;
begin
Base := WideExtractBaseName(FileName);

//Find last '-' by greedy RegEx:
Parts := SubMatchesRegEx(Base, '(.+-)(.+)', FALSE);
If (Length(Parts) <=0) then exit;

//Split file name into two:
Part1 := WideCopy( Base, 1 , Length(Parts[0]) );
Part2 := WideCopy( Base, Length(Parts[0]) +1, 999 );

WideShowMessage(Part1 + ' # ' + Part2 + WideExtractFileExt(FileName));
end.
</source>
How did this works? 
See yourself: 
Add to the code, right under 
If (Length(Parts) <=0) then exit; 
this two commands:
<source>
ShowMessage( Parts[0] );
ShowMessage( IntToStr( Length(Parts[0]) ) );
</source>
Or with more infos:
<source>

ShowMessage( '=' + Parts[0] + '=' + #13#10 + '=' + Parts[1] + '=' );
ShowMessage( IntToStr(Length(Parts[0])) +#13#10+ IntToStr(Length(Parts[1])) );
</source>
Hints: 
Putting the '=' -signs (or similar) around the content will let you spot additional spaces more easier. 
Since "Length(Parts[n])" will provide an number/digit, and ShowMessage() only allows chars, we have to convert 'Int-to-Chars'. 
Then you will see that 
Parts[0] will hold "Dzenan Loncarevic - 2009 - 10 -" and 
the length of this string in 'Parts[0]' is '31'. 
So we can use this info as parameter for WideCopy(). 
 
Ahh, yes: the '999' for 'Part2' just means: "give me all till the end", since an average file name is 25 chars only. Maybe '100', but not '999', isn't it? 
And with this little trick ReNamer gives me all chars till the end, no matter how many that are.

We can also use Split() to split an file name into parts:
<source>
// Swaps FileName-parts at minus-sign.pas
// FROM: "Artist - Song.mp3"
// TO: "Song - Artist.mp3"
var
Parts: TStringsArray;
SplitSign: String;
Count: integer;

begin

// sign to split the file name, e.g. for "Artist - Song.mp3" we split at ' - '
SplitSign = ' - ';

//Trick to ask the user for an delimiter. Using 'count' var to prompt only once.
//If count < 1 Then
//SplitSign := InputBox('Split FileName', 'Insert the sign where you want to split the FileName into parts:', SplitSign);
//Count := 2

// split the filename at '-' into parts:
Parts := WideSplitString(WideExtractBaseName(FileName), SplitSign);
// Note: parts are numbered in array from 0 on: 0, 1, 2, 3... So first part has the index '0'

// build your new name:
// Here: second part[1] first, then SpaceMinusSpace, then the first part[0]:
FileName := Parts[1] + ' - ' + Parts[0] + WideExtractFileExt(FileName);
end.
</source>
 
 
Please note: to split file name you can use also the Arrange Rule (see ReNamer beta and the wiki about rules) 
 
---------------------

ReNamer:Pascal Script:SplitPath

2011-08-18T08:21:50Z

Stefan: More examples how to split file name

{{Cleanup}}

Find an overview of all build-in functions there >> [[ReNamer:Pascal_Script:Functions#File_Name_Utilities|File Name Utilities]].

Here on this page we show you only the needed functions to extract parts 
of the file name and how to use them in an PascalScript for ReNamer.
 

We like to show you this on an example file name 
"C:\GreatGrand\GrandParent\ParentFolder\file.ext"
 
 
 

First, there are the always available variables 'FilePath' and 'FileName' 
You don't have to declare ('var' / 'dim') or initialize ('var="";') this variables. 
Just use them, they are always there for you.

{| class="wikitable"
|-
! Variable
! provides
|-
| FilePath
| C:\GreatGrand\GrandParent\ParentFolder\file.ext
|-
| FileName
| file.ext
|}
Use this e.g. like: 
<source>
var
vExt: WideString;
begin
vExt := WideExtractFileExt(FilePath);
FileName := FileName + '.backup' + vExt;
end.
</source>
 
 
And there are this functions to extract parts: 

{| class="wikitable"
|-
! Function
! provides
|-
| WideExtractFilePath
| C:\GreatGrand\GrandParent\ParentFolder\
|-
| WideExtractFileDir
| C:\GreatGrand\GrandParent\ParentFolder
|-
| WideExtractFileDrive
| C:\
|-
| WideExtractFileName
| file.ext
|-
| WideExtractBaseName
| file
|-
| WideExtractFileExt
| .ext (dot included)
|}
 
You can fill an variable with the extracted part first 
Use this e.g. like: 
<source>
var
vPath, vDir, vDrive, vName, vBase, vExt, vE: WideString;
vOUT: WideString;
begin

//extract the parts and store them into an var each:
vPath := WideExtractFilePath(FilePath);
vDir := WideExtractFileDir(FilePath);
vDrive := WideExtractFileDrive(FilePath);
vName := WideExtractFileName(FilePath);
vBase := WideExtractBaseName(FilePath);
vExt := WideExtractFileExt(FilePath);

// Test output as MsgBox:
vOUT := 'Default build-in vars:' + #13#10
+ 'FilePath >>> ' + FilePath + #13#10
+ 'FileName >>> ' + FileName + #13#10
+ #13#10
+ 'Extracted by using functions:' + #13#10
+ 'WideExtractFilePath >>> ' + vPath + #13#10
+ 'WideExtractFileDir >>> ' + vDir + #13#10
+ 'WideExtractFileDrive >>> ' + vDrive + #13#10
+ 'WideExtractFileName >>> ' + vName + #13#10
+ 'WideExtractBaseName >>> ' + vBase + #13#10
+ 'WideExtractFileExt >>> ' + vExt;
ShowMessage( vOUT );
end.
</source>
Or just use the function 'on the fly', without using an var first 
Use this e.g. like: 
<source>
begin
FileName := FileName + '_backup' + WideExtractFileExt(FilePath);
end.
</source>
 
 
---------------------
 

But this functions didn't gave all possibilities to split an full path into all wanted parts. 
You have to know how to handle this functions and/or use own code to achieve what you want. 
 
Here are some code snippets for this issue: 
 
First we show you an 'trick' seen by Denis: 
Here we extract the path first "WideExtractFileDir(FilePath)" 
and then extract the last part, which is normal the filename, but here the parent folder "WideExtractFileName(...)" 
 
You can even use this trick more then once: 
 
(Here for our example "C:\GreatGrand\GrandParent\ParentFolder\file.ext") 
{| class="wikitable"
|-
! nested Functions
! provides the folder
|-
| WideExtractFileName(WideExtractFileDir(FilePath));
| ParentFolder
|-
| WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
| GrandParent
|-
| WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
| GreatGrand
|}
 
Use this like: 
<source>
var
ParentFolder, GrandParent, GreatGrandParent: WideString;
begin
ParentFolder := WideExtractFileName(WideExtractFileDir(FilePath));
GrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
GreatGrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
FileName := GreatGrandParent + '-' + GrandParent + '-' + ParentFolder + '-' + FileName;
end.
</source>
 
 
Other tricks: 
 
To get the extension without the dot use something like: 
<source>
vExt := WideReplaceStr(WideExtractFileExt(FilePath), '.', '');
</source>
Or showing this as step by step: 
<source>
vExt := WideExtractFileExt(FilePath);
vExt := WideReplaceStr( vExt, '.', '');
</source>
 

---------------------
 

Here is an another way to get the name of an parent folder of an path 
by splitting the path at the back slash into an array of 'Folders'. 
 
We use 
Folders: TStringsArray; 
"Folders := WideSplitString( WideExtractFileDir(FilePath), at sign '\')" 
 
to get the elements of such an path. 
Then we can access each level of parent folders 
by referring to the right element in the array. 
Note that an array start counting at '0' 
And if you try to access an array element that is not there, 
you will get an error message "Exception: Out Of Range". 
 
Again for our example "C:\GreatGrand\GrandParent\ParentFolder\file.ext" 
there are 4 elements in the array, counting from '0' to '3' 
{| class="wikitable"
|-
! Array level
! provides
|-
| Folders[0]
| C:
|-
| Folders[1]
| GreatGrand
|-
| Folders[2]
| GrandParent
|-
| Folders[3]
| ParentFolder
|}
If you not know how deep the folder hierarchy is, you may want to count from the right. 
Therefor we can utilize the max. amount of elements in an array. We use the 'Length' attribute here. 
"Length(Folders)" is '4'. But Folders[4] is for our example path "Out Of Range". 
That is why we use "Length(Folders) -1" to get '3'. 
So to get the last element in array use "Folders[ Length(Folders) -1 ]", which is here the same as "Folders[ 3 ]" 
And so we can use '-1' (4 -1 = 3) till '-4' (4 -4 = 0) for our example path. (remember: we have 4 elements, from '0' to '3'.)

{| class="wikitable"
|-
! Array level
! provides the folder
|-
| Folders[Length(Folders)-1]
| ParentFolder
|-
| Folders[Length(Folders)-2]
| GrandParent
|-
| Folders[Length(Folders)-3]
| GreatGrand
|-
| Folders[Length(Folders)-4]
| C:
|}

 
Use this like: 
<source>
var
Folders: TStringsArray;
oldPath, ParentFolder, GrandParentFolder, GrandGrandParentFolder, TopMostFolder, SecondTopMostFolder: WideString;

begin
// Get parts of the current file path:
oldPath := WideExtractFileDir(FilePath);
Folders := WideSplitString(oldPath, '\');
TopMostFolder := Folders[1];
SecondTopMostFolder := Folders[2];
GrandGrandParentFolder := Folders[Length(Folders)-3];
GrandParentFolder := Folders[Length(Folders)-2];
ParentFolder := Folders[Length(Folders)-1];

FileName := SecondTopMostFolder + '-' + GrandParentFolder + '-' + ParentFolder + '-' + FileName;
end.
</source>

Tip: 
You can use ShowMessage() like MsgBox to be prompte what the elements contains: 
<source>
ShowMessage('Debug: ' + Folders[1] + ' # ' + Folders[Length(Folders)-1] );
</source>

To loop trough each element of an part (e.g. to check if an given folder exists) 
you may take an look at this example:
<source>
var
I: Integer; Parts: TStringsArray;
begin
//function WideSplitString(const Input, Delimiter: WideString): TStringsArray;
Parts := WideSplitString(FilePath, '\');
for I:=0 to Length(Parts)-1 do
begin
// access each part via Parts[i]
end;
end.
</source>
 
---------------------
 

And you could use Regular Expression to extract the parts of an part:
<source>
Parent := ReplaceRegEx(FilePath, '.+\\(.+)\\.+', '$1', False, True);
GrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+', '$1', False, True);
GrandGrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+\\.+', '$1', False, True);
</source>

But note that RegEx is slow by its nature. But then you will see this first for more then thousand files ;-)

 
---------------------
 

You can also use Meta Tags to extract e.g. the parent folder:
<source>
ParentFolder := CalculateMetaTag(FilePath, ':File_FolderName:');
</source>

See 'Insert' Rule and click there at 'Insert Meta Tag'

 
---------------------
 

File name

To split the file name 
into parts at an given delimiter 
we can use f.ex.:

E.g. for 
FROM: 
"my fav artist - title album song.mp3" 
TO: 
"My Fav Artist - Title album song.mp3" 
Use: 
We split the file name at the dash and then modify the case different for the part before, and the part after the dash. 
<source>
var
Delimiter, Extension, Part1, Part2, Part2Char1, Part2Rest: WideString;
PosOfDelimiter: Integer;
begin
Delimiter := '-';
PosOfDelimiter := Pos(Delimiter, FileName);

if (PosOfDelimiter > 0) then
begin
Extension := WideExtractFileExt(FileName)
Part1 := WideCopy(WideExtractBaseName(FileName), 1, PosOfDelimiter -2 );
Part2 := WideCopy(WideExtractBaseName(FileName), PosOfDelimiter +2, Length(FileName) );
Part2Char1 := WideCopy(Part2, 1, 1 );
Part2Rest := WideCopy(Part2, 2, Length(Part2) -1 );

//ShowMessage('Debug: #' + Part1 + '#' + Part2 + '#' + Part2Char1 + '#' + Part2Rest + '#');

FileName := WideCaseCapitalize(Part1)
+ ' ' + Delimiter + ' '
+ WideUpperCase(Part2Char1) + WideLowerCase(Part2Rest)
+ WideUpperCase(Extension);
end;
end.
</source>

To split an file name with regular expression you can use something like this: 
Note that you have to adjust the RegEx by your needs, according to your real file names.
<source>
var
Parts: TStringsArray;
begin
Parts := SubMatchesRegEx(WideExtractBaseName(FileName), '(.)(.+_)(.+_)(.+)', FALSE);
If (Length(Parts) <=0) then exit;

FileName := WideUpperCase(Parts[0]) + Parts[1] + WideUpperCase(Parts[2]) + Parts[3] + WideExtractFileExt(FileName);
end.
</source>

Here we are using RegEx and WideCopy() to split an string into parts. 
 
For an example file name like 
"Dzenan Loncarevic - 2009 - 10 - Laura (Bonus).mp3" 
our message will look like: 
"Dzenan Loncarevic - 2009 - 10 - # Laura (Bonus).mp3"
<source>
var
Parts: TStringsArray;
Base, Part1, Part2: WideString;
begin
Base := WideExtractBaseName(FileName);

//Find last '-' by greedy RegEx:
Parts := SubMatchesRegEx(Base, '(.+-)(.+)', FALSE);
If (Length(Parts) <=0) then exit;

//Split file name into two:
Part1 := WideCopy( Base, 1 , Length(Parts[0]) );
Part2 := WideCopy( Base, Length(Parts[0]) +1, 999 );

WideShowMessage(Part1 + ' # ' + Part2 + WideExtractFileExt(FileName));
end.
</source>
How did this works? 
See yourself: 
Add to the code, right under 
If (Length(Parts) <=0) then exit; 
this two commands:
<source>
ShowMessage( Parts[0] );
ShowMessage( IntToStr( Length(Parts[0]) ) );
</source>
Or with more infos:
<source>

ShowMessage( '=' + Parts[0] + '=' + #13#10 + '=' + Parts[1] + '=' );
ShowMessage( IntToStr(Length(Parts[0])) +#13#10+ IntToStr(Length(Parts[1])) );
</source>
Hints: 
Putting the '=' -signs (or similar) around the content will let you spot additional spaces more easier. 
Since "Length(Parts[n])" will provide an number/digit, and ShowMessage() only allows chars, we have to convert 'Int-to-Chars'. 
Then you will see that 
Parts[0] will hold "Dzenan Loncarevic - 2009 - 10 -" and 
the length of this string in 'Parts[0]' is '31'. 
So we can use this info as parameter for WideCopy(). 
 
Ahh, yes: the '999' for 'Part2' just means: "give me all till the end", since an average file name is 25 chars only. Maybe '100', but not '999', isn't it? 
And with this little trick ReNamer gives me all chars till the end, no matter how many that are.

We can also use Split() to split an file name into parts:
<source>
// Swaps FileName-parts at minus-sign.pas
// FROM: "Artist - Song.mp3"
// TO: "Song - Artist.mp3"
var
Parts: TStringsArray;
SplitSign: String;
Count: integer;

begin

// sign to split the file name, e.g. for "Artist - Song.mp3" we split at ' - '
SplitSign = ' - ';

//Trick to ask the user for an delimiter. Using 'count' var to prompt only once.
//If count < 1 Then
//SplitSign := InputBox('Split FileName', 'Insert the sign where you want to split the FileName into parts:', SplitSign);
//Count := 2

// split the filename at '-' into parts:
Parts := WideSplitString(WideExtractBaseName(FileName), vUserInput);
// Note: parts are numbered in array from 0 on: 0, 1, 2, 3... So first part has the index '0'

// build your new name:
// Here: second part[1] first, then SpaceMinusSpace, then the first part[0]:
FileName := Parts[1] + ' - ' + Parts[0] + WideExtractFileExt(FileName);
end.
</source>
 
 
Please note: to split file name you can use also the Arrange Rule (see ReNamer beta and the wiki about rules) 
 
---------------------

ReNamer:Pascal Script:SplitPath

2011-08-18T06:47:39Z

Stefan: "~~~" was expanded to "Stefan"

ReNamer:Pascal Script:SplitPath

2011-08-18T06:45:16Z

Stefan: First clean up. Then more examples.

{{Cleanup}}

Find an overview of all build-in functions there >> [[ReNamer:Pascal_Script:Functions#File_Name_Utilities|File Name Utilities]].

Here on this page we show you only the needed functions to extract parts 
of the file name and how to use them in an PascalScript for ReNamer.
 

We like to show you this on an example file name 
"C:\GreatGrand\GrandParent\ParentFolder\file.ext"
 
 
 

First, there are the always available variables 'FilePath' and 'FileName' 
You don't have to declare ('var' / 'dim') or initialize ('var="";') this variables. 
Just use them, they are always there for you.

{| class="wikitable"
|-
! Variable
! provides
|-
| FilePath
| C:\GreatGrand\GrandParent\ParentFolder\file.ext
|-
| FileName
| file.ext
|}
Use this e.g. like: 
<source>
var
vExt: WideString;
begin
vExt := WideExtractFileExt(FilePath);
FileName := FileName + '.backup' + vExt;
end.
</source>
 
 
And there are this functions to extract parts: 

{| class="wikitable"
|-
! Function
! provides
|-
| WideExtractFilePath
| C:\GreatGrand\GrandParent\ParentFolder\
|-
| WideExtractFileDir
| C:\GreatGrand\GrandParent\ParentFolder
|-
| WideExtractFileDrive
| C:\
|-
| WideExtractFileName
| file.ext
|-
| WideExtractBaseName
| file
|-
| WideExtractFileExt
| .ext (dot included)
|}
 
You can fill an variable with the extracted part first 
Use this e.g. like: 
<source>
var
vPath, vDir, vDrive, vName, vBase, vExt, vE: WideString;
vOUT: WideString;
begin

//extract the parts and store them into an var each:
vPath := WideExtractFilePath(FilePath);
vDir := WideExtractFileDir(FilePath);
vDrive := WideExtractFileDrive(FilePath);
vName := WideExtractFileName(FilePath);
vBase := WideExtractBaseName(FilePath);
vExt := WideExtractFileExt(FilePath);

// Test output as MsgBox:
vOUT := 'Default build-in vars:' + #13#10
+ 'FilePath >>> ' + FilePath + #13#10
+ 'FileName >>> ' + FileName + #13#10
+ #13#10
+ 'Extracted by using functions:' + #13#10
+ 'WideExtractFilePath >>> ' + vPath + #13#10
+ 'WideExtractFileDir >>> ' + vDir + #13#10
+ 'WideExtractFileDrive >>> ' + vDrive + #13#10
+ 'WideExtractFileName >>> ' + vName + #13#10
+ 'WideExtractBaseName >>> ' + vBase + #13#10
+ 'WideExtractFileExt >>> ' + vExt;
ShowMessage( vOUT );
end.
</source>
Or just use the function 'on the fly', without using an var first 
Use this e.g. like: 
<source>
begin
FileName := FileName + '_backup' + WideExtractFileExt(FilePath);
end.
</source>
 
 
---------------------
 

But this functions didn't gave all possibilities to split an full path into all wanted parts. 
You have to know how to handle this functions and/or use own code to achieve what you want. 
 
Here are some code snippets for this issue: 
 
First we show you an 'trick' seen by Denis: 
Here we extract the path first "WideExtractFileDir(FilePath)" 
and then extract the last part, which is normal the filename, but here the parent folder "WideExtractFileName(...)" 
 
You can even use this trick more then once: 
 
(Here for our example "C:\GreatGrand\GrandParent\ParentFolder\file.ext") 
{| class="wikitable"
|-
! nested Functions
! provides the folder
|-
| WideExtractFileName(WideExtractFileDir(FilePath));
| ParentFolder
|-
| WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
| GrandParent
|-
| WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
| GreatGrand
|}
 
Use this like: 
<source>
var
ParentFolder, GrandParent, GreatGrandParent: WideString;
begin
ParentFolder := WideExtractFileName(WideExtractFileDir(FilePath));
GrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
GreatGrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
FileName := GreatGrandParent + '-' + GrandParent + '-' + ParentFolder + '-' + FileName;
end.
</source>
 
 
Other tricks: 
 
To get the extension without the dot use something like: 
<source>
vExt := WideReplaceStr(WideExtractFileExt(FilePath), '.', '');
</source>
Or showing this as step by step: 
<source>
vExt := WideExtractFileExt(FilePath);
vExt := WideReplaceStr( vExt, '.', '');
</source>
 

---------------------
 

Here is an another way to get the name of an parent folder of an path 
by splitting the path at the back slash into an array of 'Folders'. 
 
We use 
Folders: TStringsArray; 
"Folders := WideSplitString( WideExtractFileDir(FilePath), at sign '\')" 
 
to get the elements of such an path. 
Then we can access each level of parent folders 
by referring to the right element in the array. 
Note that an array start counting at '0' 
And if you try to access an array element that is not there, 
you will get an error message "Exception: Out Of Range". 
 
Again for our example "C:\GreatGrand\GrandParent\ParentFolder\file.ext" 
there are 4 elements in the array, counting from '0' to '3' 
{| class="wikitable"
|-
! Array level
! provides
|-
| Folders[0]
| C:
|-
| Folders[1]
| GreatGrand
|-
| Folders[2]
| GrandParent
|-
| Folders[3]
| ParentFolder
|}
If you not know how deep the folder hierarchy is, you may want to count from the right. 
Therefor we can utilize the max. amount of elements in an array. We use the 'Length' attribute here. 
"Length(Folders)" is '4'. But Folders[4] is for our example path "Out Of Range". 
That is why we use "Length(Folders) -1" to get '3'. 
So to get the last element in array use "Folders[ Length(Folders) -1 ]", which is here the same as "Folders[ 3 ]" 
And so we can use '-1' (4 -1 = 3) till '-4' (4 -4 = 0) for our example path. (remember: we have 4 elements, from '0' to '3'.)

{| class="wikitable"
|-
! Array level
! provides the folder
|-
| Folders[Length(Folders)-1]
| ParentFolder
|-
| Folders[Length(Folders)-2]
| GrandParent
|-
| Folders[Length(Folders)-3]
| GreatGrand
|-
| Folders[Length(Folders)-4]
| C:
|}

 
Use this like: 
<source>
var
Folders: TStringsArray;
oldPath, ParentFolder, GrandParentFolder, GrandGrandParentFolder, TopMostFolder, SecondTopMostFolder: WideString;

begin
// Get parts of the current file path:
oldPath := WideExtractFileDir(FilePath);
Folders := WideSplitString(oldPath, '\');
TopMostFolder := Folders[1];
SecondTopMostFolder := Folders[2];
GrandGrandParentFolder := Folders[Length(Folders)-3];
GrandParentFolder := Folders[Length(Folders)-2];
ParentFolder := Folders[Length(Folders)-1];

FileName := SecondTopMostFolder + '-' + GrandParentFolder + '-' + ParentFolder + '-' + FileName;
end.
</source>

Tip: 
You can use ShowMessage() like MsgBox to be prompte what the elements contains: 
<source>
ShowMessage('Debug: ' + Folders[1] + ' # ' + Folders[Length(Folders)-1] );
</source>

To loop trough each element of an part (e.g. to check if an given folder exists) 
you may take an look at this example:
<source>
var
I: Integer; Parts: TStringsArray;
begin
//function WideSplitString(const Input, Delimiter: WideString): TStringsArray;
Parts := WideSplitString(FilePath, '\');
for I:=0 to Length(Parts)-1 do
begin
// access each part via Parts[i]
end;
end.
</source>
 
---------------------
 

And you could use Regular Expression to extract the parts of an part:
<source>
Parent := ReplaceRegEx(FilePath, '.+\\(.+)\\.+', '$1', False, True);
GrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+', '$1', False, True);
GrandGrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+\\.+', '$1', False, True);
</source>

But note that RegEx is slow by its nature. But then you will see this first for more then thousand files ;-)

 
---------------------
 

You can also use Meta Tags to extract e.g. the parent folder:
<source>
ParentFolder := CalculateMetaTag(FilePath, ':File_FolderName:');
</source>

See 'Insert' Rule and click there at 'Insert Meta Tag'

 
---------------------
 

File name

To split the file name 
into parts at an given delimiter 
we can use f.ex.:

E.g. for 
FROM: 
"my fav artist - title album song.mp3" 
TO: 
"My Fav Artist - Title album song.mp3" 
Use: 
We split the file name at the dash and then modify the case different for the part before, and the part after the dash. 
<source>
var
Delimiter, Extension, Part1, Part2, Part2Char1, Part2Rest: WideString;
PosOfDelimiter: Integer;
begin
Delimiter := '-';
PosOfDelimiter := Pos(Delimiter, FileName);

if (PosOfDelimiter > 0) then
begin
Extension := WideExtractFileExt(FileName)
Part1 := WideCopy(WideExtractBaseName(FileName), 1, PosOfDelimiter -2 );
Part2 := WideCopy(WideExtractBaseName(FileName), PosOfDelimiter +2, Length(FileName) );
Part2Char1 := WideCopy(Part2, 1, 1 );
Part2Rest := WideCopy(Part2, 2, Length(Part2) -1 );

//ShowMessage('Debug: #' + Part1 + '#' + Part2 + '#' + Part2Char1 + '#' + Part2Rest + '#');

FileName := WideCaseCapitalize(Part1)
+ ' ' + Delimiter + ' '
+ WideUpperCase(Part2Char1) + WideLowerCase(Part2Rest)
+ WideUpperCase(Extension);
end;
end.
</source>

To split an file name with regular expression you can use something like this: 
Note that you have to adjust the RegEx by your needs, according to your real file names.
<source>
var
Parts: TStringsArray;
begin
Parts := SubMatchesRegEx(WideExtractBaseName(FileName), '(.)(.+_)(.+_)(.+)', FALSE);
If (Length(Parts) <=0) then exit;

FileName := WideUpperCase(Parts[0]) + Parts[1] + WideUpperCase(Parts[2]) + Parts[3] + WideExtractFileExt(FileName);
end.
</source>

Here we are using RegEx and WideCopy() to split an string into parts. 
 
For an example file name like 
"Dzenan Loncarevic - 2009 - 10 - Laura (Bonus).mp3" 
our message will look like: 
"Dzenan Loncarevic - 2009 - 10 - [[User:Stefan|Stefan]] Laura (Bonus).mp3"
<source>
var
Parts: TStringsArray;
Base, Part1, Part2: WideString;
begin
Base := WideExtractBaseName(FileName);

//Find last '-' by greedy RegEx:
Parts := SubMatchesRegEx(Base, '(.+-)(.+)', FALSE);
If (Length(Parts) <=0) then exit;

//Split file name into two:
Part1 := WideCopy( Base, 1 , Length(Parts[0]) );
Part2 := WideCopy( Base, Length(Parts[0]) +1, 999 );

WideShowMessage(Part1 + ' ~~~ ' + Part2 + WideExtractFileExt(FileName));
end.
</source>
 
---------------------

ReNamer:Pascal Script:SplitPath

2011-08-17T19:56:03Z

Stefan: Arrrghh, another little glitch.

ReNamer:Pascal Script:SplitPath

2011-08-17T19:40:21Z

Stefan: Clean up

Talk:ReNamer:Pascal Script:SplitPath

2011-08-17T19:00:30Z

Stefan: Created page with "What have to cleaned up? Should i do smtg?"

What have to cleaned up? Should i do smtg?

ReNamer:Pascal Script:SplitPath

2011-08-17T07:50:46Z

Stefan: Add another example code how to use functions

Find the build-in functions there > http://www.den4b.com/wiki/ReNamer:Pascal_Script:Functions#File_Name_Utilities

That are:

For e.g. "C:\GreatGrand\GrandParent\ParentFolder\file.ext"

The always available variable 'FilePath' and 'FileName': 

{| class="wikitable"
|-
! Variable
! provides
|-
| FilePath
| C:\GreatGrand\GrandParent\ParentFolder\file.ext
|-
| FileName
| file.ext
|}

 
And this functions to extract parts: 
{| class="wikitable"
|-
! Function
! provides
|-
| WideExtractFilePath
| C:\GreatGrand\GrandParent\ParentFolder\
|-
| WideExtractFileDir
| C:\GreatGrand\GrandParent\ParentFolder
|-
| WideExtractFileDrive
| C:\
|-
| WideExtractFileName
| file.ext
|-
| WideExtractBaseName
| file
|-
| WideExtractFileExt
| ext
|}
 
 
Use this e.g. like: 
 
<source>
var
vPath, vDir, vDrive, vName, vBase, vExt, vE: WideString;
vOUT: WideString;
begin

//extract the parts and store them into an var each:
vPath := WideExtractFilePath(FilePath);
vDir := WideExtractFileDir(FilePath);
vDrive := WideExtractFileDrive(FilePath);
vName := WideExtractFileName(FilePath);
vBase := WideExtractBaseName(FilePath);
vExt := WideExtractFileExt(FilePath);
vE := WideReplaceStr( vExt, '.', '');

// Test output as MsgBox:
vOUT := 'Default build-in vars:' + #13#10
+ 'FilePath >>> ' + FilePath + #13#10
+ 'FileName >>> ' + FileName + #13#10
+ #13#10
+ 'Extracted by using functions:' + #13#10
+ 'WideExtractFileDrive >>> '+ vDrive + #13#10
+ 'WideExtractFileDir >>> ' + vDir + #13#10
+ 'WideExtractFilePath >>> ' + vPath + #13#10
+ 'WideExtractFileName >>> ' + vName + #13#10
+ 'WideExtractBaseName >>> ' + vBase + #13#10
+ 'WideExtractFileExt >>> ' + vExt + #13#10
+ 'And without the dot >>> ' + vE;
ShowMessage( vOUT );
end.
</source>
 
 
---------------------
 

But this functions didn't gave all possibilities to split an full path into all wanted parts. 
You have to know how to handle this functions and/or use own code to achieve what you want. 
 
Here are some code snippets for this issue: 
 
First an 'trick' seen by Denis: 
{| class="wikitable"
|-
! nested Functions
! provides
|-
| WideExtractFileName(WideExtractFileDir(FilePath));
| ParentFolder
|-
| WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
| GrandParent
|-
| WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
| GreatGrand
|}

 
Use this like: 
 

<source>
var
ParentFolder, GrandParent, GreatGrandParent: WideString;
begin
ParentFolder := WideExtractFileName(WideExtractFileDir(FilePath));
GrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
GreatGrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
FileName := GreatGrandParent +'-'+GrandParent + '-'+ParentFolder + '-' + FileName;
end.
</source>
 

---------------------
 

Here is an another way by splitting the path at the back slash into an array 'Folders':

<source>
var
Folders: TStringsArray;
oldPath, ParentFolder, GrandParentFolder, GrandGrandParentFolder, TopMostFolder, SecondTopMostFolder: WideString;

begin

// Get parts of the current file path:
oldPath := WideExtractFileDir(FilePath);
Folders := WideSplitString(oldPath, '\');
TopMostFolder := Folders[1];
SecondTopMostFolder := Folders[2];
GrandGrandParentFolder := Folders[Length(Folders)-3];
GrandParentFolder := Folders[Length(Folders)-2];
ParentFolder := Folders[Length(Folders)-1];

FileName := SecondTopMostFolder +'-'+GrandParent + '-'+ParentFolder + '-' + FileName;
end.
</source>

 
---------------------
 

And there is Regular Expression to extract the parts:

<source>
Parent := ReplaceRegEx(FilePath, '.+\\(.+)\\.+', '$1', False, True);
GrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+', '$1', False, True);
GrandGrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+\\.+', '$1', False, True);
</source>

But note that RegEx is slow by its nature.

 
---------------------
 

And there are Meta Tags to extract e.g. the parent folder

<source>
ParentFolder := CalculateMetaTag(FilePath, ':File_FolderName:');
</source>

See 'Insert' Rule and click there at 'Insert Meta Tag'

 
---------------------
 

To split file name into parts at an delimiter we can use f.ex.:

E.g. for 
FROM: 
"my fav artist - title album song.mp3" 
TO: 
"My Fav Artist - Title album song.mp3" 
Use: 
<source>
var
Delimiter, Extension, Part1, Part2, Part2Char1, Part2Rest: WideString;
PosOfDelimiter: Integer;
begin
Delimiter := '-';
PosOfDelimiter := Pos(Delimiter, FileName);

if (PosOfDelimiter > 0) then
begin
Extension := WideExtractFileExt(FileName)
Part1 := WideCopy(WideExtractBaseName(FileName), 1, PosOfDelimiter -2);
Part2 := WideCopy(WideExtractBaseName(FileName), PosOfDelimiter +2, Length(FileName));
Part2Char1 := WideCopy(Part2, 1, 1);
Part2Rest := WideCopy(Part2, 2, Length(Part2)-1);

//ShowMessage('Debug: #' + Part1 + '#' + Part2 + '#' + Part2Char1 + '#' + Part2Rest + '#');

FileName := WideCaseCapitalize(Part1)
+ ' ' + Delimiter + ' '
+ WideUpperCase(Part2Char1) + WideLowerCase(Part2Rest)
+ WideUpperCase(Extension);
end;
end.
</source>

 
---------------------

ReNamer:Pascal Script:SplitPath

2011-08-17T07:15:19Z

Stefan: Tried some formating :-(

Find the build-in functions there > http://www.den4b.com/wiki/ReNamer:Pascal_Script:Functions#File_Name_Utilities

That are:

For e.g. "C:\GreatGrand\GrandParent\ParentFolder\file.ext"

The always available variable 'FilePath' and 'FileName': 

{| class="wikitable"
|-
! Variable
! provides
|-
| FilePath
| C:\GreatGrand\GrandParent\ParentFolder\file.ext
|-
| FileName
| file.ext
|}

 
And this functions to extract parts: 
{| class="wikitable"
|-
! Function
! provides
|-
| WideExtractFilePath
| C:\GreatGrand\GrandParent\ParentFolder\
|-
| WideExtractFileDir
| C:\GreatGrand\GrandParent\ParentFolder
|-
| WideExtractFileDrive
| C:\
|-
| WideExtractFileName
| file.ext
|-
| WideExtractBaseName
| file
|-
| WideExtractFileExt
| ext
|}
 
---------------------
 

But this functions didn't gave all possibilities to split an full path into all wanted parts. 
You have to know how to handle this functions and/or use own code to achieve what you want. 
 
Here are some code snippets for this issue: 
 
First an 'trick' seen by Denis: 
{| class="wikitable"
|-
! nested Functions
! provides
|-
| WideExtractFileName(WideExtractFileDir(FilePath));
| ParentFolder
|-
| WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
| GrandParent
|-
| WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
| GreatGrand
|}

 
Use this like: 
 

<source>
var
ParentFolder, GrandParent, GreatGrandParent: WideString;
begin
ParentFolder := WideExtractFileName(WideExtractFileDir(FilePath));
GrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
GreatGrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
FileName := GreatGrandParent +'-'+GrandParent + '-'+ParentFolder + '-' + FileName;
end.
</source>
 

---------------------
 

Here is an another way by splitting the path at the back slash into an array 'Folders':

<source>
var
Folders: TStringsArray;
oldPath, ParentFolder, GrandParentFolder, GrandGrandParentFolder, TopMostFolder, SecondTopMostFolder: WideString;

begin

// Get parts of the current file path:
oldPath := WideExtractFileDir(FilePath);
Folders := WideSplitString(oldPath, '\');
TopMostFolder := Folders[1];
SecondTopMostFolder := Folders[2];
GrandGrandParentFolder := Folders[Length(Folders)-3];
GrandParentFolder := Folders[Length(Folders)-2];
ParentFolder := Folders[Length(Folders)-1];

FileName := SecondTopMostFolder +'-'+GrandParent + '-'+ParentFolder + '-' + FileName;
end.
</source>

 
---------------------
 

And there is Regular Expression to extract the parts:

<source>
Parent := ReplaceRegEx(FilePath, '.+\\(.+)\\.+', '$1', False, True);
GrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+', '$1', False, True);
GrandGrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+\\.+', '$1', False, True);
</source>

But note that RegEx is slow by its nature.

 
---------------------
 

And there are Meta Tags to extract e.g. the parent folder

<source>
ParentFolder := CalculateMetaTag(FilePath, ':File_FolderName:');
</source>

See 'Insert' Rule and click there at 'Insert Meta Tag'

 
---------------------
 

To split file name into parts at an delimiter we can use f.ex.:

E.g. for 
FROM: 
"my fav artist - title album song.mp3" 
TO: 
"My Fav Artist - Title album song.mp3" 
Use: 
<source>
var
Delimiter, Extension, Part1, Part2, Part2Char1, Part2Rest: WideString;
PosOfDelimiter: Integer;
begin
Delimiter := '-';
PosOfDelimiter := Pos(Delimiter, FileName);

if (PosOfDelimiter > 0) then
begin
Extension := WideExtractFileExt(FileName)
Part1 := WideCopy(WideExtractBaseName(FileName), 1, PosOfDelimiter -2);
Part2 := WideCopy(WideExtractBaseName(FileName), PosOfDelimiter +2, Length(FileName));
Part2Char1 := WideCopy(Part2, 1, 1);
Part2Rest := WideCopy(Part2, 2, Length(Part2)-1);

//ShowMessage('Debug: #' + Part1 + '#' + Part2 + '#' + Part2Char1 + '#' + Part2Rest + '#');

FileName := WideCaseCapitalize(Part1)
+ ' ' + Delimiter + ' '
+ WideUpperCase(Part2Char1) + WideLowerCase(Part2Rest)
+ WideUpperCase(Extension);
end;
end.
</source>

 
---------------------

ReNamer:Pascal Script:SplitPath

2011-08-17T06:46:43Z

Stefan: Add some examples to split path and file into parts

Find the build-in functions there > http://www.den4b.com/wiki/ReNamer:Pascal_Script:Functions#File_Name_Utilities

That are:

For "C:\GreatGrand\GrandParent\ParentFolder\file.ext"

The always available variable 'FilePath' and 'FileName':
* FilePath > C:\GreatGrand\GrandParent\ParentFolder\file.ext
* FileName > file.ext

And this functions to extract parts:
* WideExtractFilePath ==> C:\GreatGrand\GrandParent\ParentFolder\
* WideExtractFileDir ==> C:\GreatGrand\GrandParent\ParentFolder
* WideExtractFileDrive ==> C:\
* WideExtractFileName ==> file.ext
* WideExtractBaseName ==> file
* WideExtractFileExt ===> ext
 
---------------------
 
But this functions didn't gave all possibilities to split an full path into all wanted parts. 
You have to know how to handle this functions and/or use own code to achieve what you want. 
Here are some code snippets for this issue: 
 
First an 'trick' seen by Denis: 
* WideExtractFileName(WideExtractFileDir(FilePath)); ==> ParentFolder
* WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath))); ==> GrandParent
* WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath)))); ==> GreatGrand

 
Use this like: 
 

<source>
var
ParentFolder, GrandParent, GreatGrandParent: WideString;
begin
ParentFolder := WideExtractFileName(WideExtractFileDir(FilePath));
GrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(FilePath)));
GreatGrandParent := WideExtractFileName(WideExtractFileDir(WideExtractFileDir(WideExtractFileDir(FilePath))));
FileName := GreatGrandParent +'-'+GrandParent + '-'+ParentFolder + '-' + FileName;
end.
</source>
 

---------------------

Here is an another way by splitting the path at the back slash into an array 'Folders':

<source>
var
Folders: TStringsArray;
oldPath, ParentFolder, GrandParentFolder, GrandGrandParentFolder, TopMostFolder, SecondTopMostFolder: WideString;

begin

// Get parts of the current file path:
oldPath := WideExtractFileDir(FilePath);
Folders := WideSplitString(oldPath, '\');
TopMostFolder := Folders[1];
SecondTopMostFolder := Folders[2];
GrandGrandParentFolder := Folders[Length(Folders)-3];
GrandParentFolder := Folders[Length(Folders)-2];
ParentFolder := Folders[Length(Folders)-1];

FileName := SecondTopMostFolder +'-'+GrandParent + '-'+ParentFolder + '-' + FileName;
end.
</source>

---------------------

And there is Regular Expression to extract the parts:

<source>
Parent := ReplaceRegEx(FilePath, '.+\\(.+)\\.+', '$1', False, True);
GrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+', '$1', False, True);
GrandGrandPa := ReplaceRegEx(FilePath, '.+\\(.+)\\.+\\.+\\.+', '$1', False, True);
</source>

But note that RegEx is slow by its nature.

---------------------

And there are Meta Tags to extract e.g. the parent folder

<source>
ParentFolder := CalculateMetaTag(FilePath, ':File_FolderName:');
</source>

See 'Insert' Rule and click there at 'Insert Meta Tag'

---------------------

To split file name into parts at an delimiter we can use f.ex.:

E.g. for 
FROM: 
"my fav artist - title album song.mp3" 
TO: 
"My Fav Artist - Title album song.mp3" 
Use: 
<source>
var
Delimiter, Extension, Part1, Part2, Part2Char1, Part2Rest: WideString;
PosOfDelimiter: Integer;
begin
Delimiter := '-';
PosOfDelimiter := Pos(Delimiter, FileName);

if (PosOfDelimiter > 0) then
begin
Extension := WideExtractFileExt(FileName)
Part1 := WideCopy(WideExtractBaseName(FileName), 1, PosOfDelimiter -2);
Part2 := WideCopy(WideExtractBaseName(FileName), PosOfDelimiter +2, Length(FileName));
Part2Char1 := WideCopy(Part2, 1, 1);
Part2Rest := WideCopy(Part2, 2, Length(Part2)-1);

//ShowMessage('Debug: #' + Part1 + '#' + Part2 + '#' + Part2Char1 + '#' + Part2Rest + '#');

FileName := WideCaseCapitalize(Part1)
+ ' ' + Delimiter + ' '
+ WideUpperCase(Part2Char1) + WideLowerCase(Part2Rest)
+ WideUpperCase(Extension);
end;
end.
</source>

---------------------

ReNamer:Pascal Script

2011-08-17T05:54:08Z

Stefan: Some examples how to split an file path into its parts

{{Up|ReNamer}}

The [[ReNamer:Rules:PascalScript|PascalScript Rule]] in [[ReNamer]] uses Pascal Script component to allow users to program their own renaming rule.

To master Pascal Script, follow these steps:

# Learn the basic syntax and concepts of Pascal Script
# Understand the specific variables, procedures and functions that are defined within ReNamer
# Learn how to use these variables/functions/procedures in scripts

Let us see these steps in more details.

== Learn the basics ==

To learn the basics of Pascal Script, please refer to the [[ReNamer:Pascal Script:Quick guide|Pascal Script Quick Guide]].

== Types and functions ==

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

*[[ReNamer:Pascal Script:Types|Types]]
*[[ReNamer:Pascal Script:Functions|Procedures and functions]]

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

== Script cookbook ==

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

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

# [[ReNamer:Pascal Script:FileName|How to rename a file (using the FileName variable)]]
# [[ReNamer:Pascal Script:FileName Utilities|How to skip extention (basic FileName utilities)]]
# [[ReNamer:Pascal Script:WideUpperCase|How to convert the filename to ALLCAPS (the WideUpperCase function)]]
# [[ReNamer:Pascal Script:Unicode String Handling Routines|How to operate on words (Unicode string-handling routines)]]
# [[ReNamer:Pascal Script:Basic Conversion Routines|How to serialize files (basic conversion routines)]]
# [[ReNamer:Pascal Script:Initialization of variables|How to initialize variables]]
# [[ReNamer:Pascal Script:Dialogs|How to create interactive dialogs]]
# [[ReNamer:Pascal Script:FilePath|How to work with folders and paths (FilePath constant)]]
# [[ReNamer:Pascal Script:Break script execution|How to break the script execution]]
# [[ReNamer:Pascal Script:Read file content|How to read file content]]
# [[ReNamer:Pascal Script:Import functions|How to import functions]]
# [[ReNamer:Pascal Script:SplitPath|How to split file path into parts (folders, base, extension)]]

== Scripts repository ==

* Official [[ReNamer:Scripts|Scripts Repository]].
* The [http://www.den4b.com/forum/ Forum] contains several ready scripts.

Study them and adopt them for your purpose.

== Tips ==

A few quick tips:

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

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

'''Warning:''' Some of the functions are able to alter your file system (create new folders, move files, etc.). So use them with caution! Remember that scripts are executed during Preview (NOT Rename) operation. So you let the script alter your system by pressing Preview or having Auto Preview on.

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

== External links ==

* [http://www.remobjects.com/ps RemObjects Pascal Script]
: Developers of the Pascal Script component.
* [http://www.delphibasics.co.uk/ Delphi Basics]
: Help and reference for the fundamentals of the Delphi/Pascal language.

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

ReNamer:Quick Guide

2010-09-22T19:39:33Z

Stefan: Test adding an ALT text

{{Up|ReNamer}}

Using ReNamer is very simple. Just follow the four steps shown below.

[[Image:ReNamer Main Steps.png]]

Test 1

<imagemap>
Image:ReNamer Main Steps.png|
rect 76 58 253 82 [[Adding files and folders|Adding files and folders]]
desc none
</imagemap>

Test 2

<imagemap>
Image:ReNamer Main Steps.png||alt=Hoover over this image to spot links to more explanations.
rect 3 40 255 86 [[Adding files and folders]]
rect 303 53 393 135 [[Previewing files|See HowTo Previewing files]]
rect 465 55 545 135 [[Renaming files|I use just IrfanView (or such) to make an selection to get the rectangle coordinates]]
rect 3 83 295 129 [[Managing rules|See the full power of ReNamer: This section explains how to add rules, remove rules, edit a rule andchange the order in which they are applied to files and folders.]]
desc none
</imagemap>

{| class="wikitable"
|-
! Step
! What to do
|-
! style="background-color: rgb(255, 0, 0); font-size: 1.8em;" | 1
| Select the files from various folders and add them to the working area.

a. Change default behavior for the '''Add Folders''' button (optional step)

b. Add individually selected files ('''Add Files''') and/or all files in selected folders ('''Add Folders'''), and/or...

c. Drag-n-drop files from Windows Explorer (or any other application) in this area (called "'''Files''' pane").

|-
! style="background-color: rgb(210, 105, 30); font-size: 1.8em;" | 2
| Add rules to create a sequence. Delete or edit an existing rule. Change the order of the rules.

a. Allows addition and deletion of rules. Also change the order of any rule in the stack.

b. Click in this area to add a rule (or to edit an existing rule, or just move it to a new position in the list)

|-
! style="background-color: rgb(65, 105, 225); font-size: 1.8em;" | 3
| Preview the results (check before proceeding with the actual renaming)

a. Set options (e.g. highlight changed names, experiment with your own text, resolve conflicts, etc.)

b. Click to see preview the new file names in the bottom pane (not required in '''''auto-preview''''' mode)

|-
! style="background-color: rgb(60, 179, 113); font-size: 1.8em" | 4
| Press this button to rename files and folders.
|}

ReNamer is so intuitive that you would be able to use it without reading the manual any further.

The rest of the chapters provide more details on all aspects of ReNamer. Use them as reference.

There is an older version of this guide available here: [[ReNamer:Quick Start]]

[[Category:ReNamer]]

ReNamer:Quick Guide

2010-09-22T19:24:45Z

Stefan: Some tests with ImageMap syntax

{{Up|ReNamer}}

Using ReNamer is very simple. Just follow the four steps shown below.

[[Image:ReNamer Main Steps.png]]

Test 1

<imagemap>
Image:ReNamer Main Steps.png|
rect 76 58 253 82 [[Adding files and folders|Adding files and folders]]
desc none
</imagemap>

Test 2

<imagemap>
Image:ReNamer Main Steps.png|
rect 76 55 253 85 [[Adding files and folders]]
rect 303 53 393 135 [[Previewing files|See HowTo Previewing files]]
rect 465 55 545 135 [[Renaming files|I use just IrfanView (or such) to make an selection to get the rectangle coordinates]]
rect 3 83 295 129 [[Managing rules|See the full power of ReNamer: This section explains how to add rules, remove rules, edit a rule andchange the order in which they are applied to files and folders.]]
desc none
</imagemap>

{| class="wikitable"
|-
! Step
! What to do
|-
! style="background-color: rgb(255, 0, 0); font-size: 1.8em;" | 1
| Select the files from various folders and add them to the working area.

a. Change default behavior for the '''Add Folders''' button (optional step)

b. Add individually selected files ('''Add Files''') and/or all files in selected folders ('''Add Folders'''), and/or...

c. Drag-n-drop files from Windows Explorer (or any other application) in this area (called "'''Files''' pane").

|-
! style="background-color: rgb(210, 105, 30); font-size: 1.8em;" | 2
| Add rules to create a sequence. Delete or edit an existing rule. Change the order of the rules.

a. Allows addition and deletion of rules. Also change the order of any rule in the stack.

b. Click in this area to add a rule (or to edit an existing rule, or just move it to a new position in the list)

|-
! style="background-color: rgb(65, 105, 225); font-size: 1.8em;" | 3
| Preview the results (check before proceeding with the actual renaming)

a. Set options (e.g. highlight changed names, experiment with your own text, resolve conflicts, etc.)

b. Click to see preview the new file names in the bottom pane (not required in '''''auto-preview''''' mode)

|-
! style="background-color: rgb(60, 179, 113); font-size: 1.8em" | 4
| Press this button to rename files and folders.
|}

ReNamer is so intuitive that you would be able to use it without reading the manual any further.

The rest of the chapters provide more details on all aspects of ReNamer. Use them as reference.

There is an older version of this guide available here: [[ReNamer:Quick Start]]

[[Category:ReNamer]]