Delete manuscript folder

jhudsl · Sep 17, 2024 · 004076a · 004076a
1 parent 4e30ad8
commit 004076a
Show file tree

Hide file tree

Showing 45 changed files with 101 additions and 126 deletions.
diff --git a/make_screenshots.R b/make_screenshots.R
@@ -0,0 +1,87 @@
+#!/usr/bin/env Rscript
+# Written by Candace Savonen Jan 2022
+
+if (!('devtools' %in% installed.packages())) {
+  # install.packages("remotes", repos = "http://cran.us.r-project.org")
+}
+
+if (!('optparse' %in% installed.packages())) {
+  # install.packages("optparse", repos = "http://cran.us.r-project.org")
+}
+
+# Find .git root directory
+root_dir <- rprojroot::find_root(rprojroot::has_dir(".git"))
+
+
+Sys.setenv("CHROMOTE_CHROME" = "/usr/bin/vivaldi")
+
+library(optparse)
+library(magrittr)
+
+option_list <- list(
+  optparse::make_option(
+    c("--repo"),
+    type = "character",
+    default = NULL,
+    help = "GitHub repository name, e.g. jhudsl/OTTR_Template",
+  ),
+  optparse::make_option(
+    c("--git_pat"),
+    type = "character",
+    default = NULL,
+    help = "GitHub personal access token",
+  ),
+  optparse::make_option(
+    c("--output_dir"),
+    type = "character",
+    default = "resources/chapt_screen_images",
+    help = "Output directory where the chapter's screen images should be stored",
+  ),
+  optparse::make_option(
+    c("--base_url"),
+    type = "character",
+    default = NULL,
+    help = "Output directory where the chapter's screen images should be stored",
+  )
+)
+
+# Read the arguments passed
+opt_parser <- optparse::OptionParser(option_list = option_list)
+opt <- optparse::parse_args(opt_parser)
+
+output_folder <- file.path(opt$output_dir)
+if (!dir.exists(output_folder)) {
+  dir.create(output_folder, recursive = TRUE)
+}
+
+if (is.null(opt$base_url)) {
+  base_url <- cow::get_pages_url(repo_name = opt$repo, git_pat = opt$git_pat)
+  base_url <- gsub("/$", "", base_url)
+}
+
+# Collect all the chapter pages for the url given
+chapt_df <- ottrpal::get_chapters(html_page =  file.path(root_dir, "docs", "index.html"),
+                         base_url = base_url)
+
+# Now take screenshots for each
+file_names <- lapply(chapt_df$url, function(url) {
+  file_name <- gsub(".html", ".png", file.path(output_folder, basename(url)))
+
+  # Get rid of special characters because leanpub no like
+  file_name <- gsub(":|?|!|\\'", "", file_name)
+
+  # Take the screenshot
+  webshot2::webshot(url, file = file_name)
+
+  return(file_name)
+
+})
+
+# Save file of chapter urls and file_names
+chapt_df <- chapt_df %>%
+  dplyr::mutate(img_path = unlist(file_names))
+
+chapt_df %>%
+  readr::write_tsv(file.path(output_folder, "chapter_urls.tsv"))
+
+message(paste("Image Chapter key written to: ", file.path(output_folder, "chapter_urls.tsv")))
diff --git a/manuscript/1-Introduction.md b/manuscript/1-Introduction.md
diff --git a/manuscript/10-Other-helpful-features.md b/manuscript/10-Other-helpful-features.md
diff --git a/manuscript/11-How-to-keep-your-documentation-up-to-date.md b/manuscript/11-How-to-keep-your-documentation-up-to-date.md
diff --git a/manuscript/2-Documentation:-Why-it’s-worth-the-effort!.md b/manuscript/2-Documentation:-Why-it’s-worth-the-effort!.md
diff --git a/manuscript/3-Lessons-we-should-borrow-from-user-designers.md b/manuscript/3-Lessons-we-should-borrow-from-user-designers.md
diff --git a/manuscript/4-What-does-good-documentation-look-like?.md b/manuscript/4-What-does-good-documentation-look-like?.md
diff --git a/manuscript/5-Creating-a-smooth-getting-started-section.md b/manuscript/5-Creating-a-smooth-getting-started-section.md
diff --git a/manuscript/6-Creating-helpful-how-to-examples.md b/manuscript/6-Creating-helpful-how-to-examples.md
diff --git a/manuscript/7-Creating-handy-reference-guides.md b/manuscript/7-Creating-handy-reference-guides.md
diff --git a/manuscript/8-Creating-clarifying-code-comments.md b/manuscript/8-Creating-clarifying-code-comments.md
diff --git a/manuscript/9-Obtaining-user-feedback.md b/manuscript/9-Obtaining-user-feedback.md
diff --git a/manuscript/About-the-Authors.md b/manuscript/About-the-Authors.md
diff --git a/manuscript/About-this-course.md b/manuscript/About-this-course.md
diff --git a/manuscript/Book.txt b/manuscript/Book.txt
diff --git a/manuscript/References.md b/manuscript/References.md
diff --git a/manuscript/resources/chapt_screen_images/about-the-authors.png b/manuscript/resources/chapt_screen_images/about-the-authors.png
diff --git a/...ipt/resources/chapt_screen_images/creating-a-smooth-getting-started-section.png b/...ipt/resources/chapt_screen_images/creating-a-smooth-getting-started-section.png
diff --git a/manuscript/resources/chapt_screen_images/creating-clarifying-code-comments.png b/manuscript/resources/chapt_screen_images/creating-clarifying-code-comments.png
diff --git a/manuscript/resources/chapt_screen_images/creating-handy-reference-guides.png b/manuscript/resources/chapt_screen_images/creating-handy-reference-guides.png
diff --git a/manuscript/resources/chapt_screen_images/creating-helpful-how-to-examples.png b/manuscript/resources/chapt_screen_images/creating-helpful-how-to-examples.png
diff --git a/...script/resources/chapt_screen_images/documentation-why-its-worth-the-effort.png b/...script/resources/chapt_screen_images/documentation-why-its-worth-the-effort.png
diff --git a/...ipt/resources/chapt_screen_images/how-to-keep-your-documentation-up-to-date.png b/...ipt/resources/chapt_screen_images/how-to-keep-your-documentation-up-to-date.png
diff --git a/manuscript/resources/chapt_screen_images/index.png b/manuscript/resources/chapt_screen_images/index.png
diff --git a/manuscript/resources/chapt_screen_images/introduction.png b/manuscript/resources/chapt_screen_images/introduction.png
diff --git a/.../resources/chapt_screen_images/lessons-we-should-borrow-from-user-designers.png b/.../resources/chapt_screen_images/lessons-we-should-borrow-from-user-designers.png
diff --git a/manuscript/resources/chapt_screen_images/obtaining-user-feedback.png b/manuscript/resources/chapt_screen_images/obtaining-user-feedback.png
diff --git a/manuscript/resources/chapt_screen_images/other-helpful-features.png b/manuscript/resources/chapt_screen_images/other-helpful-features.png
diff --git a/manuscript/resources/chapt_screen_images/references.png b/manuscript/resources/chapt_screen_images/references.png
diff --git a/...script/resources/chapt_screen_images/what-does-good-documentation-look-like.png b/...script/resources/chapt_screen_images/what-does-good-documentation-look-like.png
diff --git a/resources/chapt_screen_images/about-the-authors.png b/resources/chapt_screen_images/about-the-authors.png
diff --git a/resources/chapt_screen_images/chapter_urls.tsv b/resources/chapt_screen_images/chapter_urls.tsv
@@ -1,15 +1,15 @@
 url	chapt_title	img_path
