Improve usage of fenced divs for Theorem and Proof environment #1145

cderv · 2021-04-20T14:26:31Z

This PR closes #1143

After all I think it is best the bookdown does not interfere with beamer. beamer defines its own theorem env with some not supported by bookdown. So it would be lead to have a specific syntax for some env supported by bookdown and another syntax for other

::: {.lemma name="my name"}
`lemma` is known by bookdown
:::

::: {.fact data-latex='[Special]'}
fact is not known but define by beamer. It would only work in beamer.
:::

If we don't process beamer output, this means that the syntax is

::: {.lemma data-latex="[my name]"}
Using `data-latex` works also as `latex`
:::

::: {.fact data-latex='[Special]'}
Using beamer own definintion environment not in **bookdown** works with the same syntax
:::

The syntax offer by bookdown is there because we want the same type of output for these supported environment for HTML and PDF book. I am not sure that when bookdown is used with beamer, the gitbook() format is also one output. is it ?

The Lua filter is now easy to change - providing support for beamer with bookdown syntax would mean changing this only

diff --git a/inst/rmarkdown/lua/custom-environment.lua b/inst/rmarkdown/lua/custom-environment.lua
index d7d389e5..4986f9d2 100644
--- a/inst/rmarkdown/lua/custom-environment.lua
+++ b/inst/rmarkdown/lua/custom-environment.lua
@@ -133,7 +133,7 @@ Div = function (div)
     print_debug("label for reference -> ", label)

     -- TODO: should we support beamer also ?
-    if (FORMAT:match 'latex') then
+    if (FORMAT:match 'latex' or FORMAT:match 'beamer') then
         local label_part
         if label then
             label_part = string.format("\\protect\\hypertarget{%s}{}\\label{%s}", label, label)
@@ -192,7 +192,7 @@ Div = function (div)
 end

 -- only run filter for supported format
-if (FORMAT:match 'html' or FORMAT:match 'latex') then
+if (FORMAT:match 'html' or FORMAT:match 'latex' or FORMAT:match 'beamer') then
     return {{Meta = Meta}, {Div = Div}}
 else
     print_debug("Lua Filter skipped. Output format not supported:", FORMAT)

So @yihui this is as we discussed : skip bookdown Lua custom environment processing for beamer usage.
I think you know the pro & cons now.

@XiangyunHuang, the below is what is working now with this PR what are your thought ?

Examples

---
title: "beamer"
output: 
  bookdown::beamer_presentation2:
    toc: no
    latex_engine: xelatex
    citation_package: natbib
    theme: Xiaoshan # https://www.ctan.org/pkg/pgfornament-han 
    template: null
link-citations: yes
colorlinks: yes
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = FALSE)
```

## some blocks from beamer theme [*Xiaoshan*](https://github.com/liantze/pgfornament-han/)

::: {.block latex="{Metropolis}"}
block is ok.
:::

::: {.exampleblock latex="{Metropolis}"}
exampleblock is also ok.
:::

::: {.theorem latex="[Metropolis]"}
theorem is now ok.
:::

## Some other blocks

::: {.lemma data-latex="[Metropolis]"}
Using `data-latex` works also as `latex`
:::

::: {.fact data-latex='[Special]'}
Using beamer own definintion environment not in **bookdown** works with the same syntax
:::

Also this would work using `rmarkdown::beamer_presentation` without change

Changes

do not add \newtheorem in preamble when output is beamer format. This fixes the use of bookdown special environment that are using block2 knitr engine.
Only support specific format - beamer defines its own environment so we don't let bookdown feature interfere.
Improve lua filter base on latex-divs.lua in rmarkdown

This fixes the use of bookdown special environment that are using block2 knitr engine.

this defers to latex-div.lua in rmarkdown for processing of the div.

This is useful for rticles format than can define environment in .cls Closes #1001

…div" This reverts commit da896b8. it is better to still ignore the attributes used for rmarkdown filter

[skip ci]

XiangyunHuang · 2021-04-21T11:34:39Z

all works well in beamer, but not book documentclass.

Here is a minimal example.

---
title: "book"
output: 
  bookdown::pdf_book:
    toc: no
    latex_engine: xelatex
    citation_package: natbib
    template: null
link-citations: yes
colorlinks: yes
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = FALSE)
```

## some blocks from book


