refresh look of vignettes by using Bitstream Charter, and microtype package (cf http://www.khirevich.com/latex)

add vignettes/notyet to .Rbuildignore

Author: eddelbuettel

.Rbuildignore

@@ -9,3 +9,4 @@ vignettes/jss.bst
 ^\.Rproj\.user$
 inst/include/Rcpp/preprocessor
 inst/include/Rcpp/sugar/functions/impl
+vignettes/notyet

ChangeLog

@@ -4,6 +4,15 @@
 	which again caused problems for the Windows builds at R-Forge and
 	win-builder. Unit tests comprise the same functionality and pass.
 
+	* vignettes/Rcpp-attributes.Rnw: Refresh look by using Bitstream
+	Charter, and microtype package (cf http://www.khirevich.com/latex)
+	* vignettes/Rcpp-extending.Rnw: Idem
+	* vignettes/Rcpp-FAQ.Rnw: Idem
+	* vignettes/Rcpp-modules.Rnw: Idem
+	* vignettes/Rcpp-package.Rnw: Idem
+	* vignettes/Rcpp-quickref.Rnw: Idem
+	* vignettes/Rcpp-sugar.Rnw: Idem
+
 2013-09-20  Dirk Eddelbuettel  <edd@debian.org>
 
 	* R/Module.R: More ':::' cleanups to make R CMD check happy

inst/NEWS.Rd

@@ -74,9 +74,11 @@
     \item Changes in Rcpp documentation:
     \itemize{
       \item The vignettes have been moved from \code{inst/doc/} to the
-      \code{vignettes} directory which is now preferred
+      \code{vignettes} directory which is now preferred.
       \item The unitTest vignette has been disabled as no longer builds
-      when called from \code{R CMD check};
+      when called from \code{R CMD check}.
+      \item The appearance of the vignettes has been refreshed by
+      switching to the Bistream Charter font, and microtype package.
     }
     \item Deprecation of \code{RCPP_FUNCTION_*}:
     \itemize{

vignettes/Rcpp-FAQ.Rnw

@@ -16,6 +16,10 @@
     urlcolor=link
 }
 
+\usepackage{microtype}                     %% cf http://www.khirevich.com/latex/microtype/
+\usepackage[T1]{fontenc}		   %% cf http://www.khirevich.com/latex/font/
+\usepackage[bitstream-charter]{mathdesign} %% cf http://www.khirevich.com/latex/font/
+
 \newcommand{\proglang}[1]{\textsf{#1}}
 \newcommand{\pkg}[1]{{\fontseries{b}\selectfont #1}}
 \newcommand{\code}[1]{\texttt{#1}}

vignettes/Rcpp-attributes.Rnw

@@ -4,7 +4,6 @@
 \usepackage[USletter]{vmargin}
 \setmargrb{1.25in}{1.25in}{1.25in}{1.25in}
 
-
 \usepackage{textcomp}
 \usepackage{color, alltt}
 \usepackage[authoryear,round,longnamesfirst]{natbib}
@@ -18,6 +17,10 @@
     urlcolor=link
 }
 
+\usepackage{microtype}                     %% cf http://www.khirevich.com/latex/microtype/
+\usepackage[T1]{fontenc}		   %% cf http://www.khirevich.com/latex/font/
+\usepackage[bitstream-charter]{mathdesign} %% cf http://www.khirevich.com/latex/font/
+
 \newcommand{\proglang}[1]{\textsf{#1}}
 \newcommand{\pkg}[1]{{\fontseries{b}\selectfont #1}}
 \newcommand{\code}[1]{\texttt{#1}}

vignettes/Rcpp-extending.Rnw

@@ -16,6 +16,10 @@
     urlcolor=link
 }
 
+\usepackage{microtype}                     %% cf http://www.khirevich.com/latex/microtype/
+\usepackage[T1]{fontenc}		   %% cf http://www.khirevich.com/latex/font/
+\usepackage[bitstream-charter]{mathdesign} %% cf http://www.khirevich.com/latex/font/
+
 \newcommand{\proglang}[1]{\textsf{#1}}
 \newcommand{\pkg}[1]{{\fontseries{b}\selectfont #1}}
 

vignettes/Rcpp-modules.Rnw

@@ -16,6 +16,10 @@
     urlcolor=link
 }
 
+\usepackage{microtype}                     %% cf http://www.khirevich.com/latex/microtype/
+\usepackage[T1]{fontenc}		   %% cf http://www.khirevich.com/latex/font/
+\usepackage[bitstream-charter]{mathdesign} %% cf http://www.khirevich.com/latex/font/
+
 \newcommand{\code}[1]{\texttt{#1}}
 \newcommand{\proglang}[1]{\textsf{#1}}
 \newcommand{\pkg}[1]{{\fontseries{b}\selectfont #1}}

vignettes/Rcpp-package.Rnw

@@ -16,6 +16,10 @@
     urlcolor=link
 }
 
+\usepackage{microtype}                     %% cf http://www.khirevich.com/latex/microtype/
+\usepackage[T1]{fontenc}		   %% cf http://www.khirevich.com/latex/font/
+\usepackage[bitstream-charter]{mathdesign} %% cf http://www.khirevich.com/latex/font/
+
 \newcommand{\proglang}[1]{\textsf{#1}}
 \newcommand{\pkg}[1]{{\fontseries{b}\selectfont #1}}
 
@@ -146,12 +150,12 @@ package, and it also includes the different components needed for using
 
 \subsection{\proglang{C++} code}
 
-If the \texttt{attributes} argument is set to 
+If the \texttt{attributes} argument is set to
 \texttt{TRUE}\footnote{Setting \texttt{attributes} to \texttt{TRUE} is the default. This document
-does not cover the behavior of \texttt{Rcpp.package.skeleton} when \texttt{attributes} is set 
-to \texttt{FALSE} as we try to encourage package developpers to use 
-attributes. }, 
-the following \proglang{C++} file is included in the \texttt{src/} directory: 
+does not cover the behavior of \texttt{Rcpp.package.skeleton} when \texttt{attributes} is set
+to \texttt{FALSE} as we try to encourage package developpers to use
+attributes. },
+the following \proglang{C++} file is included in the \texttt{src/} directory:
 
 <<lang=cpp>>=
 #include <Rcpp.h>
@@ -169,14 +173,14 @@ List rcpp_hello_world() {
 @
 
 The file defines the simple \texttt{rcpp\_hello\_world} function that
-uses a few \pkg{Rcpp} classes and returns a \texttt{List}. 
+uses a few \pkg{Rcpp} classes and returns a \texttt{List}.
 
 This function is preceded by the \texttt{Rcpp::export} attribute to automatically
-handle argument conversion because \proglang{R} has to be taught how to 
-e.g. handle the \texttt{List} class. 
+handle argument conversion because \proglang{R} has to be taught how to
+e.g. handle the \texttt{List} class.
 
 \Sexpr{link("Rcpp.package.skeleton")} then invokes \Sexpr{link("compileAttributes")}
-on the package, which generates the \texttt{RcppExports.cpp} file: 
+on the package, which generates the \texttt{RcppExports.cpp} file:
 
 <<lang=cpp>>=
 // This file was generated by Rcpp::compileAttributes
@@ -203,16 +207,16 @@ END_RCPP
 @
 
 This file defines a function with the appropriate calling convention, suitable for
-\Sexpr{link(".Call")}. It needs to be regenerated each time functions 
-exposed by attributes are modified. This is the task of the 
+\Sexpr{link(".Call")}. It needs to be regenerated each time functions
+exposed by attributes are modified. This is the task of the
 \Sexpr{link("compileAttributes")} function. A discussion on attributes is
-beyond the scope of this document and more information is available 
-in the attributes vignette \citep{CRAN:Rcpp:Attributes}. 
+beyond the scope of this document and more information is available
+in the attributes vignette \citep{CRAN:Rcpp:Attributes}.
 
 \subsection{\proglang{R} code}
 
-The \Sexpr{link("compileAttributes")} also generates \proglang{R} code 
-that uses the \proglang{C++} function. 
+The \Sexpr{link("compileAttributes")} also generates \proglang{R} code
+that uses the \proglang{C++} function.
 
 <<lang=cpp>>=
 # This file was generated by Rcpp::compileAttributes
@@ -224,7 +228,7 @@ rcpp_hello_world <- function() {
 @
 
 This is also a generated file so it should not be modified manually, rather
-regenerated as needed by \Sexpr{link("compileAttributes")}. 
+regenerated as needed by \Sexpr{link("compileAttributes")}.
 
 \subsection{\texttt{DESCRIPTION}}
 
@@ -411,7 +415,7 @@ rcpp_hello_world()
 
 This document does not cover the use of the \texttt{module} argument
 of \Sexpr{link("Rcpp.package.skeleton")}. It is covered
-in the modules vignette \citep{CRAN:Rcpp:Modules}. 
+in the modules vignette \citep{CRAN:Rcpp:Modules}.
 
 \section{Further examples}
 

vignettes/Rcpp-quickref.Rnw

@@ -17,6 +17,10 @@
 
 \usepackage[colorlinks]{hyperref}
 
+\usepackage{microtype}                     %% cf http://www.khirevich.com/latex/microtype/
+\usepackage[T1]{fontenc}		   %% cf http://www.khirevich.com/latex/font/
+\usepackage[bitstream-charter]{mathdesign} %% cf http://www.khirevich.com/latex/font/
+
 \newcommand{\pkg}[1]{{\fontseries{b}\selectfont #1}}
 
 <<echo=FALSE,print=FALSE>>=

vignettes/Rcpp-sugar.Rnw

@@ -16,6 +16,10 @@
     urlcolor=link
 }
 
+\usepackage{microtype}                     %% cf http://www.khirevich.com/latex/microtype/
+\usepackage[T1]{fontenc}		   %% cf http://www.khirevich.com/latex/font/
+\usepackage[bitstream-charter]{mathdesign} %% cf http://www.khirevich.com/latex/font/
+
 \newcommand{\proglang}[1]{\textsf{#1}}
 \newcommand{\pkg}[1]{{\fontseries{b}\selectfont #1}}
 \newcommand{\sugar}{\textsl{Rcpp sugar}}