add new YAML entry for a short FSAR/FSRR title, and appropriate bookm…

…arks for replacing in Word files
pbs-assess · Dec 16, 2024 · ed44eec · ed44eec
1 parent e4c2b09
commit ed44eec
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 3 deletions.
diff --git a/R/fsar-word.R b/R/fsar-word.R
@@ -129,7 +129,8 @@ render_sar <- function(...) {
 
   doc <- officer::headers_replace_text_at_bkm(doc, "region_name", x$region)
   doc <- officer::headers_replace_text_at_bkm(doc, "region_name_rest", x$region) # non-first page
-  doc <- officer::headers_replace_text_at_bkm(doc, "report_name_rest", x$report_title) # non-first page
+  doc <- officer::headers_replace_text_at_bkm(doc, "report_name_rest", x$report_title_short) # non-first page
+
   doc <- officer::headers_replace_text_at_bkm(doc, "report_year", x$report_year)
   doc <- officer::headers_replace_text_at_bkm(doc, "report_number", x$report_number)
 

diff --git a/inst/csas-docx/fsar-first-page.docx b/inst/csas-docx/fsar-first-page.docx
diff --git a/inst/csas-docx/fsar-template.docx b/inst/csas-docx/fsar-template.docx
diff --git a/inst/rmarkdown/templates/fsar/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/fsar/skeleton/skeleton.Rmd
@@ -1,5 +1,6 @@
 ---
 report_title: "[Publication Title]"
+report_title_short: "[Short Publication Title]"
 report_year: "2024"
 release_month: "January"
 report_number: "XXX"

diff --git a/inst/rmarkdown/templates/fsar/template.yaml b/inst/rmarkdown/templates/fsar/template.yaml
@@ -1,4 +1,4 @@
 name:  FSAR
 description: >
-  Template for creating a DFO FSAR reports using R Markdown using the R
-  bookdown package.
+  Template for creating a DFO FSAR or FSRR reports using R Markdown
+  using the R bookdown package.