Home » Custom Cleaner Editor TextSoap

Custom Cleaner Editor

The custom cleaner editor can be divided into three main panes.

Custom Cleaner List

The leftmost pane represents the custom cleaner list. This contains a list of all custom cleaners created. You can use the filter field (on top of the list) to quickly find your cleaner if you have a large collection of custom cleaners.

You can double click the cleaner name to rename it.

The action buttons represent the most common actions for custom cleaners:

Add a new cleaner

Delete the selected cleaner

Duplicate the selected cleaner

Sort the list of cleaners

Export the selected cleaner

For importing and exporting, you can option drag custom cleaner files into and out of the custom cleaner list to automatically import or export the file.

Action List

The center pane contains the list of actions used for the selected cleaner.

The top bar contains a preview button, allowing you to try out the current cleaner using the text in the clipboard workspace.

The actions menu allows you to copy, cut, paste, expand, collapse, enable and disable selected actions.

The properties button provides access to the custom cleaners properties, including name, description note, and author.

Finally, the subroutine popup menu allows you create, remove and edit subroutines.

Actions are dragged in from the source list in the righthand pane. Some actions, such as "Find and Replace Text" are resizable, others like the "Apply Cleaner" are not. The action lists works very much like Automator's actions. You can drag items to reorder them, collapse the contents and selectively disable specific actions.

When an action is selected, you can store notes regarding that particular action in the comment section below the list. If more than one item is selected, comments for the first selected item are shown.

Source List

The source list contains the actions (or steps) that are available to transform your text. To add an action, you can double-click the action and it will automatically append it to the current cleaner. You may also drag the action into any specific location within the list of actions in the current cleaner. The actions are grouped based on their general type.

See: Available Actions for a complete list of actions.

The action list also includes a list of all the custom cleaners available as well. Adding one of these actions is the equivalent of adding the "Apply Cleaner" action and selecting the given cleaner name from the popup.

Select the icon to toggle displaying descriptions with the action names. You can use the filter at the top of the list to find a specific action based on its name or description (if showing descriptions are on).