[rkward-cvs] SF.net SVN: rkward:[3407] branches/jss_dec_10/FINAL_JSS_TEX
tfry at users.sourceforge.net
tfry at users.sourceforge.net
Mon Jan 31 14:58:10 UTC 2011
Revision: 3407
http://rkward.svn.sourceforge.net/rkward/?rev=3407&view=rev
Author: tfry
Date: 2011-01-31 14:58:10 +0000 (Mon, 31 Jan 2011)
Log Message:
-----------
Fix \pkg markup in a few places.
Modified Paths:
--------------
branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex
branches/jss_dec_10/FINAL_JSS_TEX/example_plugin.tex
branches/jss_dec_10/FINAL_JSS_TEX/example_session.tex
branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex
branches/jss_dec_10/FINAL_JSS_TEX/revision_notes.txt
branches/jss_dec_10/FINAL_JSS_TEX/sources.bib
branches/jss_dec_10/FINAL_JSS_TEX/technical.tex
Modified: branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex 2011-01-30 22:16:05 UTC (rev 3406)
+++ branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex 2011-01-31 14:58:10 UTC (rev 3407)
@@ -15,7 +15,7 @@
%% for pretty printing and a nice hypersummary also set:
\Plainauthor{Stefan R\"odiger, Thomas Friedrichsmeier, Prasenjit Kapat, Meik Michalke} %% comma-separated
\Plaintitle{RKWard -- A Comprehensive Graphical User Interface and Integrated Development Environment for Statistical Analysis with {R}} %% without formatting
-\Shorttitle{RKWard a GUI for \proglang{R}} %% a short title (if necessary)
+\Shorttitle{\pkg{RKWard} a GUI for \proglang{R}} %% a short title (if necessary)
%% an abstract and keywords
\Abstract{
Modified: branches/jss_dec_10/FINAL_JSS_TEX/example_plugin.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/example_plugin.tex 2011-01-30 22:16:05 UTC (rev 3406)
+++ branches/jss_dec_10/FINAL_JSS_TEX/example_plugin.tex 2011-01-31 14:58:10 UTC (rev 3407)
@@ -1,5 +1,5 @@
% !TEX root = RKWard_paper.tex
-\section{Extending RKWard -- an example of creating a plugin}
+\section[Extending RKWard -- an example of creating a plugin]{Extending \pkg{RKWard} -- an example of creating a plugin}
\label{sec:example_plugin}
As discussed in Section~\ref{sec:technical_plugins}, plugins in \pkg{RKWard} are
defined by four separate files (Figure~\ref{fig:plugin_structure}). To give an impression of the technique,
Modified: branches/jss_dec_10/FINAL_JSS_TEX/example_session.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/example_session.tex 2011-01-30 22:16:05 UTC (rev 3406)
+++ branches/jss_dec_10/FINAL_JSS_TEX/example_session.tex 2011-01-31 14:58:10 UTC (rev 3407)
@@ -1,5 +1,5 @@
% !TEX root = RKWard_paper.tex
-\section{Using RKWard -- an example session}
+\section[Using RKWard -- an example session]{Using \pkg{RKWard} -- an example session}
\label{sec:using_RKWard}
This section describes an example \pkg{RKWard} session, in order to give an idea
of what working with \pkg{RKWard} is like in practice.
Modified: branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex 2011-01-30 22:16:05 UTC (rev 3406)
+++ branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex 2011-01-31 14:58:10 UTC (rev 3407)
@@ -1,4 +1,4 @@
-\section{Installing and starting RKWard}
+\section[Installing and starting RKWard]{Installing and starting \pkg{RKWard}}
\label{sec:installing_starting_RKWard}
\pkg{RKWard} can be downloaded free of charge in source and binary form from \url{http://rkward.sourceforge.net/}.
On the GNU/Linux platform, binary packages are available for many major distributions,
Modified: branches/jss_dec_10/FINAL_JSS_TEX/revision_notes.txt
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/revision_notes.txt 2011-01-30 22:16:05 UTC (rev 3406)
+++ branches/jss_dec_10/FINAL_JSS_TEX/revision_notes.txt 2011-01-31 14:58:10 UTC (rev 3407)
@@ -106,11 +106,6 @@
* R, S, ECMAScript, JavaScript, Java, C++, Tcl/Tk, SPSS, Stata: We consider these clear cases.
* Rgui.exe, Rgui.app: As the "official" R GUIs, we decided to treat these the same as
R, i.e. to use the \proglang macro.
-* Qt: Not a programming language, but a (C++-based) programming library.
-* KDE: Probably not a prototypical example, but still a "programmable environment"
- (using D-Bus, shell scripting, and many programming languages). Also, in the
- context of this article, it is primarily used to name the KDE programming
- libraries.
----- We have not used the \proglang macro on these items -----
* PNG, JPEG: Binary file formats.
@@ -123,17 +118,27 @@
* PDF: Although based on the PostScript programming language, we decided not to use
the \proglang macro in this case, for consistency with other file storage
formats.
+* R Commander: For similar reasons, we marked up only the "R" in R Commander with the
+ \proglang macro (the corresponding package Rcmdr is marked up using the \pkg macro).
+* XEmbed: A protocol. Here we interpreted the term to name a technology similar to "repartening".
+
+---- Use of the \pkg macro
+I addition to the names of R packages, we have marked software applications and libraries with the
+\pkg marco. We did so after observing similar highlighting in published articles in JSS, such as
+http://www.jstatsoft.org/v25/s01/paper, although we remain unsure, whether this usage of the \pkg
+macro is called for or not:
* RKWard: The program presented in this article is a GUI and IDE to R. As such, it provides
full access to R's programmability. It also features extensibility by plugins. For
the purpose of markup, we decided to consider it as a pure GUI, however, rather than
a complete environment. We are not sure, whether or not this is in line with the
- intended usage of the macro.
-* R Commander: For similar reasons, we marked up only the "R" in R Commander with the
- \proglang macro (the corresponding package Rcmdr is marked up using the \pkg macro).
-* Red-R: Not marked as \proglang, for the same reason as "RKWard".
+ intended usage of the \proglang and \pkg macros.
+* Red-R: Same reasoning as for "RKWard".
* X11: Used as the name of the corresponding platform, rather than the name of the library
in the context of this article.
-* XEmbed: A protocol. Here we interpreted the term to name a technology similar to "repartening".
+* Qt: (C++-based) programming library.
+* KDE: In the context of this article, "KDE" is primarily used to name the KDE programming
+ libraries.
+* KWord, Kate, KatePart: KDE software.
---- Expansion of acronyms or partial abbreviations ----
We have decided to treat the following items as proper names that do not need to be
Modified: branches/jss_dec_10/FINAL_JSS_TEX/sources.bib
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/sources.bib 2011-01-30 22:16:05 UTC (rev 3406)
+++ branches/jss_dec_10/FINAL_JSS_TEX/sources.bib 2011-01-31 14:58:10 UTC (rev 3407)
@@ -79,7 +79,7 @@
@MANUAL{CullmannND,
author = {Christoph Cullmann},
year = {n.d.},
- title = {KatePart},
+ title = {\pkg{KatePart}},
owner = {tux},
timestamp = {2010.12.15},
url = {http://kate-editor.org/about-katepart/}
@@ -130,7 +130,7 @@
year = {2000},
author = {David Faure},
address = {Indianapolis, IN, USA},
- booktitle = {\proglang{KDE} 2.0 Development},
+ booktitle = {\pkg{KDE} 2.0 Development},
editor = {David Sweet},
owner = {tux},
timestamp = {2010.12.12}
@@ -203,7 +203,7 @@
@MANUAL{Friedrichsmeier2010,
author = {Thomas Friedrichsmeier},
- title = {Introduction to Writing Plugins for RKWard},
+ title = {Introduction to Writing Plugins for \pkg{RKWard}},
year = {2010},
owner = {tux},
timestamp = {2010.12.12},
@@ -563,7 +563,7 @@
}
@MANUAL{KWord,
- title = {KWord},
+ title = {\pkg{KWord}},
author = {{KOffice{.}Org}},
year = {2010},
timestamp = {2010.12.15},
Modified: branches/jss_dec_10/FINAL_JSS_TEX/technical.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/technical.tex 2011-01-30 22:16:05 UTC (rev 3406)
+++ branches/jss_dec_10/FINAL_JSS_TEX/technical.tex 2011-01-31 14:58:10 UTC (rev 3407)
@@ -158,7 +158,7 @@
Contrary to the approach used in \pkg{JGR} \citep{JGR2010}, \pkg{RKWard} does
not technically provide a custom on-screen graphics device. \pkg{RKWard} detects when
new graphics windows are created via calls to \code{X11()} or \code{windows()}. These windows
-are then ``captured'' in a platform dependent way (based on the \pkg{XEmbed} \citep{Ettrich2002} protocol
+are then ``captured'' in a platform dependent way (based on the XEmbed \citep{Ettrich2002} protocol
for \pkg{X11}, on reparenting for the Microsoft Windows platform). An \pkg{RKWard} menu bar and a
toolbar is then added to these windows to provide added functionality. While
this approach requires some platform dependent code, any corrections or
@@ -201,7 +201,7 @@
GUI components, which accept user settings and translate those user settings
into \proglang{R} code\footnote{
Plugins are also used in some other contexts within \pkg{RKWard}, for instance, the
- integrated text editor (kate part) supports extensions via plugins and user scripts. At this point we
+ integrated text editor (\pkg{kate} part) supports extensions via plugins and user scripts. At this point we
will focus only on plugins generating \proglang{R} code.
}. Thus, the plugin framework is basically a tool set used to define
GUIs for the automatic generation of \proglang{R} code.
@@ -353,7 +353,7 @@
Dependencies between (embedded) plugins are handled using the \code{<require>}-tag in the plugin map.
\subsection{Development process}
-\subsubsection{RKWard core and external plugins}
+\subsubsection[RKWard core and external plugins]{\pkg{RKWard} core and external plugins}
\label{sec:technical_processes_plugins}
Newly developed plugins are placed in a dedicated plugin map file.
Plugins in this map are not visible to the user by
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the rkward-tracker
mailing list