den4b Wiki - User contributions [en]

MediaWiki:Sidebar

2026-03-24T23:59:06Z

Den4b: Remove link to the forum

MediaWiki:Sitenotice

2026-03-24T23:49:54Z

Den4b: Deprecation notice

<div style="background:#fff3cd; border:1px solid #ffc107; padding:10px; text-align:center; font-size:1.2em;">
<big>⚠️</big> This wiki is deprecated and read-only. Please use the [https://www.den4b.com/docs/ new documentation platform] instead.
</div>

ReNamer:Long paths

2025-11-06T19:09:35Z

Den4b: /* Long paths in Windows */ Native long path support in Windows

{{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 "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''', and enables paths that end with a dot.

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.

== Native long path support in Windows ==

On Windows 10 version 1607 and later, long paths can be enabled natively, which requires:

# The application's manifest must have the ''Long Path Aware'' feature enabled.
#: <code><ws2:longPathAware>true</ws2:longPathAware></code>
# The system must have the <code>LongPathsEnabled</code> registry entry set to "1" (DWORD).
#: <code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem\LongPathsEnabled</code>

A reboot or log off/on may be required for changes to take effect.

Once this feature is enabled, the maximum path length extends to approximately '''32,767 characters''', without the need for <code>\\?\</code> prefix.

== 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:Rules:Strip

2025-09-20T21:34:44Z

Den4b: Document "Unicode range" option.

{{DISPLAYTITLE:ReNamer › Rules › Strip rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Extension|next=ReNamer:Rules:Case}}

[[Image:StripRule.png]]

Strip characters from the filename. The rule has predefined character sets, like digits, symbols and brackets, but you can also define your own character set. All occurrences of the specified characters will be removed from the filename.

Character set parameters:

{| class="wikitable"
|-
! Parameter
! Details
|-
| English
|
Strip all English characters.

* Numbers (0-9) will not be stripped.
* Non-English characters will not be stripped, e.g. characters with [http://en.wikipedia.org/wiki/Diacritic diacritical mark], which are used in many languages in Europe and Asia)

|-
| Digits
| Strip digits 0 through 9.
|-
| Symbols
| Strip common symbols.

* All characters that are considered to be symbols are showed in the box on the right.
|-
| Brackets
| Strip common brackets.

* The content between the brackets will remain unaffected.
* If you want to delete the content as well, use the [[ReNamer:Rules:CleanUp|CleanUp]] rule instead.
|-
| User defined
| Specify any characters that need to be removed.
* Note that this is not a string. All characters in the text box will removed individually.
|-
| Unicode range
| Strip Unicode codepoints by their hexadecimal notation.

For example:
* "10000-10FFFF" for [https://www.compart.com/en/unicode/plane supplementary planes],
* "200B,200C,200D,FEFF" for [https://www.compart.com/en/unicode/search?q=zero+width#characters zero width characters].
|}

Positioning parameters:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Everywhere
| The characters will be stripped no matter where they occur in the filename.
|-
| Leading
| Strip characters only at the beginning of the filename.
|-
| Trailing
| Strip characters only at the end of the filename.
|}

Miscellaneous parameters:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Strip all characters except selected
|
Retains the selected characters only, and strips the rest.

* This option is very useful to strip all non-English characters: Select this option along with the '''English''' option above.
|-
| Case sensitive
| Strip characters in a case sensitive manner.
|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.
|}

[[Category:ReNamer]]

File:StripRule.png

2025-09-20T21:22:39Z

Den4b: Den4b uploaded a new version of File:StripRule.png

Strip Rule

[[Category:ReNamer]]

ReNamer:Using presets

2025-09-19T15:41:05Z

Den4b: /* Locate presets */ Slight rewording

{{Go|up=ReNamer|next=ReNamer:Presets Manager}}

A "preset" is a set of rules that is saved with a user-defined name. It can also save custom [[ReNamer:Filter_settings|filter settings]].

You can save frequently used rules as presets, and load them up on demand. You can also use saved presets for unattended renaming via [[ReNamer:Command Line|command line options]].

== Save a preset ==

How to create a preset:

# [[ReNamer:Managing rules|Create a list of rules]].
# Configure [[ReNamer:Menus for the Files pane#Filters_menu|filter settings]], if necessary.
# Press '''CTRL + S''', or use the '''Presets » Save As''' menu option.
# A window pops up: [[Image:SavePresetDialog.png]]
# 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.

You can abort the process by pressing the '''ESC''' key or closing the window.

== Load a preset ==

Saved presets can be loaded via the '''Presets » Load''' menu or via the [[ReNamer:Presets Manager|Presets Manager]].

For quick access, the top 9 presets can be loaded via '''CTRL + 1''' through '''CTRL + 9''' shortcut keys. Presets are sorted alphabetically, so you can rearrange their order by renaming them.

When you load a new preset you lose the current set of rules, if you had any.

You can also append rules from an existing preset to the current set of rules by holding down the '''SHIFT''' key when lading a preset via the '''Presets » Load''' menu. This feature is available since ''v7.1.0.6 Beta''.

== Manage presets ==

The [[ReNamer:Presets Manager|Presets Manager]] offers several options for managing your collection of presets, including loading, merging, duplicating, renaming and deleting.

You can access it via the '''Presets » Manage''' menu option or using the '''CTRL + P''' shortcut from the main window.

[[File:PresetsManager.png]]

== Presets directory structure ==

The preset files can be structured in a directory hierarchy, as opposed to having them all in a single folder. This feature is intended to simply the management of a large collection of presets.

[[File:ReNamer presets directory structure.png]]

To save a preset in a directory structure you just need to specify the structured path when saving a preset.

For example, "Folder\Preset" will save a preset by name "Preset" in a folder by name "Folder".

Alternatively, you can browse to the presets folder and arrange them using the Windows Explorer.

== Locate presets ==

Presets are stored as plain text files, located in the "Presets" folder:

* In a portable version, this "Presets" folder is located in the same directory as "ReNamer.exe".
* In an installer version, it is normally located in the user profile folder.

You can find the exact location by launching ReNamer and opening the Presets Manager via ''Main Menu » Presets » Manage'' (<kbd>Ctrl+P</kbd>). At the top of the window, you will see the path to the presets folder. There is also ''Main Menu » Presets » Browse'' option which will open Windows Explorer with the presets folder in view.

To back up or transfer the stored presets to another location, simply copy the <code>*.rnp</code> files.

See also [[Application Data Storage]] for additional information on locating your application data.

== Transfer presets ==

How to transfer presets between computers or multiple installations of ReNamer?

Open ReNamer on the source computer, and go to ''Main Menu » Presets » Browse''. A file browser window should open at the location where your preset files are stored.

Copy the desired files, and then import them into ReNamer on the target computer by either manually placing the files in the presets directory or using ''Main Menu » Presets » Import''.

[[Category:ReNamer]]

ReNamer:Using presets

2025-09-19T15:26:06Z

Den4b: /* Transfer presets */ Slight rewording

{{Go|up=ReNamer|next=ReNamer:Presets Manager}}

A "preset" is a set of rules that is saved with a user-defined name. It can also save custom [[ReNamer:Filter_settings|filter settings]].

You can save frequently used rules as presets, and load them up on demand. You can also use saved presets for unattended renaming via [[ReNamer:Command Line|command line options]].

== Save a preset ==

How to create a preset:

# [[ReNamer:Managing rules|Create a list of rules]].
# Configure [[ReNamer:Menus for the Files pane#Filters_menu|filter settings]], if necessary.
# Press '''CTRL + S''', or use the '''Presets » Save As''' menu option.
# A window pops up: [[Image:SavePresetDialog.png]]
# 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.

You can abort the process by pressing the '''ESC''' key or closing the window.

== Load a preset ==

Saved presets can be loaded via the '''Presets » Load''' menu or via the [[ReNamer:Presets Manager|Presets Manager]].

For quick access, the top 9 presets can be loaded via '''CTRL + 1''' through '''CTRL + 9''' shortcut keys. Presets are sorted alphabetically, so you can rearrange their order by renaming them.

When you load a new preset you lose the current set of rules, if you had any.

You can also append rules from an existing preset to the current set of rules by holding down the '''SHIFT''' key when lading a preset via the '''Presets » Load''' menu. This feature is available since ''v7.1.0.6 Beta''.

== Manage presets ==

The [[ReNamer:Presets Manager|Presets Manager]] offers several options for managing your collection of presets, including loading, merging, duplicating, renaming and deleting.

You can access it via the '''Presets » Manage''' menu option or using the '''CTRL + P''' shortcut from the main window.

[[File:PresetsManager.png]]

== Presets directory structure ==

The preset files can be structured in a directory hierarchy, as opposed to having them all in a single folder. This feature is intended to simply the management of a large collection of presets.

[[File:ReNamer presets directory structure.png]]

To save a preset in a directory structure you just need to specify the structured path when saving a preset.

For example, "Folder\Preset" will save a preset by name "Preset" in a folder by name "Folder".

Alternatively, you can browse to the presets folder and arrange them using the Windows Explorer.

== Locate presets ==

Presets are stored as plain text files, located in the "Presets" folder. In a portable version, this "Presets" folder is in the same directory as "ReNamer.exe". In an installer version, it is normally located in Windows user profile folder.

You can tell by launching ReNamer and opening the Presets Manager: "Presets > Manage..." (Ctrl+P). In 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 Windows Explorer with the Presets folder in view.

To backup or transfer the stored presets to an another location or PC, simply copy *.rnp files and you are done.

See also [[Application Data Storage]] for additional information on locating your application data.

== Transfer presets ==

How to transfer presets between computers or multiple installations of ReNamer?

Open ReNamer on the source computer, and go to ''Main Menu » Presets » Browse''. A file browser window should open at the location where your preset files are stored.

Copy the desired files, and then import them into ReNamer on the target computer by either manually placing the files in the presets directory or using ''Main Menu » Presets » Import''.

[[Category:ReNamer]]

Shutter:Events

2025-09-07T07:48:31Z

Den4b: /* Network usage */ Implementation notes

{{Up|Shutter}}

Below is a list of all available events.

Remember that Shutter is often used with a ''set'' of multiple events (rather than a single event); and these events have a [[Shutter:Logic|pre-defined relationship]] between them.

== Countdown ==

Count down a specified amount of time. This Event is considered "triggered" when the timer reaches zero.

'''Example uses:'''

#If you suffer from [http://en.wikipedia.org/wiki/Repetitive_strain_injury RSI], set timer to take a break every few minutes and exercise your hands, shoulder and neck.
#Use Shutter as a count-down timer clock (to give alarm at the end of specified time).
#Play a pre-recorded sound every few minutes (to calm down a baby or a pet).

== On Time ==

Event is triggered when the current time (as displayed in the system tray) reaches the specified time.

'''Example uses:'''

#Launch an application (e.g. a downloader) at certain time.
#Share your PC on LAN till a particular time, and then turn it off at certain time.

== Winamp Stops ==

Event periodically checks the playback state of [http://www.winamp.com/ Winamp]. The event is triggered once it is detected that application is no longer playing the media.

'''Note:''' [http://forums.winamp.com/showthread.php?threadid=180297 Winamp Messaging API] is used to achieve this.

'''Example uses:'''

#When the WinAmp playlist is over, pause for a specified time period and then play another playlist, or hibernate the PC.

== CPU Usage ==

Periodically check the processor usage and trigger event when the usage stays above (or below) the specified mark for the specified amount of time.

'''Example uses:'''

#Launch a CPU-intensive application (e.g. Blender rendering) to get the benefit of full CPU power.
#When CPU usage goes above certain threshold, pause the resource-intensive applications.

== Network usage ==

Check the network's load (select from ''total'', ''upload only'', or ''download only''); and if it falls below specified limit for the specified duration, then the event is triggered.

'''Example uses:'''

#Start a downloader when the download is below a limit.
#Upload a large folder when the upload falls below certain point
#Pause file-transfers till the total traffic in the network falls below a certain limit.

'''Implementation notes:'''

The actual measurement of the network usage is taken every second in all configurations. If the averaging option is disabled, then all measurements within the configured period of time (duration) must stay below the threshold in order to trigger the event. If the averaging option is enabled, then the average of all measurements within the configured period of time (duration) must stay below the threshold in order to trigger the event.

== User Inactive ==

Track the time of user's last mouse and keyboard activity. Trigger the event when the user has been inactive for the specified period of time.

Methods for monitoring user inactivity:

# '''Last Input Event''' - Uses <tt>GetLastInputInfo</tt> API. Captures activity only of the initiating user session. The most stable and the least intrusive approach.
# '''Low Level Hook''' - Uses <tt>SetWindowsHookEx(WH_KEYBOARD_LL)</tt> and <tt>SetWindowsHookEx(WH_MOUSE_LL)</tt> API. Captures activity from all user sessions. Applied without injection into foreign processes to achieve a less intrusive effect, contrary to the official documentation, so it may stop working in future versions of Windows.
# '''Injection Hook''' - Uses <tt>SetWindowsHookEx(WH_KEYBOARD)</tt> and <tt>SetWindowsHookEx(WH_MOUSE)</tt> API. Captures activity from all user sessions. A tiny dedicated library file is injected into all foreign processes to capture user activity across all applications. This is a well established approach which may yield better results in some cases, but it is the most intrusive approach.

'''Example uses:'''

#Play WinAmp when no one is using the PC (turn the PC into entertainment center).
#Launch a task that can otherwise slow down the PC.

== Battery Low ==

Monitor power battery level and trigger event when level drops below specified level.

'''Example uses:'''

#Take backup of critical data.
#Close specified applications gracefully.
#Remind the user to plug in the laptop charger.

== Window Closes ==

Monitor opened windows for the specified title match. Event is triggered when specified title does not match any of the opened windows.

*The name is NOT case-sensitive.
*You can specify wildcards to find a partial match. For example, '''''*Firefox*'''''. If you do not use wildcards, Shutter will look for an exact match (if the actual Window name has more characters compared to the specified string, Shutter will treat it as "not matching").

'''Note:''' Be careful when specifying the window name: The text should match with what you see in the '''Title Bar '''of the application (the top bar of the application's window). Sometimes the '''Title Bar''' shows the file that is opened in the application, instead of the application's name.

'''Example uses:'''

#Warn the user that the desired application has stopped running.
#Launch the process ''only if'' the application is not running already (to avoid multiple instances running simultaneously)

== Process Stops ==

Monitor all processes that match the specified filename. Event is triggered when the specified filename is not found in the list of executing processes.

'''Example uses:'''

#Warn the user that the process has stopped.
#Launch the next process in sequence.

== Ping Stops ==

[http://en.wikipedia.org/wiki/Ping Ping] the specified host and trigger when host is not responding for the specified period of time. Useful for monitoring availability of network services.

'''Example uses:'''

#Warn the user that the remote PC is not communicating any more (either bad link or crash).

== File Size ==

Periodically check the size of the specified file and trigger the event when the selected condition is met.

The list of available conditions:

# file reaches a certain size;
# file is created;
# file no longer exists.

Internally, when the file or directory does not exist, it has an effective size of "-1".

'''Example uses:'''

#Take a backup of the file.
#Warn the user that the file size has reached the limit.

[[Category:Shutter]]

Localization

2025-06-08T15:55:13Z

Den4b: /* Editing translation file */ Poedit settings

This article describes localization (translation) of applications into different languages.

Please carefully study the material in this article before attempting to update or create a translation!

== Translation files ==

Translations are stored in '''PO files''' (as produced by [http://en.wikipedia.org/wiki/Gettext gettext]) which are distributed together with the application, inside '''Languages''' folder:

* <tt>Languages\Application.po</tt> – '''Template''' file.
* <tt>Languages\Application.ru.po</tt> – '''Russian''' (RU) translation file.
* <tt>Languages\Application.es.po</tt> – '''Spanish''' (ES) translation file.
* <tt>Languages\Application.fr.po</tt> – '''French''' (FR) translation file.
* ...

The template file (<tt>Application.po</tt> / <tt>Application.pot</tt>) is used as the basis for creating translations for new languages, not yet available in the application.

Translation files (<tt>Application.XX.po</tt>) contain translated text. A '''two-letter language code''' in the file extension identifies a particular language.

== Create new translations ==

To create a translation file for a new language:
# Create a copy of <tt>Application.po</tt> (template file)
# Rename it to <tt>Application.XX.po</tt> (translation file), where ''XX'' is a two-letter language code.
# Translate entries to the new langauge using instructions below.
# Populate PO file headers, copy from any other translation file and modify appropriately.
# Save new file using UTF-8 encoding, without byte order mark ([https://en.wikipedia.org/wiki/Byte_order_mark BOM]).

Example of relevant entries in PO file headers for a new translation file:
<pre><nowiki>
msgid ""
msgstr ""
...
"Language: ru\n"
"X-Country: ru\n"
"X-Country-Name: Russia\n"
"X-Language-Name: Russian\n"
"X-Language-Name-Native: Русский\n"
"X-Translators: Your Name <your.email@example.com>\n"
...
</nowiki></pre>

* Language codes are defined in [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO 639-1]
* Country codes are defined in [http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2].
* In conflicting and ambiguous situations:
*# Name the translation file using <tt>Application.XX_YY.po</tt> format, where ''XX'' is a language code and ''YY'' is a country code.
*# Set <tt>X-Language-Name</tt> header to highlight the difference between translations.
*: For example: "<tt>en_US</tt>" code for ''English (United States)'', "<tt>en_GB</tt>" code for ''English (United Kingdom)''.

== Editing translation file ==

The process involves translation of individual textual messages to create a mapping from original text to a different language.

Translation files (*.po) should be edited with specially designed translation tools, such as:

* [http://poedit.net/ Poedit] – for Windows, Linux and Mac.
** Enable "Preserve formatting of existing files" option and disable "Wrap at" option in ''File » Preferences » Advanced'' settings.

Translation files could also be edited manually using a text editor, but this is highly discouraged as tiny mistakes can result in corruption of the entire file.

== Guidelines for translators ==

Guidelines for translators:
* Use the most up-to-date language files from the latest development version (Beta versions).
* Try not the exceed the length of the translated text, comparing to the length of the original text.
*: Some components may not fit longer text, so it is better to make it shorter rather than longer.
* Beware of the special formatting, symbols and placeholders, e.g. "\n", "%s", "%d".
*: Make sure to maintain such formatting, translate only actual words.
* If you don't have a good translation for some text, just leave those blank.
*: Other people may be able to fill in the blanks later.
* Try to use formal but easy to understand language.
*: Avoid the use of slang, which may not be understood by some readers.

Attribution to translators:
* Add your name to "<tt>X-Translators:</tt>" field in PO file headers.
* Please keep names of other translators (separate multiple names with a comma).

== Auxiliary translation files ==

In addition to the main translation file, you may find auxiliary translation files in subfolders. These correspond to 3rd party components, for example, "LCLStrConsts" subfolder contains messages that appear in Lazarus Component Library (LCL). We do not handle the updates to auxiliary translation files directly, because we source that from the original vendor. If you wish, you can submit your improvements directly to the vendor.

Updates for "LCLStrConsts" translations should submitted to the [https://www.lazarus-ide.org/ Lazarus IDE] project, using the following steps:

# The translation should be based on the [https://gitlab.com/freepascal.org/lazarus/lazarus/-/tree/main/lcl/languages latest development files].
# The translation file can be submitted via the [https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues issue tracker] or as a [https://gitlab.com/freepascal.org/lazarus/lazarus/-/merge_requests merge request] (preferred).

== Loading specific language ==

All available language files are automatically added to the "Languages" menu on startup. Select a desired language and restart the application.

When selected language is set to "''Autodetect''" mode:
* Application automatically tries to recognize system language and loads appropriate translation file.
* It is also possible to load a specific language file, by either:
*# Adding "<tt>--lang XX</tt>" command line parameters to the application, where ''XX'' is a two-letter language code.
*# Setting "<tt>LANG</tt>" environmental variable to a two-letter language code.

== Publishing your translation ==

Please send new and updated translation files via email, as attachments.

The email address can be found in the ''About'' dialog of every application.

[[Category:Localization]]

Template:Go

2025-04-17T13:09:32Z

Den4b: Allow custom page titles, increase padding and margin.

<includeonly><div class="noprint"><div style="background-color: #ffe; border: 1px solid #c0c0c0; padding: 0.5em 1em; margin-bottom: 1em; font-style: italic;">
{| border="0" cellspacing="0" cellpadding="0"
| '''Navigation'''  
| {{#if: {{{up|}}} | [[Image:Arrow Return.png|link={{{up}}}]] [[{{{up}}}{{#if: {{{uptitle|}}} | {{!}}{{{uptitle}}} | }}]]   | }}
| {{#if: {{{prev|}}} | [[Image:Arrow Left.png|link={{{prev}}}]] [[{{{prev}}}{{#if: {{{prevtitle|}}} | {{!}}{{{prevtitle}}} | }}]]   | }}
| {{#if: {{{next|}}} | [[Image:Arrow Right.png|link={{{next}}}]] [[{{{next}}}{{#if: {{{nexttitle|}}} | {{!}}{{{nexttitle}}} | }}]]   | }}
|}</div></div></includeonly><noinclude>
__NOTOC__
== Usage ==

=== Parent ===

<pre><nowiki>{{Go|up=Parent Article}}</nowiki></pre>
{{Go|up=#Parent Article}}

=== Previous and Next ===

<pre><nowiki>{{Go|prev=Previous Article|next=Next Article}}</nowiki></pre>
{{Go|prev=#Previous Article|next=#Next Article}}

=== Parent, Previous and Next ===

<pre><nowiki>{{Go|up=Parent Article|prev=Previous Article|next=Next Article}}</nowiki></pre>
{{Go|up=#Parent Article|prev=#Previous Article|next=#Next Article}}

=== Parent, Previous and Next, with custom titles ===

<pre><nowiki>{{Go|up=Parent Article|uptitle=My Parent Title|prev=Previous Article|prevtitle=My Previous Title|next=Next Article|nexttitle=My Next Title}}</nowiki></pre>
{{Go|up=#Parent Article|uptitle=My Parent Title|prev=#Previous Article|prevtitle=My Previous Title|next=#Next Article|nexttitle=My Next Title}}

[[Category:Navigation]]
[[Category:Exclude in print]]
</noinclude>

ReNamer:Rules:Delete

2025-04-17T10:55:39Z

Den4b: Remove superfluous description

{{DISPLAYTITLE:ReNamer › Rules › Delete rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Insert|next=ReNamer:Rules:Remove}}

[[Image:DeleteRule.png]]

This rule will delete all characters located between the '''From''' and the '''Until ''' positions.

The parameters are as follows:

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

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

|-
| Delete current name
| A shortcut option for deleting the whole current name.

|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.
|-
| Right-to-left
| Inverts the normal direction for counting a position, so that the count goes from right and towards left.

When this option is selected, the "till the end" option in '''Until''' deletes all characters on the left, what we normally regard as the ''beginning'' of the name.

For example, to keep only the four characters on the right side of the name and delete all the rest of the characters on the left, use:

* '''From:''' Position 5
* '''Until:''' Till the end

|-
| Do not remove delimiters
| If you select this option, the delimiters themselves will be retained.

If you have used two different delimiters in '''From '''and '''Until''' sections, ''both'' of them will be retained.

|}

[[Category:ReNamer]]

ReNamer:Rules:ReformatDate

2025-04-17T10:39:45Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Reformat Date rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:UserInput}}
__NOTOC__
[[File:ReformatDateRule.png]]

This rule allows finding and reformatting various date/time values in the filename.

Allowed date/time format variables are described in the [[ReNamer:Date and Time format|Date and Time format]] article.

{| class="wikitable"
! Parameter
! Description
|-
| Find date/time format
| Find date and/or time matching a specified format.

A dropdown menu provides a quick access to commonly used formats.
|-
| Convert to date/time format
| Convert found date and/or time values to the specified format.

A dropdown menu provides a quick access to commonly used formats.
|-
| Match as whole words only
| When searching for a matching date/time pattern, match only if the found pattern is a whole word, i.e. surrounded by word boundaries.

For example: A 4 digit year pattern (YYYY) will be found in "''foo'''''1234'''''bar''" if this option is disabled, but not found if option is enabled.
|-
| Skip extension
| Exclude file extension from processing.
|-
| Use custom short months
| Use a custom list of short month names when searching or formatting short month name pattern (MMM). Month names are separated by a comma.

By default, month names from the system locale are used.
|-
| Use custom long months
| Use a custom list of long month names when searching or formatting long month name pattern (MMMM). Month names are separated by a comma.

By default, month names from the system locale are used.
|-
| Adjust time by
| This option lets you adjust date/time by any arbitrary number of years, months, days, hours, minutes, seconds and milliseconds.
|}

[[Category:ReNamer]]

ReNamer:Rules:UserInput

2025-04-17T10:39:36Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › User Input rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:PascalScript|next=ReNamer:Rules:ReformatDate}}
__NOTOC__
[[Image:UserInputRule.png]]

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 the [[ReNamer:Export_menu|Export menu]] for options on export and import of files and their new names.

== 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:PascalScript

2025-04-17T10:39:25Z

Den4b: Left align all images

{{DISPLAYTITLE:ReNamer › Rules › Pascal Script rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:RegEx|next=ReNamer:Rules:UserInput}}

[[Image:PascalScriptRule.png]]

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

== Using a ready script ==

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

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

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

== Borrowing readymade scripts ==

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

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

Search for a suitable script.

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

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

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

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

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

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

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

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

|-
! 5
| '''Saving the script and giving it a name:'''
The '''save '''button is hidden under the '''scripts '''menu. So first click on the [[Image:ScriptsButton.png]] button. It pops up a window like this:

: [[Image:PascalScriptsMenu.png]]

Note that all the existing scripts are listed here. (When you save the new script, it will also be added to this list.)

Select the '''Save script... '''option (at the very bottom of the menu). Another window pops up.

: [[Image:SaveScriptDialog.png]]

Enter a name that suggests the function of your script. Press '''OK'''. The new name is added to the list of scripts. Now use it as described [[#Using_a_ready_script|above]].

|}

== Writing your own scripts ==

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

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

The step-by-step procedure is as follows:

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

[[Category:ReNamer]]

ReNamer:Rules:RegEx

2025-04-17T10:35:20Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Regular Expressions rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Translit|next=ReNamer:Rules:PascalScript}}

[[Image:RegExRule.png]]

This rule allows finding and replacing patterns defined as [[ReNamer:Regular Expressions|Regular Expressions]].

Regular Expressions (RegEx) use a special syntax for describing search and replace patterns, they are very powerful and ''really'' worth learning.

ReNamer users have posted many RegEx examples at the [http://www.den4b.com/forum/ User Forum], where you might find your particular case already solved.

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

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]]

[[Category:ReNamer]]

ReNamer:Rules:Translit

2025-04-17T10:35:02Z

Den4b: Left align all images and data snippets

{{DISPLAYTITLE:ReNamer › Rules › Translit rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:CleanUp|next=ReNamer:Rules:RegEx}}

[[Image:TranslitRule.png]]

This rule transliterates one alphabet into another. Its main goal is to transliterate Non-English characters from different languages into their English/Latin representation. For example, the German character '''ü''' can be transliterated to '''ue''' (the name '''Müller '''can be also written as '''Mueller''').

This rule uses ''transliteration maps'' (explained below).

== Transliteration maps ==

To transliterate, we create a pair of equivalent characters, like this: '''ü=ue'''

(Note that the right side of this equation has ''two'' characters. Any number of characters may be placed on both sides of the equation.)

We need several such ''equivalent character pairs'' to convert one language into another. The entire set is called a ''transliteration map''. (This is really some kind of a find-and-replace rule.)

ReNamer has several such built-in maps. Each map is named after a language (the second language in all maps is English).

Each map can be used in ''both'' directions (e.g. French-to-English or English-to-French.)

When you start up the '''Translit''' Rule, its window does not show any maps. You are free to do any of the following:

#Use any of the built-in maps (and use it in ''forward'' or ''reverse'' direction)
#Create your own map and use it.
#Edit a built-in map first, and then use it.

Let us see how to do this.

== Automatic case conversion ==

Translit rule does automatic case conversion with an algorithm adopted specifically for transliteration. Translit rule discard the case on the input, i.e. "A=B" is same as "a=b". Case is decided upon case of the input fragment. Multiple character fragments are treated as part of words, with their case decided based on the case of letters around them.

The logic for the case conversion is as follows (ReNamer Beta from 23 Aug 2009):
<pre>
set OUTPUT-PART to lower case
if first letter in INPUT-PART is upper case then
if length of OUTPUT-PART bigger than 1 then
if next letter in original name is upper case then
convert whole OUTPUT-PART to upper case
else
convert only first letter in OUTPUT-PART to upper case
else
convert whole OUTPUT-PART to upper case
</pre>

== Using a built-in transliteration map ==

To select any of the built-in maps, press the [[Image:TranslitMapsButton.png]] button. A list of available transliteration maps pops up:

[[Image:TranslitMenu.png]]

Click on the desired transliteration map. As an example, let us click on the French (to English) transliteration map.

The '''Rules''' window changes immediately to show the French characters and their English equivalents.

[[Image:TranslitRuleExample.png]]

You can edit any of the entry in this list, add new entries, or delete any of the entries.

Note that such editing does not alter the saved version of the map. The map is edited just for a one-time use. If you select the same Translit map again, ReNamer will load the ''original'' version, not the ''edited'' version. You will see how to [[#Saving_a_transliteration_map|alter a transliteration map]] in a section below.

Next, select the rule's parameters as shown below:

{| class="wikitable"
|-
! Parameter
! Details
|-
| forward
| This is transliteration from-left-to-right direction, as defined in the map.
|-
| backward
| This is transliteration from-right-to-left direction, as defined in the map.
|-
| skip extension
| If this check box is selected, the extension will be ignored by the rule.
|}

Finally, press the [[Image:AddRuleButton.png]] button to add the rule to the stack.

== Making your own transliteration map ==

Click in the '''Translit Alphabet''' window, and start entering your custom alphabet.

Transliteration alphabet consists of two equivalence parts (or a couple), which are entered one per line and two parts separated with "=" (equal sign). Alphabet should not contain spaces and should have case discarded ([[ReNamer:Rules:Translit#Automatic_case_conversion|case is adjusted automatically]]). Also, make sure to put couples which contain greater number of characters at the top, so they will get processed first and will not get processed partially by shorter representations. Below is a simple example:

<pre>
щ=sh
ю=yu
я=ya
ь='
э=e
</pre>

After entering all such transliterations, press the [[Image:AddRuleButton.png]] button to add the rule to the rule-stack.

Note that this rule is not saved yet (it was just composed for a one-time use). The following topic shows how to save a map.

== Saving a transliteration map ==

To save a newly composed Transliteration rule,

#Press the [[Image:TranslitMapsButton.png]] button.
#:A menu pops up.
#:[[Image:TranslitMenu.png]]
#Select the last option ('''Save Translit...''').
#:A window pops up, as shown below:
#:[[Image:SaveTranslitMapDialog.png]]
#Enter a new name for the map and press '''OK'''. The new map is saved.

The process of saving an edited Transliteration map is similar. The only difference is that the '''Save Translit '''window (see above) shows the current map's name. You can press '''OK''' to save the changes you've just made, or enter a new name to create a new translit map for the edited version of the current map.

The new map's name is added to the map list.

From now on, the new map will also be available as "standard".

== Unicode character forms ==

Have you encounter a case where some characters don't get converted, despite having a visually identical character defined in the Translit alphabet?

Unicode characters can be defined using exact character codes or using [https://en.wikipedia.org/wiki/Combining_character combining characters]. The displayed characters will look identical, but their binary content is completely different. The conversion process between these forms is covered by the [https://unicode.org/reports/tr15/ Unicode Normalization] standard.

Alphabets in the Translit rule are normally defined using exact character codes, so the combining characters won't get affected. You can put a piece of text through a ''Unicode analyzer'' to see exactly how each character is defined and to identify the use of combining characters.

To handle all possible forms of the same visual character in Translit alphabets, one could define all possible forms in an alphabet or one can simply strip away those combining characters, which can be accomplished by using the "Strip unicode marks" option found in the [[ReNamer:Rules:CleanUp|Clean Up rule]].

[[Category:ReNamer]]

ReNamer:Rules:CleanUp

2025-04-17T10:32:29Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Clean Up rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Padding|next=ReNamer:Rules:Translit}}

[[Image:CleanUpRule.png]]

This rule cleans up the filenames from (or for) commonly used naming conventions for Internet, peer-to-peer networks and other resources. Multiple problems can be removed at once.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details

|-
| Strip out content of brackets
| A typical use of this option is to strip the needless comments attached to filenames, such as '''(best!!)'''.
*This option removes the brackets also.
*You can select any/all of the various types of brackets.

If you do NOT want to delete the content within the brackets, use the [[ReNamer:Rules:Strip|Strip]] rule instead.

|-
| Replace these characters with spaces
| These characters occurring in the file names are removed and a space is inserted in their place.

|-
| Fix spaces
| Replace multiple consecutive spaces with a single space.
It also removes spaces from the beginning and the end of the filename:
*If '''skip extension''' is selected it removes spaces from the beginning and end of the ''base name'' (''before'' the extension).
*If '''skip extension''' is deselected it removes spaces from the beginning and from the end of the ''filename'' (''after'' the extension).

|-
| Normalize unicode spaces
| Replace all Unicode white space characters with a standard space bar character code. [[Unicode]] character set contains a number of different characters (<tt>C1_SPACE</tt> type) that represent a white space with slightly different properties (e.g. wider, narrower, etc).

|-
| Strip unicode marks
| Strip unicode marks, including combining marks, diacritics and accents.

For example, it will convert "á" to "a", "Ñ" to "N", "X̅" to "X", and so on.

|-
| Insert a space in front of capitalized letters
| Often words in the file name are just joined together, without spaces or underscores to separate them. Each word begins with a capital letter, so that you can read it easily.

This option separates such words in the file name.
:For example, '''SeparateTheseWords.pdf''' becomes '''Separate These Words.pdf'''.

(Note that if there is a capitalized letter at the very beginning of the name, ReNamer does NOT add a space before it.)

|-
| Prepare for SharePoint
| Prepares the file for hosting it on [http://www.microsoft.com/sharepoint/prodinfo/what.mspx Microsoft Sharepoint].
#strips standard forbidden filename characters
#strips consecutive dots
#strips '''#''', '''%''', '''~''', '''&'''
#replaces '''{''' and '''}''' with '''(''' and ''')'''

|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.
|}

[[Category:ReNamer]]

ReNamer:Rules:Padding

2025-04-17T10:32:20Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Padding rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Randomize|next=ReNamer:Rules:CleanUp}}

[[Image:PaddingRule.png]]

This rule allows you to apply or remove zero padding to/from number sequences, or add text padding using custom characters.

The "number sequences" parameters:

{| class="wikitable"
|-
! Parameter
! Description

|-
| Add zero padding to length
| Apply zero padding to number sequences until the number of digits reaches a specified count (length).

|-
| Remove zero padding
| Strip away leading zeros from all number sequences.

|}

The "text padding" parameters:

{| class="wikitable"
|-
! Parameter
! Description

|-
| Add padding to length
| Add custom text padding either form the left or the right side of the subject.

|-
| Padding characters
| A sequence of custom characters which will be used as the padding material.

|-
| Position
| Choose either the left or the right side for adding the text padding.

|}

General parameters:

{| class="wikitable"
|-
! Parameter
! Description

|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.

|}

[[Category:ReNamer]]

ReNamer:Rules:Randomize

2025-04-17T10:32:15Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Randomize rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Serialize|next=ReNamer:Rules:Padding}}

[[Image:RandomizeRule.png]]

This rule inserts randomly generated sequences of specified length and using a selection characters (digits, letters, or a custom set).

Several common practical uses:
# Randomize the order files.
# Destroy existing filenames.

The parameters are as follows:

{| class="wikitable"
! Parameter
! Description

|-
| Length of random sequence
| Specify how many characters your random sequence should have.

For example, if you are using only digits and set length to 4, you will will get random numbers from 0000 to 9999 (inclusive).

|-
| Unique if possible
| Normally, randomly generated values can repeat themselves. If this option is selected, ReNamer will generate unique values (no repetition) when possible.

|-
| Characters to use
| The set of characters which will be used for generating random sequences.

You can choose between using digits (0..9), English letters (a..z) or specify your custom set of characters.

|-
| Insert where
| Specify where to insert the number (see below for individual options).

|}

Options for where to insert the number:

{| class="wikitable"
! Option
! Description

|-
| Prefix
| Before the original filename

|-
| Suffix
| After the original filename

|-
| Position
| Insert the number at the specified position.

|-
| Replace current name
| Inserted number replaces the entire filename.

|-
| Skip extension
| Exclude file extension when calculating the position for insertion.

|}

[[Category:ReNamer]]

ReNamer:Rules:Serialize

2025-04-17T10:32:04Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Serialize rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Case|next=ReNamer:Rules:Randomize}}

[[Image:SerializeRule.png]]

This rule works on a set of files, and inserts incremental numeric series of digits in the names of those filenames.

The files listed in the pane can be numbered in increasing or decreasing order, with various steps, repeat and reset configuration. The position of each file in the '''Files''' pane becomes important, so check the order of the files in the list before applying this rule.

Examples:

# You have a bunch of log files, and you want to make them look like "log0001", "log0002", "log0003", etc.
# You want to force specific sorting for files: "01 - Song XYZ", "02 - Song ABC", "03 - Song YYY", etc.

The parameters are as follows:

{| class="wikitable"
! Parameter
! Description

|-
| Index start
| Starting number. For example, if the destination folder already has some files with serialized numbers, you can start with the next number.

|-
| Step
| Increment the index by this value after each processed file. Usually 1, but you may like to enter a higher number here if files with intermediate numbers are expected later. Also, negative numbers can be used to make decremental indexes, e.g. -1, -2, -3, etc.

|-
| Repeat
| How many times to repeat (reuse) the same index before incrementing it.

|-
| Reset every
| Reset index to the initial value after processing this many files.

|-
| Reset if folder changes
| Since ReNamer can work on files collected from multiple folders, this control allows you to reset the counter for each of those folders. The effect is as if you are repeating the same command for each of the folders separately.

|-
| Reset if file name changes
| Reset the counter when the file name changes. This option is especially useful for fixing (serializing) duplicated file names, when the files with the same name are grouped together, which can be achieved by sorting the files by name or path.

|-
| Pad with zeros to length
| Pad the inserted number with leading zeros. For example, "457" becomes "000457" if it is padded to reach 6 digits, and "0457" if padded to 4 digits.

|-
| Insert where
| Specify where to insert the number (see below for individual options).

|}

