[education/rkward] rkward: Write paragraph on kate plugins, and improve layout around those.

Thomas Friedrichsmeier null at kde.org
Sat Apr 2 15:37:57 BST 2022


Git commit 30810cd483265740a556a4341bc7972457afac0f by Thomas Friedrichsmeier.
Committed on 02/04/2022 at 14:37.
Pushed by tfry into branch 'master'.

Write paragraph on kate plugins, and improve layout around those.

M  +4    -3    rkward/pages/rkward_addons.rkh
M  +1    -3    rkward/pages/rkward_welcome.rkh
M  +6    -1    rkward/settings/rksettings.cpp

https://invent.kde.org/education/rkward/commit/30810cd483265740a556a4341bc7972457afac0f

diff --git a/rkward/pages/rkward_addons.rkh b/rkward/pages/rkward_addons.rkh
index 9f4e1fdc..5c909365 100644
--- a/rkward/pages/rkward_addons.rkh
+++ b/rkward/pages/rkward_addons.rkh
@@ -27,9 +27,10 @@ still have to install additional libraries or other software for the compilation
 	</section>
 
 	<section title="Kate Add-ons" id="kate_addons_in_rkward">
-	TODO: Write this
-
-	<link href="rkward://settings/addons">Addon settings</link>
+<link href="https://kate.kde.org">Kate</link> is a very powerful text editor using the same text editing component that is also used in RKWard. It also comes with a variety
+of add-ons, e.g. for creating code snippets, or for managing projects in a git repository. Some of these - like e.g. the C++ backtrace navigation tool  do not make much
+sense in the context of RKWard, but many do. To explore what is available, make sure you have kate installed, then visit <link href="rkward://settings/addons">Settings->Addons</link>.
+Addons shown in bold have been reported to be useful and work well in RKWard, but feel free to explore the others, too.
 	</section>
 
 	<section title="RKWard Plugins" id="rkward_plugins">
diff --git a/rkward/pages/rkward_welcome.rkh b/rkward/pages/rkward_welcome.rkh
index 9b0e5bae..96b2edc2 100644
--- a/rkward/pages/rkward_welcome.rkh
+++ b/rkward/pages/rkward_welcome.rkh
@@ -10,10 +10,8 @@
 
 	<section title="Introduction to RKWard" id="introduction">
 	RKWard is a GUI frontend and IDE to <link href="http://www.r-project.org">R</link>, a powerful scripting language for statistical computing. It aims to provide useful features both to experienced users of R, wishing to exploit R's scripting capabilities, as well as to users new to R, looking for an easy way to carry out statistical computation tasks.
-	</section>
 
-	<section title="Getting Started" id="getting_started">
-	If you have used neither R nor RKWard before, you should start with the following guide: <link href="rkward://page/rkward_for_new_users" />.
+	If you have used neither R nor RKWard before, you may want to start by reading the following guide: <link href="rkward://page/rkward_for_new_users" />.
 
 	After that, or for users with some knowledge of R, but new to RKWard, here is a guide focused on introducing the IDE features of RKWard: <link href="rkward://page/rkward_for_r_users" />.
 	</section>
diff --git a/rkward/settings/rksettings.cpp b/rkward/settings/rksettings.cpp
index 2a441134..e3cc9ddb 100644
--- a/rkward/settings/rksettings.cpp
+++ b/rkward/settings/rksettings.cpp
@@ -17,6 +17,7 @@
 #include "rksettings.h"
 
 #include <QPushButton>
+#include <QVBoxLayout>
 
 #include <KLocalizedString>
 #include <KSharedConfig>
@@ -157,10 +158,14 @@ void RKSettings::initModules () {
 		modules.insert(NumPages+i, ktexteditorpages[i]);
 	}
 
+	QWidget *page = new QWidget();
+	auto layout = new QVBoxLayout(page);
 	QLabel *l = new QLabel(i18n("<h1>Add-ons</h1><p>RKWard add-ons come in a variety of forms, each with their own configuration options:</p><h2>R packages</h2><p><a href=\"rkward://settings/rpackages\">Add-ons to the R language itself</a>. These are usually downloaded from \"CRAN\". Some of these add-on packages may additionally contain RKWard plugins.</p><h2>RKWard plugins</h2><p><a href=\"rkward://settings/plugins\">Graphical dialogs to R functionality</a>. These plugins are usually pre-installed with RKWard, or with an R package. However, they can be activated/deactivated to help keep the menus manageable. Note that it is relatively easy to <a href=\"https://api.kde.org/doc/rkwardplugins/\">create your own custom dialogs as plugins</a>!</p><h2>Kate plugins</h2><p><a href=\"rkward://settings/kateplugins\">Plugins developed for Kate / KTextEditor</a>. These provide shared functionality that is useful in the context of text editing and IDE applications. These plugins are usually found pre-installed on your system. You can configure to load the plugins that are useful to your own workflow.</p>"));
 	l->setWordWrap(true);
 	connect(l, &QLabel::linkActivated, [=](const QString &url) { RKWorkplace::mainWorkplace()->openAnyUrl(QUrl(url)); });
-	pages[SuperPageAddons] = addPage(l, i18n("Add-ons"));
+	layout->addWidget(l);
+	layout->addStretch();
+	pages[SuperPageAddons] = addPage(page, i18n("Add-ons"));
 	registerPageModule(SuperPageAddons, PageRPackages);
 	registerPageModule(SuperPageAddons, PagePlugins);
 	registerPageModule(SuperPageAddons, PageKatePlugins);


More information about the rkward-tracker mailing list