[rkward/work/render_rmd] /: Link to some settings pages.
Thomas Friedrichsmeier
null at kde.org
Thu Sep 27 11:29:05 BST 2018
Git commit b6af7c8bb0b67d9d39220c976da3f4cd5c1bae93 by Thomas Friedrichsmeier.
Committed on 27/09/2018 at 10:27.
Pushed by tfry into branch 'work/render_rmd'.
Link to some settings pages.
M +1 -0 ChangeLog
M +1 -1 rkward/pages/rkward_console.rkh
M +1 -1 rkward/pages/rkward_plot_history.rkh
M +6 -3 rkward/pages/rkward_workspace_browser.rkh
M +6 -0 rkward/windows/rkhtmlwindow.cpp
https://commits.kde.org/rkward/b6af7c8bb0b67d9d39220c976da3f4cd5c1bae93
diff --git a/ChangeLog b/ChangeLog
index d01639a2..d9c66c93 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,5 @@
--- Version 0.7.1 - UNRELEASED
+- Make it possible to "link" to specific settings pages from the internal documentation
- Compile in ui definitions, instead of providing them as separate files
- Fix printing of strings with R 3.5.0 on Windows in the console
- Offer R_LIBS_USER, instead of ~/.rkward/library as standard library installation location
diff --git a/rkward/pages/rkward_console.rkh b/rkward/pages/rkward_console.rkh
index 523bc5e6..ecd40016 100644
--- a/rkward/pages/rkward_console.rkh
+++ b/rkward/pages/rkward_console.rkh
@@ -54,7 +54,7 @@ Based on some simple heuristics, RKWard will try to complete file names instead
</section>
<section id="settings" title="Configurable Settings">
-To configure the behavior of the console, select "Configure" from the context menu. The following options are configurable:
+To configure the behavior of the console, select <a href="rkward://settings/console">Settings->Configure RKWard->R Console</a> or "Configure" from the context menu. The following options are configurable:
<ul>
<li><b>Load/save command history</b>: Whether the <link href="#command_history">command history</link> is saved when closing RKWard, and reloaded when next starting RKWard again. If this is not checked, each session of RKWard will start out with an empty command history.</li>
diff --git a/rkward/pages/rkward_plot_history.rkh b/rkward/pages/rkward_plot_history.rkh
index c83022b4..0a6a956e 100644
--- a/rkward/pages/rkward_plot_history.rkh
+++ b/rkward/pages/rkward_plot_history.rkh
@@ -22,7 +22,7 @@
</section>
<section title="Configurable Settings" id="scd_settings">
- Some default settings for the Screen device history can be configured from Settings->Configure RKWard->Onscreen Graphics:
+ Some default settings for the Screen device history can be configured from <a href="rkward://settings/graphics">Settings->Configure RKWard->Onscreen Graphics</a>:
<ul>
<li><b>Screen device history</b>: Enables / disables the recording of plots globally. You can toggle this from within a running RKWard session which will affect all currently open and future screen devices. When unchecked, RKWard will not store any further plots in the history; although, the ones already stored are not lost! You can access the stored plots by re-enabling this. When toggling this, RKWard tries to save any unsaved plots, but be careful especially when the maximum history length is small (see below). You may want to disable this when the implemented history behavior seems non-intuitive or when dealing with large plots.</li>
diff --git a/rkward/pages/rkward_workspace_browser.rkh b/rkward/pages/rkward_workspace_browser.rkh
index 53eeb6cc..59d0f66a 100644
--- a/rkward/pages/rkward_workspace_browser.rkh
+++ b/rkward/pages/rkward_workspace_browser.rkh
@@ -40,14 +40,17 @@
</section>
<section title="Configurable Settings" id="settings">
- Some default settings for the Workspace Browser can be configured using Settings->Configure RKWard->Workspace, or by selecting "Configure Defaults" from the context menu:
-
+ Some default settings for the Workspace Browser can be configured using the context menu:
<ul>
<li><b>Show hidden objects / show all environments</b>: See <link href="#introduction">above</link>. In contrast to the settings made directly in the workspace browser, these configure the <i>default</i> settings in the workspace browser (i.e. those that are effectively after restarting RKWard).</li>
<li><b>Show objects with children</b>: Controls whether objects with children (such as environments, lists) are shown, even if they do not correspond to the current filter.</li>
<li><b>Show variables / functions</b>: Equivalent to the "All vs. Non-Function vs. Functions" control described <link href="#introduction">above</link>.</li>
<li><b>Label field / Type field / Class field</b>: Which columns are shown for each object?</li>
+ </ul>
+
+ One additional setting is available from <a href="rkward://settings/browser">Settings->Configure RKWard->Workspace</a>:
+ <ul>
<li><b>Never fetch the structure of these packages</b>: Some (few) R packages contain <b>very</b> many small objects (tens of thousands). In the worst case, trying to fetch structure information on those (i.e. fetching the information to be shown in the workspace browser) can consume a lot of resources and make RKWard unresponsive. Package "GO" is one such package, and is "blacklisted" by default. If you note that loading a package takes exceedingly long, you may consider adding it to this list.</li>
</ul>
</section>
-</document>
\ No newline at end of file
+</document>
diff --git a/rkward/windows/rkhtmlwindow.cpp b/rkward/windows/rkhtmlwindow.cpp
index 75568838..efaac028 100644
--- a/rkward/windows/rkhtmlwindow.cpp
+++ b/rkward/windows/rkhtmlwindow.cpp
@@ -340,6 +340,12 @@ bool RKHTMLWindow::handleRKWardURL (const QUrl &url, RKHTMLWindow *window) {
if (path.startsWith ('/')) path = path.mid (1);
if (path == QStringLiteral ("rbackend")) {
RKSettings::configureSettings (RKSettings::PageR);
+ } else if (path == QStringLiteral ("console")) {
+ RKSettings::configureSettings (RKSettings::PageConsole);
+ } else if (path == QStringLiteral ("graphics")) {
+ RKSettings::configureSettings (RKSettings::PageX11);
+ } else if (path == QStringLiteral ("browser")) {
+ RKSettings::configureSettings (RKSettings::PageObjectBrowser);
} else {
RKSettings::configureSettings (RKSettings::NoPage);
}
More information about the rkward-tracker
mailing list