Adding Helpers

All you need to do to add a helper application is fill in the name field with what you want to call the helper (this will be used as the menu label), and enter the command to run in the command box.

Then you need to tell Screem what input/output mode to use. By default the current document is fed to the helper (via stdin) and when the helper is finished it replaces the document contents with its output.

Input:
  • Page text This mode will feed the current document to the helper when it is used.

    If you only want part of the document to be processed simply select it in the editor view.

  • Used defined This mode will lets you provide different content each time you run the helper, with an option to use the selected content of the current document.

  • None As the name would suggest, no input will be given to the helper.

Output:
  • Replaces Page This mode will replace the current document with the output (on stdout) of the helper.

    If you only want part of the document to be processed simply select it in the editor view.

  • Inserted into page This mode will insert the helper output (on stdout) at the current cursor position.

    Not implemented yet

  • Shown as messages The output of the helper (on stdout) will be displayed in the messages window.

The final option that can be chosen is whether the helper should be automatically run when you save a document. To do this click the Execute helper when saving documents checkbox, and then select the type of file you want the helper to be used for.

After you have filled in all the details click the Add button and the helper will be added to the list, and appear in the menu with any others you have already created.