set_globals: Set the necessary common global variables for use in the...

In zkamvar/sandpaper: Create and Curate Carpentries Lessons

Set the necessary common global variables for use in the {varnish} template.

Description

This will enforce four global lists:

Usage

set_globals(path)

Arguments

path	the path to the lesson

Details

1. .resources, which is equivalent to the output of get_resource_list()

2. this_metadata, which contains the metadata common for the lesson

3. learner_globals the navigation items for the learners

4. instructor_globals the namvigation items for the instructors

The things that are added:

• sidebar This is generated from create_sidebar() and is the same in the learner and instructor globals with the exception of the first element.

• more This is the "More" dropdown menu, which is created via create_resources_dropdown().

• resources The same as "More", but positioned on the mobile sidebar.

• ⁠{sandpaper,varnish,pegboard}_version⁠ package versions of each package.

zkamvar/sandpaper documentation built on Feb. 2, 2025, 5:17 p.m.