├── .github ├── .gitignore └── workflows │ ├── pkgdown.yaml │ ├── R-CMD-check.yaml │ └── test-coverage.yaml ├── img ├── logo.png ├── feather.png ├── scribblr.gif └── logo.R ├── inst ├── img │ └── logo.png └── rstudio │ └── addins.dcf ├── man ├── figures │ └── logo.png ├── scribblr_list.Rd ├── scribblr_delete.Rd ├── scribblr-package.Rd └── scribble.Rd ├── tests ├── testthat.R └── testthat │ ├── test-placeholder.R │ ├── test-scribble.R │ ├── test-filesystem.R │ └── test-utils.R ├── _pkgdown.yml ├── pkgdown └── favicon │ ├── favicon.ico │ ├── favicon-16x16.png │ ├── favicon-32x32.png │ ├── apple-touch-icon.png │ ├── apple-touch-icon-60x60.png │ ├── apple-touch-icon-76x76.png │ ├── apple-touch-icon-120x120.png │ ├── apple-touch-icon-152x152.png │ └── apple-touch-icon-180x180.png ├── .gitignore ├── .Rbuildignore ├── .scribblr └── notes │ └── main ├── NAMESPACE ├── codecov.yml ├── R ├── post_github_issue.R ├── scribblr-package.R ├── placeholder.R ├── notes_management.R ├── filesystem.R ├── utils.R └── scribble.R ├── scribblr.Rproj ├── DESCRIPTION ├── NEWS.md ├── README.md ├── README.Rmd └── LICENSE.md /.github/.gitignore: -------------------------------------------------------------------------------- 1 | *.html 2 | -------------------------------------------------------------------------------- /img/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/img/logo.png -------------------------------------------------------------------------------- /img/feather.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/img/feather.png -------------------------------------------------------------------------------- /img/scribblr.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/img/scribblr.gif -------------------------------------------------------------------------------- /inst/img/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/inst/img/logo.png -------------------------------------------------------------------------------- /man/figures/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/man/figures/logo.png -------------------------------------------------------------------------------- /tests/testthat.R: -------------------------------------------------------------------------------- 1 | library(testthat) 2 | library(scribblr) 3 | 4 | test_check("scribblr") 5 | -------------------------------------------------------------------------------- /_pkgdown.yml: -------------------------------------------------------------------------------- 1 | url: https://vgherard.github.io/scribblr/, https://github.com/vgherard/scribblr 2 | -------------------------------------------------------------------------------- /pkgdown/favicon/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/pkgdown/favicon/favicon.ico -------------------------------------------------------------------------------- /pkgdown/favicon/favicon-16x16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/pkgdown/favicon/favicon-16x16.png -------------------------------------------------------------------------------- /pkgdown/favicon/favicon-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/pkgdown/favicon/favicon-32x32.png -------------------------------------------------------------------------------- /pkgdown/favicon/apple-touch-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/pkgdown/favicon/apple-touch-icon.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .Rproj.user 2 | .Rhistory 3 | .RData 4 | .Ruserdata 5 | .Rdata 6 | .httr-oauth 7 | .DS_Store 8 | ignore 9 | docs 10 | -------------------------------------------------------------------------------- /pkgdown/favicon/apple-touch-icon-60x60.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/pkgdown/favicon/apple-touch-icon-60x60.png -------------------------------------------------------------------------------- /pkgdown/favicon/apple-touch-icon-76x76.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/pkgdown/favicon/apple-touch-icon-76x76.png -------------------------------------------------------------------------------- /pkgdown/favicon/apple-touch-icon-120x120.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/pkgdown/favicon/apple-touch-icon-120x120.png -------------------------------------------------------------------------------- /pkgdown/favicon/apple-touch-icon-152x152.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/pkgdown/favicon/apple-touch-icon-152x152.png -------------------------------------------------------------------------------- /pkgdown/favicon/apple-touch-icon-180x180.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vgherard/scribblr/HEAD/pkgdown/favicon/apple-touch-icon-180x180.png -------------------------------------------------------------------------------- /tests/testthat/test-placeholder.R: -------------------------------------------------------------------------------- 1 | test_that("multiplication works", { 2 | expect_vector(scribblr_placeholder(NULL), ptype = character(), size = 1L) 3 | }) 4 | -------------------------------------------------------------------------------- /inst/rstudio/addins.dcf: -------------------------------------------------------------------------------- 1 | Name: Open scribblr note editor 2 | Description: Opens the scribblr note editor in a new window. 3 | Binding: scribble 4 | Interactive: true 5 | -------------------------------------------------------------------------------- /.Rbuildignore: -------------------------------------------------------------------------------- 1 | ^.*\.Rproj$ 2 | ^\.Rproj\.user$ 3 | ^LICENSE\.md$ 4 | ^README\.Rmd$ 5 | ^img$ 6 | ^\.scribblr$ 7 | ^ignore$ 8 | ^\.github$ 9 | ^codecov\.yml$ 10 | ^_pkgdown\.yml$ 11 | ^docs$ 12 | ^pkgdown$ 13 | -------------------------------------------------------------------------------- /tests/testthat/test-scribble.R: -------------------------------------------------------------------------------- 1 | test_that("Throws error if rstudio is not available", { 2 | skip_if(rstudioapi::isAvailable(), message = "RStudio is running") 3 | expect_error(scribble(), class = "rs_not_available_error") 4 | }) 5 | -------------------------------------------------------------------------------- /tests/testthat/test-filesystem.R: -------------------------------------------------------------------------------- 1 | test_that("get_cur_proj() returns a two-component list", { 2 | skip_if_not(rstudioapi::isAvailable(), message = "RStudio not running") 3 | 4 | res <- get_cur_proj() 5 | expect_vector(res, ptype = list(), size = 2L) 6 | }) 7 | -------------------------------------------------------------------------------- /.scribblr/notes/main: -------------------------------------------------------------------------------- 1 | ### ToDo 2 | - Add (Ctrl+I) key stroke for "About" tab 3 | - Build a pkgdown website 4 | - Link pkgdown website in README 5 | 6 | ### Testing 7 | 8 | For testing shiny apps see [this reference](https://shiny.rstudio.com/articles/testing-overview.html) 9 | 10 | 11 | -------------------------------------------------------------------------------- /NAMESPACE: -------------------------------------------------------------------------------- 1 | # Generated by roxygen2: do not edit by hand 2 | 3 | export(scribble) 4 | export(scribblr_delete) 5 | export(scribblr_list) 6 | import(miniUI) 7 | import(shiny) 8 | import(shinyWidgets) 9 | importFrom(utils,URLencode) 10 | importFrom(utils,browseURL) 11 | importFrom(utils,packageVersion) 12 | -------------------------------------------------------------------------------- /codecov.yml: -------------------------------------------------------------------------------- 1 | comment: false 2 | 3 | coverage: 4 | status: 5 | project: 6 | default: 7 | target: auto 8 | threshold: 1% 9 | informational: true 10 | patch: 11 | default: 12 | target: auto 13 | threshold: 1% 14 | informational: true 15 | -------------------------------------------------------------------------------- /R/post_github_issue.R: -------------------------------------------------------------------------------- 1 | post_github_issue <- function(title, body) { 2 | 3 | ght <- gh::gh_tree_remote() 4 | title <- URLencode(title) 5 | body <- URLencode(body, reserved = TRUE) 6 | 7 | url <- sprintf("https://github.com/%s/%s/issues/new?title=%s&body=%s", 8 | ght[["username"]], ght[["repo"]], title, body) 9 | browseURL(url) 10 | 11 | } 12 | -------------------------------------------------------------------------------- /R/scribblr-package.R: -------------------------------------------------------------------------------- 1 | #' @keywords internal 2 | "_PACKAGE" 3 | 4 | # The following block is used by usethis to automatically manage 5 | # roxygen namespace tags. Modify with care! 6 | ## usethis namespace: start 7 | ## usethis namespace: end 8 | #' @import shiny 9 | #' @import miniUI 10 | #' @import shinyWidgets 11 | #' @importFrom utils URLencode browseURL packageVersion 12 | NULL 13 | -------------------------------------------------------------------------------- /scribblr.Rproj: -------------------------------------------------------------------------------- 1 | Version: 1.0 2 | 3 | RestoreWorkspace: Default 4 | SaveWorkspace: Default 5 | AlwaysSaveHistory: Default 6 | 7 | EnableCodeIndexing: Yes 8 | UseSpacesForTab: No 9 | NumSpacesForTab: 4 10 | Encoding: UTF-8 11 | 12 | RnwWeave: Sweave 13 | LaTeX: pdfLaTeX 14 | 15 | AutoAppendNewline: Yes 16 | StripTrailingWhitespace: Yes 17 | 18 | BuildType: Package 19 | PackageUseDevtools: Yes 20 | PackageInstallArgs: --no-multiarch --with-keep.source 21 | PackageRoxygenize: rd,collate,namespace 22 | -------------------------------------------------------------------------------- /man/scribblr_list.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/notes_management.R 3 | \name{scribblr_list} 4 | \alias{scribblr_list} 5 | \title{List \code{scribblr} notes} 6 | \usage{ 7 | scribblr_list() 8 | } 9 | \value{ 10 | a character vector. 11 | } 12 | \description{ 13 | List all \code{scribblr} notes. 14 | } 15 | \examples{ 16 | \dontrun{ 17 | scribblr_list("todo") 18 | } 19 | } 20 | \seealso{ 21 | \link{scribble} 22 | } 23 | \author{ 24 | Valerio Gherardi 25 | } 26 | -------------------------------------------------------------------------------- /man/scribblr_delete.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/notes_management.R 3 | \name{scribblr_delete} 4 | \alias{scribblr_delete} 5 | \title{Delete a \code{scribblr} note} 6 | \usage{ 7 | scribblr_delete(note) 8 | } 9 | \arguments{ 10 | \item{note}{a length one character (not NA). Note to be deleted.} 11 | } 12 | \value{ 13 | returns \code{NULL}, invisibly. Used for side-effects. 14 | } 15 | \description{ 16 | Delete a \code{scribblr} note. 17 | } 18 | \examples{ 19 | \dontrun{ 20 | scribblr_delete("todo") 21 | } 22 | } 23 | \seealso{ 24 | \link{scribble} 25 | } 26 | \author{ 27 | Valerio Gherardi 28 | } 29 | -------------------------------------------------------------------------------- /tests/testthat/test-utils.R: -------------------------------------------------------------------------------- 1 | test_that("assert_is_string works correctly", { 2 | expect_error(assert_is_string("string"), NA) 3 | expect_error(assert_is_string(NULL, can_be_null = TRUE), NA) 4 | 5 | expect_error(assert_is_string(1)) 6 | expect_error(assert_is_string(NULL, can_be_null = FALSE)) 7 | expect_error(assert_is_string(letters)) 8 | }) 9 | 10 | test_that("assert_is_note_name works correctly", { 11 | expect_error(assert_is_note_name("name"), NA) 12 | expect_error(assert_is_note_name(NULL), NA) 13 | expect_error(assert_is_note_name("1st_name.2nd_name"), NA) 14 | 15 | expect_error(assert_is_note_name(1)) 16 | expect_error(assert_is_note_name("x/y")) 17 | }) 18 | -------------------------------------------------------------------------------- /img/logo.R: -------------------------------------------------------------------------------- 1 | library(showtext) 2 | library(hexSticker) 3 | font_add_google("Righteous", "scribblr_font") 4 | ## Automatically use showtext to render text for future devices 5 | showtext_auto() 6 | 7 | print( 8 | sticker(package = "scribblr" 9 | ,p_family = "scribblr_font" 10 | ,p_color = "#000000" 11 | ,p_size = 36, 12 | ,p_y = 1.35 13 | ,h_fill = "white" 14 | ,h_color = "black" 15 | ,subplot = "img/feather.png" 16 | ,s_x = 1, s_y = .65, s_width = 0.55, s_height = 0.55 17 | 18 | ,filename = "img/logo.png" 19 | )) 20 | 21 | usethis::use_logo("img/logo.png") 22 | if (!dir.exists("inst/img")) dir.create("inst/img") 23 | file.copy("img/logo.png", "inst/img/logo.png") 24 | -------------------------------------------------------------------------------- /man/scribblr-package.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/scribblr-package.R 3 | \docType{package} 4 | \name{scribblr-package} 5 | \alias{scribblr} 6 | \alias{scribblr-package} 7 | \title{scribblr: A Notepad Inside RStudio} 8 | \description{ 9 | \if{html}{\figure{logo.png}{options: align='right' alt='logo' width='120'}} 10 | 11 | A project aware notepad inside RStudio, for taking quick project-related notes without distractions. RStudio addin. 12 | } 13 | \seealso{ 14 | Useful links: 15 | \itemize{ 16 | \item Report bugs at \url{https://github.com/vgherard/scribblr/issues} 17 | } 18 | 19 | } 20 | \author{ 21 | \strong{Maintainer}: Valerio Gherardi \email{vgherard@sissa.it} (\href{https://orcid.org/0000-0002-8215-3013}{ORCID}) 22 | 23 | } 24 | \keyword{internal} 25 | -------------------------------------------------------------------------------- /R/placeholder.R: -------------------------------------------------------------------------------- 1 | scribblr_placeholder <- function(note) { 2 | welcome <- "Welcome to {scribblr}!" 3 | 4 | msg <- ifelse( 5 | is.null(note), 6 | paste0( 7 | "You can use this space to take quick notes about the current " 8 | ,"project. The content of this text area will be automatically " 9 | ,"saved upon closing this window." 10 | ,"\n\n" 11 | ,"If you want to organize your notes in separate files, try " 12 | ,"`scribblr::scribble(note_name)`, where `note_name` is the title " 13 | ,"of your note."), 14 | paste0( 15 | "The content of this text area will be automatically " 16 | ,"saved upon closing this window." 17 | ) 18 | ) 19 | 20 | bugs <- paste0( 21 | "If you encounter a bug or want to suggest an improvement, " 22 | ,"please follow the GitHub link at the bottom of this window and file " 23 | ,"an issue in the {scribblr} repository." 24 | ) 25 | 26 | paste0(welcome, "\n\n", msg, "\n\n", bugs) 27 | } 28 | -------------------------------------------------------------------------------- /DESCRIPTION: -------------------------------------------------------------------------------- 1 | Package: scribblr 2 | Title: A Notepad Inside RStudio 3 | Version: 0.2.1 4 | Authors@R: 5 | person(given = "Valerio", 6 | family = "Gherardi", 7 | role = c("aut", "cre"), 8 | email = "vgherard840@gmail.com", 9 | comment = c(ORCID = "0000-0002-8215-3013")) 10 | Description: A project aware notepad inside RStudio, for taking quick project-related notes without distractions. RStudio addin. 11 | License: GPL (>= 3) 12 | Encoding: UTF-8 13 | LazyData: true 14 | Roxygen: list(markdown = TRUE) 15 | RoxygenNote: 7.1.1 16 | Imports: 17 | shiny (>= 0.13), 18 | miniUI (>= 0.1.1), 19 | shinyjs, 20 | rstudioapi (>= 0.5), 21 | fs, 22 | usethis, 23 | keys, 24 | gh, 25 | shinyWidgets, 26 | utils, 27 | rlang 28 | BugReports: https://github.com/vgherard/scribblr/issues 29 | URL: https://vgherard.github.io/scribblr/, https://github.com/vgherard/scribblr 30 | Suggests: 31 | covr, 32 | testthat (>= 3.0.0) 33 | Config/testthat/edition: 3 34 | -------------------------------------------------------------------------------- /.github/workflows/pkgdown.yaml: -------------------------------------------------------------------------------- 1 | # Workflow derived from https://github.com/r-lib/actions/tree/v2/examples 2 | # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help 3 | on: 4 | push: 5 | branches: [main, master] 6 | pull_request: 7 | branches: [main, master] 8 | release: 9 | types: [published] 10 | workflow_dispatch: 11 | 12 | name: pkgdown 13 | 14 | jobs: 15 | pkgdown: 16 | runs-on: ubuntu-latest 17 | # Only restrict concurrency for non-PR jobs 18 | concurrency: 19 | group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} 20 | env: 21 | GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} 22 | permissions: 23 | contents: write 24 | steps: 25 | - uses: actions/checkout@v3 26 | 27 | - uses: r-lib/actions/setup-pandoc@v2 28 | 29 | - uses: r-lib/actions/setup-r@v2 30 | with: 31 | use-public-rspm: true 32 | 33 | - uses: r-lib/actions/setup-r-dependencies@v2 34 | with: 35 | extra-packages: any::pkgdown, local::. 36 | needs: website 37 | 38 | - name: Build site 39 | run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) 40 | shell: Rscript {0} 41 | 42 | - name: Deploy to GitHub pages 🚀 43 | if: github.event_name != 'pull_request' 44 | uses: JamesIves/github-pages-deploy-action@v4.4.1 45 | with: 46 | clean: false 47 | branch: gh-pages 48 | folder: docs 49 | -------------------------------------------------------------------------------- /.github/workflows/R-CMD-check.yaml: -------------------------------------------------------------------------------- 1 | # Workflow derived from https://github.com/r-lib/actions/tree/v2/examples 2 | # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help 3 | on: 4 | push: 5 | branches: [main, master] 6 | pull_request: 7 | branches: [main, master] 8 | 9 | name: R-CMD-check 10 | 11 | jobs: 12 | R-CMD-check: 13 | runs-on: ${{ matrix.config.os }} 14 | 15 | name: ${{ matrix.config.os }} (${{ matrix.config.r }}) 16 | 17 | strategy: 18 | fail-fast: false 19 | matrix: 20 | config: 21 | - {os: macos-latest, r: 'release'} 22 | - {os: windows-latest, r: 'release'} 23 | - {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'} 24 | - {os: ubuntu-latest, r: 'release'} 25 | - {os: ubuntu-latest, r: 'oldrel-1'} 26 | 27 | env: 28 | GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} 29 | R_KEEP_PKG_SOURCE: yes 30 | 31 | steps: 32 | - uses: actions/checkout@v3 33 | 34 | - uses: r-lib/actions/setup-pandoc@v2 35 | 36 | - uses: r-lib/actions/setup-r@v2 37 | with: 38 | r-version: ${{ matrix.config.r }} 39 | http-user-agent: ${{ matrix.config.http-user-agent }} 40 | use-public-rspm: true 41 | 42 | - uses: r-lib/actions/setup-r-dependencies@v2 43 | with: 44 | extra-packages: any::rcmdcheck 45 | needs: check 46 | 47 | - uses: r-lib/actions/check-r-package@v2 48 | with: 49 | upload-snapshots: true 50 | -------------------------------------------------------------------------------- /.github/workflows/test-coverage.yaml: -------------------------------------------------------------------------------- 1 | # Workflow derived from https://github.com/r-lib/actions/tree/v2/examples 2 | # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help 3 | on: 4 | push: 5 | branches: [main, master] 6 | pull_request: 7 | branches: [main, master] 8 | 9 | name: test-coverage 10 | 11 | jobs: 12 | test-coverage: 13 | runs-on: ubuntu-latest 14 | env: 15 | GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} 16 | 17 | steps: 18 | - uses: actions/checkout@v3 19 | 20 | - uses: r-lib/actions/setup-r@v2 21 | with: 22 | use-public-rspm: true 23 | 24 | - uses: r-lib/actions/setup-r-dependencies@v2 25 | with: 26 | extra-packages: any::covr 27 | needs: coverage 28 | 29 | - name: Test coverage 30 | run: | 31 | covr::codecov( 32 | quiet = FALSE, 33 | clean = FALSE, 34 | install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package") 35 | ) 36 | shell: Rscript {0} 37 | 38 | - name: Show testthat output 39 | if: always() 40 | run: | 41 | ## -------------------------------------------------------------------- 42 | find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true 43 | shell: bash 44 | 45 | - name: Upload test results 46 | if: failure() 47 | uses: actions/upload-artifact@v3 48 | with: 49 | name: coverage-test-failures 50 | path: ${{ runner.temp }}/package 51 | -------------------------------------------------------------------------------- /man/scribble.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/scribble.R 3 | \name{scribble} 4 | \alias{scribble} 5 | \title{Open \code{scribblr} note editor} 6 | \usage{ 7 | scribble(note = NULL) 8 | } 9 | \arguments{ 10 | \item{note}{either \code{NULL}, or a length one character (not \code{NA}). 11 | See details.} 12 | } 13 | \value{ 14 | returns \code{NULL}, invisibly. Called for side-effects. 15 | } 16 | \description{ 17 | Opens the \code{scribblr} note editor in a new window. 18 | } 19 | \details{ 20 | \code{scribblr} integrates a minimalist note editor within RStudio, 21 | useful for taking quick project-related notes without distractions. 22 | \code{scribblr} notes are RStudio project aware: each project has associated 23 | its own notes, which can be accessed by calling \code{scribble()}, and are 24 | stored into the project's root directory. Using \code{scribble()} without 25 | any active project will take the R home directory as root. 26 | 27 | Calling \code{scribble()} with the default \code{note = NULL} gives access to 28 | the main project notes. Otherwise, \code{note} must be a string specifying a 29 | valid filename. 30 | 31 | \code{scribblr} notes and settings for the active project are stored in the 32 | \code{".scribblr"} directory, under the project's root. If this, or the note 33 | specified by \code{note}, do not exist, the user will be prompted for 34 | permission to create the required files/directories. 35 | 36 | Notes are autosaved when the editor is closed; until that 37 | moment, the R session will remain busy. 38 | 39 | \code{scribble()} can also be called (and, in particular, associated a 40 | custom keystroke) via the RStudio Addin "Open scribblr note editor". 41 | } 42 | \examples{ 43 | \dontrun{ 44 | scribble() 45 | } 46 | } 47 | \author{ 48 | Valerio Gherardi 49 | } 50 | -------------------------------------------------------------------------------- /NEWS.md: -------------------------------------------------------------------------------- 1 | # scribblr 0.2.1 2 | 3 | ### Fixes 4 | 5 | - Indenting with Tab in text area is now undo-able (with Ctrl+Z) (#19) 6 | - Added instructions to install from my R-universe in README (#13) 7 | - Import `utils`. 8 | - Fix encoding of reserved symbols (e.g. `#`) in URL queries for exporting notes as GitHub issues. 9 | - Fix broken icons in "About" page (#25) 10 | 11 | ### API changes 12 | - Note names now can only contain alphanumeric characters, underscores (_) and 13 | dots (.). 14 | 15 | ### Testing 16 | - Added `testthat` infrastructure. 17 | 18 | # scribblr 0.2.0 19 | 20 | ### New features 21 | 22 | - Support for exporting notes as GitHub Issues 23 | 24 | ### UI changes 25 | 26 | - New tabstrip interface 27 | - Added "About" tab 28 | 29 | # scribblr 0.1.0 30 | 31 | ### New features 32 | 33 | - Add support for multiple notes 34 | 35 | ### Backward incompatible changes 36 | 37 | - `scribblr` notes and settings are now stored in the ".scribblr" directory 38 | under the project's root (previously this was a single ".scribblr" text file). 39 | 40 | # scribblr 0.0.4 41 | 42 | ### New features 43 | 44 | - New logo for `{scribblr}` 45 | 46 | ### UI change 47 | 48 | - "Close" button becomes "Done" button 49 | - UI displays the logo 50 | 51 | # scribblr 0.0.3 52 | 53 | ### New features 54 | 55 | - Notes can now be exported to an external file (#4) 56 | - Markdown previews now available (#3) 57 | - Added placeholder text explaining when and where `{scribblr}` notes are stored (#4) 58 | 59 | ### Fixes 60 | 61 | - Pressing Tab in text input area is now used to add indentation (#2) 62 | 63 | # scribblr 0.0.2 64 | 65 | * `scribblr` file paths are now generated with `file.path()`, for platform independence. 66 | * Added GitHub link to user interface. 67 | 68 | # scribblr 0.0.1 69 | 70 | * `scribblr` now imports `usethis`. 71 | -------------------------------------------------------------------------------- /R/notes_management.R: -------------------------------------------------------------------------------- 1 | # scribblr 2 | # Copyright (C) 2021 Valerio Gherardi 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | 17 | #' @title Delete a \code{scribblr} note 18 | #' 19 | #' @author Valerio Gherardi 20 | #' 21 | #' @description Delete a \code{scribblr} note. 22 | #' @param note a length one character (not NA). Note to be deleted. 23 | #' @return returns \code{NULL}, invisibly. Used for side-effects. 24 | #' @examples 25 | #' \dontrun{ 26 | #' scribblr_delete("todo") 27 | #' } 28 | #' @seealso \link{scribble} 29 | #' @export 30 | scribblr_delete <- function(note) { 31 | path <- scribblr_note_path(note) 32 | 33 | if (!file.exists(path)) { 34 | warn_missing_note() 35 | return(invisible(NULL)) 36 | } 37 | 38 | # Warn about erasing notes 39 | cat("This operation will erase your {scribblr} note and cannot be undone.") 40 | if (ask_yesno_qn("Do you want to proceed?")) 41 | fs::dir_delete(dirname(path)) 42 | 43 | return(invisible(NULL)) 44 | } 45 | 46 | #' @title List \code{scribblr} notes 47 | #' 48 | #' @author Valerio Gherardi 49 | #' 50 | #' @description List all \code{scribblr} notes. 51 | #' @return a character vector. 52 | #' @examples 53 | #' \dontrun{ 54 | #' scribblr_list("todo") 55 | #' } 56 | #' @seealso \link{scribble} 57 | #' @export 58 | scribblr_list <- function() { 59 | if (!dir.exists(scribblr_dir())) { 60 | warn_missing_scribblr_dir() 61 | return(character()) 62 | } 63 | 64 | path <- file.path(scribblr_dir(), "notes") 65 | 66 | basename(fs::dir_ls(path, type = "directory")) 67 | } 68 | -------------------------------------------------------------------------------- /R/filesystem.R: -------------------------------------------------------------------------------- 1 | get_cur_proj <- function() 2 | { 3 | dir <- rstudioapi::getActiveProject() 4 | is_r_project <- !is.null(dir) 5 | # If there is no active project, use the R Home directory as base 6 | if (!is_r_project) { 7 | dir <- fs::path_home_r() 8 | } 9 | list(dir = dir, is_r_project = is_r_project) 10 | } 11 | 12 | scribblr_dir_name <- function() 13 | ".scribblr" 14 | 15 | main_note_name <- function() 16 | "main" 17 | 18 | scribblr_dir <- function(where = get_cur_proj()[["dir"]]) 19 | file.path(where, scribblr_dir_name()) 20 | 21 | scribblr_dir_exists <- function(where = get_cur_proj()[["dir"]]) 22 | dir.exists(scribblr_dir(where)) 23 | 24 | scribblr_dir_create <- function(where = get_cur_proj()[["dir"]], check = TRUE) 25 | { 26 | scribblr_dir <- scribblr_dir(where) 27 | 28 | if (check) 29 | { 30 | if (dir.exists(scribblr_dir)) 31 | return() 32 | warn_missing_scribblr_dir() 33 | if (!ask_yesno_qn("Should I create one?")) 34 | stop("Execution aborted by user.") 35 | } 36 | 37 | dir.create(scribblr_dir) 38 | dir.create(file.path(scribblr_dir, "notes")) 39 | file.create(file.path(scribblr_dir, "notes", main_note_name())) 40 | cat("A new {scribblr} directory was created at:\n", scribblr_dir, "\n") 41 | 42 | if ( file.exists(file.path(where, ".Rbuildignore")) ) 43 | usethis::use_build_ignore(scribblr_dir_name()) 44 | } 45 | 46 | scribblr_note_path <- function(note, where = get_cur_proj()[["dir"]]) 47 | { 48 | assert_is_note_name(note) 49 | 50 | if (is.null(note)) 51 | return(file.path(scribblr_dir(where), "notes", main_note_name())) 52 | 53 | return(file.path(scribblr_dir(where), "notes", note, note)) 54 | } 55 | 56 | scribblr_note_create <- function( 57 | where = get_cur_proj()[["dir"]], note, check = TRUE 58 | ) 59 | { 60 | assert_is_note_name(note) 61 | path <- scribblr_note_path(where = where, note = note) 62 | 63 | if (check) 64 | { 65 | if (file.exists(path)) 66 | return() 67 | warn_missing_note() 68 | if (!ask_yesno_qn("Should I create it?")) 69 | stop("Execution aborted by user.") 70 | } 71 | 72 | dir <- dirname(path) 73 | if (!exists(dir)) 74 | dir.create(dir) 75 | file.create(path) 76 | } 77 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | # scribblr 5 | 6 | 7 | 8 | [![Project Status: Active – The project has reached a stable, usable 9 | state and is being actively 10 | developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) 11 | [![R-CMD-check](https://github.com/vgherard/scribblr/workflows/R-CMD-check/badge.svg)](https://github.com/vgherard/scribblr/actions) 12 | [![Codecov test 13 | coverage](https://codecov.io/gh/vgherard/scribblr/branch/master/graph/badge.svg)](https://codecov.io/gh/vgherard/scribblr?branch=master) 14 | [![CRAN 15 | status](https://www.r-pkg.org/badges/version/scribblr)](https://CRAN.R-project.org/package=scribblr) 16 | [![R-universe 17 | status](https://vgherard.r-universe.dev/badges/scribblr)](https://vgherard.r-universe.dev/) 18 | [![Website](https://img.shields.io/badge/Website-here-blue)](https://vgherard.github.io/scribblr/) 19 | [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=%7Bscribblr%7D:%20A%20Notepad%20Inside%20RStudio&url=https://github.com/vgherard/scribblr&via=ValerioGherardi&hashtags=rstats,rstudio,productivity) 20 | [![R-CMD-check](https://github.com/vgherard/scribblr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/vgherard/scribblr/actions/workflows/R-CMD-check.yaml) 21 | 22 | 23 | `scribblr` is a project-aware notepad inside RStudio. 24 | 25 |
26 | scribblr demonstration 29 | 30 |
31 | 32 | ## Installation 33 | 34 | `scribblr` is not yet available on CRAN. In the meanwhile, you can 35 | install the development version from [my R-universe 36 | repository](https://vgherard.r-universe.dev/), with: 37 | 38 | ``` r 39 | install.packages("scribblr", repos = "https://vgherard.r-universe.dev") 40 | ``` 41 | 42 | or equivalently from [GitHub](https://github.com/vgherard/scribblr) 43 | with: 44 | 45 | ``` r 46 | # install.packages("devtools") 47 | devtools::install_github("vgherard/scribblr") 48 | ``` 49 | -------------------------------------------------------------------------------- /R/utils.R: -------------------------------------------------------------------------------- 1 | # scribblr 2 | # Copyright (C) 2021 Valerio Gherardi 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | 17 | warn_missing_note <- function() 18 | cat("This {scribblr} note does not exist.", file = stderr()) 19 | 20 | warn_missing_scribblr_dir <- function() 21 | cat("No {scribblr} directory found.\n", file = stderr()) 22 | 23 | assert_is_string <- function( 24 | x, can_be_null = FALSE, name = deparse(substitute(x)) 25 | ) 26 | { 27 | p <- can_be_null && is.null(x) 28 | q <- is.character(x) && length(x) == 1 && !is.na(x) 29 | if (p || q) return() 30 | 31 | msg <- paste0("'", name, "' ", 32 | "must be", ifelse(can_be_null, " either NULL or ", " "), 33 | "a length one character (not NA)." 34 | ) 35 | 36 | stop(msg) 37 | } 38 | 39 | assert_is_note_name <- function(x, name = deparse(substitute(x))) 40 | { 41 | assert_is_string(x, can_be_null = TRUE, name = name) 42 | 43 | if (is.null(x) || !grepl("[^[:alnum:]_.]", x)) 44 | return() 45 | 46 | msg <- paste0("'", name, "' ", 47 | "can contain only alphanumeric characters, ", 48 | "underscores (_) and dots (.)" 49 | ) 50 | 51 | stop(msg) 52 | } 53 | 54 | assert_rs_is_available <- function( 55 | msg = paste0("`", deparse(sys.calls()[[sys.nframe() - 1]]), "`", # function name 56 | "can only be used inside RStudio." 57 | ) 58 | ) 59 | { 60 | if (!rstudioapi::isAvailable()) 61 | rlang::abort(msg, class = "rs_not_available_error") 62 | } 63 | 64 | ask_yesno_qn <- function(qn) { 65 | prompt <- paste(qn, "(y/n)> ") 66 | while (!is_valid_ans(ans <- readline(prompt))) 67 | next; 68 | return(ans == "y") 69 | } 70 | 71 | is_valid_ans <- function(ans) 72 | identical(ans, "y") || identical(ans, "n") 73 | -------------------------------------------------------------------------------- /README.Rmd: -------------------------------------------------------------------------------- 1 | --- 2 | output: github_document 3 | --- 4 | 5 | 6 | 7 | ```{r, include = FALSE} 8 | knitr::opts_chunk$set( 9 | collapse = TRUE, 10 | comment = "#>", 11 | fig.path = "man/figures/README-", 12 | out.width = "100%" 13 | ) 14 | ``` 15 | 16 | # scribblr 17 | 18 | 19 | [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) 20 | [![R-CMD-check](https://github.com/vgherard/scribblr/workflows/R-CMD-check/badge.svg)](https://github.com/vgherard/scribblr/actions) 21 | [![Codecov test coverage](https://codecov.io/gh/vgherard/scribblr/branch/master/graph/badge.svg)](https://codecov.io/gh/vgherard/scribblr?branch=master) 22 | [![CRAN status](https://www.r-pkg.org/badges/version/scribblr)](https://CRAN.R-project.org/package=scribblr) 23 | [![R-universe status](https://vgherard.r-universe.dev/badges/scribblr)](https://vgherard.r-universe.dev/) 24 | [![Website](https://img.shields.io/badge/Website-here-blue)](https://vgherard.github.io/scribblr/) 25 | [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text={scribblr}:%20A%20Notepad%20Inside%20RStudio&url=https://github.com/vgherard/scribblr&via=ValerioGherardi&hashtags=rstats,rstudio,productivity) 26 | [![R-CMD-check](https://github.com/vgherard/scribblr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/vgherard/scribblr/actions/workflows/R-CMD-check.yaml) 27 | 28 | 29 | `scribblr` is a project-aware notepad inside RStudio. 30 | 31 | ![scribblr demonstration](https://raw.githubusercontent.com/vgherard/scribblr/master/img/scribblr.gif) 32 | 33 | ## Installation 34 | 35 | `scribblr` is not yet available on CRAN. In the meanwhile, you can install 36 | the development version from 37 | [my R-universe repository](https://vgherard.r-universe.dev/), with: 38 | 39 | ``` r 40 | install.packages("scribblr", repos = "https://vgherard.r-universe.dev") 41 | ``` 42 | 43 | or equivalently from [GitHub](https://github.com/vgherard/scribblr) with: 44 | 45 | ``` r 46 | # install.packages("devtools") 47 | devtools::install_github("vgherard/scribblr") 48 | ``` 49 | -------------------------------------------------------------------------------- /R/scribble.R: -------------------------------------------------------------------------------- 1 | # scribblr 2 | # Copyright (C) 2021 Valerio Gherardi 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | 17 | #' @title Open \code{scribblr} note editor 18 | #' 19 | #' @author Valerio Gherardi 20 | #' 21 | #' @description Opens the \code{scribblr} note editor in a new window. 22 | #' @param note either \code{NULL}, or a length one character (not \code{NA}). 23 | #' See details. 24 | #' @return returns \code{NULL}, invisibly. Called for side-effects. 25 | #' @details 26 | #' \code{scribblr} integrates a minimalist note editor within RStudio, 27 | #' useful for taking quick project-related notes without distractions. 28 | #' \code{scribblr} notes are RStudio project aware: each project has associated 29 | #' its own notes, which can be accessed by calling \code{scribble()}, and are 30 | #' stored into the project's root directory. Using \code{scribble()} without 31 | #' any active project will take the R home directory as root. 32 | #' 33 | #' Calling \code{scribble()} with the default \code{note = NULL} gives access to 34 | #' the main project notes. Otherwise, \code{note} must be a string specifying a 35 | #' valid filename. 36 | #' 37 | #' \code{scribblr} notes and settings for the active project are stored in the 38 | #' \code{".scribblr"} directory, under the project's root. If this, or the note 39 | #' specified by \code{note}, do not exist, the user will be prompted for 40 | #' permission to create the required files/directories. 41 | #' 42 | #' Notes are autosaved when the editor is closed; until that 43 | #' moment, the R session will remain busy. 44 | #' 45 | #' \code{scribble()} can also be called (and, in particular, associated a 46 | #' custom keystroke) via the RStudio Addin "Open scribblr note editor". 47 | #' @examples 48 | #' \dontrun{ 49 | #' scribble() 50 | #' } 51 | #' @export 52 | scribble <- function(note = NULL) { 53 | assert_rs_is_available() 54 | 55 | data <- scribble_init(note) 56 | 57 | #------------------------------------------------------------ User Interface 58 | ui <- miniPage( 59 | NULL 60 | 61 | # Plugins 62 | ,shinyjs::useShinyjs() 63 | ,keys::useKeys() 64 | 65 | # Set focus on text area input 66 | ,tags$head(tags$script(HTML(' 67 | $(document).on("shiny:connected", function(){ 68 | Shiny.setInputValue("loaded", 1); 69 | Shiny.addCustomMessageHandler("focus", 70 | function(el) { 71 | document.getElementById(el).focus(); 72 | }) 73 | }); 74 | '))) 75 | 76 | # Hotkeys 77 | ,keys::keysInput("sendKeys", 78 | c("ctrl+s", "command+s"), 79 | global = TRUE 80 | ) 81 | ,keys::keysInput("previewKeys", 82 | c("ctrl+p", "command+p"), 83 | global = TRUE 84 | ) 85 | ,keys::keysInput("editKeys", 86 | c("ctrl+e", "command+e"), 87 | global = TRUE 88 | ) 89 | 90 | 91 | # Title bar 92 | ,gadgetTitleBar( 93 | data[["title"]], 94 | left = dropdownButton( 95 | inputId = "sendDropdown", 96 | label = "Send... (Ctrl+S[+Tab])", 97 | icon = icon("share"), 98 | status = "primary", 99 | circle = FALSE, 100 | up = FALSE, 101 | right = FALSE, 102 | actionBttn( 103 | inputId = "saveToFileButton", 104 | label = "...to File", 105 | icon = icon("save"), 106 | style = "fill", 107 | size = "xs" 108 | ), 109 | actionBttn( 110 | inputId = "ghIssueButton", 111 | label = "...to GitHub Issues", 112 | icon = icon("github"), 113 | style = "fill", 114 | size = "xs" 115 | ) 116 | ), 117 | right = miniTitleBarCancelButton( 118 | inputId = "doneButton", label = "Done (Esc)" 119 | ) 120 | ) # gadgetTitleBar 121 | 122 | # Text/preview area 123 | ,miniTabstripPanel( 124 | id = "textAreaTabPanel", 125 | miniTabPanel( 126 | "Edit (Ctrl+E)", icon = icon("edit"), 127 | textAreaInput( 128 | inputId = "noteIO", 129 | label = NULL, 130 | value = data[["txt"]], 131 | placeholder = scribblr_placeholder(note), 132 | width = "100%", 133 | height = "310px" 134 | ) 135 | ), 136 | miniTabPanel( 137 | "Preview (Ctrl+P)", icon = icon("markdown"), 138 | uiOutput("preview") 139 | ), 140 | miniTabPanel( 141 | "About", icon = icon("info-circle"), 142 | sidebarLayout( 143 | sidebarPanel = sidebarPanel( 144 | NULL 145 | ,br() 146 | ,img(src = "img/logo.png", width = 200) 147 | ), 148 | mainPanel = mainPanel( 149 | NULL 150 | ,h2(paste0("{scribblr} v", data[["ver"]]), 151 | align = "center" 152 | ) 153 | ,p("Author: Valerio Gherardi", 154 | a("vgherard840@gmail.com", 155 | href = "mailto:vgherard840@gmail.com" 156 | ), 157 | align = "center" 158 | ) 159 | 160 | # Links and share 161 | ,br() 162 | ,fluidRow( 163 | NULL 164 | ,column( 165 | 5, offset = 1 166 | ,h4(icon("link"), "Links") 167 | ,a(icon("github"), "GitHub", 168 | href = "https://github.com/vgherard/scribblr" 169 | ) 170 | ,br() 171 | ,a(icon("bug"), "Bug Reports", 172 | href = "https://github.com/vgherard/scribblr/issues" 173 | ) 174 | ) 175 | ,column( 176 | 5, offset = 1 177 | ,h4(icon("share-alt"), "Share") 178 | ,a(icon("twitter"), "Twitter", 179 | href = "https://twitter.com/intent/tweet?text={scribblr}:%20A%20Minimalist%20Notepad%20Inside%20RStudio&url=https://github.com/vgherard/scribblr&via=ValerioGherardi&hashtags=rstats,rstudio,productivity" 180 | ) 181 | ,br() 182 | ,a(icon("linkedin"), "LinkedIn", 183 | href = "https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/vgherard/scribblr" 184 | ) 185 | ) 186 | ) 187 | 188 | ) 189 | ) 190 | 191 | ) # About miniTabPanel 192 | 193 | ) # miniTabstripPanel 194 | ) 195 | 196 | #-------------------------------------------------------------------- Server 197 | server <- function(input, output, session) { 198 | # Set focus on text area on load 199 | observeEvent(input$loaded, { 200 | session$sendCustomMessage("focus", list("noteIO")) 201 | }) 202 | 203 | # Use tab to indent in text area 204 | # See https://stackoverflow.com/questions/6140632/ 205 | observe(shinyjs::runjs(" 206 | document.getElementById('noteIO').addEventListener('keydown', 207 | function(e) { 208 | if (e.key == 'Tab') { 209 | e.preventDefault(); 210 | var start = this.selectionStart; 211 | var end = this.selectionEnd; 212 | 213 | const TAB_SIZE = 4; 214 | 215 | // The one-liner that does the magic 216 | document.execCommand('insertText', false, ' '.repeat(TAB_SIZE)); 217 | return; 218 | } 219 | });")) 220 | 221 | # Edit note 222 | observeEvent( 223 | input$editKeys, { 224 | updateTabsetPanel( 225 | session, "textAreaTabPanel", selected = "Edit (Ctrl+E)" 226 | ) 227 | }, ignoreInit = TRUE, priority = 1 228 | ) 229 | observeEvent( 230 | input$textAreaTabPanel, { 231 | if (input$textAreaTabPanel == "Edit (Ctrl+E)") 232 | session$sendCustomMessage("focus", list("noteIO")) 233 | }, ignoreInit = TRUE, priority = 0 234 | ) 235 | 236 | 237 | # Markdown preview 238 | output$preview <- renderUI(markdown(input$noteIO)) 239 | observeEvent( 240 | input$previewKeys, { 241 | updateTabsetPanel( 242 | session, "textAreaTabPanel", selected = "Preview (Ctrl+P)" 243 | ) 244 | }, ignoreInit = TRUE) 245 | 246 | 247 | # Export dropdown menu 248 | observeEvent(input$sendKeys, { 249 | toggleDropdownButton(inputId = "sendDropdown", session = session) 250 | }, ignoreInit = TRUE) 251 | 252 | observeEvent(input$sendDropdown_state, { 253 | if (input$sendDropdown_state) 254 | session$sendCustomMessage("focus", list("saveToFileButton")) 255 | else 256 | session$sendCustomMessage("focus", list("noteIO")) 257 | }, ignoreInit = TRUE) 258 | 259 | observeEvent(input$saveToFileButton, { 260 | try({ 261 | write(input$noteIO, file.choose(new = T), append = F) 262 | }, silent = TRUE) 263 | session$sendCustomMessage("focus", list("noteIO")) # refocus text 264 | }, ignoreInit = TRUE) 265 | 266 | observeEvent(input$ghIssueButton, { 267 | title <- ifelse(!is.null(note), note, "") 268 | post_github_issue(title = title, body = input$noteIO) 269 | session$sendCustomMessage("focus", list("noteIO")) # refocus text 270 | }, ignoreInit = TRUE) 271 | 272 | # Done 273 | observeEvent(input$doneButton, { 274 | write(input$noteIO, data[["note_path"]], append = F) 275 | stopApp() 276 | }, ignoreInit = TRUE) 277 | 278 | } 279 | 280 | 281 | #------------------------------------------------------------------- Run App 282 | viewer <- dialogViewer(dialogName = "scribblr", width = 800, height = 600) 283 | runGadget(ui, server, viewer = viewer, stopOnCancel = FALSE) 284 | } 285 | 286 | scribble_init <- function(note) { 287 | scribblr_dir_create(check = TRUE) 288 | scribblr_note_create(note = note, check = TRUE) 289 | 290 | proj <- get_cur_proj() 291 | note_path <- scribblr_note_path(note = note) 292 | txt <- paste0(readLines(note_path), collapse = "\n") 293 | 294 | 295 | note_name <- basename(note_path) 296 | title <- paste0("'", note_name, "'", " @ RStudio") 297 | if (proj[["is_r_project"]]) 298 | title <- paste0(title, " project '", basename(proj[["dir"]]), "'") 299 | 300 | ver <- packageVersion("scribblr") 301 | 302 | addResourcePath("img", system.file("img", package = "scribblr")) 303 | 304 | list( 305 | note = note, note_path = note_path, txt = txt, title = title, ver = ver 306 | ) 307 | } 308 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU General Public License 2 | ========================== 3 | 4 | _Version 3, 29 June 2007_ 5 | _Copyright © 2007 Free Software Foundation, Inc. <>_ 6 | 7 | Everyone is permitted to copy and distribute verbatim copies of this license 8 | document, but changing it is not allowed. 9 | 10 | ## Preamble 11 | 12 | The GNU General Public License is a free, copyleft license for software and other 13 | kinds of works. 14 | 15 | The licenses for most software and other practical works are designed to take away 16 | your freedom to share and change the works. By contrast, the GNU General Public 17 | License is intended to guarantee your freedom to share and change all versions of a 18 | program--to make sure it remains free software for all its users. We, the Free 19 | Software Foundation, use the GNU General Public License for most of our software; it 20 | applies also to any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not price. Our General 24 | Public Licenses are designed to make sure that you have the freedom to distribute 25 | copies of free software (and charge for them if you wish), that you receive source 26 | code or can get it if you want it, that you can change the software or use pieces of 27 | it in new 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 these rights or 30 | asking you to surrender the rights. Therefore, you have certain responsibilities if 31 | you distribute copies of the software, or if you modify it: responsibilities to 32 | respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether gratis or for a fee, 35 | you must pass on to the recipients the same freedoms that you received. You must make 36 | sure that they, too, receive or can get the source code. And you must show them these 37 | terms so they know their rights. 38 | 39 | Developers that use the GNU GPL protect your rights with two steps: **(1)** assert 40 | copyright on the software, and **(2)** offer you this License giving you legal permission 41 | to copy, distribute and/or modify it. 42 | 43 | For the developers' and authors' protection, the GPL clearly explains that there is 44 | no warranty for this free software. For both users' and authors' sake, the GPL 45 | requires that modified versions be marked as changed, so that their problems will not 46 | be attributed erroneously to authors of previous versions. 47 | 48 | Some devices are designed to deny users access to install or run modified versions of 49 | the software inside them, although the manufacturer can do so. This is fundamentally 50 | incompatible with the aim of protecting users' freedom to change the software. The 51 | systematic pattern of such abuse occurs in the area of products for individuals to 52 | use, which is precisely where it is most unacceptable. Therefore, we have designed 53 | this version of the GPL to prohibit the practice for those products. If such problems 54 | arise substantially in other domains, we stand ready to extend this provision to 55 | those domains in future versions of the GPL, as needed to protect the freedom of 56 | users. 57 | 58 | Finally, every program is threatened constantly by software patents. States should 59 | not allow patents to restrict development and use of software on general-purpose 60 | computers, but in those that do, we wish to avoid the special danger that patents 61 | applied to a free program could make it effectively proprietary. To prevent this, the 62 | GPL assures that patents cannot be used to render the program non-free. 63 | 64 | The precise terms and conditions for copying, distribution and modification follow. 65 | 66 | ## TERMS AND CONDITIONS 67 | 68 | ### 0. Definitions 69 | 70 | “This License” refers to version 3 of the GNU General Public License. 71 | 72 | “Copyright” also means copyright-like laws that apply to other kinds of 73 | works, such as semiconductor masks. 74 | 75 | “The Program” refers to any copyrightable work licensed under this 76 | License. Each licensee is addressed as “you”. “Licensees” and 77 | “recipients” may be individuals or organizations. 78 | 79 | To “modify” a work means to copy from or adapt all or part of the work in 80 | a fashion requiring copyright permission, other than the making of an exact copy. The 81 | resulting work is called a “modified version” of the earlier work or a 82 | work “based on” the earlier work. 83 | 84 | A “covered work” means either the unmodified Program or a work based on 85 | the Program. 86 | 87 | To “propagate” a work means to do anything with it that, without 88 | permission, would make you directly or secondarily liable for infringement under 89 | applicable copyright law, except executing it on a computer or modifying a private 90 | copy. Propagation includes copying, distribution (with or without modification), 91 | making available to the public, and in some countries other activities as well. 92 | 93 | To “convey” a work means any kind of propagation that enables other 94 | parties to make or receive copies. Mere interaction with a user through a computer 95 | network, with no transfer of a copy, is not conveying. 96 | 97 | An interactive user interface displays “Appropriate Legal Notices” to the 98 | extent that it includes a convenient and prominently visible feature that **(1)** 99 | displays an appropriate copyright notice, and **(2)** tells the user that there is no 100 | warranty for the work (except to the extent that warranties are provided), that 101 | licensees may convey the work under this License, and how to view a copy of this 102 | License. If the interface presents a list of user commands or options, such as a 103 | menu, a prominent item in the list meets this criterion. 104 | 105 | ### 1. Source Code 106 | 107 | The “source code” for a work means the preferred form of the work for 108 | making modifications to it. “Object code” means any non-source form of a 109 | work. 110 | 111 | A “Standard Interface” means an interface that either is an official 112 | standard defined by a recognized standards body, or, in the case of interfaces 113 | specified for a particular programming language, one that is widely used among 114 | developers working in that language. 115 | 116 | The “System Libraries” of an executable work include anything, other than 117 | the work as a whole, that **(a)** is included in the normal form of packaging a Major 118 | Component, but which is not part of that Major Component, and **(b)** serves only to 119 | enable use of the work with that Major Component, or to implement a Standard 120 | Interface for which an implementation is available to the public in source code form. 121 | A “Major Component”, in this context, means a major essential component 122 | (kernel, window system, and so on) of the specific operating system (if any) on which 123 | the executable work runs, or a compiler used to produce the work, or an object code 124 | interpreter used to run it. 125 | 126 | The “Corresponding Source” for a work in object code form means all the 127 | source code needed to generate, install, and (for an executable work) run the object 128 | code and to modify the work, including scripts to control those activities. However, 129 | it does not include the work's System Libraries, or general-purpose tools or 130 | generally available free programs which are used unmodified in performing those 131 | activities but which are not part of the work. For example, Corresponding Source 132 | includes interface definition files associated with source files for the work, and 133 | the source code for shared libraries and dynamically linked subprograms that the work 134 | is specifically designed to require, such as by intimate data communication or 135 | control flow between those subprograms and other parts of the work. 136 | 137 | The Corresponding Source need not include anything that users can regenerate 138 | automatically from other parts of the Corresponding Source. 139 | 140 | The Corresponding Source for a work in source code form is that same work. 141 | 142 | ### 2. Basic Permissions 143 | 144 | All rights granted under this License are granted for the term of copyright on the 145 | Program, and are irrevocable provided the stated conditions are met. This License 146 | explicitly affirms your unlimited permission to run the unmodified Program. The 147 | output from running a covered work is covered by this License only if the output, 148 | given its content, constitutes a covered work. This License acknowledges your rights 149 | of fair use or other equivalent, as provided by copyright law. 150 | 151 | You may make, run and propagate covered works that you do not convey, without 152 | conditions so long as your license otherwise remains in force. You may convey covered 153 | works to others for the sole purpose of having them make modifications exclusively 154 | for you, or provide you with facilities for running those works, provided that you 155 | comply with the terms of this License in conveying all material for which you do not 156 | control copyright. Those thus making or running the covered works for you must do so 157 | exclusively on your behalf, under your direction and control, on terms that prohibit 158 | them from making any copies of your copyrighted material outside their relationship 159 | with you. 160 | 161 | Conveying under any other circumstances is permitted solely under the conditions 162 | stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 163 | 164 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law 165 | 166 | No covered work shall be deemed part of an effective technological measure under any 167 | applicable law fulfilling obligations under article 11 of the WIPO copyright treaty 168 | adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention 169 | of such measures. 170 | 171 | When you convey a covered work, you waive any legal power to forbid circumvention of 172 | technological measures to the extent such circumvention is effected by exercising 173 | rights under this License with respect to the covered work, and you disclaim any 174 | intention to limit operation or modification of the work as a means of enforcing, 175 | against the work's users, your or third parties' legal rights to forbid circumvention 176 | of technological measures. 177 | 178 | ### 4. Conveying Verbatim Copies 179 | 180 | You may convey verbatim copies of the Program's source code as you receive it, in any 181 | medium, provided that you conspicuously and appropriately publish on each copy an 182 | appropriate copyright notice; keep intact all notices stating that this License and 183 | any non-permissive terms added in accord with section 7 apply to the code; keep 184 | intact all notices of the absence of any warranty; and give all recipients a copy of 185 | this License along with the Program. 186 | 187 | You may charge any price or no price for each copy that you convey, and you may offer 188 | support or warranty protection for a fee. 189 | 190 | ### 5. Conveying Modified Source Versions 191 | 192 | You may convey a work based on the Program, or the modifications to produce it from 193 | the Program, in the form of source code under the terms of section 4, provided that 194 | you also meet all of these conditions: 195 | 196 | * **a)** The work must carry prominent notices stating that you modified it, and giving a 197 | relevant date. 198 | * **b)** The work must carry prominent notices stating that it is released under this 199 | License and any conditions added under section 7. This requirement modifies the 200 | requirement in section 4 to “keep intact all notices”. 201 | * **c)** You must license the entire work, as a whole, under this License to anyone who 202 | comes into possession of a copy. This License will therefore apply, along with any 203 | applicable section 7 additional terms, to the whole of the work, and all its parts, 204 | regardless of how they are packaged. This License gives no permission to license the 205 | work in any other way, but it does not invalidate such permission if you have 206 | separately received it. 207 | * **d)** If the work has interactive user interfaces, each must display Appropriate Legal 208 | Notices; however, if the Program has interactive interfaces that do not display 209 | Appropriate Legal Notices, your work need not make them do so. 210 | 211 | A compilation of a covered work with other separate and independent works, which are 212 | not by their nature extensions of the covered work, and which are not combined with 213 | it such as to form a larger program, in or on a volume of a storage or distribution 214 | medium, is called an “aggregate” if the compilation and its resulting 215 | copyright are not used to limit the access or legal rights of the compilation's users 216 | beyond what the individual works permit. Inclusion of a covered work in an aggregate 217 | does not cause this License to apply to the other parts of the aggregate. 218 | 219 | ### 6. Conveying Non-Source Forms 220 | 221 | You may convey a covered work in object code form under the terms of sections 4 and 222 | 5, provided that you also convey the machine-readable Corresponding Source under the 223 | terms of this License, in one of these ways: 224 | 225 | * **a)** Convey the object code in, or embodied in, a physical product (including a 226 | physical distribution medium), accompanied by the Corresponding Source fixed on a 227 | durable physical medium customarily used for software interchange. 228 | * **b)** Convey the object code in, or embodied in, a physical product (including a 229 | physical distribution medium), accompanied by a written offer, valid for at least 230 | three years and valid for as long as you offer spare parts or customer support for 231 | that product model, to give anyone who possesses the object code either **(1)** a copy of 232 | the Corresponding Source for all the software in the product that is covered by this 233 | License, on a durable physical medium customarily used for software interchange, for 234 | a price no more than your reasonable cost of physically performing this conveying of 235 | source, or **(2)** access to copy the Corresponding Source from a network server at no 236 | charge. 237 | * **c)** Convey individual copies of the object code with a copy of the written offer to 238 | provide the Corresponding Source. This alternative is allowed only occasionally and 239 | noncommercially, and only if you received the object code with such an offer, in 240 | accord with subsection 6b. 241 | * **d)** Convey the object code by offering access from a designated place (gratis or for 242 | a charge), and offer equivalent access to the Corresponding Source in the same way 243 | through the same place at no further charge. You need not require recipients to copy 244 | the Corresponding Source along with the object code. If the place to copy the object 245 | code is a network server, the Corresponding Source may be on a different server 246 | (operated by you or a third party) that supports equivalent copying facilities, 247 | provided you maintain clear directions next to the object code saying where to find 248 | the Corresponding Source. Regardless of what server hosts the Corresponding Source, 249 | you remain obligated to ensure that it is available for as long as needed to satisfy 250 | these requirements. 251 | * **e)** Convey the object code using peer-to-peer transmission, provided you inform 252 | other peers where the object code and Corresponding Source of the work are being 253 | offered to the general public at no charge under subsection 6d. 254 | 255 | A separable portion of the object code, whose source code is excluded from the 256 | Corresponding Source as a System Library, need not be included in conveying the 257 | object code work. 258 | 259 | A “User Product” is either **(1)** a “consumer product”, which 260 | means any tangible personal property which is normally used for personal, family, or 261 | household purposes, or **(2)** anything designed or sold for incorporation into a 262 | dwelling. In determining whether a product is a consumer product, doubtful cases 263 | shall be resolved in favor of coverage. For a particular product received by a 264 | particular user, “normally used” refers to a typical or common use of 265 | that class of product, regardless of the status of the particular user or of the way 266 | in which the particular user actually uses, or expects or is expected to use, the 267 | product. A product is a consumer product regardless of whether the product has 268 | substantial commercial, industrial or non-consumer uses, unless such uses represent 269 | the only significant mode of use of the product. 270 | 271 | “Installation Information” for a User Product means any methods, 272 | procedures, authorization keys, or other information required to install and execute 273 | modified versions of a covered work in that User Product from a modified version of 274 | its Corresponding Source. The information must suffice to ensure that the continued 275 | functioning of the modified object code is in no case prevented or interfered with 276 | solely because modification has been made. 277 | 278 | If you convey an object code work under this section in, or with, or specifically for 279 | use in, a User Product, and the conveying occurs as part of a transaction in which 280 | the right of possession and use of the User Product is transferred to the recipient 281 | in perpetuity or for a fixed term (regardless of how the transaction is 282 | characterized), the Corresponding Source conveyed under this section must be 283 | accompanied by the Installation Information. But this requirement does not apply if 284 | neither you nor any third party retains the ability to install modified object code 285 | on the User Product (for example, the work has been installed in ROM). 286 | 287 | The requirement to provide Installation Information does not include a requirement to 288 | continue to provide support service, warranty, or updates for a work that has been 289 | modified or installed by the recipient, or for the User Product in which it has been 290 | modified or installed. Access to a network may be denied when the modification itself 291 | materially and adversely affects the operation of the network or violates the rules 292 | and protocols for communication across the network. 293 | 294 | Corresponding Source conveyed, and Installation Information provided, in accord with 295 | this section must be in a format that is publicly documented (and with an 296 | implementation available to the public in source code form), and must require no 297 | special password or key for unpacking, reading or copying. 298 | 299 | ### 7. Additional Terms 300 | 301 | “Additional permissions” are terms that supplement the terms of this 302 | License by making exceptions from one or more of its conditions. Additional 303 | permissions that are applicable to the entire Program shall be treated as though they 304 | were included in this License, to the extent that they are valid under applicable 305 | law. If additional permissions apply only to part of the Program, that part may be 306 | used separately under those permissions, but the entire Program remains governed by 307 | this License without regard to the additional permissions. 308 | 309 | When you convey a copy of a covered work, you may at your option remove any 310 | additional permissions from that copy, or from any part of it. (Additional 311 | permissions may be written to require their own removal in certain cases when you 312 | modify the work.) You may place additional permissions on material, added by you to a 313 | covered work, for which you have or can give appropriate copyright permission. 314 | 315 | Notwithstanding any other provision of this License, for material you add to a 316 | covered work, you may (if authorized by the copyright holders of that material) 317 | supplement the terms of this License with terms: 318 | 319 | * **a)** Disclaiming warranty or limiting liability differently from the terms of 320 | sections 15 and 16 of this License; or 321 | * **b)** Requiring preservation of specified reasonable legal notices or author 322 | attributions in that material or in the Appropriate Legal Notices displayed by works 323 | containing it; or 324 | * **c)** Prohibiting misrepresentation of the origin of that material, or requiring that 325 | modified versions of such material be marked in reasonable ways as different from the 326 | original version; or 327 | * **d)** Limiting the use for publicity purposes of names of licensors or authors of the 328 | material; or 329 | * **e)** Declining to grant rights under trademark law for use of some trade names, 330 | trademarks, or service marks; or 331 | * **f)** Requiring indemnification of licensors and authors of that material by anyone 332 | who conveys the material (or modified versions of it) with contractual assumptions of 333 | liability to the recipient, for any liability that these contractual assumptions 334 | directly impose on those licensors and authors. 335 | 336 | All other non-permissive additional terms are considered “further 337 | restrictions” within the meaning of section 10. If the Program as you received 338 | it, or any part of it, contains a notice stating that it is governed by this License 339 | along with a term that is a further restriction, you may remove that term. If a 340 | license document contains a further restriction but permits relicensing or conveying 341 | under this License, you may add to a covered work material governed by the terms of 342 | that license document, provided that the further restriction does not survive such 343 | relicensing or conveying. 344 | 345 | If you add terms to a covered work in accord with this section, you must place, in 346 | the relevant source files, a statement of the additional terms that apply to those 347 | files, or a notice indicating where to find the applicable terms. 348 | 349 | Additional terms, permissive or non-permissive, may be stated in the form of a 350 | separately written license, or stated as exceptions; the above requirements apply 351 | either way. 352 | 353 | ### 8. Termination 354 | 355 | You may not propagate or modify a covered work except as expressly provided under 356 | this License. Any attempt otherwise to propagate or modify it is void, and will 357 | automatically terminate your rights under this License (including any patent licenses 358 | granted under the third paragraph of section 11). 359 | 360 | However, if you cease all violation of this License, then your license from a 361 | particular copyright holder is reinstated **(a)** provisionally, unless and until the 362 | copyright holder explicitly and finally terminates your license, and **(b)** permanently, 363 | if the copyright holder fails to notify you of the violation by some reasonable means 364 | prior to 60 days after the cessation. 365 | 366 | Moreover, your license from a particular copyright holder is reinstated permanently 367 | if the copyright holder notifies you of the violation by some reasonable means, this 368 | is the first time you have received notice of violation of this License (for any 369 | work) from that copyright holder, and you cure the violation prior to 30 days after 370 | your receipt of the notice. 371 | 372 | Termination of your rights under this section does not terminate the licenses of 373 | parties who have received copies or rights from you under this License. If your 374 | rights have been terminated and not permanently reinstated, you do not qualify to 375 | receive new licenses for the same material under section 10. 376 | 377 | ### 9. Acceptance Not Required for Having Copies 378 | 379 | You are not required to accept this License in order to receive or run a copy of the 380 | Program. Ancillary propagation of a covered work occurring solely as a consequence of 381 | using peer-to-peer transmission to receive a copy likewise does not require 382 | acceptance. However, nothing other than this License grants you permission to 383 | propagate or modify any covered work. These actions infringe copyright if you do not 384 | accept this License. Therefore, by modifying or propagating a covered work, you 385 | indicate your acceptance of this License to do so. 386 | 387 | ### 10. Automatic Licensing of Downstream Recipients 388 | 389 | Each time you convey a covered work, the recipient automatically receives a license 390 | from the original licensors, to run, modify and propagate that work, subject to this 391 | License. You are not responsible for enforcing compliance by third parties with this 392 | License. 393 | 394 | An “entity transaction” is a transaction transferring control of an 395 | organization, or substantially all assets of one, or subdividing an organization, or 396 | merging organizations. If propagation of a covered work results from an entity 397 | transaction, each party to that transaction who receives a copy of the work also 398 | receives whatever licenses to the work the party's predecessor in interest had or 399 | could give under the previous paragraph, plus a right to possession of the 400 | Corresponding Source of the work from the predecessor in interest, if the predecessor 401 | has it or can get it with reasonable efforts. 402 | 403 | You may not impose any further restrictions on the exercise of the rights granted or 404 | affirmed under this License. For example, you may not impose a license fee, royalty, 405 | or other charge for exercise of rights granted under this License, and you may not 406 | initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging 407 | that any patent claim is infringed by making, using, selling, offering for sale, or 408 | importing the Program or any portion of it. 409 | 410 | ### 11. Patents 411 | 412 | A “contributor” is a copyright holder who authorizes use under this 413 | License of the Program or a work on which the Program is based. The work thus 414 | licensed is called the contributor's “contributor version”. 415 | 416 | A contributor's “essential patent claims” are all patent claims owned or 417 | controlled by the contributor, whether already acquired or hereafter acquired, that 418 | would be infringed by some manner, permitted by this License, of making, using, or 419 | selling its contributor version, but do not include claims that would be infringed 420 | only as a consequence of further modification of the contributor version. For 421 | purposes of this definition, “control” includes the right to grant patent 422 | sublicenses in a manner consistent with the requirements of this License. 423 | 424 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license 425 | under the contributor's essential patent claims, to make, use, sell, offer for sale, 426 | import and otherwise run, modify and propagate the contents of its contributor 427 | version. 428 | 429 | In the following three paragraphs, a “patent license” is any express 430 | agreement or commitment, however denominated, not to enforce a patent (such as an 431 | express permission to practice a patent or covenant not to sue for patent 432 | infringement). To “grant” such a patent license to a party means to make 433 | such an agreement or commitment not to enforce a patent against the party. 434 | 435 | If you convey a covered work, knowingly relying on a patent license, and the 436 | Corresponding Source of the work is not available for anyone to copy, free of charge 437 | and under the terms of this License, through a publicly available network server or 438 | other readily accessible means, then you must either **(1)** cause the Corresponding 439 | Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the 440 | patent license for this particular work, or **(3)** arrange, in a manner consistent with 441 | the requirements of this License, to extend the patent license to downstream 442 | recipients. “Knowingly relying” means you have actual knowledge that, but 443 | for the patent license, your conveying the covered work in a country, or your 444 | recipient's use of the covered work in a country, would infringe one or more 445 | identifiable patents in that country that you have reason to believe are valid. 446 | 447 | If, pursuant to or in connection with a single transaction or arrangement, you 448 | convey, or propagate by procuring conveyance of, a covered work, and grant a patent 449 | license to some of the parties receiving the covered work authorizing them to use, 450 | propagate, modify or convey a specific copy of the covered work, then the patent 451 | license you grant is automatically extended to all recipients of the covered work and 452 | works based on it. 453 | 454 | A patent license is “discriminatory” if it does not include within the 455 | scope of its coverage, prohibits the exercise of, or is conditioned on the 456 | non-exercise of one or more of the rights that are specifically granted under this 457 | License. You may not convey a covered work if you are a party to an arrangement with 458 | a third party that is in the business of distributing software, under which you make 459 | payment to the third party based on the extent of your activity of conveying the 460 | work, and under which the third party grants, to any of the parties who would receive 461 | the covered work from you, a discriminatory patent license **(a)** in connection with 462 | copies of the covered work conveyed by you (or copies made from those copies), or **(b)** 463 | primarily for and in connection with specific products or compilations that contain 464 | the covered work, unless you entered into that arrangement, or that patent license 465 | was granted, prior to 28 March 2007. 466 | 467 | Nothing in this License shall be construed as excluding or limiting any implied 468 | license or other defenses to infringement that may otherwise be available to you 469 | under applicable patent law. 470 | 471 | ### 12. No Surrender of Others' Freedom 472 | 473 | If conditions are imposed on you (whether by court order, agreement or otherwise) 474 | that contradict the conditions of this License, they do not excuse you from the 475 | conditions of this License. If you cannot convey a covered work so as to satisfy 476 | simultaneously your obligations under this License and any other pertinent 477 | obligations, then as a consequence you may not convey it at all. For example, if you 478 | agree to terms that obligate you to collect a royalty for further conveying from 479 | those to whom you convey the Program, the only way you could satisfy both those terms 480 | and this License would be to refrain entirely from conveying the Program. 481 | 482 | ### 13. Use with the GNU Affero General Public License 483 | 484 | Notwithstanding any other provision of this License, you have permission to link or 485 | combine any covered work with a work licensed under version 3 of the GNU Affero 486 | General Public License into a single combined work, and to convey the resulting work. 487 | The terms of this License will continue to apply to the part which is the covered 488 | work, but the special requirements of the GNU Affero General Public License, section 489 | 13, concerning interaction through a network will apply to the combination as such. 490 | 491 | ### 14. Revised Versions of this License 492 | 493 | The Free Software Foundation may publish revised and/or new versions of the GNU 494 | General Public License from time to time. Such new versions will be similar in spirit 495 | to the present version, but may differ in detail to address new problems or concerns. 496 | 497 | Each version is given a distinguishing version number. If the Program specifies that 498 | a certain numbered version of the GNU General Public License “or any later 499 | version” applies to it, you have the option of following the terms and 500 | conditions either of that numbered version or of any later version published by the 501 | Free Software Foundation. If the Program does not specify a version number of the GNU 502 | General Public License, you may choose any version ever published by the Free 503 | Software Foundation. 504 | 505 | If the Program specifies that a proxy can decide which future versions of the GNU 506 | General Public License can be used, that proxy's public statement of acceptance of a 507 | version permanently authorizes you to choose that version for the Program. 508 | 509 | Later license versions may give you additional or different permissions. However, no 510 | additional obligations are imposed on any author or copyright holder as a result of 511 | your choosing to follow a later version. 512 | 513 | ### 15. Disclaimer of Warranty 514 | 515 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 516 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 517 | PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER 518 | EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 519 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 520 | QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 521 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 522 | 523 | ### 16. Limitation of Liability 524 | 525 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY 526 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS 527 | PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 528 | INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 529 | PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE 530 | OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE 531 | WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 532 | POSSIBILITY OF SUCH DAMAGES. 533 | 534 | ### 17. Interpretation of Sections 15 and 16 535 | 536 | If the disclaimer of warranty and limitation of liability provided above cannot be 537 | given local legal effect according to their terms, reviewing courts shall apply local 538 | law that most closely approximates an absolute waiver of all civil liability in 539 | connection with the Program, unless a warranty or assumption of liability accompanies 540 | a copy of the Program in return for a fee. 541 | 542 | _END OF TERMS AND CONDITIONS_ 543 | 544 | ## How to Apply These Terms to Your New Programs 545 | 546 | If you develop a new program, and you want it to be of the greatest possible use to 547 | the public, the best way to achieve this is to make it free software which everyone 548 | can redistribute and change under these terms. 549 | 550 | To do so, attach the following notices to the program. It is safest to attach them 551 | to the start of each source file to most effectively state the exclusion of warranty; 552 | and each file should have at least the “copyright” line and a pointer to 553 | where the full notice is found. 554 | 555 | 556 | Copyright (C) 557 | 558 | This program is free software: you can redistribute it and/or modify 559 | it under the terms of the GNU General Public License as published by 560 | the Free Software Foundation, either version 3 of the License, or 561 | (at your option) any later version. 562 | 563 | This program is distributed in the hope that it will be useful, 564 | but WITHOUT ANY WARRANTY; without even the implied warranty of 565 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 566 | GNU General Public License for more details. 567 | 568 | You should have received a copy of the GNU General Public License 569 | along with this program. If not, see . 570 | 571 | Also add information on how to contact you by electronic and paper mail. 572 | 573 | If the program does terminal interaction, make it output a short notice like this 574 | when it starts in an interactive mode: 575 | 576 | Copyright (C) 577 | This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. 578 | This is free software, and you are welcome to redistribute it 579 | under certain conditions; type 'show c' for details. 580 | 581 | The hypothetical commands `show w` and `show c` should show the appropriate parts of 582 | the General Public License. Of course, your program's commands might be different; 583 | for a GUI interface, you would use an “about box”. 584 | 585 | You should also get your employer (if you work as a programmer) or school, if any, to 586 | sign a “copyright disclaimer” for the program, if necessary. For more 587 | information on this, and how to apply and follow the GNU GPL, see 588 | <>. 589 | 590 | The GNU General Public License does not permit incorporating your program into 591 | proprietary programs. If your program is a subroutine library, you may consider it 592 | more useful to permit linking proprietary applications with the library. If this is 593 | what you want to do, use the GNU Lesser General Public License instead of this 594 | License. But first, please read 595 | <>. 596 | --------------------------------------------------------------------------------