Commit 5345f483 authored by Waqar Ahmed's avatar Waqar Ahmed
Browse files

Update External Tools doc

Doc updated to mention the addition of "Triggers".
parent e1b89dea
Pipeline #132761 passed with stage
in 3 minutes and 54 seconds

46.2 KB | W: | H:


65.5 KB | W: | H:

  • 2-up
  • Swipe
  • Onion skin
......@@ -172,6 +172,15 @@ configuration of the tool:</para>
<para><userinput>Working directory</userinput>, the working directory the tool will be started in. If empty, the working directory is set to the current document’s path.</para>
<para><userinput>Mime types</userinput>, if set, the tool is active only if the current document’s mime type matches.</para>
<para><userinput>Save</userinput>, when invoked, saves none, the current document, or all documents.</para>
<para><userinput>Trigger</userinput>, a trigger to execute this tool. A trigger will only affect the currently active document and will only execute if the mimetype of current active document matches the mimetype of the external tool.</para>
<term>Following triggers are available:</term>
<para><userinput>None</userinput>, this is the default, it means the tool has no trigger.</para>
<para><userinput>Before Save</userinput>, this trigger will execute right before saving the document.</para>
<para><userinput>After Save</userinput>, this trigger will execute the tool after the document was saved.</para>
<para><userinput>Reload current document after execution</userinput>, useful when the current file is modified on disk.</para>
<para><userinput>Output</userinput>, the output defines the target of stdout. It is either set to <userinput>Ignored</userinput>, <userinput>Insert at Cursor Position</userinput>, <userinput>Replace Selected Text</userinput>, <userinput>Replace Current Document</userinput>, <userinput>Append to Current Document</userinput>, <userinput>Insert in New Document</userinput>, <userinput>Copy to Clipboard</userinput>, or <userinput>Display in Pane</userinput>.</para>
<para><userinput>Editor command</userinput>, optional command that can be used to invoke the external tool via the built-in <ulink url="help:/katepart/advanced.html#advanced-editing-tools-commandline">command line</ulink>.</para>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment