[education/rkward] rkward: Touch up some of the help pages
Thomas Friedrichsmeier
null at kde.org
Wed Mar 9 22:04:49 GMT 2022
Git commit 6ec7e052fb19719fadda74cdb7ea53f8f6d8bdd5 by Thomas Friedrichsmeier.
Committed on 09/03/2022 at 22:04.
Pushed by tfry into branch 'master'.
Touch up some of the help pages
A +40 -0 rkward/pages/rkward_addons.rkh
M +14 -5 rkward/pages/rkward_output.rkh
M +1 -1 rkward/pages/rkward_trouble_shooting.rkh
M +7 -11 rkward/pages/rkward_welcome.rkh
M +17 -13 rkward/settings/rksettings.cpp
https://invent.kde.org/education/rkward/commit/6ec7e052fb19719fadda74cdb7ea53f8f6d8bdd5
diff --git a/rkward/pages/rkward_addons.rkh b/rkward/pages/rkward_addons.rkh
new file mode 100644
index 00000000..c9e08130
--- /dev/null
+++ b/rkward/pages/rkward_addons.rkh
@@ -0,0 +1,40 @@
+<!DOCTYPE rkhelp>
+<document>
+ <title>RKWard Add-Ons</title>
+ <summary>
+To offer you the best features, RKWard combines different technologies. Arguably this can make it a bit confusing on where to find the addon features you are looking for.
+
+In a nutshell:
+<ul>
+<li><strong>R packages</strong> offer a sheer incredible amount of data algorithms and tools. This functionality is (mostly) provided in the form of additional R functions that you can use
+in scripts, or in the interactive R console.</li>
+<li><strong>Kate add-ons</strong>: Kate is the engine behind RKWard's script editor. It comes with many add-ons features from various indentation scripts to elaborate support for
+git-projects, to name just two concepts. Many of these should come pre-installed with RKWard, but due to their sheer number, not all are activated by default. Additional scripts,
+color-schemes, etc. are available for download, separately.</li>
+<li><strong>RKWard plugins</strong>: If you are looking for a graphical dialog to help you import/convert/analyse/visualize your data, such dialogs are mostly implemented as plugin-ins in
+RKWard. Many such plugins are available for download, separately.</li>
+</ul>
+
+The following sections deal with these, in turn, showing you how to find / install, what you need.
+ </summary>
+
+ <section title="R packages" id="r_packages_in_rkward">
+ TODO: Write this
+ </section>
+
+ <section title="Kate Add-ons" id="kate_addons_in_rkward">
+ TODO: Write this
+ </section>
+
+ <section title="RKWard Plugins" id="rkward_plugins">
+ TODO: Extend this
+
+ 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.
+ </section>
+
+ <section title="Creating your own RKWard Plugins" id="writing_plugins">
+ 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.
+ </section>
+</document>
diff --git a/rkward/pages/rkward_output.rkh b/rkward/pages/rkward_output.rkh
index 41f566bb..d834f4a2 100644
--- a/rkward/pages/rkward_output.rkh
+++ b/rkward/pages/rkward_output.rkh
@@ -2,16 +2,25 @@
<document>
<title>RKWard Output</title>
<summary>
-Describe the RKWard output window, and how to make use of the generated output.
+The RKWard output window, or, more generally, RKWard output files (.rko) are intended as an easy way to keep a log of the work on your data. By default, one output file is always available. Depending on your configuration (<link href="rkward://settings/output">Settings->Configure RKWard->Output</link>), this output file may or may not be shared across different workspaces.
-TODO: This page is incomplete.
+RKWard output can be saved and opened like regular files. To direct output to a specific output file, you will have to "activate" it. Closing an output window does not discard the
+modifications, but on closing RKWard you will be prompted to save (or discard) any pending changes.
</summary>
- <section title="Using the output in an office suite" id="integration_in_office_suite">
-One of the many goals of RKWard is to have easy integration with an office-suite. Right now output is simply stored in HTML format (including images as png) of your results. HTML can be read and worked on with any modern office suite.
+ <section title="Producing RKWard output from R" id="rkward_output_r">
+To write to the active RKWard output file from custom R code, refer to <link href="rkward://rhelp/rk.print"/>, and the functions linked from there.
+
+To load / save / switch between output files, etc., refer to <link href="rkward://rhelp/rk.output"/>.
+ </section>
+ <section title="Using the output in an office suite" id="integration_in_office_suite">
The easiest way to get output into your office suite, is to first select the relevant portions, copy them (Edit->Copy), then paste them. This works well, at least in OpenOffice. You can also drag and drop images from the output to an OpenOffice document.
-If you need access to the raw HTML and image files, these are stored in a hidden directory. By default this is a sub-folder called ".rkward" of your home directory (Settings->Configure RKWard->General). You'll want the files "rk_out.html" and the "graph*.png" files.
+Internally, RKWard output files are currently simply based on HTML. If you need access to the raw HTML and image files, a .rko-file is really just a zip'ed folder. You can unzip it using standard tools, or open it in RKWard, and retrieve the files from the ".rkward" of your home directory (location configurable in Settings->Configure RKWard->General).
+ </section>
+
+ <section title="RKWard output vs. R Markdown" id="rkward_output_vs_rmarkdown">
+RKWard also assists you in writing RMarkdown documents. In particular there is a powerful preview feature for .RMd scripts. While RMarkdown is great for writing interactive "reports", the RKWard Output is very easy to use for ad-hoc documentation while exploring your data.
</section>
</document>
diff --git a/rkward/pages/rkward_trouble_shooting.rkh b/rkward/pages/rkward_trouble_shooting.rkh
index 33dc06c2..2bdec9ce 100644
--- a/rkward/pages/rkward_trouble_shooting.rkh
+++ b/rkward/pages/rkward_trouble_shooting.rkh
@@ -1,6 +1,6 @@
<!DOCTYPE rkhelp>
<document>
- <title>Trouble Shooting</title>
+ <title>Trouble Shooting / FAQ</title>
<summary>
RKWard is far from complete and certainly there are many issues that need to be fixed. However, some of the things you notice are not due to the nature of RKWard but R or something else. This section will try to cover some common issues. See also <link href="http://rkward.kde.org/faq">the online FAQ</link>.
</summary>
diff --git a/rkward/pages/rkward_welcome.rkh b/rkward/pages/rkward_welcome.rkh
index aba6bdeb..9b0e5bae 100644
--- a/rkward/pages/rkward_welcome.rkh
+++ b/rkward/pages/rkward_welcome.rkh
@@ -5,7 +5,7 @@
<summary>
This help page gives a rough overview of the most important parts of RKWard.
- By default, this page is shown each time RKWard is started. You can disable or re-enable this behavior under Settings->Configure RKWard->General.
+ By default, this page is shown each time RKWard is started (configurable in <link href="rkward://settings/general">Settings->Configure RKWard->General</link>).
</summary>
<section title="Introduction to RKWard" id="introduction">
@@ -13,21 +13,17 @@
</section>
<section title="Getting Started" id="getting_started">
- Due to the large differences in prior knowledge of R, we provide two different guides for getting started with RKWard. The first is aimed at users with some knowledge of the R language, and focuses on introducing the IDE features of RKWard: <link href="rkward://page/rkward_for_r_users" />.
+ If you have used neither R nor RKWard before, you should start with the following guide: <link href="rkward://page/rkward_for_new_users" />.
- The second gives a more hands on introduction to getting started with RKWard, but does not go quite as deep. If you have never used R or RKWard before, you should start with this guide, then later read the above page link: <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>
- <section title="Trouble Shooting" id="Trouble Shooting">
- If you encounter problems please feel free to search in <link href="rkward://page/rkward_trouble_shooting">Trouble Shooting</link> first.
- </section>
-
- <section title="Missing something?" id="missing_something">
- 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.
+ <section title="Installing Add-Ons" id="add-ons">
+ Missing something? Many features are available as separate add-ons. Please refer to <link href="rkward://page/rkward_addons" /> for more information.
</section>
- <section title="Still missing something?" id="writing_plugins">
- 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. As another way of contributing, consider supporting the development of RKWard with money. One easy way to give a small amount is <a href="http://flattr.com/thing/1092073/RKWard">donating via <i>Flattr</i></a>.
+ <section title="Trouble Shooting" id="Trouble Shooting">
+ If you encounter problems please take a look in <link href="rkward://page/rkward_trouble_shooting">Trouble Shooting / FAQ</link> first. The preferred way to report a bug is using "Report Bug" from the "Help"-menu.
</section>
<section title="General Information" id="further_info">
diff --git a/rkward/settings/rksettings.cpp b/rkward/settings/rksettings.cpp
index d62ba0d6..ebeab433 100644
--- a/rkward/settings/rksettings.cpp
+++ b/rkward/settings/rksettings.cpp
@@ -61,21 +61,25 @@ void RKSettings::configureSettings (SettingsPage page, QWidget *parent, RCommand
void RKSettings::configureSettings (const QString& page, QWidget *parent, RCommandChain *chain) {
RK_TRACE (SETTINGS);
- if (page == QStringLiteral ("rbackend")) {
- RKSettings::configureSettings (RKSettings::PageR, parent, chain);
- } else if (page == QStringLiteral ("console")) {
- RKSettings::configureSettings (RKSettings::PageConsole, parent, chain);
- } else if (page == QStringLiteral ("editor")) {
- RKSettings::configureSettings (RKSettings::PageCommandEditor, parent, chain);
- } else if (page == QStringLiteral ("graphics")) {
- RKSettings::configureSettings (RKSettings::PageX11, parent, chain);
- } else if (page == QStringLiteral ("browser")) {
- RKSettings::configureSettings (RKSettings::PageObjectBrowser, parent, chain);
- } else if (page == QStringLiteral ("rpackages")) {
- RKSettings::configureSettings (RKSettings::PageRPackages, parent, chain);
+ if (page == QStringLiteral("rbackend")) {
+ RKSettings::configureSettings(RKSettings::PageR, parent, chain);
+ } else if (page == QStringLiteral("console")) {
+ RKSettings::configureSettings(RKSettings::PageConsole, parent, chain);
+ } else if (page == QStringLiteral("editor")) {
+ RKSettings::configureSettings(RKSettings::PageCommandEditor, parent, chain);
+ } else if (page == QStringLiteral("graphics")) {
+ RKSettings::configureSettings(RKSettings::PageX11, parent, chain);
+ } else if (page == QStringLiteral("browser")) {
+ RKSettings::configureSettings(RKSettings::PageObjectBrowser, parent, chain);
+ } else if (page == QStringLiteral("rpackages")) {
+ RKSettings::configureSettings(RKSettings::PageRPackages, parent, chain);
+ } else if (page == QStringLiteral("output")) {
+ RKSettings::configureSettings(RKSettings::PageOutput, parent, chain);
+ } else if (page == QStringLiteral("general")) {
+ RKSettings::configureSettings(RKSettings::PageGeneral, parent, chain);
} else {
RK_ASSERT(page.isEmpty());
- RKSettings::configureSettings (RKSettings::NoPage, parent, chain);
+ RKSettings::configureSettings(RKSettings::NoPage, parent, chain);
}
}
More information about the rkward-tracker
mailing list