関数を書く

引数xをそのまま返す関数fは以下の通り。

function f(x)
  return x
end

コードブロックをそのまま返す

Pandoc’s Markdown（というよりはASTによる内部表現）の要素名と一致する関数を用意してやると、該当する要素がフィルタに送り込まれる。ドキュメントにはPandocにおける様々な種類の要素が一覧されている（https://pandoc.org/lua-filters.html#module-pandoc）。今回はコードブロックを対象としたいので、CodeBlockだ。

関数の引数は1つだけ。第二引数以降は用意してもnilが入る。そして引数をそのままreturnしてやれば、コードブロックを編集せずにそのまま返す。

function CodeBlock(elem)
  return elem
end

ちなみにreturnせずに終わった場合も入力はそのまま維持される。文字数を数えるとか内容の変更を伴わないフィルタに使うようだ。今回の最終目的は入力を置換していくことなので、returnした。

コードブロックを<detals>タグで囲む

PandocにおいてHTMLはコードブロックではなくRawBlockなので、 pandoc.RawBlockで作成してやる。 pandoc.RawBlockは第一引数が言語名（今回は"html"）で、第二引数がスクリプトである。例えばPandoc本家へのリンクをpandoc.Rawblockで表現すると以下の通りである。

pandoc.RawBlock("html", "<a href=https://pandoc.org/>Pandoc</a>") 

ところで今回は、CodeBlockを<details>と</details>で挟まなければならない。

従って

• RawBlock
• CodeBlock
• RawBlock

の順に3要素を返す必要がある。複数の値を返すには、return 1, 2やreturn{1, 2}とすればよい。後者であれば途中で改行できるので、今回は後者を利用する。

すると以下のようになる。せっかくなので、<summary>タグも入れておいた。

function CodeBlock(elem)
  return{
    pandoc.RawBlock("html", "<details><summary>Code</summary>"),
    elem,
    pandoc.RawBlock("html", "</details>")
  }
end

detailsクラスを持つコードブロックだけ<details>タグで囲う。

既に述べた通り、Lua Filterでは返り値がなかった場合、入力はそのままになる。従ってコードブロックがdetailsクラスを持つ時だけreturnが発生するようif文を記述すれば良い。

CodeBlockのクラスは変数名.classesで取り出せる（https://pandoc.org/lua-filters.html#type-codeblock）。なお、classesフィールドは、コードブロックがクラスを持たない場合はnilで、クラスを持つ場合はpandoc.Listである。 pandoc.Listは:findメソッドを持ち、ある要素と一致するリスト中の要素のインデックスを返す。見つからなければnilを返す。

従ってelem.classesもelem.classes:find("details")もnilではない場合にreturnすれば良い。 lua言語のif文では、論理値以外が与えられると、nilなら偽、さもなければ真として扱われるようだ。よって以下のように書ける。

function CodeBlock(elem)
  if elem.classes and elem.classes:find("details") then
    return{
      pandoc.RawBlock("html", "<details><summary>Code</summary>"),
      elem,
      pandoc.RawBlock("html", "</details>")
    }
  end
end

detailsクラスを持つコードブロックだけ<details>タグで囲い、summary要素が指定されていれば、<summary>タグに記述する

疲れたので説明を割愛するがこんな感じ。

function CodeBlock(elem)
  if elem.classes and elem.classes:find("details") then
    local summary = "Code"
    if elem.attributes.summary then
      summary = elem.attributes.summary
    end
    return{
      pandoc.RawBlock(
        "html", "<details><summary>" .. summary .. "</summary>"
      ),
      elem,
      pandoc.RawBlock("html", "</details>")
    }
  end
end

Rmdファイル

---
output:
  html_document:
    self_contained: false
    pandoc_args: [
        "--lua-filter", "test.lua"
      ]
---

```{r, class.source='details'}
set.seed(1)
rnorm(10)
```

デモ: 折り畳み時

デモ: 展開時