r-lib · maelle · Feb 19, 2021 · Feb 16, 2021 · Feb 16, 2021 · Feb 16, 2021
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,10 @@
 # pkgdown (development version)
 
+* Make footer specification more flexible: users can now
+    * change the placement of elements on the left and right
+    * add sentences to the left and right
+  (#1502)
+
 * pkgdown can now use the templates "in-header.html"/"after-head.html", "before-body.html" and 
 "after-body.html" whose content will be placed 
 (similarly to bookdown options `in_header`, `before_body` and `after_body`), 
@@ -9,11 +14,12 @@ right below the opening `<body>` tag; and before the closing tag `</body>` (#148
 * Links for GitHub Enterprise and GitLab Enterprise repositories are detected 
   by assuming such host address begin with `github.` or `gitlab.` 
   (@ijlyttle, #1452).
+
 * Make sidebar specification more flexible: users can now
     * change the order of sidebar elements
-    * add custom sidebar sections (title, text that has to be HTML)
+    * add custom sidebar sections (title, text that can be Markdown or HTML)
     * completely suppress the navbar (even "Dev status")
-    * provide their own HTML for the navbar. (#1443, #1488)
+    * provide their own HTML for the navbar. (#1443, #1488, #1502)
 
 
 * Protect the rules drawn by the CLI (as for example, in `build_site()`) against

diff --git a/R/build-home-index.R b/R/build-home-index.R
@@ -103,22 +103,7 @@ data_home_sidebar <- function(pkg = ".") {
   missing <- setdiff(sidebar_structure, names(sidebar_components))
 
   if (length(missing) > 0) {
-    missing_components <- lapply(
-      missing, append,
-      c("home", "sidebar", "components"),
-      after = 0
-    )
-    missing_fields <- pkgdown_fields(pkg = pkg, fields = missing_components)
-
-    abort(
-      sprintf(
-        "Can't find component%s %s.",
-        if (length(missing) > 1) "s" else "",
-        paste0(
-          missing_fields, collapse = " nor "
-        )
-      )
-    )
+    abort_missing(missing, where = c("home", "sidebar", "components"), pkg)
   }
 
   sidebar_final_components <- purrr::compact(
@@ -135,20 +120,20 @@ default_sidebar_structure <- function() {
 
 data_home_component <- function(component, component_name, pkg) {
 
-  if (!all(c("title", "html") %in% names(component))) {
+  if (!all(c("title", "text") %in% names(component))) {
     abort(
       sprintf(
         "Can't find %s for the component %s",
         paste0(
-          c("title", "html")[!c("title", "html") %in% names(component)],
+          c("title", "text")[!c("title", "text") %in% names(component)],
           collapse = " nor "
           ),
         pkgdown_field(pkg = pkg, "home", "sidebar", "components", component_name)
         )
       )
   }
 
-  sidebar_section(component$title, bullets = component$html)
+  sidebar_section(component$title, bullets = markdown_text2(component$text))
 }
 
 data_home_sidebar_links <- function(pkg = ".") {

diff --git a/R/build-home.R b/R/build-home.R
@@ -127,6 +127,7 @@
 #' The example below creates a sidebar whose only components will be the
 #' authors section, a custom section, and a Dev Status section if there are
 #' badges.
+#' The `text` can be Markdown or HTML.
 #'
 #' ```
 #' home:
@@ -135,7 +136,7 @@
 #'     components:
 #'       custom:
 #'         title: Funding
-#'         html: We are grateful for funding!
+#'         text: 'We are *grateful* for funding!'
 #' ```
 #'
 #' You can provide a ready-made sidebar HTML:

diff --git a/R/build.r b/R/build.r
@@ -309,6 +309,23 @@
 #'    deploy:
 #'      install_metadata: true
 #'    ```
+#' @section YAML config - footer:
+#' By default, the footer is automatically populated with:
+#' * the names of the authors `authors`, on the left;
+#' * a reference to pkgdown `pkgdown`, on the right.
+#'
+#' The example below puts the authors information on the right together with
+#' a legal disclaimer, and puts pkgdown on the left.
+#'
+#' ```
+#' footer:
+#'   left:
+#'     structure: [pkgdown]
+#'   right:
+#'     structure: [authors, legal]
+#'     components:
+#'       legal: 'Provided without ***any warranty***.'
+#' ```
 #'
 #' @section Options:
 #' Users with limited internet connectivity can disable CRAN checks by setting

diff --git a/R/markdown.R b/R/markdown.R
@@ -68,3 +68,15 @@ markdown_text <- function(text, ...) {
   write_lines(text, path = tmp)
   markdown(tmp, ...)
 }
+
+
+markdown_text2 <- function(text, ...) {
+  html <- markdown_text(text, ...)
+  html %>%
+    xml2::read_html() %>%
+    xml2::xml_child() %>% # body
+    xml2::xml_child() %>% # p
+    xml2::xml_contents() %>%
+    as.character() %>%
+    paste(collapse = "")
+}
diff --git a/R/render.r b/R/render.r
@@ -40,6 +40,8 @@ render_page <- function(pkg = ".", name, data, path = "", depth = NULL, quiet =
     data$site$root <- paste0(pkg$meta$url, "/")
   }
 
+  data$footer <- pkgdown_footer(data, pkg)
+
   # render template components
   pieces <- c(
     "head", "navbar", "header", "content", "docsearch", "footer",
@@ -301,3 +303,64 @@ check_made_by <- function(first) {
   if (length(first) == 0L) return(FALSE)
   grepl("<!-- Generated by pkgdown", first, fixed = TRUE)
 }
+
+pkgdown_footer <- function(data, pkg) {
+  footer_components <- list(
+    authors = footer_authors(data),
+    pkgdown = footer_pkgdown(data)
+  )
+
+  # footer left
+  left_structure <- pkg$meta$footer$left$structure %||% c("authors")
+
+  left_components <- utils::modifyList(
+    footer_components,
+    purrr::map(pkg$meta$footer$left$components, markdown_text2) %>%
+      set_names(names(pkg$meta$footer$left$components))
+  )
+
+  missing <- setdiff(left_structure, names(left_components))
+
+  if (length(missing) > 0) {
+    abort_missing(missing, where = c("footer", "left", "components"), pkg)
+  }
+
+  left_final_components <- purrr::compact(
+    paste0(left_components[left_structure], collapse = " ")
+  )
+
+  # footer right
+  right_structure <- pkg$meta$footer$right$structure %||% c("pkgdown")
+
+  right_components <- utils::modifyList(
+    footer_components,
+    purrr::map(pkg$meta$footer$right$components, markdown_text2) %>%
+      set_names(names(pkg$meta$footer$right$components))
+  )
+
+  missing <- setdiff(right_structure, names(right_components))
+
+  if (length(missing) > 0) {
+    abort_missing(missing, where = c("footer", "right", "components"), pkg)
+  }
+
+  right_final_components <- purrr::compact(
+    paste0(right_components[right_structure], collapse = " ")
+  )
+
+  list(left = left_final_components, right = right_final_components)
+}
+
+footer_authors <- function(data) {
+  whisker::whisker.render(
+    "{{#package}}Developed by {{{authors}}}.{{/package}}",
+    data
+  )
+}
+
+footer_pkgdown <- function(data) {
+  whisker::whisker.render(
+    'Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> {{#pkgdown}}{{version}}{{/pkgdown}}.',
+    data
+  )
+}
diff --git a/R/utils.r b/R/utils.r
@@ -130,6 +130,25 @@ pkgdown_fields <- function(pkg, fields) {
   pkgdown_field(pkg, fields)
 }
 
+abort_missing <- function(missing, where, pkg) {
+  missing_components <- lapply(
+      missing, append,
+      where,
+      after = 0
+    )
+    missing_fields <- pkgdown_fields(pkg = pkg, fields = missing_components)
+
+    abort(
+      sprintf(
+        "Can't find component%s %s.",
+        if (length(missing) > 1) "s" else "",
+        paste0(
+          missing_fields, collapse = " nor "
+        )
+      )
+    )
+}
+
 #' @export
 print.print_yaml <- function(x, ...) {
   cat(yaml::as.yaml(x), "\n", sep = "")

diff --git a/inst/templates/BS3/footer.html b/inst/templates/BS3/footer.html
@@ -1,7 +1,7 @@
 <div class="copyright">
-  <p>{{#package}}Developed by {{{authors}}}.{{/package}}</p>
+  <p>{{#footer}}{{#left}}{{{.}}}{{/left}}{{/footer}}</p>
 </div>
 
 <div class="pkgdown">
-  <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> {{#pkgdown}}{{version}}{{/pkgdown}}.</p>
+  <p>{{#footer}}{{#right}}{{{.}}}{{/right}}{{/footer}}</p>
 </div>
diff --git a/man/build_home.Rd b/man/build_home.Rd
diff --git a/man/build_site.Rd b/man/build_site.Rd
diff --git a/tests/testthat/_snaps/data_home_sidebar.md b/tests/testthat/_snaps/data_home_sidebar.md
@@ -35,12 +35,12 @@
 # data_home_sidebar() can get a custom component
 
     Code
-      xml2::xml_find_first(result, ".//div[@class='fancy-section']")
+      xml2::xml_find_first(xml2::xml_find_first(result,
+        ".//div[@class='fancy-section']"), ".//ul")
     Output
       {html_node}
-      <div class="fancy-section">
-      [1] <h2>Fancy section</h2>
-      [2] <ul class="list-unstyled">\n<li>How cool is pkgdown?!</li>\n</ul>
+      <ul class="list-unstyled">
+      [1] <li>How <em>cool</em> is pkgdown?!</li>
 
 # data_home_sidebar() outputs informative error messages
 
@@ -56,5 +56,5 @@
 
 ---
 
-    Can't find title nor html for the component home.sidebar.components.fancy in '_pkgdown.yml'
+    Can't find title nor text for the component home.sidebar.components.fancy in '_pkgdown.yml'
 
diff --git a/tests/testthat/_snaps/pkgdown_footer.md b/tests/testthat/_snaps/pkgdown_footer.md
@@ -0,0 +1,44 @@
+# pkgdown_footer() works by default
+
+    Code
+      pkgdown_footer(data, pkg)
+    Output
+      $left
+      [1] "Developed by bla."
+
+      $right
+      [1] "Site built with <a href=\"https://pkgdown.r-lib.org/\">pkgdown</a> 42."
+
+
+# pkgdown_footer() can use custom components
+
+    Code
+      pkgdown_footer(data, pkg)
+    Output
+      $left
+      [1] "Developed by bla. <strong><em>Wow</em></strong>"
+
+      $right
+      [1] "Site built with <a href=\"https://pkgdown.r-lib.org/\">pkgdown</a> 42."
+
+
+---
+
+    Code
+      pkgdown_footer(data, pkg)
+    Output
+      $left
+      [1] "<strong><em>Wow</em></strong>"
+
+      $right
+      [1] "Site built with <a href=\"https://pkgdown.r-lib.org/\">pkgdown</a> 42."
+
+
+# pkgdown_footer() throws informative error messages
+
+    Can't find component footer.left.components.pof in '_pkgdown.yml'.
+
+---
+
+    Can't find component footer.right.components.bof in '_pkgdown.yml'.
+