create_sidebar_item: Create a single item that appears in the sidebar

In zkamvar/sandpaper: Create and Curate Carpentries Lessons

Create a single item that appears in the sidebar

Description

Varnish uses a sidebar for navigation across and within an episode. This funciton will create a sidebar item for a single episode, providing a dropdown menu of the sections within the episode if it is labeled as the current episode.

Usage

create_sidebar_item(nodes, link, position)

create_sidebar_headings(nodes)

Arguments

nodes	html nodes of a webpage generated from render_html() or parsed from xml2 that have level 2 section headings with the class section-heading
link	a character vector of length 1 that defines the HTML links to be used as the node for the sidebar item.
position	either a number or "current", if "current", then the html is parsed for second level headings to list in the sidebar navigation.

Value

a character vector with a div item to insert into the sidebar navigation

Examples

snd <- asNamespace("sandpaper")
html <- c(
  "<section id='one'><h2 class='section-heading'>Section 1</h2><p>section 1</p></section>",
  "<section id='two'><h2 class='section-heading'>Section 2</h2><p>section 2</p></section>"
)
nodes <- xml2::read_html(paste(html, collapse = "\n"))

# The sidebar headings are extracted from the nodes
writeLines(snd$create_sidebar_headings(nodes))

link <- "<a href='https://example.com/this-page.html'><em>This Page</em></a>"

# the sidebar item will contain the headings if it is the current chapter
writeLines(snd$create_sidebar_item(nodes, link, position = "current"))

# it will be an ordinary link otherwise
writeLines(snd$create_sidebar_item(nodes, link, position = 3))

zkamvar/sandpaper documentation built on Sept. 5, 2024, 6:21 a.m.