Add a closeread in a quarto book on gitlab-pages

[Douxvalkyn]

Hello !
How can I add a closeread into an existing quarto book on gitlab-pages ?
When I try, the closeread.html page doesn't scroll and therefore doesn't work. Outside the quarto book, my closeread.html is OK.
My _quarto.yml look like this:

project:
  type: book
  output-dir: _book

book:
  title: "Etude"
  date: today
  date-format: "DD/MM/YYYY"
  navbar:
    background: primary
  page-navigation: true
  back-to-top-navigation: true
  chapters:
    - index.qmd
    - closeread.qmd
    - part: "A"
      chapters: 
        - quarto/page0.qmd
        - quarto/page1.qmd
        - quarto/page2.qmd
        - quarto/page3.qmd
        - quarto/page4.qmd
    - part: "B"
      chapters:
        - quarto/plan.qmd
        - quarto/text.qmd
        - quarto/figures.qmd
    - quarto/biblio.qmd


format: 
  html:
    page-layout: full 
    theme: cosmo
    css: styles.css
    number-depth: 6
    toc: TRUE
    toc-depth: 6
    toc-title: Sommaire
    date-format: "DD/MM/YYYY"
    echo: true
    code-fold: true 

It works beside the quarto book, but not into the quarto book;
this artifact is OK:
public/
public/_extensions
public/closeread_files
public/data
public/quarto
public/closeread.html
public/index.html

[factorialmap]

I haven't tried this with book, but with website I changed the qmd header and it worked.

---
title: ""
format:
  closeread-html:
    cr-style:
      narrative-background-color-overlay: "#9e948f"
      narrative-text-color-overlay: "#f1e3dd"
      narrative-background-color-sidebar: "#563f46"
      narrative-text-color-sidebar: "#f1e3dd"
---

[andrewpbray]

Hi @Douxvalkyn , thanks for your message. Could you point me to a public repo that has both the book and the closeread-html document so that I can have a look at how all of the metadata is set up?

This issue is related to #99 : the sidebar of a book (or a website with sidebar nav) can throw off the layout the closeread uses. We certainly plan on making this possible, though, so if you have a full reproducible example, that's help!

[jimjam-slam]

I've just done a quick test, @andrewpbray, starting from quarto create book and then adding a cr.qmd:

---
title: "Closeread test"
format:
  closeread-html:
    style:
      section-background-color: lemonyellow
---

:::{style="color: slategrey; font-style: italic"}
Test test test
:::

::::{.cr-section}

Closeread enables scrollytelling.

Draw your readers attention with: @cr-features

:::{#cr-features}
1. Highlighting
2. Zooming
3. Panning
:::

::::

I've thrown in a debugging statement at the top of closeread.lua, and it isn't printing (and also citeproc complains about the citation). So it seems like Closeread isn't running at all in a book project. I wonder why, though — I have no reason to assume that HTML filters can't run when you're generating an HTML book 🤔

EDIT: In my testing, Closeread does not run if your book's default format is set to html in _quarto.yml and you override it with format: closeread-html in the document front matter... but if you set the book's default format to closeread-html in the _quarto.yml, it does run (although the book sidebar gets in the way if you don't also set sidebar: false).

Not sure if it was the Quarto team's intention to have HTML custom format filters not run if you only set the custom format in the individual document!

@Douxvalkyn, in the short term, you may find that you're able to get Closeread to work by moving the format.html spec from your _quarto.yml to the front matter of your non-Closeread pages and then changing it to closeread-html on the _quarto.yml... I understand if that's not a satisfying solution, though, as in most cases I'd imagine there are far more HTML pages than Closeread ones!

[Douxvalkyn]

@jimjam-slam
I set my book project this way:
format: closeread-html in my _quarto.yml, then format: closeread-html for my closeread.qmd page and format:html for other .qmd pages.

It works perfectly, thanks ! :)
I can see my closeread page in the menu of my book and it's really a closeread.
But I can't see the sidebar and come back to my menu (not very important).

[jimjam-slam]

@Douxvalkyn Yeah, we still need to give proper consideration to the sidebar! I'm glad the basics are working for you, though 😊