jgm/pandoc

`RawBlock` and `raw_attributes` does not always respect the FORMAT or `--to` value

Open

#8,880 opened on May 30, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Haskell (44,133 stars) (3,850 forks)batch import
buggood first issue

Description

From documentation, pandoc.RawBlock and raw_attributes are supposed to respect the FORMAT or --to value

  • For raw_attributes, doc says https://pandoc.org/MANUAL.html#extension-raw_attribute

    The format name should match the target format name (see -t/—to, above, for a list, or use pandoc —list-output-formats)

  • For pandoc.RawBlock only says format of content without much precision.

I would think that pandoc.RawBlock(FORMAT, text) would work, but FORMAT is

The global FORMAT is set to the format of the pandoc writer being used (html5, latex, etc.), so the behavior of a filter can be made conditional on the eventual output format.

but it seems this don’t work in some case like revealjs

```{=revealjs}
content
```

does not get included in output, only using html works. Same with pandoc.RawBlock()

I believe other format like epub will be the same.

It seems for some format there is a matching done, like with beamer for latex format https://github.com/jgm/pandoc/blob/0e0c00db5159c6edad01b95a5b3047315fb40780/src/Text/Pandoc/Writers/LaTeX.hs#L467-L474

but for other like in HTML, only html will be recognized for RawBlock https://github.com/jgm/pandoc/blob/0e0c00db5159c6edad01b95a5b3047315fb40780/src/Text/Pandoc/Writers/HTML.hs#L908-L920

https://github.com/jgm/pandoc/blob/0e0c00db5159c6edad01b95a5b3047315fb40780/src/Text/Pandoc/Writers/HTML.hs#L1737-L1741

Probably all the slides format should be added in there ?

Though it seems epub also has this issue https://github.com/jgm/pandoc/blob/0e0c00db5159c6edad01b95a5b3047315fb40780/src/Text/Pandoc/Writers/EPUB.hs#L1166-L1170 https://github.com/jgm/pandoc/blob/0e0c00db5159c6edad01b95a5b3047315fb40780/src/Text/Pandoc/Writers/EPUB.hs#L1157-L1161

as epub won't be recognized as a valid rawBlock format.

Hopefully this is clear enough. I can show more example.

I would expect --to format to work in ```{=format} syntax, and also pandoc.RawBlock(FORMAT, ...) to work too.

Originally posted in https://groups.google.com/g/pandoc-discuss/c/2ffxC1uLh2M

Contributor guide

Tech stack
None
Domain
documentationbackend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
HaskellPandoc writersRawBlock handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
The issue describes that RawBlock and raw attributes only recognize base formats like 'html' or 'latex' but not derived formats like 'revealjs' or 'epub'. The fix requires adding these derived format names to the list of accepted raw formats in the respective writer files: src/Text/Pandoc/Writers/HTML.hs (lines 908-920, 1737-1741) for revealjs, and src/Text/Pandoc/Writers/EPUB.hs (lines 1157-1161, 1166-1170) for epub. The maintainer should clarify whether all slide formats should be mapped to 'html' or if specific formats should be added. A good approach is to create a mapping from derived format to base format in the RawBlock handler.