fix #909: disable pandoc --file-scope by default (#916)

jjallaire · web-flow · commit 285cba41c50d · 2020-07-22T10:36:47.000-05:00
The `--file-scope` behavior introduced in bookdown v0.20 is now disabled by default. This is due to broken TOC links for duplicate section names (e.g. "Exercises") that have automatically generated identifiers.
diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,8 @@
 # CHANGES IN bookdown VERSION 0.21
 
+## MINOR CHANGES
 
+- The `--file-scope` behavior introduced in bookdown v0.20 is now disabled by default. This is due to broken TOC links for duplicate section names (e.g., "Exercises"; see #909) that have automatically generated identifiers.
 
 # CHANGES IN bookdown VERSION 0.20
 
diff --git a/R/utils.R b/R/utils.R
@@ -26,10 +26,10 @@ new_counters = function(type, rownames) {
 
 # set common format config
 common_format_config = function(
-  config, format, file_scope = getOption('bookdown.render.file_scope', TRUE)
+  config, format, file_scope = getOption('bookdown.render.file_scope', FALSE)
 ) {
 
-  # provide file_scope unless disabled via the global option
+  # provide file_scope if requested
   if (file_scope) config$file_scope = md_chapter_splitter
 
   # set output format
