[utilities/kate] doc/kate: Update External Tools doc

Waqar Ahmed null at kde.org
Thu Feb 3 19:07:56 GMT 2022


Git commit 5345f4837510413404855d134e89a0a2719ac7b4 by Waqar Ahmed.
Committed on 03/02/2022 at 18:57.
Pushed by waqar into branch 'master'.

Update External Tools doc

Doc updated to mention the addition of "Triggers".

M  +-    --    doc/kate/kateeditexternaltool.png
M  +9    -0    doc/kate/plugins.docbook

https://invent.kde.org/utilities/kate/commit/5345f4837510413404855d134e89a0a2719ac7b4

diff --git a/doc/kate/kateeditexternaltool.png b/doc/kate/kateeditexternaltool.png
index 67f9b75aa..15f21974e 100644
Binary files a/doc/kate/kateeditexternaltool.png and b/doc/kate/kateeditexternaltool.png differ
diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook
index b40631490..1f2fd11bc 100644
--- a/doc/kate/plugins.docbook
+++ b/doc/kate/plugins.docbook
@@ -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>
+    <variablelist><varlistentry>
+    <term>Following triggers are available:</term>
+    <listitem>
+    <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>
+    </listitem>
+    </varlistentry></variablelist>
 <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>


More information about the kde-doc-english mailing list