=== Insert location ===

Options for where to insert the number:

{| class="wikitable"
! Option
! Description

|-
| Prefix
| Before the original filename

|-
| Suffix
| After the original filename

|-
| Position
| Insert the number at the specified position.

|-
| Replace current name
| Inserted number replaces the entire filename.

|-
| Skip extension
| Exclude file extension when calculating the position for insertion.

|}

=== Numbering system ===

A choice of the '''Numbering system''' dictates which symbols and enumeration technique are used for the serialization.

{| class="wikitable"
! Number system
! Description / Examples

|-
| Decimal digits
| Index starts at 0 with repeat 1 and step 1: 
<tt>0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, …</tt>

|-
| English letters
| Index starts at 1 with repeat 1 and step 1: 
<tt>a, b, c, …, x, y, z, ba, bb, bc, …, bx, by, bz, ca, cb, cc, …, zx, zy, zz, baa, bab, bac, …</tt>

Index starts at 1 with repeat 1 and step 1, pad to length 3: 
<tt>aaa, aab, aac, …, aax, aay, aaz, aba, abb, abc, …, abx, aby, abz, aca, acb, acc, …, azx, azy, azz, baa, bab, bac, …</tt>

|-
| Roman numerals
| Index starts at 1 with repeat 1 and step 1: 
<tt>I, II, III, IV, V, VI, VII, VIII, IX, X, XI, XII, …</tt>

|-
| Music notes
| Index starts at 1 with repeat 1 and step 1: 
<tt>C0, C#0, D0, D#0, E0, F0, F#0, G0, G#0, A0, A#0, B0, C1, C#1, …</tt> 
''Added in ReNamer 7.3.0.2 Beta.''

|-
| Simplified Chinese
| Index starts at 1 with repeat 1 and step 1: 
<tt>一, 二, 三, 四, 五, 六, 七, 八, 九, 一十, 一十一, 一十二, 一十三, …</tt>

|-
| Custom alphabetic
| Index starts at 1 with repeat 1 and step 1, using "ABC" symbols: 
<tt>A, B, C, BA, BB, BC, CA, CB, CC, BAA, BAB, BAC, BBA, …</tt>

Index starts at 1 with repeat 1 and step 1, using "01" symbols: 
<tt>0, 1, 10, 11, 100, 101, 110, 111, 1000, 1001, 1010, 1011, 1100, …</tt>

|-
| Custom numeric
| Index starts at 0 with repeat 1 and step 1, using "ABC" symbols: 
<tt>A, B, C, BA, BB, BC, CA, CB, CC, BAA, BAB, BAC, BBA, …</tt>

Index starts at 0 with repeat 1 and step 1, using "01" symbols: 
<tt>0, 1, 10, 11, 100, 101, 110, 111, 1000, 1001, 1010, 1011, 1100, …</tt>

|}