::: {.theorem data-latex="[Metropolis]"}
[WARNING] data-latex attribute can't be used with one of bookdown custom environment. It has been removed.
:::


::: {.theorem name="Metropolis"}
NO WARNING. theorem is ok.
:::


## Some other blocks

::: {.lemma data-latex="[Metropolis]"}
[WARNING] data-latex attribute can't be used with one of bookdown custom environment. It has been removed.
:::

The output is ok.

My session info

xfun::session_info(c('bookdown', 'rmarkdown'))
R version 4.0.3 (2020-10-10)
Platform: x86_64-apple-darwin17.0 (64-bit)
Running under: macOS Big Sur 10.16, RStudio 1.3.1093

Locale: en_US.UTF-8 / en_US.UTF-8 / en_US.UTF-8 / C / en_US.UTF-8 / en_US.UTF-8

Package version:
  base64enc_0.1.3   bookdown_0.21.11  digest_0.6.27     evaluate_0.14     glue_1.4.2       
  graphics_4.0.3    grDevices_4.0.3   highr_0.9         htmltools_0.5.1.1 jsonlite_1.7.2   
  knitr_1.32        magrittr_2.0.1    markdown_1.1      methods_4.0.3     mime_0.10        
  rlang_0.4.10      rmarkdown_2.7.12  stats_4.0.3       stringi_1.5.3     stringr_1.4.0    
  tinytex_0.31.4    tools_4.0.3       utils_4.0.3       xfun_0.22         yaml_2.2.1       

Pandoc version: 2.13

cderv · 2021-04-21T12:27:14Z

With bookdown::pdf_book, the syntax is the current working one

::: {.env #id name="NAME"}
:::

with

env one of bookdown supported environment, ``
#id the identifier to use to reference theorem-like block
name= the name to append in parenthesis after the env name

So you example should be

---
title: "book"
output: 
  bookdown::pdf_book:
    toc: no
    latex_engine: xelatex
    citation_package: natbib
    template: null
link-citations: yes
colorlinks: yes
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = FALSE)
```

## some blocks from book

::: {.theorem name="Metropolis"}
A theorem
:::


## Some other blocks

::: {.lemma name="Metropolis"}
A lemma
:::

To be clear, this is the way it is supposed to work without this PR. it works this way for HTML and PDF format.
beamer is not supported though because of its specificity - it is your issue.

Do you expect the same syntax with bookdown::beamer_presentation2 ?

I really appreciate your feedback because I have a hard time choosing the correct solution for beamer.

XiangyunHuang · 2021-04-21T15:08:30Z

Do you expect the same syntax with bookdown::beamer_presentation2 ?

Yes. I feel better if they stay the same.

cderv · 2021-04-21T15:35:01Z

Ok I could change that.

However, here are the limitations this will lead to:

bookdown's special syntax with name= attributes could be used with beamer_presentation2 only for environment defined in beamer and known by bookdown, as listed in don't respect beamer theme's buildin theorem/proof block #1143 (comment) (so theorem, lemma, corollary, definition, example, solution).
Other environment known by bookdown could be used if user defines them in a preamble.tex (so proposition, conjecture, exercise, hypothesis, remark)
For environment known only by beamer, the data-latex= or latex= syntax should be used. (so I think fact, problem, block and exampleblock).

So

For common environment known by bookdown, the syntax would be the same between pdf_document2, pdf_book and beamer_document2
For special beamer env, the syntax would be different. Also pdf_* format would not about those.

Is that ok ?

XiangyunHuang · 2021-04-21T15:53:42Z

OK, That's awesome! Thanks for your patience and great work!

yihui

I didn't review the Lua script carefully. Feel free to merge whenever both you and @XiangyunHuang are happy with the PR. Thanks!

R/latex.R

Co-authored-by: Yihui Xie <[email protected]>

cderv · 2021-04-21T16:18:46Z

@XiangyunHuang let's try that then. I'll push the change for you to test.

@yihui this is only a matter of choice with the syntax to use for beamer and related potential limitation if we support the bookdown syntax. If you have an opinion feel free to share. Otherwise I'll merge it as soon as we are ok with @XiangyunHuang

About the Lua filter, the changes are mainly to update based on latex-div.lua in rmarkdown as this is almost the same here that we are doing. It is also only about applying the filter for some known format to avoid issue with other unsupported format.

cderv · 2021-04-21T16:27:06Z

@XiangyunHuang if you reinstall new this PR this is the syntax to use

---
title: "book"
output: 
  bookdown::beamer_presentation2:
    toc: no
    latex_engine: xelatex
    theme: Xiaoshan
    citation_package: natbib
    template: null
link-citations: yes
colorlinks: yes
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = FALSE)
```

