[kate] /: Improve the discoverability of the Filter Text plugin and its menu item

Nathaniel Graham null at kde.org
Mon Jul 30 23:27:46 BST 2018


Git commit 25879726e1ff4c049c5fc5b97ae676f6e983e175 by Nathaniel Graham.
Committed on 30/07/2018 at 22:27.
Pushed by ngraham into branch 'master'.

Improve the discoverability of the Filter Text plugin and its menu item

Summary:
The "Filter Text" plugin is one of Kate's most useful plugins for serious professional use, but it's rather hidden behind a nondescript name, caption, and menu item.

This patch improves the caption to mention "terminal commands" to give a hint about its true power, and also uses a compact variant of that same terminology for the menu item. These changes should improve discoverability.

BUG: 396864
FIXED-IN: 18.12.0

Test Plan:
More descriptive caption in the plugins list:
{F6142006}

More descriptive menu item text:
{F6142008}

Reviewers: #kate, dhaumann, cullmann

Reviewed By: #kate, dhaumann, cullmann

Subscribers: kde-doc-english, lueck, kwrite-devel

Tags: #kate, #documentation

Differential Revision: https://phabricator.kde.org/D14390

M  +1    -1    addons/textfilter/plugin_katetextfilter.cpp
M  +1    -1    addons/textfilter/textfilterplugin.desktop
M  +4    -4    doc/kate/plugins.docbook

https://commits.kde.org/kate/25879726e1ff4c049c5fc5b97ae676f6e983e175

diff --git a/addons/textfilter/plugin_katetextfilter.cpp b/addons/textfilter/plugin_katetextfilter.cpp
index 023c9b66e..6aa99419b 100644
--- a/addons/textfilter/plugin_katetextfilter.cpp
+++ b/addons/textfilter/plugin_katetextfilter.cpp
@@ -260,7 +260,7 @@ PluginViewKateTextFilter::PluginViewKateTextFilter(PluginKateTextFilter *plugin,
 
     // create our one and only action
     QAction* a = actionCollection()->addAction(QStringLiteral("edit_filter"));
-    a->setText(i18n("Filter Te&xt..."));
+    a->setText(i18n("&Filter Through Command..."));
     actionCollection()->setDefaultShortcut(a, Qt::CTRL + Qt::Key_Backslash);
     connect(a, &QAction::triggered, plugin, &PluginKateTextFilter::slotEditFilter);
 
diff --git a/addons/textfilter/textfilterplugin.desktop b/addons/textfilter/textfilterplugin.desktop
index e3eb87b46..1ae72fb84 100644
--- a/addons/textfilter/textfilterplugin.desktop
+++ b/addons/textfilter/textfilterplugin.desktop
@@ -60,7 +60,7 @@ Name[vi]=Bộ lọc văn bản
 Name[x-test]=xxText Filterxx
 Name[zh_CN]=文本过滤
 Name[zh_TW]=文字過濾器
-Comment=Easy text filtering
+Comment=Process text using terminal commands
 Comment[ar]=ترشيح سهل للنّصوص
 Comment[ast]=Peñera fácil de testu
 Comment[bg]=Лесно филтриране на текст
diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook
index 0416d6061..69cf42a31 100644
--- a/doc/kate/plugins.docbook
+++ b/doc/kate/plugins.docbook
@@ -2874,14 +2874,14 @@ so the calling program is aware you have finished editing the file.</para></list
 
 <sect1 id="kate-application-plugin-textfilter">
 
-<title>Text Filter Plugin</title><!--Name is completely misleading and should be changed-->
+<title>Text Filter Plugin</title>
 
 <sect2 id="textfilter-using">
 <title>Using the Text Filter Plugin</title>
 
-<para>You can use this plugin to execute shell commands. A selection will
-be used as argument for the shell command, the output will either replace the selection
-or copied to the clipboard.
+<para>You can use this plugin to process selected text using terminal commands.
+The selection will be used as input for the command, and the output will either
+replace the selection or be copied to the clipboard, depending on the user's preference.
 </para>
 
 <itemizedlist>


More information about the kde-doc-english mailing list