[[Category:ReNamer]]

ReNamer:Rules:Case

2025-04-17T10:31:41Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Case rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Strip|next=ReNamer:Rules:Serialize}}

[[Image:CaseRule.png]]

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

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

The parameters are as follows:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

=== Examples of Force case option ===

You may want to use a very specific case format for certain text fragments, irregardless of other case options.

Here are some typical examples where "Force case" option may be useful:

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

|}

[[Category:ReNamer]]

ReNamer:Rules:Strip

2025-04-17T10:31:27Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Strip rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Extension|next=ReNamer:Rules:Case}}

[[Image:StripRule.png]]

Strip characters from the filename. The rule has predefined character sets, like digits, symbols and brackets, but you can also define your own character set. All occurrences of the specified characters will be removed from the filename.

Character set parameters:

{| class="wikitable"
|-
! Parameter
! Details
|-
| English
|
Strip all English characters.

* Numbers (0-9) will not be stripped.
* Non-English characters will not be stripped, e.g. characters with [http://en.wikipedia.org/wiki/Diacritic diacritical mark], which are used in many languages in Europe and Asia)

|-
| Digits
| Strip digits.
|-
| Symbols
| Strip symbols.

* All characters that are considered to be symbols are showed in the box on the right.
|-
| Brackets
| Strip brackets.

* The content between the brackets will remain unaffected.
* If you want to delete the content as well, use the [[ReNamer:Rules:CleanUp|CleanUp]] rule instead.
|-
| User-defined
| Define any character that needs to be stripped off.
* Note that this is not a string. All characters in the text box will removed individually.
|}

Positioning parameters:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Everywhere
| The characters will be stripped no matter where they occur in the filename.
|-
| Leading
| Strip characters only at the beginning of the filename.
|-
| Trailing
| Strip characters only at the end of the filename.
|}

Miscellaneous parameters:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Strip all characters except selected
|
Retains the selected characters only, and strips the rest.

* This option is very useful to strip all non-English characters: Select this option along with the '''English''' option above.
|-
| Case sensitive
| Strip characters in a case sensitive manner.
|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.
|}

[[Category:ReNamer]]

ReNamer:Rules:Extension

2025-04-17T10:31:15Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Extension rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Rearrange|next=ReNamer:Rules:Strip}}

[[Image:ExtensionsRule.png]]

This rule allows you to attach a new extension. It is useful when the extension of a file is missing (or if the file has a wrong extension). There is an option to find the correct extension based on the file's structure.

