[kde-doc-english] [rkward] /: Small updates to documentation and ChangeLog.

Thomas Friedrichsmeier thomas.friedrichsmeier at ruhr-uni-bochum.de
Thu Mar 10 20:29:45 UTC 2016


Git commit e31730e7617aa516b420dc803f5bc9c24f8e8dad by Thomas Friedrichsmeier.
Committed on 10/03/2016 at 20:29.
Pushed by tfry into branch 'master'.

Small updates to documentation and ChangeLog.

M  +3    -2    ChangeLog
M  +6    -2    doc/rkwardplugins/index.docbook
M  +2    -1    rkward/plugin/rkpreviewbox.cpp

http://commits.kde.org/rkward/e31730e7617aa516b420dc803f5bc9c24f8e8dad

diff --git a/ChangeLog b/ChangeLog
index 9651ac6..87b2eb7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,9 +1,10 @@
+- Added context menu option to search for information on current symbol online
 - Fixed: Wizard plugins would be too small, initially
 - Fixed: Help Search was not longer working correctly with R 3.2.x
 - Fix compilation with R 3.3.x
 - Provide better status feedback when searching / filtering among installable packages
 - Add access to basic menu items for docked previews
-- Move preview controls to the button-column of dialogs                                            TODO document, polish
+- Move preview controls to the button-column of dialogs
 - Add preview to Sort data-, Subset data, and Recode categorical data-plugins
 - Add preview to Power Analysis plugin
 - Add support for adding "htmlwidget"- and "gvis"-class objects to the output window via rk.print()
@@ -15,7 +16,7 @@
 - File selectors in "Import XYZ" plugins now filter for standard file extensions, by default
 - Add previews for CSV, SPSS, and Stata import plugins
 - Allow previews for data, (HTML) output, and custom types of previews
-- Allow previews to be docked to the dialog window, and dock them, by default                      TODO: update documentation on placemnet
+- Allow previews to be docked to the dialog window, and dock them, by default
 - Implicitly save code preview visibility and size (instead of the former explicit settings)
 - data.frame objects outside of globalenv() can be opened read-only in an editor window
 - Show a warning screen when invoking plugins from the command line (or from clicking an rkward://-link in an external application)
diff --git a/doc/rkwardplugins/index.docbook b/doc/rkwardplugins/index.docbook
index 0a7458f..e7afbc4 100644
--- a/doc/rkwardplugins/index.docbook
+++ b/doc/rkwardplugins/index.docbook
@@ -1350,6 +1350,8 @@ This chapter contains information on some topics that are useful only to certain
 		<para>
 			Adding a <command><preview></command> check box is simple. Just place the following somewhere in your GUI. It will take care of all the behind-the-scenes magic of creating a preview device, updating the preview whenever the setting have changed, &etc; Example:
 		</para>
+		<note><para>Starting with version 0.6.5 of &kapp; <command><preview></command> preview elements are special-cased in plugin dialogs (not wizards): They will be placed in the button-column, irrespective of where exactly they are defined in the UI. It is still a good idea to define them at a sensible place in the layout, for backwards compatibility.
+		</para></note>
 		<programlisting>
 	<document>
 		[...]
@@ -3504,7 +3506,9 @@ Child-elements:
 
 <varlistentry>
 <term><preview></term>
-<listitem><para>Checkbox to toggle preview functionality. Attributes:
+<listitem><para>Checkbox to toggle preview functionality. Note that starting with version 0.6.5 of &kapp; <command><preview></command> preview elements are special-
+		cased in plugin dialogs (not wizards): They will be placed in the button-column, irrespective of where exactly they are defined in the UI. It is still a good idea to
+		define them at a sensible place in the layout, for backwards compatibility. Attributes:
 	<variablelist>
 	<varlistentry>
 	<term><parameter>label</parameter></term>
@@ -3516,7 +3520,7 @@ Child-elements:
 	</varlistentry>
 	<varlistentry>
 	<term><parameter>placement</parameter></term>
-	<listitem><para>Placement of the preview: "attached" (to the main workplace), "detached" (standalone window), "docked" (attached to the plugin dialog) and "default" (default depending on type of preview). In general, it is recommended to leave this as the default setting for best UI-consistency (optional, default is "default")</para></listitem>
+	<listitem><para>Placement of the preview: "attached" (to the main workplace), "detached" (standalone window), "docked" (attached to the plugin dialog) and "default" (currently this is the same as "docked", but might become user-configuarable at some point). In general, it is recommended to leave this as the default setting for best UI-consistency (optional, default is "default")</para></listitem>
 	</varlistentry>
 	<varlistentry>
 	<term><parameter>active</parameter></term>
diff --git a/rkward/plugin/rkpreviewbox.cpp b/rkward/plugin/rkpreviewbox.cpp
index 3b54d46..330bdaa 100644
--- a/rkward/plugin/rkpreviewbox.cpp
+++ b/rkward/plugin/rkpreviewbox.cpp
@@ -46,7 +46,8 @@ RKPreviewBox::RKPreviewBox (const QDomElement &element, RKComponent *parent_comp
 	XMLHelper *xml = parent_component->xmlHelper ();
 
 	preview_mode = (PreviewMode) xml->getMultiChoiceAttribute (element, "mode", "plot;data;output;custom", 0, DL_INFO);
-	placement = (PreviewPlacement) xml->getMultiChoiceAttribute (element, "placement", "default;attached;detached;docked", (preview_mode == PlotPreview) ? 3 : 3, DL_INFO);
+	placement = (PreviewPlacement) xml->getMultiChoiceAttribute (element, "placement", "default;attached;detached;docked", 0, DL_INFO);
+	if (placement == DefaultPreview) placement = DockedPreview;
 	preview_active = xml->getBoolAttribute (element, "active", false, DL_INFO);
 	idprop = RObject::rQuote (QString ().sprintf ("%p", this));
 


More information about the kde-doc-english mailing list