| Magic File Renamer Help

Index > Operation > User Interface > Formatting Editor

The formatting editor is available in filters that supports formatting according to a pattern, like Replacer and ID3 Setter.
Formatting allows you to use a variety of formatting parameters, to form a pattern. The pattern is called 'Format String' .
Formatting Parameters

- Format string can include any number or valid formatting parameters and constant text.
- Formatting parameters always extract data as text. Data in different formats, as dates for example, will be converted to text.
- All formatting parameters are in the form: `<name:param1,param2,...>`.

Formatting Parameters Context

- Formatting parameters get a different context for each file or folder in Rename List.
  For example, File Date Formatting Parameter will get the data value for each file or folder in Rename List, when the formatting filter is applied on that file.
- Formatting parameters always use the current (preview) field values and not the original values.
  For example, if a Letters Case Filter set to uppercase is added to Applied Filters List and a File Name Formatting Parameter is used in the Formatter Filter afterwards, then the returned value for the formatting parameter will be the uppercased.
- Once formatting parameter fails to extract data, for a particular file or folder, the formatting filter will fail for that item, causing the preview for this item to fail, thus causing this file to be ignored when Applying Changes.
  For example, Trying to Use Image Data Formatting Parameter on a non-image file.

Highlighting

- Valid formatting parameters are highlighted with red and blue text alternatively.
- Constant text is in default text color (black).
- Invalid formatting parameters are also in default text color.

Usage

- The formatting editor consists of a text box and two buttons to the right of it.
- You can input the format string to the text box by typing, or by using the button.
  When the button is clicked, a pop-up menu with available formatting parameters, divided into groups, is displayed.
  When you select a formatting parameter from the menu, the parameter is added to the text box at the current caret position, with it's default configuration.
- Most of the formatting parameters support configuration. You can customize a formatting parameter by editing it's parameters in the text box, or by using it's configuration window.
  To open a configuration window for a parameter, either right click on the desired parameter in the text box, or place the caret over it and click on the button.
- Double-click on a formatting parameter in the text box to select the entire formatting parameter.

See Also:
Formatting Parameters Reference
Filters Reference
Fields Reference