The parameters are as follows:

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

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

|-
| Detect using binary signature
| Try to detect a correct file extension using built-in [[#Binary signatures|Binary signatures]] of commonly used files.
|}

=== Binary signatures ===

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

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

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

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

=== Filename starts with a dot ===

Many operating systems treat the dot at the start of the filename as an indicator that the file should be hidden. For that reason, the dot at the start of the filename is not considered as a file extension delimiter.

This behavior can be toggled via an option in the settings file:

<pre>FirstDotAtFileNameStartIsExtension=1</pre>

The settings file is normally located in the [[Application Data Storage]].

Examples of filenames and their considered extension depending on the value of the option:

{| class=wikitable
! Filename
! Extension if 1
! Extension if 0
|-
| file.ext
| .ext
| .ext
|-
| .file.ext
| .ext
| .ext
|-
| .file
| .file
|
|}

[[Category:ReNamer]]

ReNamer:Rules:Rearrange

2025-04-17T10:30:54Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Rearrange rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Replace|next=ReNamer:Rules:Extension}}

[[Image:RearrangeRule.png]]

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.

|-
| [[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.

|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.

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

=== 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

2025-04-17T10:30:46Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Replace rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Remove|next=ReNamer:Rules:Rearrange}}

[[Image:ReplaceRule.png]]

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 also use wildcards to create simple patterns.

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.

In that case, the nth entry in the '''Find''' field is replaced by the nth entry in the '''Replace''' field.

|-
| Replace
| Enter strings that will replace the "Find" strings.

Note that the number of strings (separated with '''*|*''') in "Find" and "Replace" fields should be the same. If there is more strings in the "Find" field than in the "Replace" field the spare strings will be removed (replaced with an empty string). If there is more strings in the "Replace" field, 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.
|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.
|-
| Case sensitive
| Will only remove a specified string from the name if the case matches exactly.
|-
| Whole words only
| Remove the subject text only when it is whole word, not a part of another word.

For example, searching for "bar" would not find a match in "foobar" or "bars".
|-
| 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.
|}

Backreferences allow for reuse of wildcard matches in the Replace field using the '''$N''' notation, where '''$1''' is the first wildcard match, '''$2''' is second, and so on.

Examples of the use of backreferences:

{| class="wikitable"
|-
! Find
! Replace
! Example Input
! Produced Output
|-
| <code>*, *</code>
| <code>$2 $1</code>
| <code>Smith, John</code>
| <code>John Smith</code>
|-
| <code>Happy ?-th birthday *</code>
| <code>$2 is $1 years old</code>
| <code>Happy 5-th birthday Bob</code>
| <code>Bob is 5 years old</code>
|}

== 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 field will be searched and 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:Remove

2025-04-17T10:30:35Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Remove rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Delete|next=ReNamer:Rules:Replace}}

[[Image:RemoveRule.png]]

This rule removes the specified string from the file name. It has options to remove the first occurrence, the last occurrence, or all the occurrences of the specified string. You can enter multiple strings at a time (just separate them with '''*|*'''). If ReNamer finds any of them in the name, they will be removed. 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
|-
| Remove
| Enter the string to be removed.
*You can enter multiple strings at a time. Press the + button to separate two strings
*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 remove all of them.

'''TIP:''' Sometimes, the file names have a common string that needs to be removed. In such cases, rather than entering the whole string by hand, it is easier to borrow it from one of the file names. To do this, just click on a file name in the '''Files''' pane of ReNamer ''BEFORE'' launching the '''Remove''' rule. ReNamer will automatically copy the entire name of the selected file into the Remove field. Now edit this entry to get the desired common string.

|-
| [[Image:PlusButton.png]] button
| Inserts a separator ('''*{{Pipe}}*''') sequence between two delimiter entries. (You can directly type *{{Pipe}}* instead of clicking on this button.)
|-
| Occurrences
| In case the strings occur multiple times in the name, specify which occurrences should be removed. (Options are: ''first only'', ''last only'', or ''all'')
|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.
|-
| Case sensitive
| Will only remove a specified string from the name if the case matches exactly.
|-
| Whole words only
| Remove the subject text only when it is whole word, not a part of another word.

For example, searching for "bar" would not find a match in "foobar" or "bars".
|-
| Interpret symbols as wildcards
| Treat certain symbols as [[#Wildcards|Wildcards]] for matching simple patterns (similar to [[ReNamer:Regular Expressions|Regular Expressions]]).

|}

=== Wildcards ===

{| class="wikitable"
|-
! Wildcard
! Represents
! Example
|-
| <center><nowiki>*</nowiki></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><nowiki>[]</nowiki></center>
| Brackets enclose a set of characters, any one of which may match a single character at that position.
| '''<nowiki>foo[ab]ar </nowiki>'''equals '''fooaar''' and '''foobar'''
|-
| <center>-</center>
| (only within a pair of brackets) denotes a range of characters.
| '''<nowiki>foo[a-z]ar </nowiki>'''equals '''fooaar''', '''foobar,''' '''foocar,''' '''foodar,''' etc.
|}

[[Category:ReNamer]]

ReNamer:Rules:Delete

2025-04-17T10:30:25Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Delete rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Insert|next=ReNamer:Rules:Remove}}

[[Image:DeleteRule.png]]

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

The parameters are as follows:

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

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

|-
| Delete current name
| A shortcut option for deleting the whole current name.

|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.
|-
| Right-to-left
| Inverts the normal direction for counting a position, so that the count goes from right and towards left.

When this option is selected, the "till the end" option in '''Until''' deletes all characters on the left, what we normally regard as the ''beginning'' of the name.

For example, to keep only the four characters on the right side of the name and delete all the rest of the characters on the left, use:

* '''From:''' Position 5
* '''Until:''' Till the end

|-
| Do not remove delimiters
| If you select this option, the delimiters themselves will be retained.

If you have used two different delimiters in '''From '''and '''Until''' sections, ''both'' of them will be retained.

|}

[[Category:ReNamer]]

ReNamer:Rules:Insert

2025-04-17T10:30:14Z

Den4b: Left align the rule image

{{DISPLAYTITLE:ReNamer › Rules › Insert rule}}
{{Go|up=ReNamer:Rules|next=ReNamer:Rules:Delete}}

[[Image:InsertRule.png]]

This rule inserts the specified string at the beginning of the name, or end of the name, or at any other specified position. It can also insert the string ''conditionally (''only when the existing name contains a second specified string).

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Insert
| Enter the subject text that will be inserted.
|-
| Insert meta tag
[[Image:ReNamer Insert Meta Tag Button.png]]
| Click the button to see a list of [[ReNamer:Meta Tags|meta-tags]].
|-
| Where
| Where to insert the subject text. Select one of the [[#"Where" options|"Where" options]] described below.
|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.
|}

=== "Where" options ===

{| class="wikitable"
|-
! Option
! Details
|-
| Prefix
| Adds the string before the existing name.
|-
| Suffix
| Adds the string after the existing name.
*If the '''skip extension''' option is not checked, the specified text will be inserted ''after'' the extension.

|-
| Position
| Insert at the specified position.
* The position index starts from 1.
* Count spaces and special characters also.
* You can count in the ''right-to-left'' direction
* You may use [[ReNamer:Analyze|Analyze]] window to check the position by pointing to the character with mouse or keyboard instead of counting it by yourself. Just [[ReNamer:Adding files and folders#Selecting files|select]] the file (or files) in the '''Files''' pane and choose the '''Analyze name''' option from the context menu.

|-
| After text
| Insert the main subject text after the text entered in the "after text" box.
*If the "after text" string is not found in the name, the main subject text will not be inserted.

|-
| Before text
| Insert the main subject text before the text entered in the "before text" box.
*If the "before text" string is not found in the name, the main subject text will not be inserted.

|-
| Replace current name
| The current name is deleted prior to inserting the subject text.

|}

[[Category:ReNamer]]

ReNamer:Using the Rules

2025-04-17T10:28:11Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Using the Rules}}
{{Go|up=ReNamer|next=ReNamer:Rules}}

You can load a stack of rules in ReNamer. These rules act on the loaded files in the "top-to-bottom" order.
This allows you to achieve very complex renaming algorithms.

* A rule modifies the name and then passes it to the next rule, which acts on the '''modified''' name (not the original name).
* Any rule can be used multiple times, each time with different settings.

All you have to do is to visualize how each rule in the stack affects the file name when the file name "passes through" the stack.

The first subtopic provides an [[ReNamer:Rules|overview of Rules]].

The subsequent subtopics show the specifics of each rule:

* How each option works, and how to set it.
* Examples (typical uses).

'''Tip:''' If you are going to use the same set of rules frequently, it is best to save it as a [[ReNamer:Using presets|Preset]]. This allows you to re-load the entire set with a keyboard shortcut (such as '''CTRL+1'''). A huge timesaver!

[[Category:ReNamer]]

ReNamer:Rules

2025-04-17T10:27:06Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Overview of Rules}}
{{Go|up=ReNamer}}

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.

{| 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:Padding|Padding]]
| Apply or remove zero padding to/from number sequences, or add text padding using custom characters.
|-
| [[ReNamer:Rules:CleanUp|Clean Up]]
| 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|Regular Expressions]]
|
Regular Expressions (RegEx) are 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|Pascal Script]]
| 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|User Input]]
| Rule that simply sets the new names of the files to the names entered in a list (one name per line).
|-
| [[ReNamer:Rules:ReformatDate|Reformat Date]]
| Change format of date/time values in the filename.
|}

[[Category:ReNamer]]

ReNamer:Rules:ReformatDate

2025-04-17T10:23:16Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Reformat Date rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:UserInput}}
__NOTOC__
[[File:ReformatDateRule.png|center]]

This rule allows finding and reformatting various date/time values in the filename.

Allowed date/time format variables are described in the [[ReNamer:Date and Time format|Date and Time format]] article.

{| class="wikitable"
! Parameter
! Description
|-
| Find date/time format
| Find date and/or time matching a specified format.

A dropdown menu provides a quick access to commonly used formats.
|-
| Convert to date/time format
| Convert found date and/or time values to the specified format.

A dropdown menu provides a quick access to commonly used formats.
|-
| Match as whole words only
| When searching for a matching date/time pattern, match only if the found pattern is a whole word, i.e. surrounded by word boundaries.

For example: A 4 digit year pattern (YYYY) will be found in "''foo'''''1234'''''bar''" if this option is disabled, but not found if option is enabled.
|-
| Skip extension
| Exclude file extension from processing.
|-
| Use custom short months
| Use a custom list of short month names when searching or formatting short month name pattern (MMM). Month names are separated by a comma.

By default, month names from the system locale are used.
|-
| Use custom long months
| Use a custom list of long month names when searching or formatting long month name pattern (MMMM). Month names are separated by a comma.

By default, month names from the system locale are used.
|-
| Adjust time by
| This option lets you adjust date/time by any arbitrary number of years, months, days, hours, minutes, seconds and milliseconds.
|}

[[Category:ReNamer]]

ReNamer:Rules:UserInput

