Merge pull request #256 from RcppCore/feature/vignettes-highlight-driver

jjallaire · jjallaire · commit 361bf74efa58 · 2015-02-15T05:50:52.000-07:00
Enable preview of vignettes in RStudio
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,10 @@
+2015-02-14  JJ Allaire  <jj@rstudio.org>
+
+        * Rcpp.Rproj: Specify Sweave as Rnw handler for RStudio
+        * vignettes/*.Rnw: Add driver magic comment and turn off 
+        Sweave concordance.
+        * vignettes/.gitignore: Ignore artifacts of PDF preview
+
 2015-02-13  Dirk Eddelbuettel  <edd@debian.org>
 
         * .travis.yml (install): Switch to using ppa:edd/misc to install all the
diff --git a/Rcpp.Rproj b/Rcpp.Rproj
@@ -9,7 +9,7 @@ UseSpacesForTab: Yes
 NumSpacesForTab: 4
 Encoding: UTF-8
 
-RnwWeave: knitr
+RnwWeave: Sweave
 LaTeX: pdfLaTeX
 
 AutoAppendNewline: Yes
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1,5 @@
+Rcpp-*.bbl
+Rcpp-*.log
+Rcpp-*.tex
+Rcpp-*.pdf
+unitTests-results/
diff --git a/vignettes/Rcpp-FAQ.Rnw b/vignettes/Rcpp-FAQ.Rnw
@@ -1,8 +1,10 @@
+% !Rnw driver = highlight::HighlightWeaveLatex()
 \documentclass[10pt]{article}
 %\VignetteIndexEntry{Rcpp-FAQ}
 %\VignetteEngine{highlight::highlight}
 %\VignetteKeywords{Rcpp, FAQ}
 %\VignetteDepends{Rcpp}
+
 \usepackage[USletter]{vmargin}
 \setmargrb{0.75in}{0.75in}{0.75in}{0.75in}
 
diff --git a/vignettes/Rcpp-attributes.Rnw b/vignettes/Rcpp-attributes.Rnw
@@ -1,8 +1,10 @@
+% !Rnw driver = highlight::HighlightWeaveLatex()
 \documentclass[11pt]{article}
 %\VignetteIndexEntry{Rcpp-attributes}
 %\VignetteEngine{highlight::highlight}
 %\VignetteKeywords{Rcpp, attributes}
 %\VignetteDepends{Rcpp}
+
 \usepackage[USletter]{vmargin}
 \setmargrb{1.25in}{1.25in}{1.25in}{1.25in}
 
diff --git a/vignettes/Rcpp-extending.Rnw b/vignettes/Rcpp-extending.Rnw
@@ -1,8 +1,10 @@
+% !Rnw driver = highlight::HighlightWeaveLatex()
 \documentclass[10pt]{article}
 %\VignetteIndexEntry{Rcpp-extending}
 %\VignetteEngine{highlight::highlight}
 %\VignetteKeywords{Rcpp, package}
 %\VignetteDepends{Rcpp}
+
 \usepackage[USletter]{vmargin}
 \setmargrb{0.75in}{0.75in}{0.75in}{0.75in}
 
diff --git a/vignettes/Rcpp-introduction.Rnw b/vignettes/Rcpp-introduction.Rnw
@@ -4,6 +4,7 @@
 %\VignetteIndexEntry{Rcpp-introduction}
 %\VignetteKeywords{Rcpp, foreign function interface, .Call, C++, R}
 %\VignetteDepends{Rcpp}
+\SweaveOpts{concordance=FALSE}
 
 \author{Dirk Eddelbuettel\\Debian Project \And Romain Fran\c{c}ois\\\proglang{R} Enthusiasts}
 \Plainauthor{Dirk Eddelbuettel, Romain Fran\c{c}ois}
diff --git a/vignettes/Rcpp-modules.Rnw b/vignettes/Rcpp-modules.Rnw
@@ -1,3 +1,4 @@
+% !Rnw driver = highlight::HighlightWeaveLatex()
 \documentclass[10pt]{article}
 %\VignetteIndexEntry{Rcpp-modules}
 %\VignetteEngine{highlight::highlight}
diff --git a/vignettes/Rcpp-package.Rnw b/vignettes/Rcpp-package.Rnw
@@ -1,3 +1,4 @@
+% !Rnw driver = highlight::HighlightWeaveLatex()
 \documentclass[10pt]{article}
 %\VignetteIndexEntry{Rcpp-package}
 %\VignetteEngine{highlight::highlight}
diff --git a/vignettes/Rcpp-quickref.Rnw b/vignettes/Rcpp-quickref.Rnw
@@ -1,3 +1,4 @@
+% !Rnw driver = highlight::HighlightWeaveLatex()
 \documentclass[8pt,twocolumn,a4paper]{article}
 %\VignetteIndexEntry{Rcpp-quickref}
 %\VignetteEngine{highlight::highlight}
diff --git a/vignettes/Rcpp-sugar.Rnw b/vignettes/Rcpp-sugar.Rnw
@@ -1,3 +1,4 @@
+% !Rnw driver = highlight::HighlightWeaveLatex()
 \documentclass[10pt]{article}
 %\VignetteIndexEntry{Rcpp-sugar}
 %\VignetteEngine{highlight::highlight}
diff --git a/vignettes/Rcpp-unitTests.Rnw b/vignettes/Rcpp-unitTests.Rnw
@@ -2,6 +2,7 @@
 %\VignetteIndexEntry{Rcpp-unitTests}
 %\VignetteKeywords{R,Rcpp,unit tests}
 %\VignetteDepends{Rcpp}
+\SweaveOpts{concordance=FALSE}
 
 \usepackage{vmargin}
 \setmargrb{0.75in}{0.75in}{0.75in}{0.75in}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+% !Rnw driver = highlight::HighlightWeaveLatex()`
`1`	`2`	`\documentclass[10pt]{article}`
`2`	`3`	`%\VignetteIndexEntry{Rcpp-modules}`
`3`	`4`	`%\VignetteEngine{highlight::highlight}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+% !Rnw driver = highlight::HighlightWeaveLatex()`
`1`	`2`	`\documentclass[8pt,twocolumn,a4paper]{article}`
`2`	`3`	`%\VignetteIndexEntry{Rcpp-quickref}`
`3`	`4`	`%\VignetteEngine{highlight::highlight}`