一通り動作チェックして動くことを確認したので一旦fixとしてあとは使って問題あれば直す形でやっていこうと思う、forkしたrevealjsパッケージです。
これを本家にPR出しても良いのかもですが、本家はPRは小さい物だけがマージされていて、CRANも4年更新がなく、これと同様に新しいバージョンのreveal.jsに入れ替えようというPRもほったらかしになってるので、このリポジトリをベースに別のライブラリとして作ってしまった方が良いのではないかと思っています（メンテしたくないけど…
こういう場合のお作法ってどんな感じなんですかね？元がMITライセンスだからその旨明記してforkしたライブラリだよ～って書けばよいのかな。参考になる資料等ご存知の方、こっそり（こっそりじゃなくてもいいけど）教えてください…。
横着して、pandoc_argsでno-highlightを指定したらhighlightが残っていて気付いた。Pandocは--no-highlightと--highlight-styleを同時に使用すると、highlight-styleの方が勝つようである。そのため、明示的に--no-highlightするだけでなく、--highlight-styleを与えない、ということもしないといけない。
マニュアルには明記されていないのでPandoc 2.14.0.3の挙動から判断。issueにも上がってない気がするのでとりあえず見なかったことにするが、あとで忘れるのでメモだけ残しておく。この状況にはまる人はほとんどいないと思うので。
色々調べてにっちもさっちもなのでメモ。
revealjsパッケージやrmarkdownパッケージ、その大本のPandocの仕様として、htmlなどのファイル形式に出力するときに使用するファイル、例えば画像などをhtmlファイル中に埋め込んで単一のファイルとしてリリースできるようにするオプション、--self-containedがある。
これは確かに便利なのだけど、reveal.jsのpluginを使う上ではうまく動かず、なんとかしようと思ったけど面倒すぎるので対応しない理由を書いておきます。
--self-contained指定したときの出力ファイルを見ればわかるように、画像などの外部データがよくわからない記号列によってあらわされている。これはbase64でエンコードされているデータで、これは適当にbase64 デコードなどで検索して出てくるデコードするサイトに入れてデコードすれば元のデータが見える。データの切り出しの位置に注意。最後の==は不要だったりとか。
これは結局htmlファイル中に対象のファイルを取り込むことになるが、画像のようなバイナリデータではなくてjsなどのテキストデータは復号すれば元のファイルが読める。そのためか知らないが、reveal.jsのファイルは圧縮・難読化されたものを使用するようになっている。pluginなどは元のファイルもあるので、コードの理解をするならそっちを読むべし。
話がそれてきた。
結局、htmlファイル中にjsなどのファイルを取り込むということは、そのjsファイル中で外部のファイルを指示していたり、取り込むような動作をしている場合はファイルが見えなくなるので期待する動作にならない、というのが問題となる。これはブラウザで開発モードにしてコンソールを出すとエラーが表示されているはずで、そこにそれらしきエラーメッセージがあるだろう。こんな風に。
解決策としては、データを取り込むだけでよければ最終的にすべてのファイルがhtmlファイル中にいればよいであろう、ということで無理やり別の場所でcssファイルなどを取り込んでおく。
<link rel="stylesheet" href="aaa_files/reveal.js-4.1.2/plugin/menu/menu.css"> <link rel="stylesheet" href="aaa_files/reveal.js-4.1.2/plugin/menu/font-awesome/css/all.css">
ただし、元のjsで読みに行くcssファイルは存在しないのだからえらーはのこるし、その場所にたまたま同名のファイルがあるとそれを読みに行くので意図した挙動・表示にならない。
ということで、根治するにはplugin中のデータ取り込みの記述を切り出し、html中で別途指定する運用にしないといけないがそれではpluginをASISで使用できず、メンテナンスコストが爆増してしまう。
という諸々を踏まえ、fork版revealjsではpluginを使用する場合は--self-contained=falseをマスト指定とする。内部的に常にfalseにしていても良いかもしれないが、standaloneで使いたいシーンはあるだろうからそれはしない方が良さそう。
元々のバージョンもplugin使用時はfalse指定ねってことになってたようなので、方針踏襲ということになりますね。
yamlでの指定はこんな感じで。
output: revealjs::revealjs_presentation: self_contained: false
revealjsパッケージはpluginもいくつか同梱して対応していたようである。そのため、reveal.jsを持ってきて置き換えるだけでは足りない。ただし、pluginのディレクトリに入れるだけで良いので対応は簡単。
reveal.jsのプラグインについては本家のwikiが詳しい。
また、プラグインの中でもこのリポジトリにあるものは昔のrevealjsパッケージで使われていたものがたくさん入っているので良さそうである（wikiも一番上に書いてあるし）
ひとまず、chalkboard、embed-tweet、fullscreenを導入。embed-tweetは元々ははいっていないが、ツイ廃としては入れないといけないなと思って（ツイ廃ではないが）
また、menuプラグインも入れた。これも以前のバージョンに含まれていた。構成はかなり変わっているが、オーナーは同じ。pluginディレクトリにはmenuにリネームしておいてある。
一方で、multiplexやnote-serverなどは一旦見送ることとした。
まぁ、4年もあればね…
真偽値でない、文字列の場合は''で囲う必要があるが、これがPandocのテンプレート側で対処されている。revealjsパッケージでも対処していて、二重に'がついてしまうのでrevealjsパッケージ側の対応する箇所を削除した。これで今後Pandocの最新のテンプレートを持ってきて置き換えるだけで良いと考えている。
この修正の結果、reveal_optionsに指定することでどの変数にも値を入れることが出来るようになったはずである。たとえば下記のようにすれば、headingsのレベルによらずに横方向に順にスライドが表示されるようになる（これはreveal.jsのバージョンが古いと対応できないので本家のrevealjsパッケージでは出来ない）
output:
revealjs::revealjs_presentation:
theme: blood
history: false
reveal_options:
navigationMode: linear
Pandocのテンプレートをベースにしているようだが、Rで使ったときに見やすいようになのかいくつかの変更がされており、それを新しいバージョンのテンプレートにも持ってこないといけなさそう。たとえばスライドタイトルはPandocのそれをそのまま使うと大きすぎるという印象。
いつ時点の更新かは履歴で見れるのだが、それがなぜ入っているのかがわからないようなコード片もあるので、しばらくは適当にいじって挙動を見て良し悪しを決めることになりそうである。
思ったより手間がかかりそうで既にやる気が足らなくなりそうであるが…もう少しやってみる。
ということで、ひとまずデフォルトのテンプレートから、使われている変数を目の子で引き抜いてきた。足りていないものがあるかもしれない。 Pandoc 2.14.0.3のものである。あたまにforがついているものは、複数の値が指定できるもので、テンプレート中でもforによってそれぞれの値にアクセスしている。
lang
dir
for author-meta
date-meta
for keywords
title-prefix
theme
for css
math
for header-includes
for include-before
title
for title-slide-attributes/pairs
subtitle
for author
for institute
date
toc
toc-title
mathjax
for include-after
以下のものはユーザが指定するのではなく、Pandocによって生えてくるものと思われる（詳細は未チェック）
table-of-contents
revealjs-url
また、以下のものはReveal.initialize中で使用されている変数である。revealjsの挙動を制御するために使われているので、使用しているreveal.jsのバージョンと合わせて確認が必要である。
controlscontrolsTutorialcontrolsLayoutcontrolsBackArrowsprogressslideNumbershowSlideNumberhashhashOneBasedIndexrespondToHashChangeshistorykeyboardoverviewcentertouchlooprtl
navigationMode
Vertical Slides | reveal.js
shuffle
fragmentsfragmentInURLembeddedhelppauseshowNotes
autoPlayMedia
https://revealjs.com/media/#autoplay
preloadIframes
autoSlideautoSlideStoppableautoSlideMethoddefaultTimingmouseWheeldisplayhideInactiveCursorhideCursorTimepreviewLinkstransitiontransitionSpeedbackgroundTransitionviewDistancemobileViewDistance以下のものはtrueの場合に記述が入り、falseの場合には入らないため挙動に不思議な点があれば確認すること。
parallaxBackgroundImage
background-image
parallaxBackgroundSize
parallaxBackgroundHorizontal
parallaxBackgroundVertical
width
height
margin
minScale
maxScale
列挙するだけでこれだけある。正しく使いこなすのは難しそうであるし、あまり凝りすぎたスライドは見やすくならないため注意が必要そうである。
reveal.jsのconfigのページにある、Initializeの記述のうち、Pandocのテンプレートに含まれないものは下記のようである。
keyboardCondition
https://revealjs.com/initialization/#multiple-presentations
disableLayout
https://revealjs.com/presentation-size/#byol
autoAnimate
autoAnimateMatcher
autoAnimateEasingautoAnimateDurationautoAnimateUnmatchedhttps://revealjs.com/auto-animate/#animation-settings
autoAnimateStyles: [
'opacity',
'color',
'background-color',
'padding',
'font-size',
'line-height',
'letter-spacing',
'border-width',
'border-color',
'border-radius',
'outline',
'outline-offset'
],
postMessagepostMessageEventsfocusBodyOnPageVisibilityChange
pdfMaxPagesPerSlide
https://revealjs.com/pdf-export/#page-size
pdfSeparateFragments
https://revealjs.com/pdf-export/#separate-pages-for-fragments
pdfPageHeightOffset
一方、ifで記述をomitするような変数についてはこのページには記載がなかった。要調査。
parallaxBack系の変数4つは下記のページに記載がある。
size系はここにある。
background-imageだけは見つからなかった。存在しないかもしれない。
→ parallaxBackgroundImage に与えるようである。しかしこの場合はparallaxBackgroundImageを指定しても無視されるので、両方のうちすくなくとも1つがenableだったら～に変えた方が良さそうでは？
reveal.jsの方のテンプレートはこれを参照した方が良さそう。
background-imageは検索するとreveal.scssにあるようであるが、ちゃんと指定できるのかは不明…。
本家の更新は望めないので自分で欲しいものは自分で作るということでforkして勝手にやることにした。
ひとまず同梱されているrevealjsを最新のモノに置き換え、ファイルパスを整理して、historyにtrue強制しているところをデフォルトtrueの引数も受けられるようにした。default.htmlはpandocのものを持ってきた。
default.htmlはreveljsパッケージの方でよしなにサイズを調整しているようなので、それを旧版から適当に持ってくる予定。
ほか、reveal.jsで受けられるオプションの類いはrevealjsの方でも受けられるようにする。要確認。
Codeまわりがうごかない。要確認。
h2の外側のsectionにattributesが入るものは大丈夫だが、h2自体に持たせないといけなさそうな機能はfilterで選別が必要かもしれない。いずれにしてもmarkdownからhtmlに変換してえいやでやるためにはrevealjs側でいい感じに手当てしないと駄目そうという気配。
jsやcssの記述を追加して対応するとバージョンアップ時に何が起こるのかわからないので基本的にはしない。しかしlua filterもASTで表現していないモノには無力なので、最悪の場合はreveal.js Writer in Pandocをいじらないといけないかも。要検討。
ひとまず、いくつかの機能は思った通りに動いているので、次のプレゼンの時にでも使ってみることにする、という目標でゆるゆると整備していこう。
久々にPandocのことをやろうと思って。Pandocの変遷はissueを読むと大変なので、取り込まれたPRを見るか、release noteを追うのが良い。今回は後者。 最近はpatchがぽつぽつ出ているが、2.14になったところで大きな変化があったので頑張って読んで追いつくことにする。
R上でPandocのバージョン（rmarkdownパッケージが見ているPandocのバージョン）を確認するには以下の通りです。
> rmarkdown::pandoc_version() [1] ‘2.14.0.3’
現時点の最新にした。
Rでhtmlスライド作る時にとても便利なパッケージ。だった。今も使えるのだが、CRANにあるのは2017年のものであり、その後更新がない。
より正確にはGitHub上では更新はされている。しかし、本体？のreveal.jsのバージョンが上がっていない。
最新は4.1.2のようだ。Rの方は3.3.0.1のようである。とても古い。
Pandocは最新バージョンだけが真のPandocであるとばかりにその時点の最新の周囲環境に合わせてバンバン更新が入る。API changeも3つ4つ入っていた。 詳しいことは読んでください。
Pandoc本体にもrevealjs出力向けのテンプレートが同梱されている。これが最新版では更新されている。どうやらfalseを指定したときに項目ごと抜けてしまうのをtemplateの方を修正してfalseの値を持って出力するように、という修正のようである（背景はよく知らないが）
と、このようにPandocは最新のreveal.jsのバージョンに合わせて更新をしていくので、Pandocの挙動が破壊的な変更を伴った場合にR側のrevealjsパッケージが対応できないと詰むんじゃないの？と思った次第。実際のところは知らんけど…。
Rの方はreveal.jsを同梱しているので、これを置き換え、参照するファイルをそこに向ければ良さそう。
また、ワークアラウンドとしてはPandoc同梱のテンプレートを使うという手がある。テンプレートを以下のようにして出力する。
pandoc -D revealjs > reveal.template
Rmdから出力する際、keep_md: trueをつけてmdファイルを作ったうえで、先のテンプレートを入力して使えばとりあえず出力は出来る。
pandoc -t revealjs input.md --template reveal.template -o output.html
デフォルトのテンプレートでは$revealjs-url$にhttps://unpkg.com/reveal.js@^4/が入るようなので、テンプレートの該当箇所をあらかじめダウンロードしてきたreveal.jsのファイル一式が入ったディレクトリに全て置き換えればオフラインでも使用できるし、cssの修正も手元でできる（これを便利にしているのがrevealjsパッケージという認識）
…と、最小のチェックしかしていない半分妄想で書いた記事である。何か間違っているかもしれないので見つけたらご一報を。
この一連の作業は面倒くさいので、forkして自分のリポジトリにrevealjsパッケージを生やした方が楽だな、と思っているのでやってみようと思っています（やるとは言っていない）
本当はPandocをやる予定だったんだが…
そうそう、rstudioがrevealjsパッケージに力を入れていないこと自体には特に不満がない…わけじゃないけど理由はわかるのでまぁしょうがないよねって感じで考えてます。 ただ、開発継続する意思がないのであれば、適当なタイミングでリポジトリごとフリーズしてその旨明記してもらった方が良いのではないかなと思いました。