2025-04-17T10:22:59Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › User Input rule}}
{{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 the [[ReNamer:Export_menu|Export menu]] for options on export and import of files and their new names.

== 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:PascalScript

2025-04-17T10:22:33Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Pascal Script rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:RegEx|next=ReNamer:Rules:UserInput}}

[[Image:PascalScriptRule.png|center]]

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

== Using a ready script ==

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

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

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

== Borrowing readymade scripts ==

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

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

Search for a suitable script.

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

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

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

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

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

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

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

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

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

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

|}

== Writing your own scripts ==

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

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

The step-by-step procedure is as follows:

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

[[Category:ReNamer]]

ReNamer:Rules:RegEx

2025-04-17T10:22:10Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Regular Expressions rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Translit|next=ReNamer:Rules:PascalScript}}

[[Image:RegExRule.png|center]]

This rule allows finding and replacing patterns defined as [[ReNamer:Regular Expressions|Regular Expressions]].

Regular Expressions (RegEx) use a special syntax for describing search and replace patterns, they are very powerful and ''really'' worth learning.

ReNamer users have posted many RegEx examples at the [http://www.den4b.com/forum/ User Forum], where you might find your particular case already solved.

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

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]]

[[Category:ReNamer]]

ReNamer:Rules:Translit

2025-04-17T10:21:39Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Translit rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:CleanUp|next=ReNamer:Rules:RegEx}}

[[Image:TranslitRule.png|center]]

This rule transliterates one alphabet into another. Its main goal is to transliterate Non-English characters from different languages into their English/Latin representation. For example, the German character '''ü''' can be transliterated to '''ue''' (the name '''Müller '''can be also written as '''Mueller''').

This rule uses ''transliteration maps'' (explained below).

== Transliteration maps ==

To transliterate, we create a pair of equivalent characters, like this: '''ü=ue'''

(Note that the right side of this equation has ''two'' characters. Any number of characters may be placed on both sides of the equation.)

We need several such ''equivalent character pairs'' to convert one language into another. The entire set is called a ''transliteration map''. (This is really some kind of a find-and-replace rule.)

ReNamer has several such built-in maps. Each map is named after a language (the second language in all maps is English).

Each map can be used in ''both'' directions (e.g. French-to-English or English-to-French.)

When you start up the '''Translit''' Rule, its window does not show any maps. You are free to do any of the following:

#Use any of the built-in maps (and use it in ''forward'' or ''reverse'' direction)
#Create your own map and use it.
#Edit a built-in map first, and then use it.

Let us see how to do this.

== Automatic case conversion ==

Translit rule does automatic case conversion with an algorithm adopted specifically for transliteration. Translit rule discard the case on the input, i.e. "A=B" is same as "a=b". Case is decided upon case of the input fragment. Multiple character fragments are treated as part of words, with their case decided based on the case of letters around them.

The logic for the case conversion is as follows (ReNamer Beta from 23 Aug 2009):
<pre>
set OUTPUT-PART to lower case
if first letter in INPUT-PART is upper case then
if length of OUTPUT-PART bigger than 1 then
if next letter in original name is upper case then
convert whole OUTPUT-PART to upper case
else
convert only first letter in OUTPUT-PART to upper case
else
convert whole OUTPUT-PART to upper case
</pre>

== Using a built-in transliteration map ==

To select any of the built-in maps, press the [[Image:TranslitMapsButton.png]] button. A list of available transliteration maps pops up:
<center>[[Image:TranslitMenu.png]]</center>
Click on the desired transliteration map. As an example, let us click on the French (to English) transliteration map.

The '''Rules''' window changes immediately to show the French characters and their English equivalents.
<center>[[Image:TranslitRuleExample.png]]</center>
You can edit any of the entry in this list, add new entries, or delete any of the entries.

Note that such editing does not alter the saved version of the map. The map is edited just for a one-time use. If you select the same Translit map again, ReNamer will load the ''original'' version, not the ''edited'' version. You will see how to [[#Saving_a_transliteration_map|alter a transliteration map]] in a section below.

Next, select the rule's parameters as shown below:

{| class="wikitable"
|-
! Parameter
! Details
|-
| forward
| This is transliteration from-left-to-right direction, as defined in the map.
|-
| backward
| This is transliteration from-right-to-left direction, as defined in the map.
|-
| skip extension
| If this check box is selected, the extension will be ignored by the rule.
|}

Finally, press the [[Image:AddRuleButton.png]] button to add the rule to the stack.

== Making your own transliteration map ==

Click in the '''Translit Alphabet''' window, and start entering your custom alphabet.

Transliteration alphabet consists of two equivalence parts (or a couple), which are entered one per line and two parts separated with "=" (equal sign). Alphabet should not contain spaces and should have case discarded ([[ReNamer:Rules:Translit#Automatic_case_conversion|case is adjusted automatically]]). Also, make sure to put couples which contain greater number of characters at the top, so they will get processed first and will not get processed partially by shorter representations. Below is a simple example:

{| align="center"
|
<pre>
щ=sh
ю=yu
я=ya
ь='
э=e
</pre>
|}

After entering all such transliterations, press the [[Image:AddRuleButton.png]] button to add the rule to the rule-stack.

Note that this rule is not saved yet (it was just composed for a one-time use). The following topic shows how to save a map.

== Saving a transliteration map ==

To save a newly composed Transliteration rule,

#Press the [[Image:TranslitMapsButton.png]] button.
#:A menu pops up.
#:<center>[[Image:TranslitMenu.png]]</center>
#Select the last option ('''Save Translit...''').
#:A window pops up, as shown below:
#:<center>[[Image:SaveTranslitMapDialog.png]]</center>
#Enter a new name for the map and press '''OK'''. The new map is saved.

The process of saving an edited Transliteration map is similar. The only difference is that the '''Save Translit '''window (see above) shows the current map's name. You can press '''OK''' to save the changes you've just made, or enter a new name to create a new translit map for the edited version of the current map.

The new map's name is added to the map list.

From now on, the new map will also be available as "standard".

== Unicode character forms ==

Have you encounter a case where some characters don't get converted, despite having a visually identical character defined in the Translit alphabet?

Unicode characters can be defined using exact character codes or using [https://en.wikipedia.org/wiki/Combining_character combining characters]. The displayed characters will look identical, but their binary content is completely different. The conversion process between these forms is covered by the [https://unicode.org/reports/tr15/ Unicode Normalization] standard.

Alphabets in the Translit rule are normally defined using exact character codes, so the combining characters won't get affected. You can put a piece of text through a ''Unicode analyzer'' to see exactly how each character is defined and to identify the use of combining characters.

To handle all possible forms of the same visual character in Translit alphabets, one could define all possible forms in an alphabet or one can simply strip away those combining characters, which can be accomplished by using the "Strip unicode marks" option found in the [[ReNamer:Rules:CleanUp|Clean Up rule]].

[[Category:ReNamer]]

ReNamer:Rules:CleanUp

2025-04-17T10:21:20Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Clean Up rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Padding|next=ReNamer:Rules:Translit}}

[[Image:CleanUpRule.png|center]]

This rule cleans up the filenames from (or for) commonly used naming conventions for Internet, peer-to-peer networks and other resources. Multiple problems can be removed at once.

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details

|-
| Strip out content of brackets
| A typical use of this option is to strip the needless comments attached to filenames, such as '''(best!!)'''.
*This option removes the brackets also.
*You can select any/all of the various types of brackets.

If you do NOT want to delete the content within the brackets, use the [[ReNamer:Rules:Strip|Strip]] rule instead.

|-
| Replace these characters with spaces
| These characters occurring in the file names are removed and a space is inserted in their place.

|-
| Fix spaces
| Replace multiple consecutive spaces with a single space.
It also removes spaces from the beginning and the end of the filename:
*If '''skip extension''' is selected it removes spaces from the beginning and end of the ''base name'' (''before'' the extension).
*If '''skip extension''' is deselected it removes spaces from the beginning and from the end of the ''filename'' (''after'' the extension).

|-
| Normalize unicode spaces
| Replace all Unicode white space characters with a standard space bar character code. [[Unicode]] character set contains a number of different characters (<tt>C1_SPACE</tt> type) that represent a white space with slightly different properties (e.g. wider, narrower, etc).

|-
| Strip unicode marks
| Strip unicode marks, including combining marks, diacritics and accents.

For example, it will convert "á" to "a", "Ñ" to "N", "X̅" to "X", and so on.

|-
| Insert a space in front of capitalized letters
| Often words in the file name are just joined together, without spaces or underscores to separate them. Each word begins with a capital letter, so that you can read it easily.

This option separates such words in the file name.
:For example, '''SeparateTheseWords.pdf''' becomes '''Separate These Words.pdf'''.

(Note that if there is a capitalized letter at the very beginning of the name, ReNamer does NOT add a space before it.)

|-
| Prepare for SharePoint
| Prepares the file for hosting it on [http://www.microsoft.com/sharepoint/prodinfo/what.mspx Microsoft Sharepoint].
#strips standard forbidden filename characters
#strips consecutive dots
#strips '''#''', '''%''', '''~''', '''&'''
#replaces '''{''' and '''}''' with '''(''' and ''')'''

|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.
|}

[[Category:ReNamer]]

ReNamer:Rules:Padding

2025-04-17T10:21:02Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Padding rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Randomize|next=ReNamer:Rules:CleanUp}}

[[Image:PaddingRule.png|center]]

This rule allows you to apply or remove zero padding to/from number sequences, or add text padding using custom characters.

The "number sequences" parameters:

{| class="wikitable"
|-
! Parameter
! Description

|-
| Add zero padding to length
| Apply zero padding to number sequences until the number of digits reaches a specified count (length).

|-
| Remove zero padding
| Strip away leading zeros from all number sequences.

|}

The "text padding" parameters:

{| class="wikitable"
|-
! Parameter
! Description

|-
| Add padding to length
| Add custom text padding either form the left or the right side of the subject.

|-
| Padding characters
| A sequence of custom characters which will be used as the padding material.

|-
| Position
| Choose either the left or the right side for adding the text padding.

|}

General parameters:

{| class="wikitable"
|-
! Parameter
! Description

|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.

|}

[[Category:ReNamer]]

ReNamer:Rules:Randomize

2025-04-17T10:20:42Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Randomize rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Serialize|next=ReNamer:Rules:Padding}}

[[Image:RandomizeRule.png|center]]

This rule inserts randomly generated sequences of specified length and using a selection characters (digits, letters, or a custom set).

Several common practical uses:
# Randomize the order files.
# Destroy existing filenames.

The parameters are as follows:

{| class="wikitable"
! Parameter
! Description

|-
| Length of random sequence
| Specify how many characters your random sequence should have.

For example, if you are using only digits and set length to 4, you will will get random numbers from 0000 to 9999 (inclusive).

|-
| Unique if possible
| Normally, randomly generated values can repeat themselves. If this option is selected, ReNamer will generate unique values (no repetition) when possible.

|-
| Characters to use
| The set of characters which will be used for generating random sequences.

You can choose between using digits (0..9), English letters (a..z) or specify your custom set of characters.

|-
| Insert where
| Specify where to insert the number (see below for individual options).

|}

Options for where to insert the number:

