Skip to content

Latest commit

 

History

History
146 lines (109 loc) · 3.53 KB

README.md

File metadata and controls

146 lines (109 loc) · 3.53 KB
title author
Not-in-format - Keep document parts out of selected output formats
Julien Dutant

Not-in-format

Keeps parts of a document out of selected output formats.

v1.0. Copyright: © 2021 Julien Dutant [email protected] License: MIT - see LICENSE file for details.

Usage

This Lua filter for Pandoc that keeps parts of a document out of/in selected outputs formats.

At a glance

::: {.not-in-format .latex .html}
This part will not be used in LaTeX output and html output.
:::

::: {.only-in-format .latex .html}
This part will only be used in LaTeX output or html output.
:::

Use case

Use case 1. Sometimes a bit of markdown will convert well through Pandoc to some formats not others. Say, you have a table that is reasonably well converted to html and docx, but you want more control on the LaTeX output. This filter allows you to:

Use case 2. You provide separate markdown and LaTeX code, but also want to use markdown code (e.g. citations) within the LaTeX part. You can't use Pandoc's {=latex} attribute on Raw code for that purpose.

Usage

Mark up the part you want to keep out of some output format(s) as a native Div with the attributes not-in-format and the names of the format(s) in question:

::: {.not-in-format .latex .beamer}

---------------------------
This table   is not kept
----------- ----------------
in formats    latex, beamer
----------------------------

:::

Use format names for Pandoc's list of output formats, which you can print out by running pandoc --list-output-formats.

You would normally provide a raw equivalent for the part in question in the format(s) in question, using Pandoc's fenced blocks with a raw attribute:

::: {.not-in-format .latex .beamer}

---------------------------
This table   is not kept
----------- ----------------
in formats    latex, beamer
----------------------------

:::

~~~{=latex}

\begin{tabular}{|c|c|}
\toprule
This table & is not kept \\ \addlinespace
\midrule
\endhead
in formats & latex, beamer \\ \addlinespace
\bottomrule
\end{tabluar}

~~~

A fenced block with a raw attribute can only have one attribute, so you need one for each format for which the markdown is left out. But Pandoc will output the raw block in equivalent formats: a latex block will be output in latex and beamer, a html5 block in html and epub3 and so on. See Pandoc's manual.

The only-in-format approach is needed if you want your LaTeX part to use Pandoc's markdown, e.g. for citations.

::: {.not-in-format .latex .beamer}

---------------------------
This table   is not kept
----------- ----------------
in formats    latex, beamer
----------------------------
: Data from @Smith2012.

:::

::: {.only-in-format .latex}

`\begin{tabular}{|c|c|}`{=latex}
`\caption{`{=latex} Data from @Smith 2012.
`}`{=latex}

```{=latex}
\toprule
This table & is not kept \\ \addlinespace
\midrule
\endhead
in formats & latex, beamer \\ \addlinespace
\bottomrule
\end{tabluar}

:::


Installation
------------

Copy `not-in-format.lua` in your document folder or in your pandoc data
dir path.

Contributing
------------

PRs welcome.