[education/rkward] rkward: Some more docs
Thomas Friedrichsmeier
null at kde.org
Sat Mar 12 23:15:38 GMT 2022
Git commit 9c1257f4d3937fd1487bc7793dd92ef6bbe5e319 by Thomas Friedrichsmeier.
Committed on 10/03/2022 at 14:31.
Pushed by tfry into branch 'master'.
Some more docs
M +12 -5 rkward/pages/rkward_addons.rkh
M +3 -1 rkward/settings/rksettings.cpp
https://invent.kde.org/education/rkward/commit/9c1257f4d3937fd1487bc7793dd92ef6bbe5e319
diff --git a/rkward/pages/rkward_addons.rkh b/rkward/pages/rkward_addons.rkh
index c9e08130..59eaedb1 100644
--- a/rkward/pages/rkward_addons.rkh
+++ b/rkward/pages/rkward_addons.rkh
@@ -19,22 +19,29 @@ The following sections deal with these, in turn, showing you how to find / insta
</summary>
<section title="R packages" id="r_packages_in_rkward">
- TODO: Write this
+In addition to the regular R command line tools for managing R packages (see <link href="rkward://rhelp/install.packages"/>), RKWard offers a graphical dialog to search, install and/or load
+packages (Settings->Manage R packages and plugins).
+
+Note that, by default, R packages are distributed as compiled binaries on Windows and MacOS, but not Linux. While for the latter, installation from source is fully automated, you may
+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>
</section>
<section title="RKWard Plugins" id="rkward_plugins">
- TODO: Extend this
+RKWard plugins can be installed from a variety of sources, but the usual distribution of add-on packages is via R packages. To look for R packages that provide RKWard graphical dialogs,
+use the regular dialog (Settings->Manage R packages and plugins), and check the option "Show only packages providing RKWard dialogs".
- Are you missing a particular GUI dialog in the current menu? A growing number of plugins is available for separate download as R packages. See what's available for installation at Settings->Manage R packages and plugins. In the R package installation section, you can select to show packages providing graphics dialogs for RKWard.
+Not all RKWard plugins packaged this way will be visible in the R package installation dialog, as they are not hosted (yet) hosted in the default repositories, notably, at the time of this writing, the very extensive <link href="https://github.com/rkward-community/rk.Teaching">rk.Teaching</link> set of plugins.
</section>
<section title="Creating your own RKWard Plugins" id="writing_plugins">
- Still missing something?
+Still missing something?
- Check out the <link href="help:/rkwardplugins/index.html">Introduction to Writing Plugins for RKWard</link> (<link href="http://api.kde.org/doc/rkwardplugins/">most recent version online</link>) to learn how easy it is to enhance RKWard with your custom dialogs. And if you like, how to share your work with the community of RKWard users. See the <link href="rkward://rhelp/rkward-package">rkward package overview</link> for RKWard specific function for development and scripting.
+Check out the <link href="help:/rkwardplugins/index.html">Introduction to Writing Plugins for RKWard</link> (<link href="http://api.kde.org/doc/rkwardplugins/">most recent version online</link>) to learn how easy it is to enhance RKWard with your custom dialogs. And if you like, how to share your work with the community of RKWard users. See the <link href="rkward://rhelp/rkward-package">rkward package overview</link> for RKWard specific function for development and scripting.
</section>
</document>
diff --git a/rkward/settings/rksettings.cpp b/rkward/settings/rksettings.cpp
index ebeab433..7444e46c 100644
--- a/rkward/settings/rksettings.cpp
+++ b/rkward/settings/rksettings.cpp
@@ -2,7 +2,7 @@
rksettings - description
-------------------
begin : Wed Jul 28 2004
- copyright : (C) 2004-2020 by Thomas Friedrichsmeier
+ copyright : (C) 2004-2022 by Thomas Friedrichsmeier
email : thomas.friedrichsmeier at kdemail.net
***************************************************************************/
@@ -77,6 +77,8 @@ void RKSettings::configureSettings (const QString& page, QWidget *parent, RComma
RKSettings::configureSettings(RKSettings::PageOutput, parent, chain);
} else if (page == QStringLiteral("general")) {
RKSettings::configureSettings(RKSettings::PageGeneral, parent, chain);
+ } else if (page == QStringLiteral("addons")) {
+ RKSettings::configureSettings(RKSettings::SuperPageAddons, parent, chain);
} else {
RK_ASSERT(page.isEmpty());
RKSettings::configureSettings(RKSettings::NoPage, parent, chain);
More information about the rkward-tracker
mailing list