├── NAMESPACE ├── .Rbuildignore ├── inst ├── app │ ├── bits │ │ ├── preview.R │ │ ├── header.R │ │ ├── editor.R │ │ ├── keyboard.R │ │ ├── about.R │ │ ├── hidden.R │ │ └── navbar.R │ ├── ui.R │ ├── template.Rmd │ ├── global.R │ ├── www │ │ ├── keyboard_shortcuts.html │ │ ├── about.html │ │ ├── editR.css │ │ └── actions.js │ └── server.R └── editR.opt ├── editR_screenshot.jpg ├── .gitignore ├── R ├── RcppExports.R ├── preview.R ├── bs3_dropdown.R ├── bs3_navbar.R ├── loadOptions.R ├── bs3_dialog.R └── editR.R ├── editR.Rproj ├── DESCRIPTION ├── man ├── bs3_navbar.Rd ├── preview.Rd ├── bs3_dropdown.Rd ├── bs3_dialog.Rd ├── editR.Rd └── editR-package.Rd ├── RELEASE_NOTES.md ├── README.md └── LICENSE /NAMESPACE: -------------------------------------------------------------------------------- 1 | exportPattern("^[[:alpha:]]+") 2 | -------------------------------------------------------------------------------- /.Rbuildignore: -------------------------------------------------------------------------------- 1 | ^.*\.Rproj$ 2 | ^\.Rproj\.user$ 3 | -------------------------------------------------------------------------------- /inst/app/bits/preview.R: -------------------------------------------------------------------------------- 1 | preview <- htmlOutput("knit_doc") 2 | -------------------------------------------------------------------------------- /editR_screenshot.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/swarm-lab/editR/HEAD/editR_screenshot.jpg -------------------------------------------------------------------------------- /inst/editR.opt: -------------------------------------------------------------------------------- 1 | "option","value" 2 | "editor_font_size","14" 3 | "editor_theme","tomorrow" 4 | "preview_font_size","1" 5 | -------------------------------------------------------------------------------- /inst/app/bits/header.R: -------------------------------------------------------------------------------- 1 | header <- tags$head( 2 | tags$link(rel = "stylesheet", type = "text/css", href = "editR.css"), 3 | tags$script(src = "actions.js") 4 | ) 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # History files 2 | .Rhistory 3 | 4 | # Example code in package build process 5 | *-Ex.R 6 | 7 | # R data files from past sessions 8 | .Rdata 9 | 10 | # RStudio files 11 | .Rproj.user/ 12 | .Rproj.user 13 | inst/app_bak 14 | -------------------------------------------------------------------------------- /R/RcppExports.R: -------------------------------------------------------------------------------- 1 | # This file was generated by Rcpp::compileAttributes 2 | # Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393 3 | 4 | rcpp_hello_world <- function() { 5 | .Call('editR_rcpp_hello_world', PACKAGE = 'editR') 6 | } 7 | 8 | -------------------------------------------------------------------------------- /inst/app/ui.R: -------------------------------------------------------------------------------- 1 | shinyUI( 2 | bootstrapPage( 3 | title = "editR", 4 | 5 | header, 6 | 7 | hidden, 8 | 9 | navbar, 10 | 11 | editor, 12 | 13 | preview 14 | ) 15 | ) 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /inst/app/bits/editor.R: -------------------------------------------------------------------------------- 1 | editor <- aceEditor("rmd", mode = "markdown", wordWrap = TRUE, 2 | fontSize = getOption("editR")$editor_font_size, 3 | theme = getOption("editR")$editor_theme, 4 | debounce = 100, autoComplete = "live", height = "auto") 5 | -------------------------------------------------------------------------------- /editR.Rproj: -------------------------------------------------------------------------------- 1 | Version: 1.0 2 | 3 | RestoreWorkspace: Default 4 | SaveWorkspace: Default 5 | AlwaysSaveHistory: Default 6 | 7 | EnableCodeIndexing: Yes 8 | UseSpacesForTab: Yes 9 | NumSpacesForTab: 2 10 | Encoding: UTF-8 11 | 12 | RnwWeave: Sweave 13 | LaTeX: pdfLaTeX 14 | 15 | AutoAppendNewline: Yes 16 | 17 | BuildType: Package 18 | PackageUseDevtools: Yes 19 | PackageInstallArgs: --no-multiarch --with-keep.source 20 | PackageRoxygenize: rd 21 | -------------------------------------------------------------------------------- /DESCRIPTION: -------------------------------------------------------------------------------- 1 | Package: editR 2 | Type: Package 3 | Title: A basic Rmarkdown editor with instant preview 4 | Version: 0.2.2 5 | Date: 2015-10-11 6 | Author: Simon Garnier 7 | Maintainer: Simon Garnier 8 | Description: editR is a basic Rmarkdown editor with instant previewing of your 9 | document. It allows you to create and edit Rmarkdown documents while instantly 10 | previewing the result of your writing and coding. It also allows you to render 11 | your Rmarkdown file in any format permitted by the 'rmarkdown' package. 12 | License: GPL (>= 3) 13 | Imports: shiny (>= 0.11.1), shinyBS (>= 0.61), shinyAce (>= 0.2.1), 14 | shinyFiles (>= 0.6.0), rmarkdown (>= 0.5.1), knitr (>= 1.9) 15 | -------------------------------------------------------------------------------- /man/bs3_navbar.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2 (4.1.1): do not edit by hand 2 | % Please edit documentation in R/bs3_navbar.R 3 | \name{bs3_navbar} 4 | \alias{bs3_navbar} 5 | \title{Custom navbar function for \code{\link[editR:editR-package]{editR}}} 6 | \usage{ 7 | bs3_navbar(brand = "My website", navs) 8 | } 9 | \arguments{ 10 | \item{navs}{A list of UI elements to include in the navbar (e.g. \code{\link[shiny:actionLink]{actionLinks}}).} 11 | 12 | \item{name}{The name of the navbar.} 13 | } 14 | \value{ 15 | This function return the html code for a Twitter Bootstrap 3 navbar. 16 | } 17 | \description{ 18 | This function creates custom Twitter Bootstrap 3 navbars for \code{\link[editR:editR-package]{editR}}. 19 | } 20 | \author{ 21 | Simon Garnier: \email{garnier@njit.edu}, \link[https://twitter.com/sjmgarnier]{@sjmgarnier} 22 | } 23 | 24 | -------------------------------------------------------------------------------- /inst/app/template.Rmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Your title" 3 | author: Your name 4 | date: "`r format(Sys.time(), '%B %d, %Y')`" 5 | output: html_document 6 | --- 7 | 8 | This is an R Markdown document. Markdown is a simple formatting syntax for authoring HTML, PDF, and MS Word documents. For more details on using R Markdown see . 9 | 10 | When you click the **File > Render file** button a document will be generated that includes both content as well as the output of any embedded R code chunks within the document. You can embed an R code chunk like this: 11 | 12 | ```{r} 13 | summary(cars) 14 | ``` 15 | 16 | You can also embed plots, for example: 17 | 18 | ```{r, echo=FALSE} 19 | plot(cars) 20 | ``` 21 | 22 | Note that the `echo = FALSE` parameter was added to the code chunk to prevent printing of the R code that generated the plot. 23 | -------------------------------------------------------------------------------- /man/preview.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2 (4.1.1): do not edit by hand 2 | % Please edit documentation in R/preview.R 3 | \name{preview} 4 | \alias{preview} 5 | \title{Prepare rmarkdown document for instant preview} 6 | \usage{ 7 | preview(rmd) 8 | } 9 | \arguments{ 10 | \item{rmd}{The rmarkdown document to prepare for instant preview.} 11 | } 12 | \value{ 13 | This function return a rmarkdown document ready for instant preview in editR. 14 | } 15 | \description{ 16 | This function prepares a rmarkdown document edited with editR for instant preview. 17 | It strips its front matter if it is present and add two extra line breaks at 18 | the end to prevent editR to "misbehave" when a code chunk is created at the 19 | very end of the document. 20 | } 21 | \author{ 22 | Simon Garnier: \email{garnier@njit.edu}, \link[https://twitter.com/sjmgarnier]{@sjmgarnier} 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/bs3_dropdown.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2 (4.1.1): do not edit by hand 2 | % Please edit documentation in R/bs3_dropdown.R 3 | \name{bs3_dropdown} 4 | \alias{bs3_dropdown} 5 | \title{Custom dropdown menu function for \code{\link[editR:editR-package]{editR}}} 6 | \usage{ 7 | bs3_dropdown(name = "My menu", navs) 8 | } 9 | \arguments{ 10 | \item{name}{The name of the dropdown menu.} 11 | 12 | \item{navs}{A list of UI elements to include in the dropdown menu (e.g. \code{\link[shiny:actionLink]{actionLinks}}).} 13 | } 14 | \value{ 15 | This function return the html code for a Twitter Bootstrap 3 dropdown menu. 16 | } 17 | \description{ 18 | This function creates custom Twitter Bootstrap 3 dropdown menus for \code{\link[editR:editR-package]{editR}}. 19 | } 20 | \author{ 21 | Simon Garnier: \email{garnier@njit.edu}, \link[https://twitter.com/sjmgarnier]{@sjmgarnier} 22 | } 23 | 24 | -------------------------------------------------------------------------------- /inst/app/global.R: -------------------------------------------------------------------------------- 1 | ### Load libraries ### 2 | library(shiny) 3 | library(shinyAce) 4 | library(shinyFiles) 5 | library(shinyBS) 6 | library(knitr) 7 | library(rmarkdown) 8 | ### ### 9 | 10 | 11 | ### Set options ### 12 | editR:::.loadOptions() 13 | ### ### 14 | 15 | 16 | ### Load app bits ### 17 | bits <- paste0("bits/", 18 | c("header", "about", "keyboard", "hidden", 19 | "navbar", "editor", "preview"), ".R") 20 | sapply(bits, source) 21 | ### ### 22 | 23 | 24 | ### Prepare file ### 25 | if (is.null(md_path)) { 26 | setwd(tempdir()) 27 | } else { 28 | setwd(md_path) 29 | 30 | if (!file.exists(md_name)) { 31 | template_path <- paste0(find.package("editR"), "/app/template.Rmd") 32 | template <- readChar(template_path, file.info(template_path)$size) 33 | cat(template, file = md_name) 34 | } 35 | 36 | md_bak <- NULL 37 | } 38 | ### ### 39 | 40 | 41 | 42 | -------------------------------------------------------------------------------- /inst/app/www/keyboard_shortcuts.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 |
Function Mac Linux & Windows
Open file cmd-o ctrl-o
Save file cmd-s ctrl-s
Render file cmd-r ctrl-r
Display editor only cmd-alt-e ctrl-alt-e
Display preview only cmd-alt-p ctrl-alt-p
Toggle split screen cmd-alt-s ctrl-alt-s
30 | -------------------------------------------------------------------------------- /R/preview.R: -------------------------------------------------------------------------------- 1 | #' Prepare rmarkdown document for instant preview 2 | #' 3 | #' This function prepares a rmarkdown document edited with editR for instant preview. 4 | #' It strips its front matter if it is present and add two extra line breaks at 5 | #' the end to prevent editR to "misbehave" when a code chunk is created at the 6 | #' very end of the document. 7 | #' 8 | #' @param rmd The rmarkdown document to prepare for instant preview. 9 | #' 10 | #' @return This function return a rmarkdown document ready for instant preview in editR. 11 | #' 12 | #' @author Simon Garnier: \email{garnier@@njit.edu}, \link[https://twitter.com/sjmgarnier]{@@sjmgarnier} 13 | #' 14 | preview <- function(rmd) { 15 | if (grepl("---\n(.*?)\n---", rmd)) { 16 | rmd <- sub("---\n(.*?)\n---", "", rmd) 17 | rmd <- sub("\n\n", "", rmd) 18 | } 19 | 20 | paste0("`r opts_chunk$set(cache = TRUE, autodep = TRUE)` \n\n", rmd, "\n\n") 21 | } 22 | -------------------------------------------------------------------------------- /man/bs3_dialog.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2 (4.1.1): do not edit by hand 2 | % Please edit documentation in R/bs3_dialog.R 3 | \name{bs3_dialog} 4 | \alias{bs3_dialog} 5 | \title{Custom dialog box function for \code{\link[editR:editR-package]{editR}}} 6 | \usage{ 7 | bs3_dialog(id, title, trigger, ...) 8 | } 9 | \arguments{ 10 | \item{id}{A unique identifier for the dialog box.} 11 | 12 | \item{title}{The title to appear at the top of the dialog box.} 13 | 14 | \item{trigger}{The id of a button or link that will open the dialog box.} 15 | 16 | \item{...}{UI elements to include within the dialog box (e.g. \code{\link[shiny:actionButton]{actionButtons}}).} 17 | } 18 | \value{ 19 | This function return the html code for a dialog box. 20 | } 21 | \description{ 22 | This function creates custom Twitter Bootstrap 3 dialog boxes for \code{\link[editR:editR-package]{editR}}. 23 | } 24 | \author{ 25 | Simon Garnier: \email{garnier@njit.edu}, \link[https://twitter.com/sjmgarnier]{@sjmgarnier} 26 | } 27 | 28 | -------------------------------------------------------------------------------- /R/bs3_dropdown.R: -------------------------------------------------------------------------------- 1 | #' Custom dropdown menu function for \code{\link[editR:editR-package]{editR}} 2 | #' 3 | #' This function creates custom Twitter Bootstrap 3 dropdown menus for \code{\link[editR:editR-package]{editR}}. 4 | #' 5 | #' @param name The name of the dropdown menu. 6 | #' 7 | #' @param navs A list of UI elements to include in the dropdown menu (e.g. \code{\link[shiny:actionLink]{actionLinks}}). 8 | #' 9 | #' @return This function return the html code for a Twitter Bootstrap 3 dropdown menu. 10 | #' 11 | #' @author Simon Garnier: \email{garnier@@njit.edu}, \link[https://twitter.com/sjmgarnier]{@@sjmgarnier} 12 | #' 13 | bs3_dropdown <- function(name = "My menu", navs) { 14 | tags$li(class = "dropdown", 15 | tags$a(name, class = "dropdown-toggle", "data-toggle" = "dropdown", 16 | tags$span(class = "caret") 17 | ), 18 | tags$ul(class = "dropdown-menu", 19 | lapply(navs, function(x) {tags$li(x)}) 20 | ) 21 | ) 22 | } 23 | -------------------------------------------------------------------------------- /inst/app/bits/keyboard.R: -------------------------------------------------------------------------------- 1 | keyboard <- withTags( 2 | table(style = "width: 80%; margin-left: 10%;", 3 | 4 | tr(class = "border_bottom", 5 | td(b("Function")), td(b("Mac")), td(b("Linux & Windows"))), 6 | 7 | tr(class = "padding_top", 8 | td("New file"), td("cmd-n"), td("ctrl-n")), 9 | 10 | tr(td("Open file", td("cmd-o"), td("ctrl-o"))), 11 | 12 | tr(td("Save file", td("cmd-s"), td("ctrl-s"))), 13 | 14 | tr(td("Save file as", td("cmd-shift-s"), td("ctrl-shift-s"))), 15 | 16 | tr(class = "border_bottom padding_bottom", 17 | td("Render file"), td("cmd-r"), td("ctrl-r")), 18 | 19 | tr(class = "padding_top", 20 | td("Display editor only"), td("cmd-alt-e"), td("ctrl-alt-e")), 21 | 22 | tr(td("Display preview only"), td("cmd-alt-p"), td("ctrl-alt-p")), 23 | 24 | tr(class = "border_bottom padding_bottom", 25 | td("Toggle split screen"), td("cmd-alt-s"), td("ctrl-alt-s")) 26 | ) 27 | ) 28 | -------------------------------------------------------------------------------- /inst/app/www/about.html: -------------------------------------------------------------------------------- 1 |