{| class="wikitable"
! Option
! Description

|-
| Prefix
| Before the original filename

|-
| Suffix
| After the original filename

|-
| Position
| Insert the number at the specified position.

|-
| Replace current name
| Inserted number replaces the entire filename.

|-
| Skip extension
| Exclude file extension when calculating the position for insertion.

|}

[[Category:ReNamer]]

ReNamer:Rules:Serialize

2025-04-17T10:17:53Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Serialize rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Case|next=ReNamer:Rules:Randomize}}

[[Image:SerializeRule.png|center]]

This rule works on a set of files, and inserts incremental numeric series of digits in the names of those filenames.

The files listed in the pane can be numbered in increasing or decreasing order, with various steps, repeat and reset configuration. The position of each file in the '''Files''' pane becomes important, so check the order of the files in the list before applying this rule.

Examples:

# You have a bunch of log files, and you want to make them look like "log0001", "log0002", "log0003", etc.
# You want to force specific sorting for files: "01 - Song XYZ", "02 - Song ABC", "03 - Song YYY", etc.

The parameters are as follows:

{| class="wikitable"
! Parameter
! Description

|-
| Index start
| Starting number. For example, if the destination folder already has some files with serialized numbers, you can start with the next number.

|-
| Step
| Increment the index by this value after each processed file. Usually 1, but you may like to enter a higher number here if files with intermediate numbers are expected later. Also, negative numbers can be used to make decremental indexes, e.g. -1, -2, -3, etc.

|-
| Repeat
| How many times to repeat (reuse) the same index before incrementing it.

|-
| Reset every
| Reset index to the initial value after processing this many files.

|-
| Reset if folder changes
| Since ReNamer can work on files collected from multiple folders, this control allows you to reset the counter for each of those folders. The effect is as if you are repeating the same command for each of the folders separately.

|-
| Reset if file name changes
| Reset the counter when the file name changes. This option is especially useful for fixing (serializing) duplicated file names, when the files with the same name are grouped together, which can be achieved by sorting the files by name or path.

|-
| Pad with zeros to length
| Pad the inserted number with leading zeros. For example, "457" becomes "000457" if it is padded to reach 6 digits, and "0457" if padded to 4 digits.

|-
| Insert where
| Specify where to insert the number (see below for individual options).

|}

=== Insert location ===

Options for where to insert the number:

{| class="wikitable"
! Option
! Description

|-
| Prefix
| Before the original filename

|-
| Suffix
| After the original filename

|-
| Position
| Insert the number at the specified position.

|-
| Replace current name
| Inserted number replaces the entire filename.

|-
| Skip extension
| Exclude file extension when calculating the position for insertion.

|}

=== Numbering system ===

A choice of the '''Numbering system''' dictates which symbols and enumeration technique are used for the serialization.

{| class="wikitable"
! Number system
! Description / Examples

|-
| Decimal digits
| Index starts at 0 with repeat 1 and step 1: 
<tt>0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, …</tt>

|-
| English letters
| Index starts at 1 with repeat 1 and step 1: 
<tt>a, b, c, …, x, y, z, ba, bb, bc, …, bx, by, bz, ca, cb, cc, …, zx, zy, zz, baa, bab, bac, …</tt>

Index starts at 1 with repeat 1 and step 1, pad to length 3: 
<tt>aaa, aab, aac, …, aax, aay, aaz, aba, abb, abc, …, abx, aby, abz, aca, acb, acc, …, azx, azy, azz, baa, bab, bac, …</tt>

|-
| Roman numerals
| Index starts at 1 with repeat 1 and step 1: 
<tt>I, II, III, IV, V, VI, VII, VIII, IX, X, XI, XII, …</tt>

|-
| Music notes
| Index starts at 1 with repeat 1 and step 1: 
<tt>C0, C#0, D0, D#0, E0, F0, F#0, G0, G#0, A0, A#0, B0, C1, C#1, …</tt> 
''Added in ReNamer 7.3.0.2 Beta.''

|-
| Simplified Chinese
| Index starts at 1 with repeat 1 and step 1: 
<tt>一, 二, 三, 四, 五, 六, 七, 八, 九, 一十, 一十一, 一十二, 一十三, …</tt>

|-
| Custom alphabetic
| Index starts at 1 with repeat 1 and step 1, using "ABC" symbols: 
<tt>A, B, C, BA, BB, BC, CA, CB, CC, BAA, BAB, BAC, BBA, …</tt>

Index starts at 1 with repeat 1 and step 1, using "01" symbols: 
<tt>0, 1, 10, 11, 100, 101, 110, 111, 1000, 1001, 1010, 1011, 1100, …</tt>

|-
| Custom numeric
| Index starts at 0 with repeat 1 and step 1, using "ABC" symbols: 
<tt>A, B, C, BA, BB, BC, CA, CB, CC, BAA, BAB, BAC, BBA, …</tt>

Index starts at 0 with repeat 1 and step 1, using "01" symbols: 
<tt>0, 1, 10, 11, 100, 101, 110, 111, 1000, 1001, 1010, 1011, 1100, …</tt>

|}

[[Category:ReNamer]]

ReNamer:Rules:Case

2025-04-17T10:17:37Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Case rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Strip|next=ReNamer:Rules:Serialize}}

[[Image:CaseRule.png|center]]

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

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

The parameters are as follows:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

=== Examples of Force case option ===

You may want to use a very specific case format for certain text fragments, irregardless of other case options.

Here are some typical examples where "Force case" option may be useful:

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

|}

[[Category:ReNamer]]

ReNamer:Rules:Strip

2025-04-17T10:17:08Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Strip rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Extension|next=ReNamer:Rules:Case}}

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

Strip characters from the filename. The rule has predefined character sets, like digits, symbols and brackets, but you can also define your own character set. All occurrences of the specified characters will be removed from the filename.

Character set parameters:

{| class="wikitable"
|-
! Parameter
! Details
|-
| English
|
Strip all English characters.

* Numbers (0-9) will not be stripped.
* Non-English characters will not be stripped, e.g. characters with [http://en.wikipedia.org/wiki/Diacritic diacritical mark], which are used in many languages in Europe and Asia)

|-
| Digits
| Strip digits.
|-
| Symbols
| Strip symbols.

* All characters that are considered to be symbols are showed in the box on the right.
|-
| Brackets
| Strip brackets.

* The content between the brackets will remain unaffected.
* If you want to delete the content as well, use the [[ReNamer:Rules:CleanUp|CleanUp]] rule instead.
|-
| User-defined
| Define any character that needs to be stripped off.
* Note that this is not a string. All characters in the text box will removed individually.
|}

Positioning parameters:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Everywhere
| The characters will be stripped no matter where they occur in the filename.
|-
| Leading
| Strip characters only at the beginning of the filename.
|-
| Trailing
| Strip characters only at the end of the filename.
|}

Miscellaneous parameters:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Strip all characters except selected
|
Retains the selected characters only, and strips the rest.

* This option is very useful to strip all non-English characters: Select this option along with the '''English''' option above.
|-
| Case sensitive
| Strip characters in a case sensitive manner.
|-
| Skip extension
| If this check box is selected, the extension will be ignored by the rule.
|}

[[Category:ReNamer]]

ReNamer:Rules:Extension

2025-04-17T10:06:36Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Extension rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Rearrange|next=ReNamer:Rules:Strip}}

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

This rule allows you to attach a new extension. It is useful when the extension of a file is missing (or if the file has a wrong extension). There is an option to find the correct extension based on the file's structure.

The parameters are as follows:

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

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

|-
| Detect using binary signature
| Try to detect a correct file extension using built-in [[#Binary signatures|Binary signatures]] of commonly used files.
|}

=== Binary signatures ===

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

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

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

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

=== Filename starts with a dot ===

Many operating systems treat the dot at the start of the filename as an indicator that the file should be hidden. For that reason, the dot at the start of the filename is not considered as a file extension delimiter.

This behavior can be toggled via an option in the settings file:

<pre>FirstDotAtFileNameStartIsExtension=1</pre>

The settings file is normally located in the [[Application Data Storage]].

Examples of filenames and their considered extension depending on the value of the option:

{| class=wikitable
! Filename
! Extension if 1
! Extension if 0
|-
| file.ext
| .ext
| .ext
|-
| .file.ext
| .ext
| .ext
|-
| .file
| .file
|
|}

[[Category:ReNamer]]

ReNamer:Rules:Rearrange

2025-04-17T10:06:18Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Rearrange rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Replace|next=ReNamer:Rules:Extension}}

[[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.

|-
| [[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.

|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.

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

=== 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

2025-04-17T10:05:32Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Replace rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Remove|next=ReNamer:Rules:Rearrange}}

[[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 also use wildcards to create simple patterns.

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.

In that case, the nth entry in the '''Find''' field is replaced by the nth entry in the '''Replace''' field.

|-
| Replace
| Enter strings that will replace the "Find" strings.

Note that the number of strings (separated with '''*|*''') in "Find" and "Replace" fields should be the same. If there is more strings in the "Find" field than in the "Replace" field the spare strings will be removed (replaced with an empty string). If there is more strings in the "Replace" field, 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.
|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.
|-
| Case sensitive
| Will only remove a specified string from the name if the case matches exactly.
|-
| Whole words only
| Remove the subject text only when it is whole word, not a part of another word.

For example, searching for "bar" would not find a match in "foobar" or "bars".
|-
| 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.
|}

Backreferences allow for reuse of wildcard matches in the Replace field using the '''$N''' notation, where '''$1''' is the first wildcard match, '''$2''' is second, and so on.

Examples of the use of backreferences:

{| class="wikitable"
|-
! Find
! Replace
! Example Input
! Produced Output
|-
| <code>*, *</code>
| <code>$2 $1</code>
| <code>Smith, John</code>
| <code>John Smith</code>
|-
| <code>Happy ?-th birthday *</code>
| <code>$2 is $1 years old</code>
| <code>Happy 5-th birthday Bob</code>
| <code>Bob is 5 years old</code>
|}

== 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 field will be searched and 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:Remove

2025-04-17T10:05:14Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Remove rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Delete|next=ReNamer:Rules:Replace}}

[[Image:RemoveRule.png|center]]

This rule removes the specified string from the file name. It has options to remove the first occurrence, the last occurrence, or all the occurrences of the specified string. You can enter multiple strings at a time (just separate them with '''*|*'''). If ReNamer finds any of them in the name, they will be removed. 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
|-
| Remove
| Enter the string to be removed.
*You can enter multiple strings at a time. Press the + button to separate two strings
*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 remove all of them.

'''TIP:''' Sometimes, the file names have a common string that needs to be removed. In such cases, rather than entering the whole string by hand, it is easier to borrow it from one of the file names. To do this, just click on a file name in the '''Files''' pane of ReNamer ''BEFORE'' launching the '''Remove''' rule. ReNamer will automatically copy the entire name of the selected file into the Remove field. Now edit this entry to get the desired common string.

|-
| [[Image:PlusButton.png]] button
| Inserts a separator ('''*{{Pipe}}*''') sequence between two delimiter entries. (You can directly type *{{Pipe}}* instead of clicking on this button.)
|-
| Occurrences
| In case the strings occur multiple times in the name, specify which occurrences should be removed. (Options are: ''first only'', ''last only'', or ''all'')
|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.
|-
| Case sensitive
| Will only remove a specified string from the name if the case matches exactly.
|-
| Whole words only
| Remove the subject text only when it is whole word, not a part of another word.

For example, searching for "bar" would not find a match in "foobar" or "bars".
|-
| Interpret symbols as wildcards
| Treat certain symbols as [[#Wildcards|Wildcards]] for matching simple patterns (similar to [[ReNamer:Regular Expressions|Regular Expressions]]).

|}

=== Wildcards ===

{| class="wikitable"
|-
! Wildcard
! Represents
! Example
|-
| <center><nowiki>*</nowiki></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><nowiki>[]</nowiki></center>
| Brackets enclose a set of characters, any one of which may match a single character at that position.
| '''<nowiki>foo[ab]ar </nowiki>'''equals '''fooaar''' and '''foobar'''
|-
| <center>-</center>
| (only within a pair of brackets) denotes a range of characters.
| '''<nowiki>foo[a-z]ar </nowiki>'''equals '''fooaar''', '''foobar,''' '''foocar,''' '''foodar,''' etc.
|}

[[Category:ReNamer]]

ReNamer:Rules:Delete

2025-04-17T10:04:33Z

Den4b: Display title

{{DISPLAYTITLE:ReNamer › Rules › Delete rule}}
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:Insert|next=ReNamer:Rules:Remove}}

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

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

