R/format_toc_entry.R

In johnaclouse/curios: Curios Used in Support of Practical Data Science

#' Format individual table of contents line
#'
#' The function is used for its side-effect of printing a table of contents
#' entry.
#'
#' @param entry a character string to be converted to a Table of Contents entry.
#' @param padding a character string to be added to the front of the entry string
#'   typically for indentation purposes.
#' @param html_file URL for the page containing the node. Defaults to \code{""}
#'   indicating current page.
#'
#' @keywords internal
#'
#' @return NULL
#' @export
#'
#' @examples
#' format_toc_entry(c("Header 1", "Header 2"))
#' format_toc_entry("Header 1", "---->", "mypage.html")
format_toc_entry <- function(entry,
                             padding = "2em",
                             html_file = ""){
  transformed_entry <-
    stringr::str_replace_all(tolower(entry), " ", "-")

  cat(glue::glue("<span  style=\"padding-left: {padding}; text-indent: -{padding};\">"))
  cat(glue::glue("[{entry}]({html_file}#{transformed_entry})"), "<BR>\n")
  cat("</span>")
}