## some blocks from book

::: {.theorem name="Metropolis"}
A theorem
:::

::: {.lemma name="Metropolis"}
A lemma
:::

## Some other blocks

::: {.fact latex="[A fact]"}
Some interesting stuff
:::

::: {.problem latex=true}
A problem
:::

theorem and lemma are supported by bookdown, so you can use the name= syntax
fact and problem are only know by beamer so you can use them in a beamer format but you need to use the classic custom block syntax from rmarkdown (latex= or data-latex=)

Are we merging this ? 😄

XiangyunHuang · 2021-04-22T00:52:26Z

@cderv only one small problem, theorem and lemma block have extra blank line.

cderv · 2021-04-22T09:11:20Z

Yes, there is an extra line where add the \label part to allow referencing. That is the main value of bookdown feature. It seems this happens when a theme is used

I don't get this extraline when using default

Basically, the Lua filter here will insert a \label for referencing and it seems to cause this new lines when a beamer theme is used. This label is need in other format for the referencing. If I compile a document with this syntax in pure LaTeX, then we get the new line

---
title: "book"
output: 
  beamer_presentation:
    keep_tex: true
    toc: no
    latex_engine: xelatex
    theme: Xiaoshan
    citation_package: natbib
    template: null
link-citations: yes
colorlinks: yes
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = FALSE)
```

## some blocks from book

\begin{theorem}[Metropolis]
\label{thm:th1}A theorem with a label to reference
\end{theorem}

\begin{theorem}[Metropolis]
Another one without 
\end{theorem}

## Some other blocks

See Theorem \ref{thm:th1}

So what is the expected syntax in LaTeX for this ?
Are referencing not used with beamer theorem environment ?

If they aren't I don't think there is any value of using bookdown special handling of this environment and that we should only allow the other syntax for beamer presentation.

I could maybe remove this label insertion if there is no id provided in the div (no #id) but it will still insert a blank line if used with beamer.

For HTML we need to generate a dummy label so that the numbering of environment works even if they won't be reference

cderv · 2021-04-22T10:39:34Z

I could maybe remove this label insertion if there is no id provided in the div (no #id) but it will still insert a blank line if used with beamer.

I did that because we don't need to insert \label{} where there is no explicit id provided in the fenced div.

This should work better for you now I guess. But there would still be the new line inserted if you provided an id to use as a label reference.

Is this last change better ?

@yihui I added manual test file for visual inspection that everything is ok. I hope it is fine.

yihui · 2021-04-23T03:22:07Z

I added manual test file for visual inspection that everything is ok. I hope it is fine.

That's totally fine. Thanks!

cderv · 2021-04-23T07:29:35Z

@XiangyunHuang just waiting for you confirmation before merging this PR. Hope it is ok for you now. I think so but I prefer to check. Thanks !

XiangyunHuang · 2021-04-23T13:58:46Z

@XiangyunHuang just waiting for you confirmation before merging this PR. Hope it is ok for you now. I think so but I prefer to check. Thanks !

It's OK. Thanks

[skip ci]

do not add \newtheorem in preamble when output is beamer format

fa264eb

This fixes the use of bookdown special environment that are using block2 knitr engine.

cderv mentioned this pull request Apr 20, 2021

don't respect beamer theme's buildin theorem/proof block #1143

Closed

cderv added 8 commits April 20, 2021 17:51

only run filter for supported formats

4a8b083

if data-latex or latex is provided as attributes, return div

da896b8

this defers to latex-div.lua in rmarkdown for processing of the div.

add debug log

526eee8

not is not supported I as expected

ec20ee9

support beamer for bookdown special env

704eede

remove debug logging

89741a1

add an option to opt-out bookdown adding definitions in preamble

1ed8f55

This is useful for rticles format than can define environment in .cls Closes #1001

Revert "if data-latex or latex is provided as attributes, return …

0565b6d

…div" This reverts commit da896b8. it is better to still ignore the attributes used for rmarkdown filter

cderv linked an issue Apr 20, 2021 that may be closed by this pull request

theorem like environment are conflicted with template using cls file that already define it. #1001

Closed

cderv added 4 commits April 21, 2021 11:11

fix filter to be closer to latex-div.lua in rmarkdown

269982b

Add missing new environment in test file

1ee277c

skip this filter on Beamer

fee1d19

[skip ci]

tweak comment

9cab57f

[skip ci]

cderv changed the title ~~Beamer support for special environments Theorem and Proof~~ Improve usage of fenced divs for Theorem and Proof environment Apr 21, 2021

cderv marked this pull request as ready for review April 21, 2021 10:05

yihui approved these changes Apr 21, 2021

View reviewed changes

R/latex.R Outdated Show resolved Hide resolved

Update R/latex.R

b4a8473

Co-authored-by: Yihui Xie <[email protected]>

support beamer for special environment syntax of bookdown

7aec24c

Explicitly print "nil" in debug to differentiate from empty string

d4b7260

cderv added 2 commits April 22, 2021 12:17

Add manual test folder and example in the repo

8685389

For LaTeX, don't insert \label{} if no id explicitly provided.

8ab7ab0

For HTML we need to generate a dummy label so that the numbering of environment works even if they won't be reference

cderv added 3 commits April 23, 2021 16:45

Merge branch 'master' into block-beamer-support

d89a9ab

Document changes in NEWS

7d293fd

bump version

aa34659

[skip ci]

cderv merged commit 2d692ba into master Apr 23, 2021

cderv deleted the block-beamer-support branch April 23, 2021 15:08

cderv mentioned this pull request Apr 27, 2021

Support beamer for the ne theorem environment using fenced divs #978

Closed

cderv added this to the v0.23 milestone Apr 27, 2021

cderv mentioned this pull request Aug 20, 2021

Fix issue with Theorem Fenced div block in Lua filter #1235

Merged

github-actions bot locked as resolved and limited conversation to collaborators Oct 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve usage of fenced divs for Theorem and Proof environment #1145

Improve usage of fenced divs for Theorem and Proof environment #1145

Uh oh!

cderv commented Apr 20, 2021 •

edited

Loading

Uh oh!

XiangyunHuang commented Apr 21, 2021

Uh oh!

cderv commented Apr 21, 2021 •

edited

Loading

Uh oh!

XiangyunHuang commented Apr 21, 2021

Uh oh!

cderv commented Apr 21, 2021 •

edited

Loading

Uh oh!

XiangyunHuang commented Apr 21, 2021 •

edited by yihui

Loading

Uh oh!

yihui left a comment

Uh oh!

Uh oh!

cderv commented Apr 21, 2021

Uh oh!

cderv commented Apr 21, 2021

Uh oh!

XiangyunHuang commented Apr 22, 2021

Uh oh!

cderv commented Apr 22, 2021

Uh oh!

cderv commented Apr 22, 2021

Uh oh!

yihui commented Apr 23, 2021

Uh oh!

cderv commented Apr 23, 2021

Uh oh!

XiangyunHuang commented Apr 23, 2021

Uh oh!

Uh oh!

Improve usage of fenced divs for Theorem and Proof environment #1145

Improve usage of fenced divs for Theorem and Proof environment #1145

Uh oh!

Conversation

cderv commented Apr 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Examples

Changes

Uh oh!

XiangyunHuang commented Apr 21, 2021

Here is a minimal example.

My session info

Uh oh!

cderv commented Apr 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

XiangyunHuang commented Apr 21, 2021

Uh oh!

cderv commented Apr 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

XiangyunHuang commented Apr 21, 2021 • edited by yihui Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yihui left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cderv commented Apr 21, 2021

Uh oh!

cderv commented Apr 21, 2021

Uh oh!

XiangyunHuang commented Apr 22, 2021

Uh oh!

cderv commented Apr 22, 2021

Uh oh!

cderv commented Apr 22, 2021

Uh oh!

yihui commented Apr 23, 2021

Uh oh!

cderv commented Apr 23, 2021

Uh oh!

XiangyunHuang commented Apr 23, 2021

Uh oh!

Uh oh!

cderv commented Apr 20, 2021 •

edited

Loading

cderv commented Apr 21, 2021 •

edited

Loading

cderv commented Apr 21, 2021 •

edited

Loading

XiangyunHuang commented Apr 21, 2021 •

edited by yihui

Loading