editR version 0.1.5

2 | 3 |

Author: Simon Garnier (garnier@njit.edu, 4 | @sjmgarnier)

5 | 6 |

This program is distributed under the terms of version 3 of the 7 | GNU General Public License.

8 | 9 |

editR is built thanks to the following open source componentns and the hard 10 | work of their respective authors: 11 |

12 | 13 | 21 | -------------------------------------------------------------------------------- /R/bs3_navbar.R: -------------------------------------------------------------------------------- 1 | #' Custom navbar function for \code{\link[editR:editR-package]{editR}} 2 | #' 3 | #' This function creates custom Twitter Bootstrap 3 navbars for \code{\link[editR:editR-package]{editR}}. 4 | #' 5 | #' @param name The name of the navbar. 6 | #' 7 | #' @param navs A list of UI elements to include in the navbar (e.g. \code{\link[shiny:actionLink]{actionLinks}}). 8 | #' 9 | #' @return This function return the html code for a Twitter Bootstrap 3 navbar. 10 | #' 11 | #' @author Simon Garnier: \email{garnier@@njit.edu}, \link[https://twitter.com/sjmgarnier]{@@sjmgarnier} 12 | #' 13 | bs3_navbar <- function(brand = "My website", navs) { 14 | tags$nav(class = "navbar navbar-default", 15 | tags$div(class = "container-fluid", 16 | tags$div(class = "navbar-header", 17 | tags$a(brand, class = "navbar-brand", href = "#") 18 | ), 19 | tags$div( 20 | tags$ul(class = "nav navbar-nav", 21 | lapply(navs, function(x) {tags$li(x)}) 22 | ) 23 | ) 24 | ) 25 | ) 26 | } 27 | -------------------------------------------------------------------------------- /inst/app/bits/about.R: -------------------------------------------------------------------------------- 1 | about <- withTags( 2 | div(style = "width: 80%; margin-left: 10%; text-align: justify;", 3 | 4 | h3("editR", 5 | span("version 0.2.0", style = "font-size: 12px;")), 6 | 7 | p(HTML("Author: Simon Garnier (garnier@njit.edu, 8 | @sjmgarnier)")), 9 | 10 | p(HTML("This program is distributed under the terms of version 3 of the 11 | GNU General Public License.")), 12 | 13 | p("editR is built thanks to the following open source components and the hard work of their respective authors:"), 14 | 15 | ul(li(a("shiny", href = "http://cran.r-project.org/web/packages/shiny/index.html")), 16 | li(a("shinyAce", href = "https://github.com/trestletech/shinyAce")), 17 | li(a("shinyFiles", href = "http://cran.r-project.org/web/packages/shinyFiles/index.html")), 18 | li(a("shinyBS", href = "https://github.com/ebailey78/shinyBS")), 19 | li(a("rmarkdown", href = "http://cran.r-project.org/web/packages/rmarkdown/index.html")), 20 | li(a("pandoc", href = "http://johnmacfarlane.net/pandoc/"))) 21 | ) 22 | ) 23 | -------------------------------------------------------------------------------- /man/editR.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2 (4.1.1): do not edit by hand 2 | % Please edit documentation in R/editR.R 3 | \name{editR} 4 | \alias{editR} 5 | \title{Edit Rmarkdown files with instant preview} 6 | \usage{ 7 | editR(file = NULL) 8 | } 9 | \arguments{ 10 | \item{file}{The path (as a character string) to an existing .Rmd/.md file, or 11 | to a new .Rmd/.md file. If the file does not exist, it will be created when the 12 | GUI starts.]} 13 | } 14 | \value{ 15 | This function does not return anything. 16 | } 17 | \description{ 18 | This function creates a GUI to edit \code{\link[rmarkdown:rmarkdown-package]{Rmarkdown}} 19 | documents and display an instant preview of the document as it is being 20 | written. Rmarkdown documents can be rendered directly from the GUI. 21 | } 22 | \details{ 23 | If called from RStudio on Mac and Linux, it will open in the internal 24 | RStudio browser. If called from a terminal or on Windows, it will open in your 25 | default internet browser. editR should work without any problem with recent 26 | versions of most internet browsers. It is likely to break with older versions. 27 | } 28 | \examples{ 29 | # Create and edit a new Rmarkdown document in the current working directory 30 | editR("example.Rmd") 31 | } 32 | \author{ 33 | Simon Garnier: \email{garnier@njit.edu}, \link[https://twitter.com/sjmgarnier]{@sjmgarnier} 34 | } 35 | 36 | -------------------------------------------------------------------------------- /inst/app/bits/hidden.R: -------------------------------------------------------------------------------- 1 | hidden <- list(shinyFilesButton("my_open", "Open file", "Please select a file", FALSE), 2 | shinySaveButton("my_save_as", "Save file", 3 | "Please select a folder", list(rmarkdown = c(".Rmd", ".md"))), 4 | shinySaveButton("my_save_as_new_file", "Save file", 5 | "Please select a folder", list(rmarkdown = c(".Rmd", ".md"))), 6 | uiOutput("pf_plus"), 7 | uiOutput("pf_minus"), 8 | uiOutput("view"), 9 | bsModal("k_s", "Keyboard shortcuts", trigger = "keys", keyboard), 10 | bsModal("info", "About", trigger = "about", about), 11 | bsModal("e_theme_mod", "Choose editor theme", trigger = "e_theme", 12 | tags$div(width = "100%", align = "center", 13 | selectInput("e_theme_choice", "", choices = getAceThemes(), 14 | selected = getOption("editR")$editor_theme)) 15 | ), 16 | bs3_dialog("save_current_diag", "Save currently opened file?", "new", 17 | actionButton("save_current", "Save"), 18 | actionButton("discard_current", "Discard"), 19 | tags$button("Close", type = "button", class = "btn btn-default", `data-dismiss` = "modal")) 20 | ) 21 | -------------------------------------------------------------------------------- /R/loadOptions.R: -------------------------------------------------------------------------------- 1 | .loadOptions <- function() { 2 | if (.Platform$OS.type == "unix") { 3 | path <- "~/.editR" 4 | } else { 5 | path <- paste0(path.expand("~"), "/.editR") 6 | } 7 | 8 | if (file.exists(path)) { 9 | opt <- read.csv(path, stringsAsFactors = FALSE) 10 | } else { 11 | editR:::.createOptions() 12 | opt <- read.csv(path, stringsAsFactors = FALSE) 13 | } 14 | 15 | options(editR = list(editor_font_size = as.numeric(opt$value[opt$option == "editor_font_size"]), 16 | editor_theme = opt$value[opt$option == "editor_theme"], 17 | preview_font_size = as.numeric(opt$value[opt$option == "preview_font_size"]))) 18 | } 19 | 20 | .createOptions <- function() { 21 | if (.Platform$OS.type == "unix") { 22 | path <- "~/.editR" 23 | } else { 24 | path <- paste0(path.expand("~"), "/.editR") 25 | } 26 | 27 | file.copy(from = paste0(find.package("editR"), "/editR.opt"), 28 | to = path) 29 | } 30 | 31 | .changeOptions <- function(option, value) { 32 | l <- getOption("editR") 33 | l[[which(names(l) == option)]] <- value 34 | options(editR = l) 35 | } 36 | 37 | .saveOptions <- function() { 38 | if (.Platform$OS.type == "unix") { 39 | path <- "~/.editR" 40 | } else { 41 | path <- paste0(path.expand("~"), "/.editR") 42 | } 43 | 44 | write.csv(data.frame(option = names(getOption("editR")), 45 | value = unlist(getOption("editR"))), 46 | file = path, row.names = FALSE) 47 | } 48 | -------------------------------------------------------------------------------- /R/bs3_dialog.R: -------------------------------------------------------------------------------- 1 | #' Custom dialog box function for \code{\link[editR:editR-package]{editR}} 2 | #' 3 | #' This function creates custom Twitter Bootstrap 3 dialog boxes for \code{\link[editR:editR-package]{editR}}. 4 | #' 5 | #' @param id A unique identifier for the dialog box. 6 | #' 7 | #' @param title The title to appear at the top of the dialog box. 8 | #' 9 | #' @param trigger The id of a button or link that will open the dialog box. 10 | #' 11 | #' @param ... UI elements to include within the dialog box (e.g. \code{\link[shiny:actionButton]{actionButtons}}). 12 | #' 13 | #' @return This function return the html code for a dialog box. 14 | #' 15 | #' @author Simon Garnier: \email{garnier@@njit.edu}, \link[https://twitter.com/sjmgarnier]{@@sjmgarnier} 16 | #' 17 | bs3_dialog <- function(id, title, trigger, ...) { 18 | tags$div(class = "modal sbs-modal fade", 19 | id = id, tabindex = "-1", `data-sbs-trigger` = trigger, 20 | tags$div(class = "modal-dialog", 21 | tags$div(class = "modal-content", 22 | tags$div(class = "modal-header", 23 | tags$button(type = "button", 24 | class = "close", `data-dismiss` = "modal", 25 | tags$span(HTML("×"))), 26 | tags$h4(class = "modal-title", title)), 27 | tags$div(class = "modal-footer", list(...)) 28 | ) 29 | ) 30 | ) 31 | } 32 | -------------------------------------------------------------------------------- /man/editR-package.Rd: -------------------------------------------------------------------------------- 1 | \name{editR-package} 2 | \alias{editR-package} 3 | \docType{package} 4 | \title{ 5 | A basic Rmarkdown editor with instant preview 6 | } 7 | \description{ 8 | editR is a basic Rmarkdown editor with instant previewing of your document. It 9 | allows you to create and edit \code{\link[:-package]{Rmarkdown}} 10 | documents while instantly previewing the result of your writing and coding. It 11 | also allows you to render your Rmarkdown file in any format permitted by the 12 | \code{\link[:-package]{Rmarkdown}} package. It was built 13 | using \code{\link[:-package]{shiny}} and its extensions 14 | \code{\link[:-package]{shinyBS}}, 15 | \code{\link[:-package]{shinyAce}}, 16 | \code{\link[:-package]{shinyFiles}}. 17 | } 18 | \details{ 19 | \tabular{ll}{ 20 | Package: \tab editR\cr 21 | Type: \tab Package\cr 22 | Version: \tab 0.2.0\cr 23 | Date: \tab 2015-04-05\cr 24 | License: \tab GPL (>= 3)\cr 25 | } 26 | } 27 | \author{ 28 | Simon Garnier - \href{http://twitter.com/sjmgarnier}{@sjmgarnier} 29 | } 30 | \references{ 31 | } 32 | \keyword{ package } 33 | \seealso{ 34 | \code{\link[:-package]{rmarkdown}}, \code{\link[:-package]{shiny}}, 35 | \code{\link[:-package]{shinyBS}}, \code{\link[:-package]{shinyAce}}, 36 | \code{\link[:-package]{shinyFiles}} 37 | } 38 | \examples{ 39 | %% ~~ simple examples of the most important functions ~~ 40 | } 41 | -------------------------------------------------------------------------------- /R/editR.R: -------------------------------------------------------------------------------- 1 | #' Edit Rmarkdown files with instant preview 2 | #' 3 | #' This function creates a GUI to edit \code{\link[rmarkdown:rmarkdown-package]{Rmarkdown}} 4 | #' documents and display an instant preview of the document as it is being 5 | #' written. Rmarkdown documents can be rendered directly from the GUI. 6 | #' 7 | #' @param file The path (as a character string) to an existing .Rmd/.md file, or 8 | #' to a new .Rmd/.md file. If the file does not exist, it will be created when the 9 | #' GUI starts.] 10 | #' 11 | #' @return This function does not return anything. 12 | #' 13 | #' @author Simon Garnier: \email{garnier@@njit.edu}, \link[https://twitter.com/sjmgarnier]{@@sjmgarnier} 14 | #' 15 | #' @details If called from RStudio on Mac and Linux, it will open in the internal 16 | #' RStudio browser. If called from a terminal or on Windows, it will open in your 17 | #' default internet browser. editR should work without any problem with recent 18 | #' versions of most internet browsers. It is likely to break with older versions. 19 | #' 20 | #' @examples 21 | #' # Create and edit a new Rmarkdown document in the current working directory 22 | #' editR("example.Rmd") 23 | #' 24 | #' @export 25 | #' 26 | editR <- function(file = NULL, port = NULL) { 27 | require(tools) 28 | require(shiny) 29 | 30 | if (is.null(file)) { 31 | assign("md_name", NULL, envir=globalenv()) 32 | assign("md_path", NULL, envir=globalenv()) 33 | } else { 34 | ext <- tolower(file_ext(file)) 35 | if (ext != "md" & ext != "rmd") 36 | stop("'file' is not a .Rmd or .md file.") 37 | 38 | file <- suppressWarnings(normalizePath(file)) 39 | 40 | md_name <- basename(file) 41 | md_path <- dirname(file) 42 | assign("md_name", md_name, envir=globalenv()) 43 | assign("md_path", md_path, envir=globalenv()) 44 | } 45 | 46 | app_path <- paste0(find.package("editR"), "/app") 47 | 48 | if (.Platform$OS.type == "windows") { 49 | if(!is.null(port)){ 50 | runApp(app_path, port = port, launch.browser = TRUE) 51 | }else{ 52 | runApp(app_path, launch.browser = TRUE) 53 | } 54 | } else { 55 | if(!is.null(port)){ 56 | runApp(app_path, port = port) 57 | }else{ 58 | runApp(app_path) 59 | } 60 | } 61 | 62 | } 63 | 64 | -------------------------------------------------------------------------------- /inst/app/bits/navbar.R: -------------------------------------------------------------------------------- 1 | navbar <- bs3_navbar("editR", 2 | navs = list( 3 | bs3_dropdown(name = "File", 4 | navs = list( 5 | actionLink("new", "New file"), 6 | actionLink("open", "Open file"), 7 | tags$hr(class = "sep"), 8 | actionLink("save", "Save file"), 9 | actionLink("saveas", "Save file as"), 10 | tags$hr(class = "sep"), 11 | actionLink("render", "Render file")) 12 | ), 13 | 14 | bs3_dropdown(name = "View", 15 | navs = list( 16 | actionLink("ed_only", "Editor only"), 17 | actionLink("pr_only", "Preview only"), 18 | actionLink("dual", "Dual view"), 19 | tags$hr(class = "sep"), 20 | actionLink("ef_plus", "Editor font size +"), 21 | actionLink("ef_minus", "Editor font size -"), 22 | actionLink("e_theme", "Editor theme"), 23 | tags$hr(class = "sep"), 24 | actionLink("pf_plus", "Preview font size +"), 25 | actionLink("pf_minus", "Preview font size -"), 26 | tags$hr(class = "sep"), 27 | actionLink("auto_scroll", "Toggle auto-scroll") 28 | ) 29 | ), 30 | 31 | bs3_dropdown(name = "Help", 32 | navs = list( 33 | actionLink("keys", "Keyboard shortcuts"), 34 | tags$hr(class = "sep"), 35 | actionLink("about", "About editR") 36 | ) 37 | ) 38 | 39 | ) 40 | ) 41 | -------------------------------------------------------------------------------- /RELEASE_NOTES.md: -------------------------------------------------------------------------------- 1 | Release notes 2 | ============= 3 | 4 | --- 5 | 6 | - **0.2.2**: 7 | - Overhauled the options system to prevent settings reverting to default. 8 | 9 | --- 10 | 11 | - **0.2.1**: 12 | - Added live autocompletion in the editor. 13 | 14 | --- 15 | 16 | - **0.2.0**: 17 | - The UI has been rewritten to be compatible with the latest version of shiny (>=0.11) and with Twitter Bootstrap 3. 18 | - The UI and server now rely (almost) only on packages available on CRAN. Most experimental packages used previously are not necessary anymore, making the installation process easier. 19 | - The editR function does not require the path to a rmarkdown file anymore. If no path is provided, editR will create a new temporary file that can be saved later from within the UI. 20 | - Added a "New file" menu to create new rmarkdown file from within the UI. 21 | - Added a "Save file as" menu to save new documents or save existing documents under a different name. 22 | - Added keyboard shortcuts for "New file" and "Save file as". 23 | - The structure of the app source code has been modified to be more modular and easier to modify/update. 24 | --- 25 | 26 | - **0.1.6**: 27 | - Added an experimental autoscroll function. Deactivated by default until it works well with documents containing many code chunks. 28 | - Updated installation instructions and code to accomodate the transition of `shiny` from Bootstrap2 to Bootstrap3. 29 | - Corrected a number of bugs listed [here](https://github.com/swarm-lab/editR/compare/v0.1.5...master). 30 | 31 | --- 32 | 33 | - **0.1.5**: 34 | - Added menu item to select editor theme. 35 | - Added automatic caching of code chunks to speed up preview. 36 | - Added automatic numbering of headings. 37 | 38 | --- 39 | 40 | - **0.1.4**: 41 | - Added 'Help' menu with 'About' submenu and 'Keyboard shorcuts' submenu. 42 | 43 | --- 44 | 45 | - **0.1.3**: 46 | - Added possibility to display editor or preview only. 47 | 48 | --- 49 | 50 | - **0.1.2**: 51 | - Added file containing release notes. 52 | - When editR cannot parse the markdown file without error, it shows the 53 | last working version instead but displays it with reduced opacity to indicate 54 | an error. 55 | 56 | --- 57 | 58 | - **0.1.1:** 59 | - Added 'View' menu. 60 | - In 'View' menu, added possibility to increase/decrease font size in editor and preview 61 | 62 | --- 63 | 64 | - **0.1:** 65 | - Initial release. 66 | -------------------------------------------------------------------------------- /inst/app/www/editR.css: -------------------------------------------------------------------------------- 1 | /* App formating */ 2 | 3 | #rmd { 4 | position: absolute; 5 | top: 55px; 6 | bottom: 0; 7 | left: 0%; 8 | right: 50%; 9 | padding-right: 10px; 10 | } 11 | 12 | #knit_doc { 13 | position: absolute; 14 | top: 55px; 15 | bottom: 0; 16 | left: 50%; 17 | right: 0%; 18 | padding-left: 10px; 19 | overflow-y: scroll; 20 | } 21 | 22 | #my_open { 23 | position: absolute; 24 | left: -99em; 25 | } 26 | 27 | #my_save_as { 28 | position: absolute; 29 | left: -99em; 30 | } 31 | 32 | #my_save_as_new_file { 33 | position: absolute; 34 | left: -99em; 35 | } 36 | 37 | .hr_menu { 38 | margin: 0px; 39 | } 40 | 41 | tr.border_bottom td { 42 | border-bottom: 1pt solid black; 43 | } 44 | 45 | tr.padding_top td { 46 | padding-top: 0.5em; 47 | } 48 | 49 | tr.padding_bottom td { 50 | padding-bottom: 0.5em; 51 | } 52 | 53 | #e_theme_mod .modal-body { 54 | height: 20em; 55 | } 56 | 57 | #editor_theme + div.modal-backdrop.fade.in { 58 | opacity: 0.001; 59 | } 60 | 61 | hr.sep { 62 | padding: 0px; 63 | margin: 2px; 64 | } 65 | 66 | /* Preview formatting */ 67 | 68 | body { 69 | counter-reset: h1; 70 | } 71 | 72 | #knit_doc h1 { 73 | font-size: 2em; 74 | counter-reset: h2; 75 | } 76 | 77 | #knit_doc h2 { 78 | font-size: 1.8em; 79 | counter-reset: h3; 80 | } 81 | 82 | #knit_doc h3 { 83 | font-size: 1.6em; 84 | counter-reset: h4; 85 | } 86 | 87 | #knit_doc h4 { 88 | font-size: 1.4em; 89 | counter-reset: h5; 90 | } 91 | 92 | #knit_doc h5 { 93 | font-size: 1.2em; 94 | counter-reset: h6; 95 | } 96 | 97 | #knit_doc h6 { 98 | font-size: 1em; 99 | } 100 | 101 | #knit_doc h1:before { 102 | counter-increment: h1; 103 | content: counter(h1) ". " 104 | } 105 | 106 | #knit_doc h2:before { 107 | counter-increment: h2; 108 | content: counter(h1) "." counter(h2) ". " 109 | } 110 | 111 | #knit_doc h3:before { 112 | counter-increment: h3; 113 | content: counter(h1) "." counter(h2) "." counter(h3) ". " 114 | } 115 | 116 | #knit_doc h4:before { 117 | counter-increment: h4; 118 | content: counter(h1) "." counter(h2) "." counter(h3) "." counter(h4) ". " 119 | } 120 | 121 | #knit_doc h5:before { 122 | counter-increment: h5; 123 | content: counter(h1) "." counter(h2) "." counter(h3) "." counter(h4) "." counter(h5) ". " 124 | } 125 | 126 | #knit_doc h6:before { 127 | counter-increment: h6; 128 | content: counter(h1) "." counter(h2) "." counter(h3) "." counter(h4) "." counter(h5) "." counter(h6) ". " 129 | } 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | -------------------------------------------------------------------------------- /inst/app/www/actions.js: -------------------------------------------------------------------------------- 1 | $(document).ready(function() { 2 | 3 | window.autoscroll = 0; 4 | window.frontmatter = 0; 5 | 6 | jQuery(function($){ 7 | $('#open').on('click', function(e) { 8 | e.preventDefault(); 9 | $('#my_open')[0].click(); 10 | }); 11 | }); 12 | 13 | jQuery(function($){ 14 | $('#saveas').on('click', function(e) { 15 | e.preventDefault(); 16 | $('#my_save_as')[0].click(); 17 | }); 18 | }); 19 | 20 | jQuery(function($){ 21 | $(document).keydown(function(e) { 22 | if((e.ctrlKey || e.metaKey) && e.which == 78) { 23 | e.preventDefault(); 24 | $('#new')[0].click(); 25 | }; 26 | 27 | if((e.ctrlKey || e.metaKey) && e.which == 79) { 28 | e.preventDefault(); 29 | $('#my_open')[0].click(); 30 | }; 31 | 32 | if((e.ctrlKey || e.metaKey) && e.which == 83) { 33 | e.preventDefault(); 34 | $('#save').click(); 35 | }; 36 | 37 | if((e.ctrlKey || e.metaKey) && e.shiftKey && e.which == 83) { 38 | e.preventDefault(); 39 | $('#my_save_as').click(); 40 | }; 41 | 42 | if((e.ctrlKey || e.metaKey) && e.altKey && e.which == 69) { 43 | e.preventDefault(); 44 | $('#ed_only').click(); 45 | }; 46 | 47 | if((e.ctrlKey || e.metaKey) && e.altKey && e.which == 80) { 48 | e.preventDefault(); 49 | $('#pr_only').click(); 50 | }; 51 | 52 | if((e.ctrlKey || e.metaKey) && e.altKey && e.which == 83) { 53 | e.preventDefault(); 54 | $('#dual').click(); 55 | }; 56 | }); 57 | }); 58 | 59 | jQuery(function($){ 60 | $('#auto_scroll').on('click', function() { 61 | if (window.autoscroll == 0) { 62 | window.autoscroll = 1; 63 | editor__rmd.selection.moveCursorBy(0, 1); 64 | editor__rmd.selection.moveCursorBy(0, -1); 65 | } else { 66 | window.autoscroll = 0; 67 | } 68 | }); 69 | }); 70 | 71 | jQuery(function($){ 72 | editor__rmd.selection.on('changeCursor', function(e) { 73 | 74 | if (window.autoscroll == 1) { 75 | 76 | if (editor__rmd.session.getLine(0) == '---') { 77 | var frontmatter = []; 78 | for (var i = 0, l = editor__rmd.session.getLength(); i < l; i++) { 79 | if (editor__rmd.session.getLine(i) == '---') 80 | frontmatter.push(i); 81 | } 82 | } 83 | 84 | frontmatter_length = 0; 85 | if (frontmatter.length > 1) { 86 | frontmatter_length = frontmatter[1] + 2; 87 | } 88 | 89 | var ace_percent = (editor__rmd.selection.getCursor().row - frontmatter_length) / (editor__rmd.session.getLength() - (frontmatter_length + 1)); 90 | var knit_div_height = $('#knit_doc').get(0).scrollHeight; 91 | 92 | $('#knit_doc').animate({ 93 | scrollTop: ace_percent * knit_div_height - 180 94 | }, 100); 95 | 96 | } 97 | 98 | }); 99 | }); 100 | 101 | Shiny.addCustomMessageHandler("saveas", 102 | function(message) { 103 | document.getElementById("saveas").click(); 104 | } 105 | ); 106 | 107 | Shiny.addCustomMessageHandler("saveas_new_file", 108 | function(message) { 109 | document.getElementById("my_save_as_new_file").click(); 110 | } 111 | ); 112 | 113 | }); 114 | 115 | 116 | 117 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | editR 2 | ===== 3 | 4 | **IMPORTANT: the latest version of `editR` (>=0.2) has undergone important 5 | modifications (see release notes below). The most important changes are the 6 | following:** 7 | 8 | **- `editR` is now fully compatible with the latest version of `shiny` on 9 | [CRAN](http://cran.r-project.org/) (>=0.11). `editR` was modified to support 10 | [Twitter Bootstrap](http://getbootstrap.com/) version 3 instead of version 2 as 11 | in the previous releases.** 12 | 13 | **- `editR` now relies (almost) entirely on packages available through 14 | [CRAN](http://cran.r-project.org/) and not on a large number of experimental 15 | packages as previously. This will facilitate the installation process.** 16 | 17 | **As a consequence of these modifications I strongly recommend that you reinstall 18 | `editR` following the new instructions below.** 19 | 20 | [Release notes](https://github.com/swarm-lab/editR/blob/master/RELEASE_NOTES.md) 21 | 22 | --- 23 | 24 | `editR` is a basic [Rmarkdown](http://rmarkdown.rstudio.com/) editor with instant 25 | previewing of your document. It allows you to create and edit 26 | [Rmarkdown](http://rmarkdown.rstudio.com/) documents while instantly previewing the 27 | result of your writing and coding. It also allows you to render your 28 | [Rmarkdown](http://rmarkdown.rstudio.com/) file in any format permitted by the 29 | [`rmarkdown`](https://github.com/rstudio/rmarkdown) R package. 30 | 31 | ![Screenshot of editR window](https://raw.githubusercontent.com/swarm-lab/editR/master/editR_screenshot.jpg) 32 | 33 | --- 34 | 35 | #### Installation 36 | Installing `editR` from this GitHub repository is now pretty straightforward. 37 | Simply copying the following lines of code in your R terminal should to install 38 | everything you need to run `editR` on your computer: 39 | 40 | ```{r} 41 | if (!require("devtools")) install.packages("devtools") 42 | devtools::install_github("trestletech/shinyAce") 43 | devtools::install_github("swarm-lab/editR") 44 | 45 | library(editR) 46 | ``` 47 | 48 | `editR` requires the installation of the latest versions of following packages 49 | on [CRAN](http://cran.r-project.org/): 50 | 51 | 1. [`shiny`](http://cran.r-project.org/web/packages/shiny/index.html) 52 | 2. [`shinyFiles`](http://cran.r-project.org/web/packages/shinyFiles/index.html) 53 | 3. [`shinyBS`](http://cran.r-project.org/web/packages/shinyBS/index.html) 54 | 4. [`rmarkdown`](http://cran.r-project.org/web/packages/rmarkdown/index.html) 55 | 5. [`knitr`](http://cran.r-project.org/web/packages/knitr/index.html) 56 | 57 | It also requires the installation of the development version of the following 58 | package on GitHub: 59 | 60 | 1. [`shinyAce`](https://github.com/trestletech/shinyAce) 61 | 62 | Finally, to render documents in various output formats (.html, .pdf, .docx), 63 | `editR` uses the [`render`](http://www.rdocumentation.org/packages/rmarkdown/functions/render) 64 | function from the [`rmarkdown`](http://cran.r-project.org/web/packages/rmarkdown/index.html) 65 | package. This function requires the installation of [`pandoc`](http://johnmacfarlane.net/pandoc/) 66 | to work. Installation instructions for `pandoc` can be found at: 67 | [http://johnmacfarlane.net/pandoc/installing.html](http://johnmacfarlane.net/pandoc/installing.html). 68 | For Mac users, I recommend that you install `pandoc` via [Homebrew](http://brew.sh/) or 69 | [MacPorts](https://www.macports.org/). 70 | 71 | --- 72 | 73 | #### Usage 74 | To start `editR`, simply run this line of code in your R console: 75 | 76 | ```{r} 77 | editR("path/to/file.Rmd") 78 | ``` 79 | 80 | with "path/to/file.Rmd" the path to a new or existing .Rmd (or .md) file. If this 81 | is a new file, it will be created at this location. You can also open an existing 82 | file from within `editR` using the `File > Open file` menu. 83 | 84 | You can also open `editR` without providing a path to a new or existing .Rmd file. 85 | 86 | ```{r} 87 | editR() 88 | ``` 89 | 90 | In this case a temporary new file will be created that can then be saved from 91 | withing the user interface of `editR`. 92 | 93 | For more information about authoring Rmarkdown files, visit 94 | [http://rmarkdown.rstudio.com/](http://rmarkdown.rstudio.com/). 95 | 96 | --- 97 | 98 | #### Maintainer(s) 99 | Simon Garnier - [@sjmgarnier](https://twitter.com/sjmgarnier) - 100 | 101 | 102 | --- 103 | 104 | #### References 105 | `editR` was built with [`shiny`](http://shiny.rstudio.com/) by [@rstudio](https://github.com/rstudio), 106 | and its extensions 107 | [`shinyBS`](https://github.com/ebailey78/shinyBS) by [@ebailey78](https://github.com/ebailey78), 108 | [`shinyFiles`](https://github.com/thomasp85/shinyFiles) by [@thomaso85](https://github.com/thomasp85) and 109 | [`shinyAce`](https://github.com/trestletech/shinyAce) by [@trestletech](https://github.com/trestletech) 110 | -------------------------------------------------------------------------------- /inst/app/server.R: -------------------------------------------------------------------------------- 1 | shinyServer(function(input, output, session) { 2 | 3 | ### Init logic ### 4 | if (is.null(md_name)) { 5 | template_path <- paste0(find.package("editR"), "/app/template.Rmd") 6 | md_file <- readChar(template_path, file.info(template_path)$size) 7 | } else { 8 | md_file <- readChar(md_name, file.info(md_name)$size) 9 | } 10 | md_bak <<- md_file 11 | isolate({updateAceEditor(session, "rmd", value = md_file)}) 12 | react <- reactiveValues(view = "dual", refresh = -1) 13 | ### ### 14 | 15 | ### New file logic ### 16 | observe({ 17 | if (input$save_current > 0) { 18 | toggleModal(session, "save_current_diag", toggle = "close") 19 | if (is.null(md_name)) { 20 | session$sendCustomMessage("saveas_new_file", "message") 21 | } else { 22 | isolate({writeChar(input$rmd, con = md_name)}) 23 | setwd(tempdir()) 24 | template_path <- paste0(find.package("editR"), "/app/template.Rmd") 25 | md_file <- readChar(template_path, file.info(template_path)$size) 26 | isolate({updateAceEditor(session, "rmd", value = md_file)}) 27 | } 28 | } 29 | }) 30 | 31 | shinyFileSave(input, "my_save_as_new_file", session = session, 32 | roots = c(root = normalizePath("~"))) 33 | 34 | observe({ 35 | if (!is.null(input$my_save_as_new_file)) { 36 | file <- as.character(parseSavePath(roots = c(root = normalizePath("~")), 37 | input$my_save_as_new_file)$datapath) 38 | file <- normalizePath(file) 39 | md_name <<- basename(file) 40 | md_path <<- dirname(file) 41 | setwd(md_path) 42 | isolate({writeChar(input$rmd, con = md_name)}) 43 | 44 | setwd(tempdir()) 45 | template_path <- paste0(find.package("editR"), "/app/template.Rmd") 46 | md_file <- readChar(template_path, file.info(template_path)$size) 47 | isolate({updateAceEditor(session, "rmd", value = md_file)}) 48 | } 49 | }) 50 | 51 | observe({ 52 | if (input$discard_current > 0) { 53 | toggleModal(session, "save_current_diag", toggle = "close") 54 | setwd(tempdir()) 55 | template_path <- paste0(find.package("editR"), "/app/template.Rmd") 56 | md_file <- readChar(template_path, file.info(template_path)$size) 57 | isolate({updateAceEditor(session, "rmd", value = md_file)}) 58 | } 59 | }) 60 | ### ### 61 | 62 | ### Open file logic ### 63 | shinyFileChoose(input, 'my_open', session = session, 64 | roots = c(root = normalizePath("~")), 65 | filetypes = c('md', 'rmd')) 66 | 67 | observe({ 68 | if (!is.null(input$my_open)) { 69 | file <- as.character(parseFilePaths(roots = c(root = normalizePath("~")), 70 | input$my_open)$datapath) 71 | file <- normalizePath(file) 72 | 73 | md_name <<- basename(file) 74 | md_path <<- dirname(file) 75 | setwd(md_path) 76 | 77 | md_file <- readChar(md_name, file.info(md_name)$size) 78 | isolate({updateAceEditor(session, "rmd", value = md_file)}) 79 | } 80 | }) 81 | ### ### 82 | 83 | 84 | ### View menu logic ### 85 | observe({ 86 | if (input$ef_plus > 0) { 87 | editR:::.changeOptions("editor_font_size", getOption("editR")$editor_font_size + 1) 88 | editR:::.saveOptions() 89 | isolate({updateAceEditor(session, "rmd", fontSize = getOption("editR")$editor_font_size)}) 90 | } 91 | }) 92 | 93 | observe({ 94 | if (input$ef_minus > 0) { 95 | editR:::.changeOptions("editor_font_size", getOption("editR")$editor_font_size - 1) 96 | editR:::.saveOptions() 97 | isolate({updateAceEditor(session, "rmd", fontSize = getOption("editR")$editor_font_size)}) 98 | } 99 | }) 100 | 101 | output$pf_plus <- renderUI({ 102 | if (input$pf_plus > 0) { 103 | editR:::.changeOptions("preview_font_size", getOption("editR")$preview_font_size * 1.1) 104 | editR:::.saveOptions() 105 | } 106 | 107 | tags$head(tags$style( 108 | HTML(paste0("#knit_doc *{font-size: ", getOption("editR")$preview_font_size, "em;}")) 109 | )) 110 | }) 111 | 112 | output$pf_minus <- renderUI({ 113 | if (input$pf_minus > 0) { 114 | editR:::.changeOptions("preview_font_size", getOption("editR")$preview_font_size * (1 / 1.1)) 115 | editR:::.saveOptions() 116 | 117 | tags$head(tags$style( 118 | HTML(paste0("#knit_doc *{font-size: ", getOption("editR")$preview_font_size, "em;}")) 119 | )) 120 | } 121 | }) 122 | 123 | observe({ 124 | if (input$ed_only > 0) { 125 | react$view <- "ed_only" 126 | } 127 | }) 128 | 129 | observe({ 130 | if (input$pr_only > 0) { 131 | react$view <- "pr_only" 132 | } 133 | }) 134 | 135 | observe({ 136 | if (input$dual > 0) { 137 | react$view <- "dual" 138 | } 139 | }) 140 | 141 | output$view <- renderUI({ 142 | if (react$view == "ed_only") { 143 | tags$head(tags$style( 144 | HTML("#rmd {right: 0%; left: 0%;} #knit_doc{left: 200%; right: -100%;}") 145 | )) 146 | } else if (react$view == "pr_only") { 147 | tags$head(tags$style( 148 | HTML(paste0("#rmd {right: 200%; left: -100%;} #knit_doc{left: 0%; right: 0%;}")) 149 | )) 150 | } else { 151 | tags$head(tags$style( 152 | HTML(paste0("#rmd {right: 50%; left: 0%;} #knit_doc{left: 50%; right: 0%;}")) 153 | )) 154 | } 155 | }) 156 | 157 | observe({ 158 | invalidateLater(50, session) 159 | isolate({updateAceEditor(session, "rmd", theme = getOption("editR")$editor_theme)}) 160 | }) 161 | 162 | observe({ 163 | if (!is.null(input$e_theme_choice)) { 164 | editR:::.changeOptions("editor_theme", input$e_theme_choice) 165 | editR:::.saveOptions() 166 | isolate({ 167 | updateAceEditor(session, "rmd", theme = getOption("editR")$editor_theme) 168 | }) 169 | } 170 | }) 171 | ### ### 172 | 173 | 174 | ### Update preview logic ### 175 | output$knit_doc <- renderUI({ 176 | input$rmd 177 | capture.output( 178 | md <- isolate(tryCatch( 179 | suppressMessages( 180 | suppressWarnings( 181 | knit2html(text = preview(input$rmd), 182 | fragment.only = TRUE, quiet = TRUE))), 183 | error = function(e) {FALSE}))) 184 | if (md == FALSE) { 185 | md <- md_bak 186 | md <- paste(md, tags$style(paste0("#knit_doc *{opacity: 0.5;}"))) 187 | } else { 188 | md_bak <<- md 189 | } 190 | return(withMathJax(HTML(md))) 191 | }) 192 | ### ### 193 | 194 | 195 | ### Render file logic ### 196 | observe({ 197 | if (input$render > 0 | !is.null(input$render_key)){ 198 | isolate({ 199 | writeChar(input$rmd, con = md_name) 200 | doc <- render(md_name) 201 | browseURL(doc) 202 | }) 203 | } 204 | }) 205 | ### ### 206 | 207 | 208 | ### Save file logic ### 209 | shinyFileSave(input, "my_save_as", session = session, 210 | roots = c(root = normalizePath("~"))) 211 | 212 | observe({ 213 | if (!is.null(input$my_save_as)) { 214 | file <- as.character(parseSavePath(roots = c(root = normalizePath("~")), 215 | input$my_save_as)$datapath) 216 | file <- normalizePath(file) 217 | md_name <<- basename(file) 218 | md_path <<- dirname(file) 219 | setwd(md_path) 220 | isolate({writeChar(input$rmd, con = md_name)}) 221 | } 222 | }) 223 | 224 | observe({ 225 | if (input$save > 0){ 226 | if (is.null(md_name)) { 227 | session$sendCustomMessage("saveas", "message") 228 | } else { 229 | isolate({writeChar(input$rmd, con = md_name)}) 230 | } 231 | } 232 | }) 233 | ### ### 234 | 235 | }) 236 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | --------------------------------------------------------------------------------