-https://jhudatascience.org/Documentation_and_Usability/no_toc/index.html	About this course	resources/chapt_screen_images/index.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/introduction.html	1 Introduction	resources/chapt_screen_images/introduction.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/documentation-why-its-worth-the-effort.html	2 Documentation: Why it’s worth the effort!	resources/chapt_screen_images/documentation-why-its-worth-the-effort.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/lessons-we-should-borrow-from-user-designers.html	3 Lessons we should borrow from user designers	resources/chapt_screen_images/lessons-we-should-borrow-from-user-designers.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/what-does-good-documentation-look-like.html	4 What does good documentation look like?	resources/chapt_screen_images/what-does-good-documentation-look-like.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/creating-a-smooth-getting-started-section.html	5 Creating a smooth getting started section	resources/chapt_screen_images/creating-a-smooth-getting-started-section.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/creating-helpful-how-to-examples.html	6 Creating helpful how-to examples	resources/chapt_screen_images/creating-helpful-how-to-examples.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/creating-handy-reference-guides.html	7 Creating handy reference guides	resources/chapt_screen_images/creating-handy-reference-guides.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/creating-clarifying-code-comments.html	8 Creating clarifying code comments	resources/chapt_screen_images/creating-clarifying-code-comments.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/obtaining-user-feedback.html	9 Obtaining user feedback	resources/chapt_screen_images/obtaining-user-feedback.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/other-helpful-features.html	10 Other helpful features	resources/chapt_screen_images/other-helpful-features.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/how-to-keep-your-documentation-up-to-date.html	11 How to keep your documentation up to date	resources/chapt_screen_images/how-to-keep-your-documentation-up-to-date.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/about-the-authors.html	About the Authors	resources/chapt_screen_images/about-the-authors.png
-https://jhudatascience.org/Documentation_and_Usability/no_toc/references.html	References	resources/chapt_screen_images/references.png
+https://jhudatascience.org/Documentation_and_Usability/index.html	About this course	resources/chapt_screen_images/index.png
+https://jhudatascience.org/Documentation_and_Usability/introduction.html	1 Introduction	resources/chapt_screen_images/introduction.png
+https://jhudatascience.org/Documentation_and_Usability/documentation-why-its-worth-the-effort.html	2 Documentation: Why it’s worth the effort!	resources/chapt_screen_images/documentation-why-its-worth-the-effort.png
+https://jhudatascience.org/Documentation_and_Usability/lessons-we-should-borrow-from-user-designers.html	3 Lessons we should borrow from user designers	resources/chapt_screen_images/lessons-we-should-borrow-from-user-designers.png
+https://jhudatascience.org/Documentation_and_Usability/what-does-good-documentation-look-like.html	4 What does good documentation look like?	resources/chapt_screen_images/what-does-good-documentation-look-like.png
+https://jhudatascience.org/Documentation_and_Usability/creating-a-smooth-getting-started-section.html	5 Creating a smooth getting started section	resources/chapt_screen_images/creating-a-smooth-getting-started-section.png
+https://jhudatascience.org/Documentation_and_Usability/creating-helpful-how-to-examples.html	6 Creating helpful how-to examples	resources/chapt_screen_images/creating-helpful-how-to-examples.png
+https://jhudatascience.org/Documentation_and_Usability/creating-handy-reference-guides.html	7 Creating handy reference guides	resources/chapt_screen_images/creating-handy-reference-guides.png
+https://jhudatascience.org/Documentation_and_Usability/creating-clarifying-code-comments.html	8 Creating clarifying code comments	resources/chapt_screen_images/creating-clarifying-code-comments.png
+https://jhudatascience.org/Documentation_and_Usability/obtaining-user-feedback.html	9 Obtaining user feedback	resources/chapt_screen_images/obtaining-user-feedback.png
+https://jhudatascience.org/Documentation_and_Usability/other-helpful-features.html	10 Other helpful features	resources/chapt_screen_images/other-helpful-features.png
+https://jhudatascience.org/Documentation_and_Usability/how-to-keep-your-documentation-up-to-date.html	11 How to keep your documentation up to date	resources/chapt_screen_images/how-to-keep-your-documentation-up-to-date.png
+https://jhudatascience.org/Documentation_and_Usability/about-the-authors.html	About the Authors	resources/chapt_screen_images/about-the-authors.png
+https://jhudatascience.org/Documentation_and_Usability/references.html	References	resources/chapt_screen_images/references.png
diff --git a/resources/chapt_screen_images/creating-a-smooth-getting-started-section.png b/resources/chapt_screen_images/creating-a-smooth-getting-started-section.png
diff --git a/resources/chapt_screen_images/creating-clarifying-code-comments.png b/resources/chapt_screen_images/creating-clarifying-code-comments.png
diff --git a/resources/chapt_screen_images/creating-handy-reference-guides.png b/resources/chapt_screen_images/creating-handy-reference-guides.png
diff --git a/resources/chapt_screen_images/creating-helpful-how-to-examples.png b/resources/chapt_screen_images/creating-helpful-how-to-examples.png
diff --git a/resources/chapt_screen_images/documentation-why-its-worth-the-effort.png b/resources/chapt_screen_images/documentation-why-its-worth-the-effort.png
diff --git a/resources/chapt_screen_images/how-to-keep-your-documentation-up-to-date.png b/resources/chapt_screen_images/how-to-keep-your-documentation-up-to-date.png
diff --git a/resources/chapt_screen_images/index.png b/resources/chapt_screen_images/index.png
diff --git a/resources/chapt_screen_images/introduction.png b/resources/chapt_screen_images/introduction.png
diff --git a/resources/chapt_screen_images/lessons-we-should-borrow-from-user-designers.png b/resources/chapt_screen_images/lessons-we-should-borrow-from-user-designers.png
diff --git a/resources/chapt_screen_images/obtaining-user-feedback.png b/resources/chapt_screen_images/obtaining-user-feedback.png
diff --git a/resources/chapt_screen_images/other-helpful-features.png b/resources/chapt_screen_images/other-helpful-features.png
diff --git a/resources/chapt_screen_images/references.png b/resources/chapt_screen_images/references.png
diff --git a/resources/chapt_screen_images/what-does-good-documentation-look-like.png b/resources/chapt_screen_images/what-does-good-documentation-look-like.png