The parameters are as follows:

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

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

|-
| Delete current name
| A shortcut option for deleting the whole current name.

|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.
|-
| Right-to-left
| Inverts the normal direction for counting a position, so that the count goes from right and towards left.

When this option is selected, the "till the end" option in '''Until''' deletes all characters on the left, what we normally regard as the ''beginning'' of the name.

For example, to keep only the four characters on the right side of the name and delete all the rest of the characters on the left, use:

* '''From:''' Position 5
* '''Until:''' Till the end

|-
| Do not remove delimiters
| If you select this option, the delimiters themselves will be retained.

If you have used two different delimiters in '''From '''and '''Until''' sections, ''both'' of them will be retained.

|}

[[Category:ReNamer]]

ReNamer:Rules:Insert

2025-04-17T09:57:27Z

Den4b: Single guillemet as the display title separator

{{DISPLAYTITLE:ReNamer › Rules › Insert rule}}
{{Go|up=ReNamer:Rules|next=ReNamer:Rules:Delete}}

[[Image:InsertRule.png|center]]

This rule inserts the specified string at the beginning of the name, or end of the name, or at any other specified position. It can also insert the string ''conditionally (''only when the existing name contains a second specified string).

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Insert
| Enter the subject text that will be inserted.
|-
| Insert meta tag
[[Image:ReNamer Insert Meta Tag Button.png]]
| Click the button to see a list of [[ReNamer:Meta Tags|meta-tags]].
|-
| Where
| Where to insert the subject text. Select one of the [[#"Where" options|"Where" options]] described below.
|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.
|}

=== "Where" options ===

{| class="wikitable"
|-
! Option
! Details
|-
| Prefix
| Adds the string before the existing name.
|-
| Suffix
| Adds the string after the existing name.
*If the '''skip extension''' option is not checked, the specified text will be inserted ''after'' the extension.

|-
| Position
| Insert at the specified position.
* The position index starts from 1.
* Count spaces and special characters also.
* You can count in the ''right-to-left'' direction
* You may use [[ReNamer:Analyze|Analyze]] window to check the position by pointing to the character with mouse or keyboard instead of counting it by yourself. Just [[ReNamer:Adding files and folders#Selecting files|select]] the file (or files) in the '''Files''' pane and choose the '''Analyze name''' option from the context menu.

|-
| After text
| Insert the main subject text after the text entered in the "after text" box.
*If the "after text" string is not found in the name, the main subject text will not be inserted.

|-
| Before text
| Insert the main subject text before the text entered in the "before text" box.
*If the "before text" string is not found in the name, the main subject text will not be inserted.

|-
| Replace current name
| The current name is deleted prior to inserting the subject text.

|}

[[Category:ReNamer]]

ReNamer:Rules:Insert

2025-04-17T09:55:10Z

Den4b: Middle dot as the display title separator

{{DISPLAYTITLE:ReNamer · Rules · Insert rule}}
{{Go|up=ReNamer:Rules|next=ReNamer:Rules:Delete}}

[[Image:InsertRule.png|center]]

This rule inserts the specified string at the beginning of the name, or end of the name, or at any other specified position. It can also insert the string ''conditionally (''only when the existing name contains a second specified string).

The parameters are as follows:

{| class="wikitable"
|-
! Parameter
! Details
|-
| Insert
| Enter the subject text that will be inserted.
|-
| Insert meta tag
[[Image:ReNamer Insert Meta Tag Button.png]]
| Click the button to see a list of [[ReNamer:Meta Tags|meta-tags]].
|-
| Where
| Where to insert the subject text. Select one of the [[#"Where" options|"Where" options]] described below.
|-
| Skip extension
| If checked, the file extension will be excluded from the processing and will remain unaffected.
|}

=== "Where" options ===

{| class="wikitable"
|-
! Option
! Details
|-
| Prefix
| Adds the string before the existing name.
|-
| Suffix
| Adds the string after the existing name.
*If the '''skip extension''' option is not checked, the specified text will be inserted ''after'' the extension.

|-
| Position
| Insert at the specified position.
* The position index starts from 1.
* Count spaces and special characters also.
* You can count in the ''right-to-left'' direction
* You may use [[ReNamer:Analyze|Analyze]] window to check the position by pointing to the character with mouse or keyboard instead of counting it by yourself. Just [[ReNamer:Adding files and folders#Selecting files|select]] the file (or files) in the '''Files''' pane and choose the '''Analyze name''' option from the context menu.

|-
| After text
| Insert the main subject text after the text entered in the "after text" box.
*If the "after text" string is not found in the name, the main subject text will not be inserted.

|-
| Before text
| Insert the main subject text before the text entered in the "before text" box.
*If the "before text" string is not found in the name, the main subject text will not be inserted.

|-
| Replace current name
| The current name is deleted prior to inserting the subject text.

|}

[[Category:ReNamer]]

ReNamer:Rules:Insert

2025-04-17T09:53:29Z

Den4b: Display title

ReNamer:Regular Expressions

2025-04-15T16:21:11Z

Den4b: /* Useful references */ Rephrased the references, included FPC RegEx wiki link

{{Up|ReNamer}}

== Introduction ==

Regular Expressions (RegEx) is a syntax for specifying patterns of text to search and replace, which can be used for renaming files via the [[ReNamer:Rules:RegEx|Regular Expressions renaming rule]]. Special metacharacters allow you to specify, for instance, that a particular string you are looking for occurs at the beginning or end of a line, or contains N recurrences of a certain character.

Metacharacters, such as $ . ^ { [ ( | ) * + ? \ are ''interpreted'' according to their individual meaning, instead of finding a literal match for them.

In this document, RegEx patterns are shown in bold orange. The subject text which is checked against a RegEx pattern for a possible match is shown in '''bold black'''. Parts of the subject text are color-coded to provide a clue as to why a certain part matches (green color), or does not match (red color).

== Simple matches ==

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

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

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

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

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

== Escape sequences ==

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

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

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

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

== Character classes ==

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

Note that:

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

{| class="wikitable"
|-
! RegEx Pattern
! Remarks
|-
| <center>[abcdef]</center>
| Matches a, b, c, d, e, or f (only ''one'' character), but no other characters
|-
| <center>[c-m]</center>
| Matches any one (and only one) of the small alphabetical characters, from c to m
|-
| <center>[G-J]</center>
| Matches any one (and only one) of the capital alphabetical characters from G to J
|-
| <center>[a-zA-Z]</center>
| Matches any one (and only one) of the alphabetical characters (capital or small)
|-
| <center>[5-8]</center>
| Matches any one (and only one) of numerical characters from 5 to 8
|-
| <center>[\n-\x1F]</center>
|
Matches any one (and only one) of characters with their ordinal value in range from #10 (\n) to #31 (\x1F), which in [https://en.wikipedia.org/wiki/ASCII ASCII] character table correspond to some non-printable characters.

Note the use of [[#Escape_sequences|escape sequences]] inside of this example.

|}

There are some special conditions:

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

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

== Predefined classes ==

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

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

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

== Word and text boundaries ==

A word boundary \b matches a position between a word character \w and a non-word character \W. For the purpose of a word boundary position, the start and end of text will be treated as non-word characters \W. These markers are commonly used for matching patterns as whole words, while ignoring occurrences within words.

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

For example, \bhis\b will search for a whole word '''his''', but will ignore '''this''', '''history''' or '''whistle'''.

== Iterators ==

Iterators (quantifiers) are meta-characters that specify how many times the ''preceding'' expression has to repeat. For example, finding a numeric sequence exactly 3 to 5 digits long.

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

All iterators are greedy by default. Adding ? (question mark) at the end of an iterator makes it non-greedy.

For example:

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

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

Let us see some examples:

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

== Alternatives ==

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

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

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

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

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

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

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

== Subexpressions ==

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

The brackets serve two main purposes:

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

Let us see some examples:

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

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

== Backreferences ==

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

=== Substitution of text using backreference ===

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

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

The replacement text is typically a combination of-

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

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

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

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

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

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

|}

=== Upper case and lower case manipulations ===

Backreferences can also be used to adjust the case of a certain patterns or fragments, which cannot be easily achieved with generic case manipulation rules.

{| class="wikitable"
! Flag
! Description
|-
| <code>\L</code>
| Convert all characters to lowercase.
|-
| <code>\l</code>
| Convert only the first character to lowercase (that's a lower case L).
|-
| <code>\U</code>
| Convert all characters to uppercase.
|-
| <code>\u</code>
| Convert only the first character to uppercase.
|}

These flags can be used together with the backreferences in the replace pattern to adjust the case of text inserted by backreferences.

For example, we can do the following manipulations:

{| class="wikitable"
! Input || Find || Replace || Result
|-
| test ExAmple || (.+) (.+) || $1 $2 || test ExAmple
|-
| test ExAmple || (.+) (.+) || \U$1 $2 || TEST ExAmple
|-
| test ExAmple || (.+) (.+) || $1 \L$2 || test example
|-
| test ExAmple || (.+) (.+) || \u$1 \L$2 || Test example
|}

'''Note:''' Case manipulation features were added in ''v5.72.4 Beta''. This feature is less common and may not exist in other RegEx engines.

== Limitations for binary data ==

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

== Useful references ==

* [https://www.regular-expressions.info/ Regular-Expressions.info] – Excellent site devoted to regular expressions. It is nicely structured, with many easy to understand examples.
* [https://github.com/andgineer/TRegExpr TRegExpr] – Regular expressions library for Delphi and Free Pascal. For syntax and API documentation see [https://regex.sorokin.engineer/ regex.sorokin.engineer].
* [https://wiki.freepascal.org/RegEx_packages FPC RegEx packages] – Regular expressions libraries included in Free Pascal.

[[Category:ReNamer]]