HN 日本語サマリー

← 一覧へ戻る
プログラミング

Pandoc Luaフィルター

Pandoc Lua Filters (pandoc.org)

131 pointsby ankitg1211 コメント

要約

Pandoc 2.0以降では、外部依存なしにLuaでフィルターを作成できるようになりました。これにより、JSON形式のAST(抽象構文木)を介したデータ変換のオーバーヘッドが回避され、パフォーマンスが向上します。Luaフィルターは、要素名をキーとし、その要素を処理する関数を値とするテーブルとして定義され、ドキュメントツリーの走査方法(typewiseまたはtopdown)を選択できます。

全文翻訳

Pandoc Luaフィルタ

はじめに

Pandocは以前からフィルタをサポートしており、これにより解析フェーズと書き込みフェーズの間でPandocの抽象構文木(AST)を操作できます。従来のPandocフィルタは、Pandoc ASTのJSON表現を受け取り、変更されたASTのJSON表現を生成します。これらは任意のプログラミング言語で記述でき、--filterオプションを使用してPandocから呼び出せます。

従来のフィルタは非常に柔軟ですが、いくつかの欠点があります。第一に、標準出力にJSONを書き込み、標準入力から読み取る(フィルタの両側で2回)というオーバーヘッドがあります。第二に、フィルタが機能するかどうかはユーザーの環境の詳細に依存します。フィルタは、特定のプログラミング言語のインタプリタや、JSON形式でPandoc ASTを操作するためのライブラリを必要とする場合があります。特定のバージョンのPandoc実行可能ファイルを持つユーザーなら誰でも使用できるフィルタを単純に提供することはできません。

バージョン2.0以降、Pandocは外部依存なしにLuaでフィルタを記述することを可能にしました。Luaインタプリタ(バージョン5.4)とPandocフィルタを作成するためのLuaライブラリがPandoc実行可能ファイルに組み込まれています。Pandocのデータ型は直接Luaにマーシャリングされ、標準出力へのJSONの書き込みと標準入力からの読み取りのオーバーヘッドが回避されます。

以下は、strong強調をsmall capsに変換するLuaフィルタの例です。

return {
  Strong = function (elem) 
    return pandoc.SmallCaps(elem.content)
  end,
}

または同等に、

function Strong(elem)
  return pandoc.SmallCaps(elem.content)
end

これは、「ASTをウォークし、Strong要素を見つけたら、同じ内容を持つSmallCaps要素に置き換える」ことを意味します。

実行するには、それをファイル(例: smallcaps.lua)に保存し、--lua-filter=smallcaps.luaでPandocを呼び出します。

以下に、Pandocマニュアル(MANUAL.txt)をHTMLに変換する際の、コンパイル済みHaskell(smallcaps)とインタプリタ型Python(smallcaps.py)で記述された同じJSONフィルタのバージョンでの簡単なパフォーマンス比較を示します。

コマンド時間
pandoc1.01秒
pandoc --filter ./smallcaps1.36秒
pandoc --filter ./smallcaps.py1.40秒
pandoc --lua-filter ./smallcaps.lua1.03秒

ご覧のとおり、Luaフィルタはパイプを介したJSONとのマーシャリングに伴うかなりのオーバーヘッドを回避しています。

Luaフィルタの構造

Luaフィルタは、要素名をキーとし、それらの要素に作用する関数を値とするテーブルです。

フィルタは個別のファイルに配置され、--lua-filterコマンドライン引数で渡されることが期待されます。例えば、フィルタが current-date.lua というファイルで定義されている場合、次のように適用されます。

pandoc --lua-filter=current-date.lua -f markdown MANUAL.txt

--lua-filterオプションは複数回指定できます。Pandocは、コマンドラインに現れる順序で、すべてのフィルタ(--filterで指定されたJSONフィルタおよび--lua-filterで指定されたLuaフィルタを含む)を適用します。

Pandocは、各Luaファイルがフィルタを返すことを期待します。フィルタスクリプトによって値が返されない場合、PandocはPandoc要素の名前(例: Str、Para、Meta、またはPandoc)に対応するトップレベル関数をすべて収集して単一のフィルタを生成しようとします。(これが上記の2つの例が同等である理由です。)

現在、Luaファイルからフィルタのリストを返して、それらを順次呼び出すことも可能です。walkメソッドが利用可能になる前は、これが1つのLuaファイルから複数のフィルタを実行する唯一の方法でした。しかし、walkメソッドの使用が推奨されるため、フィルタのリストを返すことは現在非推奨であり、この機能は将来的に削除される可能性があります。

各フィルタについて、ドキュメントは走査され、各要素はフィルタにかけられます。フィルタにエントリ(つまり、同じ名前の関数)が含まれている要素は、Lua要素フィルタ関数に渡されます。言い換えれば、フィルタエントリはドキュメント内の対応する各要素に対して呼び出され、その要素を入力として受け取ります。

フィルタ関数の戻り値は、以下のいずれかである必要があります。

  • nil: オブジェクトは変更されないことを意味します。
  • pandocオブジェクト: 入力と同じ型である必要があり、元のオブジェクトを置き換えます。
  • pandocオブジェクトのリスト: これらは元のオブジェクトを置き換えます。リストは、元のオブジェクトの隣接要素とマージされます(元のオブジェクトが含まれるリストにスプライスされます)。空のリストを返すことは、オブジェクトを削除します。

関数の出力は、入力と同じ型の要素をもたらす必要があります。これは、インライン要素に作用するフィルタ関数は、nil、インライン、またはインラインのリストのいずれかを返す必要があり、ブロック要素をフィルタリングする関数は、nil、ブロック、またはブロックのリストのいずれかを返す必要があることを意味します。この条件が違反された場合、Pandocはエラーを発生させます。

要素ノード型に一致する関数がない場合、フィルタリングシステムはより一般的なフォールバック関数を探します。2つのフォールバック関数、InlineとBlockがサポートされています。それぞれが対応する型の要素に一致します。

一致する関数がない要素は、そのまま変更されません。

Pandoc要素のリストについては、モジュールドキュメントを参照してください。

要素シーケンスに対するフィルタ

一部のフィルタリングタスクでは、ドキュメント内で要素が発生する順序を知る必要があります。その場合、一度に1つの要素を検査するだけでは不十分です。

ブロックまたはインラインのリストに対するフィルタを定義するために使用できる特別な関数名が2つあります。

Inlines (inlines)

フィルタに存在する場合、この関数は、Para(段落)ブロックの内容や、Imageの説明など、すべてのインライン要素のリストに対して呼び出されます。関数に渡されるinlines引数は、各呼び出しに対してInline要素のListになります。

Blocks (blocks)

フィルタに存在する場合、この関数は、MetaBlocksメタ要素ブロックの内容、リストの各項目、およびPandocドキュメントのメインコンテンツなど、すべてのブロック要素のリストに対して呼び出されます。関数に渡されるblocks引数は、各呼び出しに対してBlock要素のListになります。

これらのフィルタ関数は、結果がnil(リストが変更されない場合)であるか、正しい型のリスト(つまり、入力引数と同じ型)である必要があるという点で特別です。単一の要素は、このコンテキストでは通常バグを示唆するため、許可されません。

「引用符前のスペースを削除する」の例を参照してください。

この機能はpandoc 2.9.2で追加されました。

トラバーサル順序

フィルタのトラバーサル順序は、traverseキーを'topdown'または'typewise'に設定することで選択できます。デフォルトは'typewise'です。

例:

local filter = {
  traverse = 'topdown',
  -- ... filter functions ...
}
return filter

これのサポートはpandoc 2.17で追加されました。以前のバージョンではtraverse設定は無視されます。

Typewiseトラバーサル

フィルタセット内の要素フィルタ関数は、存在しないものをスキップして、固定順序で呼び出されます。

  1. Inline要素の関数、
  2. Inlinesフィルタ関数、
  3. Block要素の関数、
  4. Blocksフィルタ関数、
  5. Metaフィルタ関数、そして最後に
  6. Pandocフィルタ関数。

walkメソッドを使用してフィルタを手動で実行することにより、異なる順序を強制することも可能です。例えば、MetaのフィルタをStrのフィルタの前に実行したい場合、次のように記述できます。

function Pandoc(doc)
  doc = doc:walk { Meta = Meta } -- (1)
  return doc:walk { Str = Str }  -- (2)
end
Topdownトラバーサル

ドキュメントツリーをルートからリーフに向かって深さ優先で、一度にすべてを走査する方が自然な場合があります。

例えば、ブロックリスト[Plain [Str "a"], Para [Str "b"]]は、次のフィルタ関数を順に試します:Blocks、Plain、Inlines、Str、Para、Inlines、Str。

Topdownトラバーサルは、フィルタ関数から2番目の値としてfalseを返すことで短縮できます。その場合、返された要素の子要素は処理されません。

例えば、脚注の内容の処理を除外したい場合は、次のように記述できます。

traverse = 'topdown'
function Note (n)
  return n, false
end

グローバル変数

Pandocは、グローバル変数を設定することによって、追加のデータをLuaフィルタに渡します。

FORMAT

グローバルFORMATは、使用されているPandocライターのフォーマット(html5、latexなど)に設定されるため、フィルタの動作は最終的な出力フォーマットに応じて条件付けできます。

PANDOC_READER_OPTIONS

パーサーに提供されたオプションのテーブル。(ReaderOptions)

PANDOC_WRITER_OPTIONS

ライターに渡されるオプションのテーブル。オブジェクトは変更可能ですが、変更はPandocによって認識されません。(WriterOptions)カスタムライターでこの変数にアクセスすることは非推奨です。Pandoc 3.0以降、カスタムライターではプレースホルダー値(デフォルトオプション)に設定されます。実際のライターオプションへのアクセスは、オプションが2番目の関数引数として渡されるWriterまたはByteStringWriter関数を介して提供されます。(Pandoc 2.17以降)

PANDOC_VERSION

PandocのバージョンをVersionオブジェクトとして含みます。これは、最も重要な数値から順に、数値インデックス付きテーブルのように動作します。例:Pandoc 2.7.3の場合、変数の値はテーブル{2, 7, 3}に相当します。バージョン文字列を生成するにはtostring(PANDOC_VERSION)を使用します。この変数はカスタムライターでも設定されます。

PANDOC_API_VERSION

PandocがコンパイルされたPandoc-types APIのバージョンを含みます。これは、最も重要な数値から順に、数値インデックス付きテーブルとして提供されます。例:PandocがPandoc-types 1.17.3に対してコンパイルされた場合、変数の値はテーブル{1, 17, 3}のように動作します。バージョン文字列を生成するにはtostring(PANDOC_API_VERSION)を使用します。この変数はカスタムライターでも設定されます。

PANDOC_SCRIPT_FILE

フィルタを呼び出すために使用された名前。この値は、スクリプトファイルに相対的なファイルを見つけるために使用できます。この変数はカスタムライターでも設定されます。

PANDOC_STATE

すべてのリーダーとライター間で共有される状態。Pandocが情報を収集して渡すために使用します。この変数の値はCommonState型であり、読み取り専用です。

pandoc

次のセクションで説明するpandocモジュールは、フィルタのLua環境で利用可能です。ここで説明する他のモジュールは、それぞれの名前の下のサブフィールドとしてロードされます。

lpeg

この変数は、Parsing Expression Grammars(PEG)に基づいたパッケージであるlpegモジュールを保持します。優れた解析ユーティリティを提供し、公式のLPegホームページで文書化されています。Pandocは、パッケージメンテナーによってシステム全体へのインストールに依存するように設定されていない限り、ライブラリの組み込みバージョンを使用します。

re

LPegの上に構築され、正規表現エンジンの実装を提供するLPeg.reモジュールを含みます。Pandocは、パッケージメンテナーによってシステム全体へのインストールに依存するように設定されていない限り、ライブラリの組み込みバージョンを使用します。

Pandocモジュール

The pandoc Luaモジュールは、フィルタのLua環境にロードされ、要素の作成と操作を容易にするための関数と定数のセットを提供します。グローバル変数pandocはこのモジュールにバインドされており、この理由から通常は上書きされるべきではありません。

モジュールは、要素作成関数とPandocの主要機能へのアクセスという2つの主要な機能を提供します。

要素作成

Str、Para、Pandocのような要素作成関数は、使いやすく、Lua環境から読み取ることができる新しい要素を簡単に作成できるように設計されています。内部的には、Pandocはこれらの関数を使用して、要素フィルタ関数に渡されるLuaオブジェクトを作成します。これは、このモジュールを介して作成された要素が、フィルタ関数パラメータを介してアクセス可能な要素とまったく同じように動作することを意味します。

公開されたPandoc機能

一部のPandoc関数がLuaで利用可能になっています。

  • walk_blockとwalk_inlineは、フィルタを特定のブロックまたはインライン要素内で適用できるようにします。
  • readは、フィルタが文字列をPandocドキュメントに解析できるようにします。
  • pipeは、文字列からの入力と文字列への出力を伴う外部コマンドを実行します。
  • pandoc.mediabagモジュールは、「メディアバッグ」へのアクセスを可能にします。これは、最終ドキュメントに含まれる可能性のある画像などのバイナリコンテンツを格納します。
  • pandoc.utilsモジュールには、さまざまなユーティリティ関数が含まれています。

Luaインタプリタの初期化

PandocのLuaインタプリタの初期化は、Pandocのデータディレクトリにinit.luaファイルを配置することで制御できます。一般的なユースケースは、追加モジュールをロードしたり、デフォルトモジュールを変更したりすることです。

以下のスニペットは、init.luaに追加すると役立つ可能性のあるコードの例です。このスニペットは、textモジュールで定義されているすべてのUnicode対応関数を、uc_という文字列を接頭辞としてデフォルトのstringモジュールに追加します。

for name, fn in pairs(require 'text') do
  string['uc_' .. name] = fn
end

これにより、これらの関数をコロン構文(mystring:uc_upper())を使用して文字列に適用できるようになります。

Luaフィルタのデバッグ

静的解析を実行することで、多くのエラーを回避できます。この目的のためにluacheckを使用できます。Pandocフィルタ用のLuacheck設定ファイルがhttps://github.com/rnwst/pandoc-luacheckrcで利用可能です。

William Luptonは、Pandoc AST要素を pretty-print する関数を含む、Luaフィルタのデバッグに便利な関数を持つLuaモジュールを記述しました。これはhttps://github.com/wlupton/pandoc-lua-loggingで利用可能です。

Pandoc内で実行されるLuaフィルタをステップ実行しながら、デバッグインターフェースを使用して実行を一時停止できます。これは、パッケージmobdebugのリモートデバッグインターフェースを使用して実現されます。mobdebugはターミナルから実行できますが、ドネーションウェアのLuaエディタおよびIDEであるZeroBrane Studio内で実行する方が便利です。ZeroBraneはREPLコンソールとUIを提供し、ステップ実行やすべての変数と状態の表示が可能です。

ZeroBraneにはLua 5.4がバンドルされていませんが、デバッグできます。そのため、Lua 5.4をインストールし、mobdebugとその依存関係luasocketをluarocksを使用してインストールする必要があります。ZeroBraneは、設定ファイルにpath.lua = "/path/to/your/lua"を追加することで、Lua 5.4のインストールを使用できます。次に、ZeroBraneでLuaフィルタを開き、ブレークポイントを置きたい行にrequire('mobdebug').start()を追加します。次に、プロジェクト > Luaインタプリタが設定で追加した「Lua」に設定されており、「デバッガサーバーの開始」が有効になっていることを確認します(詳細な手順はこちらを参照)。通常どおりPandocを実行すると、ZeroBraneは正しい行で停止します。

一般的な落とし穴

AST要素が更新されない

フィルタ関数が新しい要素を返して置き換えない限り、フィルタリングされた要素は更新されません。以下のような関数は効果がありません。関数が値を返さないためです。

function Str (str)
  str.text = string.upper(str.text)
end

正しいバージョンは次のようになります。

function Str (str)
  str.text = string.upper(str.text)
  return str
end

パターンの動作はロケールに依存する

Luaのパターンライブラリの文字クラスは現在のロケールに依存します。例えば、文字©はCP-1252ロケールでは句読点として扱われ、パターン%pで一致しますが、UTF-8ロケールを使用するシステムでは一致しません。パター​​ンと文字クラスの一貫した処理を保証する信頼性の高い方法は、Luaスクリプトの先頭にos.setlocale 'C'を追加して「C」ロケールを使用することです。

文字列ライブラリはUnicode対応ではない

Luaのstringライブラリは、各バイトを1文字として扱います。string.upperのような関数は、ASCII以外の文字を含む単語に適用された場合、意図した効果が得られません。同様に、[☃]のようなパターンは、バイト 0、 9、 4、 8のいずれかに一致しますが、雪だるまのUnicode文字には一致しません。Unicode対応の変換にはpandoc.textモジュールを使用し、パターンマッチングにはlpegまたはreライブラリの使用を検討してください。

例

以下のフィルタは例として提示されています。有用なLuaフィルタのリポジトリ(良い例としても役立つ可能性があります)はhttps://github.com/pandoc/lua-filtersで利用可能です。

マクロ置換

以下のフィルタは、文字列{{helloworld}}を強調されたテキスト「Hello, World」に変換します。

return {
  Str = function (elem) 
    if elem.text == "{{helloworld}}" then
      return pandoc.Emph {pandoc.Str "Hello, World"}
    else
      return elem
    end
  end,
}

LaTeXおよびHTML出力での画像のセンタリング

LaTeXの場合は、画像を水平に中央揃えするLaTeXスニペットでラップします。HTMLでは、画像要素のスタイル属性を使用してセンタリングを実現します。

-- 対象フォーマットがLaTeXの場合、この関数で画像をフィルタリングします。
if FORMAT:match 'latex' then
  function Image (elem) 
    -- すべての画像を画像センタリング生のLaTeXで囲みます。
    return {
      pandoc.RawInline('latex', '\hfill\break{\centering'),
      elem,
      pandoc.RawInline('latex', '\par}')
    }
  end
end

-- 対象フォーマットがHTMLの場合、この関数で画像をフィルタリングします。
if FORMAT:match 'html' then
  function Image (elem) 
    -- CSSスタイルを使用して画像を中央揃えします
    elem.attributes.style = 'margin:auto; display: block;'
    return elem
  end
end

メタデータでの日付の設定

このフィルタは、日付がまだ設定されていない場合に、ドキュメントのメタデータの日付を現在の日付に設定します。

function Meta(m)
  if m.date == nil then
    m.date = os.date("%B %e, %Y")
    return m
  end
end

引用符前のスペースの削除

このフィルタは、「テキスト中の著者」形式の引用符の前にすべてのスペースを削除します。Markdownでは、「テキスト中の著者」形式の引用符(例: @citekey)の前にはスペースが必要です。これらのスペースが不要な場合は、フィルタで削除する必要があります。

local function is_space_before_author_in_text(spc, cite)
  return spc and spc.t == 'Space'
    and cite and cite.t == 'Cite'
    -- 引用符は1つだけで、モードが 'AuthorInText' である必要があります
    and #cite.citations == 1
    and cite.citations[1].mode == 'AuthorInText'
end

function Inlines (inlines)
  -- インデックスのシフト問題を避けるため、末尾から先頭に向かって進みます。
  for i = #inlines-1, 1, -1 do
    if is_space_before_author_in_text(inlines[i], inlines[i+1]) then
      inlines:remove(i)
    end
  end
  return inlines
end

プレースホルダーをメタデータ値に置き換える

Luaフィルタ関数は、次の順序で実行されます。

Inlines → Blocks → Meta → Pandoc。

上位レベル(例: メタデータ)から下位レベル(例: インライン)に情報を渡すことは、同じファイルにある2つのフィルタを使用して依然として可能です。

local vars = {}

local function get_vars (meta)
  for k, v in pairs(meta) do
    if pandoc.utils.type(v) == 'Inlines' then
      vars["%" .. k .. "%"] = {table.unpack(v)}
    end
  end
end

local function replace (el)
  if vars[el.text] then
    return pandoc.Span(vars[el.text])
  else
    return el
  end
end

function Pandoc(doc)
  return doc:walk { Meta = get_vars }:walk { Str = replace }
end

ファイルoccupations.mdの内容が次のようになっている場合:

---
name: Samuel Q. Smith
occupation: Professor of Oenology
---

Name

:   %name%

Occupation

:   %occupation%

pandoc --lua-filter=meta-vars.lua occupations.mdを実行すると、次の出力が得られます。

<dl>
<dt>Name</dt>
<dd><p><span>Samuel Q. Smith</span></p>
</dd>
<dt>Occupation</dt>
<dd><p><span>Professor of Oenology</span></p>
</dd>
</dl>

プレースホルダーにスペースが含まれていないことに注意してください。そうしないと、それらは2つの別々のStr要素になり、フィルタは機能しません。

manページ用にPandocのMANUAL.txtを変更する

これは、MANUAL.txtをmanページに変換するときに使用するフィルタです。レベル1ヘッダーを大文字に変換し(ヘッダー内のインライン要素を変換するためにwalkを使用)、脚注を削除し、リンクを通常のテキストに置き換えます。

-- UTF-8対応の'upper'関数を取得するためにpandoc.textを使用します
local text = pandoc.text

function Header(el)
    if el.level == 1 then
      return el:walk {
        Str = function(el) 
            return pandoc.Str(text.upper(el.text))
        end
      }
    end
end

function Link(el)
    return el.content
end

function Note(el)
    return {}
end

ペーパーからハンドアウトを作成する

このフィルタは、ドキュメント内のすべての番号付き例、セクションヘッダー、ブロック引用、および図を、クラスhandoutを持つdivに加えて抽出します。(外側のレベルのブロックのみが含まれることに注意してください。リスト項目のようなネストされた構造内のブロックは無視されます。)

-- 見出し、ブロック引用、番号付き例、図、およびクラス「handout」を持つ任意のDivを使用して、記事からハンドアウトを作成します。

function Pandoc(doc)
    local hblocks = {}
    for i,el in pairs(doc.blocks) do
        if (el.t == "Div" and el.classes[1] == "handout") or
           (el.t == "BlockQuote") or
           (el.t == "OrderedList" and el.style == "Example") or
           (el.t == "Para" and #el.c == 1 and el.c[1].t == "Image") or
           (el.t == "Header") then
           table.insert(hblocks, el)
        end
    end
    return pandoc.Pandoc(hblocks, doc.meta)
end

ドキュメント内の単語数を数える

このフィルタは、ドキュメント本文(タイトルや要約などのメタデータを除く)の単語数を数え、コード内の単語も含まれます。これは、Markdownドキュメントで直接実行されるwc -wよりも正確であるはずです。なぜなら、後者はATXヘッダーの前の#やHTMLドキュメントのタグのようなマークアップ文字を単語として数えるからです。実行するには、pandoc --lua-filter wordcount.lua myfile.mdを使用します。

-- ドキュメント内の単語を数えます

words = 0

wordcount = {
  Str = function(el) 
    -- 句読点のみで構成されている単語は数えません:
    if el.text:match("%P") then
        words = words + 1
    end
  end,

  Code = function(el) 
    _,n = el.text:gsub("%S+","")
    words = words + n
  end,

  CodeBlock = function(el) 
    _,n = el.text:gsub("%S+","")
    words = words + n
  end
}

function Pandoc(el)
    -- メタデータをスキップし、本文のみを数えます:
    el.blocks:walk(wordcount)
    print(words .. " words in body")
    os.exit(0)
end

テーブルの作成

このフィルタは、5列の次のテーブルを含むドキュメントを作成します。これは、pandoc.Tableコンストラクタの使用方法を示す動作例です。

これは私のテーブルキャプションです。

この

私の

テーブル

ヘッダー

セル 1

セル 2

セル 3

セル 4

セル 5

セル 6

これは私のテーブルフッターです。

次の点に注意してください。

  • 結果のTable要素の列数は、colspecsパラメータのエントリ数に等しくなります。

  • ColSpecオブジェクトにはセルの配置が含まれている必要がありますが、列幅はオプションです。

  • TableBodyオブジェクトは、pandoc.TableBodyコンストラクタがないため、bodiesパラメータのLuaテーブルを使用して指定されます。

function Pandoc ()
  local caption = pandoc.Caption( "This is my table caption." )
  local colspecs = {
    { pandoc.AlignLeft },
    { pandoc.AlignDefault }, 
    { pandoc.AlignCenter }, 
    { pandoc.AlignRight },
    { pandoc.AlignDefault }
  }
  local head = pandoc.TableHead{
    pandoc.Row{
      pandoc.Cell( "This" ), 
      pandoc.Cell( "is my" ), 
      pandoc.Cell( "table" ),
      pandoc.Cell( "header" )
    }
  }
  local bodies = {
    {
      attr={},
      body={
        pandoc.Row{
          pandoc.Cell( "Cell 1" ), 
          pandoc.Cell( "Cell 2" ), 
          pandoc.Cell( "Cell 3" )
        },
        pandoc.Row{
          pandoc.Cell( "Cell 4" ), 
          pandoc.Cell( "Cell 5" ), 
          pandoc.Cell( "Cell 6" )
        }
      },
      head={},
      row_head_columns=0
    }
  }
  local foot = pandoc.TableFoot{
    pandoc.Row{
      pandoc.Cell( "This is my table footer.", pandoc.AlignDefault, 1, 4 )
    }
  }
  return pandoc.Pandoc { 
    pandoc.Table(caption, colspecs, head, bodies, foot) 
  }
end

ABCコードを音楽表記に変換する

このフィルタは、クラスabcを持つコードブロックを、abcm2psとImageMagickのconvertを実行して作成された画像に置き換えます。(ABC表記の詳細については、https://abcnotation.comを参照してください。)

画像はメディアバッグに追加されます。バイナリフォーマットへの出力の場合、Pandocはメディアバッグ内の画像を使用します。テキストフォーマットの場合は、--extract-mediaを使用してメディアバッグ内のファイルを書き出すディレクトリを指定するか、(HTMLのみの場合)--embed-resourcesを使用します。

-- クラス「abc」を持つコードブロックをABC表記から画像に処理するPandocフィルタ。
--
-- * abcm2psとImageMagickのconvertがパス上にあることを前提とします。
-- * テキスト出力フォーマットの場合は、--extract-media=abc-images を使用します。
-- * HTMLフォーマットの場合は、代わりに --embed-resources を使用することもできます。

local filetypes = { html = {"png", "image/png"}
                  , latex = {"pdf", "application/pdf"}
                  }
local filetype = filetypes[FORMAT][1] or "png"
local mimetype = filetypes[FORMAT][2] or "image/png"

local function abc2eps(abc, filetype)
    local eps = pandoc.pipe("abcm2ps", {"-q", "-O", "-", "-"}, abc)
    local final = pandoc.pipe("convert", {"-", filetype .. ":-"}, eps)
    return final
end

function CodeBlock(block)
    if block.classes[1] == "abc" then
        local img = abc2eps(block.text, filetype)
        local fname = pandoc.sha1(img) .. "." .. filetype
        pandoc.mediabag.insert(fname, mimetype, img)
        return pandoc.Para{ pandoc.Image({pandoc.Str("abc tune")}, fname) }
    end
end

TikZで画像をビルドする

このフィルタは、生のLaTeX TikZ環境を画像に変換します。PDFとHTML出力の両方で機能します。TikZコードはpdflatexを使用して画像にコンパイルされ、画像はpdf2svgを使用してPDFからSVG形式に変換されます。したがって、これら両方がシステムパス上にある必要があります。変換された画像は作業ディレクトリにキャッシュされ、ソースのハッシュに基づいたファイル名が付けられるため、ドキュメントがビルドされるたびに再生成する必要はありません。(より洗練されたバージョンでは、これらを特別なキャッシュディレクトリに配置することもできます。)

local system = require 'pandoc.system'

local tikz_doc_template = [[
\documentclass{standalone}
\usepackage{xcolor}
\usepackage{tikz}
\begin{document}
\nopagecolor
%s
\end{document}
]]

local function tikz2image(src, filetype, outfile)
  system.with_temporary_directory('tikz2image', function (tmpdir) 
    system.with_working_directory(tmpdir, function() 
      local f = io.open('tikz.tex', 'w')
      f:write(tikz_doc_template:format(src))
      f:close()
      os.execute('pdflatex tikz.tex')
      if filetype == 'pdf' then
        os.rename('tikz.pdf', outfile)
      else
        os.execute('pdf2svg tikz.pdf ' .. outfile)
      end
    end)
  end)
end

extension_for = {
  html = 'svg',
  html4 = 'svg',
  html5 = 'svg',
  latex = 'pdf',
  beamer = 'pdf' }

local function file_exists(name)
  local f = io.open(name, 'r')
  if f ~= nil then
    io.close(f)
    return true
  else
    return false
  end
end

local function starts_with(start, str)
  return str:sub(1, #start) == start
end


function RawBlock(el)
  if starts_with('\begin{tikzpicture}', el.text) then
    local filetype = extension_for[FORMAT] or 'svg'
    local fbasename = pandoc.sha1(el.text) .. '.' .. filetype
    local fname = system.get_working_directory() .. '/' .. fbasename
    if not file_exists(fname) then
      tikz2image(el.text, filetype, fname)
    end
    return pandoc.Para({pandoc.Image({}, fbasename)})
  else
   return el
  end
end

使用例:

pandoc --lua-filter tikz.lua -s -o cycle.html <<EOF
Here is a diagram of the cycle:

\begin{tikzpicture}

\def \n {5}
\def \radius {3cm}
\def \margin {8} % margin in angles, depends on the radius

\foreach \s in {1,...,\n}
{
  \node[draw, circle] at ({360/\n * (\s - 1)}:\radius) {$\s$};
  \draw[->, >=latex] ({360/\n * (\s - 1)+\margin}:\radius)
    arc ({360/\n * (\s - 1)+\margin}:{360/\n * (\s)-\margin}:\radius);
}
\end{tikzpicture}
EOF

Lua型リファレンス

このセクションでは、Luaフィルタで利用可能なオブジェクトの型について説明します。これらのオブジェクトを作成するには、pandocモジュールを参照してください。

共有プロパティ

clone

clone ()

読み取り専用オブジェクトを除く、ここにリストされている型のすべてのインスタンスは、clone()メソッドを介してクローンできます。

使用法:

local emph = pandoc.Emph {pandoc.Str 'important'}
local cloned_emph = emph:clone()  -- コロンに注意

Pandoc

Pandocドキュメント

この型の値は、pandoc.Pandocコンストラクタを使用して作成できます。Pandoc値は、Haskellで等しい場合にのみLuaで等しいと見なされます。

blocks

ドキュメントコンテンツ(Blocks)

meta

ドキュメントメタ情報(Metaオブジェクト)

メソッド
normalize

normalize(self)

Pandocドキュメントの正規化を実行します。例えば、連続する複数のスペースは折りたたまれ、テーブルは正規化されて、すべての行と列が同じ数のセルを持つようになります。

パラメータ:

self

要素(Pandoc)

結果:

  • クローンされ正規化されたドキュメント。(Pandoc)
walk

walk(self, lua_filter)

Pandoc要素にLuaフィルタを適用します。フルドキュメントフィルタと同様に、要素が走査される順序は、フィルタのtraverseフィールドを設定することで制御できます。詳細はトラバーサル順序のセクションを参照してください。フィルタが適用された(ディープ)コピーを返します。元の要素は変更されません。

パラメータ:

self

要素(Pandoc)

lua_filter

フィルタ関数のマップ(テーブル)

結果:

  • フィルタリングされたドキュメント(Pandoc)

使用法:

-- `pandoc.Pandoc{pandoc.Para{pandoc.Str 'Bye'}}` を返します
return pandoc.Pandoc{pandoc.Para('Hi')}:walk {
  Str = function (_) return 'Bye' end,
}

Meta

ドキュメントのメタ情報。文字列インデックス付きのMetaValuesコレクション。

この型の値は、pandoc.Metaコンストラクタを使用して作成できます。Meta値は、Haskellで等しい場合にのみLuaで等しいと見なされます。

MetaValue

ドキュメントメタ情報項目。これは個別の型ではありませんが、MetaValueが期待される場所で使用できる型のセットを表します。型は以下のHaskell型コンストラクタに対応します。

  • boolean → MetaBool
  • string または number → MetaString
  • Inlines → MetaInlines
  • Blocks → MetaBlocks
  • List/integer indexed table → MetaList

対応するコンストラクタpandoc.MetaBool、pandoc.MetaString、pandoc.MetaInlines、pandoc.MetaBlocks、pandoc.MetaList、およびpandoc.MetaMapを使用して、値が意図した方法で扱われることを保証できます。例えば、空のテーブルは通常MetaMapとして扱われますが、pandoc.MetaList{}を呼び出すことで空のMetaListにすることができます。ただし、pandoc.List、pandoc.Inlines、またはpandoc.Blocksのような汎用関数を使用しても同じことが達成できます。

メタデータ値の型を取得するには、pandoc.utils.type関数を使用します。

Block

Block値は、Haskellで等しい場合にのみLuaで等しいと見なされます。

共通メソッド
walk

walk(self, lua_filter)

Block要素にLuaフィルタを適用します。フルドキュメントフィルタと同様に、要素が走査される順序は、フィルタのtraverseフィールドを設定することで制御できます。詳細はトラバーサル順序のセクションを参照してください。フィルタが適用された(ディープ)コピーを返します。元の要素は変更されません。

注意:フィルタはサブツリーに適用されますが、self Block要素には適用されません。その理由は、そうでなければ要素がフィルタによって削除されたり、複数のBlock要素に置き換えられたりする可能性があり、予期しない結果につながる可能性があるためです。

パラメータ:

self

要素(Block)

lua_filter

フィルタ関数のマップ(テーブル)

結果:

  • フィルタリングされたBlock(Block)

使用法:

-- `pandoc.Para{pandoc.Str 'Bye'}` を返します
return pandoc.Para('Hi'):walk {
  Str = function (_) return 'Bye' end,
}
BlockQuote

ブロック引用要素。

この型の値は、pandoc.BlockQuoteコンストラクタを使用して作成できます。

フィールド:

content

ブロックコンテンツ(Blocks)

tag, t

リテラルBlockQuote(文字列)

BulletList

箇条書きリスト。

この型の値は、pandoc.BulletListコンストラクタを使用して作成できます。

フィールド:

content

リスト項目(項目のList、つまりBlocksのList)

tag, t

リテラルBulletList(文字列)

CodeBlock

コードブロック。

この型の値は、pandoc.CodeBlockコンストラクタを使用して作成できます。

フィールド:

text

コード文字列(文字列)

attr

要素属性(Attr)

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

tag, t

リテラルCodeBlock(文字列)

DefinitionList

定義リスト。用語とその説明を含みます。

この型の値は、pandoc.DefinitionListコンストラクタを使用して作成できます。

フィールド:

content

リスト項目

tag, t

リテラルDefinitionList(文字列)

Div

属性を持つ汎用ブロックコンテナ。

この型の値は、pandoc.Divコンストラクタを使用して作成できます。

フィールド:

content

ブロックコンテンツ(Blocks)

attr

要素属性(Attr)

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

tag, t

リテラルDiv(文字列)

Figure

キャプションと任意のブロックコンテンツを持つ図。

この型の値は、pandoc.Figureコンストラクタを使用して作成できます。

フィールド:

content

ブロックコンテンツ(Blocks)

caption

図のキャプション(Caption)

attr

要素属性(Attr)

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

tag, t

リテラルFigure(文字列)

HorizontalRule

水平線。

この型の値は、pandoc.HorizontalRuleコンストラクタを使用して作成できます。

フィールド:

tag, t

リテラルHorizontalRule(文字列)

LineBlock

行ブロック。つまり、各行が改行で区切られた行のリストです。

この型の値は、pandoc.LineBlockコンストラクタを使用して作成できます。

フィールド:

content

インラインコンテンツ(行のList、つまりInlinesのList)

tag, t

リテラルLineBlock(文字列)

OrderedList

順序付きリスト。

この型の値は、pandoc.OrderedListコンストラクタを使用して作成できます。

フィールド:

content

リスト項目(項目のList、つまりBlocksのList)

listAttributes

リストパラメータ(ListAttributes)

start

listAttributes.startのエイリアス(整数)

style

listAttributes.styleのエイリアス(文字列)

delimiter

listAttributes.delimiterのエイリアス(文字列)

tag, t

リテラルOrderedList(文字列)

Para

段落。

この型の値は、pandoc.Paraコンストラクタを使用して作成できます。

フィールド:

content

インラインコンテンツ(Inlines)

tag, t

リテラルPara(文字列)

Plain

プレーンテキスト、段落ではありません。

この型の値は、pandoc.Plainコンストラクタを使用して作成できます。

フィールド:

content

インラインコンテンツ(Inlines)

tag, t

リテラルPlain(文字列)

RawBlock

指定されたフォーマットの生のコンテンツブロック。

この型の値は、pandoc.RawBlockコンストラクタを使用して作成できます。

フィールド:

format

コンテンツのフォーマット(文字列)

text

生のコンテンツ(文字列)

tag, t

リテラルRawBlock(文字列)

Table

テーブル。

この型の値は、pandoc.Tableコンストラクタを使用して作成できます。

フィールド:

attr

テーブル属性(Attr)

caption

テーブルキャプション(Caption)

colspecs

列仕様、つまり配置と幅(ColSpecのList)

head

テーブルヘッダー(TableHead)

bodies

テーブルボディ(TableBodyのList)

foot

テーブルフッター(TableFoot)

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

tag, t

リテラルTable(文字列)

テーブルセルはブロックのリストです。

配置は、テーブル列の水平配置を示す文字列値です。AlignLeft、AlignRight、AlignCenterは、セルコンテンツを左揃え、右揃え、中央揃えにします。デフォルトの配置はAlignDefault(多くの場合、中央揃えと同等)です。

Blocks

Block要素のリスト。汎用Listと同じメソッドを持ちます。通常、ユーザー スクリプトでこの型の値を作成する必要はありません。Pandocは、この型の値が期待される場所で他の型をBlocksに変換できます。

  • Block(またはBlockのような)値のリストは直接使用されます。
  • 単一のInlines値はPlain要素にラップされます。
  • 文字列値は、文字列を単語に分割し(Inlinesを参照)、結果をPlainシングルトンにラップすることによって変換されます。
メソッド

Blocks型のリストは、汎用リストで利用可能なすべてのメソッドを共有します。pandoc.Listモジュールを参照してください。

さらに、Blocks値には次のメソッドが利用可能です。

walk

walk(self, lua_filter)

BlocksリストにLuaフィルタを適用します。フルドキュメントフィルタと同様に、要素が走査される順序は、フィルタのtraverseフィールドを設定することで制御できます。詳細はトラバーサル順序のセクションを参照してください。フィルタが適用された(ディープ)コピーを返します。元のリストは変更されません。

パラメータ:

self

リスト(Blocks)

lua_filter

フィルタ関数のマップ(テーブル)

結果:

  • フィルタリングされたリスト(Blocks)

使用法:

-- `pandoc.Blocks{pandoc.Para('Salve!')}` を返します
return pandoc.Blocks{pandoc.Plain('Salve!')}:walk {
  Plain = function (p) return pandoc.Para(p.content) end,
}

Inline

Inline値は、Haskellで等しい場合にのみLuaで等しいと見なされます。

共通メソッド
walk

walk(self, lua_filter)

Inline要素にLuaフィルタを適用します。フルドキュメントフィルタと同様に、要素が走査される順序は、フィルタのtraverseフィールドを設定することで制御できます。詳細はトラバーサル順序のセクションを参照してください。フィルタが適用された(ディープ)コピーを返します。元の要素は変更されません。

注意:フィルタはサブツリーに適用されますが、self Inline要素には適用されません。その理由は、そうでなければ要素がフィルタによって削除されたり、複数のInline要素に置き換えられたりする可能性があり、予期しない結果につながる可能性があるためです。

パラメータ:

self

要素(Inline)

lua_filter

フィルタ関数のマップ(テーブル)

結果:

  • フィルタリングされたInline要素(Inline)

使用法:

-- `pandoc.SmallCaps('SPQR)` を返します
return pandoc.SmallCaps('spqr'):walk {
  Str = function (s) return string.upper(s.text) end,
}
Cite

引用。

この型の値は、pandoc.Citeコンストラクタを使用して作成できます。

フィールド:

content

(Inlines)

citations

引用エントリ(CitationsのList)

tag, t

リテラルCite(文字列)

Code

インラインコード

この型の値は、pandoc.Codeコンストラクタを使用して作成できます。

フィールド:

text

コード文字列(文字列)

attr

属性(Attr)

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

tag, t

リテラルCode(文字列)

Emph

強調されたテキスト

この型の値は、pandoc.Emphコンストラクタを使用して作成できます。

フィールド:

content

インラインコンテンツ(Inlines)

tag, t

リテラルEmph(文字列)

Image

画像:代替テキスト(インラインのリスト)、ターゲット

この型の値は、pandoc.Imageコンストラクタを使用して作成できます。

フィールド:

caption

画像を説明するために使用されるテキスト(Inlines)

src

画像ファイルへのパス(文字列)

title

簡単な画像の説明(文字列)

attr

属性(Attr)

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

tag, t

リテラルImage(文字列)

LineBreak

ハード改行

この型の値は、pandoc.LineBreakコンストラクタを使用して作成できます。

フィールド:

tag, t

リテラルLineBreak(文字列)

Link

ハイパーリンク:代替テキスト(インラインのリスト)、ターゲット

この型の値は、pandoc.Linkコンストラクタを使用して作成できます。

フィールド:

attr

属性(Attr)

content

このリンクのテキスト(Inlines)

target

リンクターゲット(文字列)

title

簡単なリンクの説明

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

tag, t

リテラルLink(文字列)

Math

TeX数式(リテラル)

この型の値は、pandoc.Mathコンストラクタを使用して作成できます。

フィールド:

mathtype

数式コンテンツをインライン(InlineMath)または別行(DisplayMath)で表示するかどうかを決定する指定子(文字列)

text

数式コンテンツ(文字列)

tag, t

リテラルMath(文字列)

Note

脚注または終注

この型の値は、pandoc.Noteコンストラクタを使用して作成できます。

フィールド:

content

(Blocks)

tag, t

リテラルNote(文字列)

Quoted

引用されたテキスト

この型の値は、pandoc.Quotedコンストラクタを使用して作成できます。

フィールド:

quotetype

使用する引用符の種類。SingleQuoteまたはDoubleQuoteのいずれか(文字列)

content

引用されたテキスト(Inlines)

tag, t

リテラルQuoted(文字列)

RawInline

生のインライン

この型の値は、pandoc.RawInlineコンストラクタを使用して作成できます。

フィールド:

format

コンテンツのフォーマット(文字列)

text

生のコンテンツ(文字列)

tag, t

リテラルRawInline(文字列)

SmallCaps

小型大文字テキスト

この型の値は、pandoc.SmallCapsコンストラクタを使用して作成できます。

フィールド:

content

(Inlines)

tag, t

リテラルSmallCaps(文字列)

SoftBreak

ソフト改行

この型の値は、pandoc.SoftBreakコンストラクタを使用して作成できます。

フィールド:

tag, t

リテラルSoftBreak(文字列)

Space

単語間のスペース

この型の値は、pandoc.Spaceコンストラクタを使用して作成できます。

フィールド:

tag, t

リテラルSpace(文字列)

Span

属性を持つ汎用インラインコンテナ

この型の値は、pandoc.Spanコンストラクタを使用して作成できます。

フィールド:

attr

属性(Attr)

content

ラップされたコンテンツ(Inlines)

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

tag, t

リテラルSpan(文字列)

Str

テキスト

この型の値は、pandoc.Strコンストラクタを使用して作成できます。

フィールド:

text

コンテンツ(文字列)

tag, t

リテラルStr(文字列)

Strikeout

取り消し線付きテキスト

この型の値は、pandoc.Strikeoutコンストラクタを使用して作成できます。

フィールド:

content

インラインコンテンツ(Inlines)

tag, t

リテラルStrikeout(文字列)

Strong

強調されたテキスト

この型の値は、pandoc.Strongコンストラクタを使用して作成できます。

フィールド:

content

インラインコンテンツ(Inlines)

tag, t

リテラルStrong(文字列)

Subscript

下付き文字テキスト

この型の値は、pandoc.Subscriptコンストラクタを使用して作成できます。

フィールド:

content

インラインコンテンツ(Inlines)

tag, t

リテラルSubscript(文字列)

Superscript

上付き文字テキスト

この型の値は、pandoc.Superscriptコンストラクタを使用して作成できます。

フィールド:

content

インラインコンテンツ(Inlines)

tag, t

リテラルSuperscript(文字列)

Underline

下線付きテキスト

この型の値は、pandoc.Underlineコンストラクタを使用して作成できます。

フィールド:

content

インラインコンテンツ(Inlines)

tag, t

リテラルUnderline(文字列)

Inlines

Inline要素のリスト。汎用Listと同じメソッドを持ちます。通常、ユーザー スクリプトでこの型の値を作成する必要はありません。Pandocは、この型の値が期待される場所で他の型をInlinesに変換できます。

  • Inline要素のリストは直接使用されます。
  • 単一のInlineは、その要素のみを含むリストに変換されます。
  • 文字列値は単語に分割され、改行はSoftBreak要素に、その他の空白文字はSpacesに変換されます。
メソッド

Inlines型のリストは、汎用リストで利用可能なすべてのメソッドを共有します。pandoc.Listモジュールを参照してください。

さらに、Inlines値には次のメソッドが利用可能です。

walk

walk(self, lua_filter)

InlinesリストにLuaフィルタを適用します。フルドキュメントフィルタと同様に、要素が処理される順序は、Inline → Inlines → Block → Blocksです。フィルタは、リストのすべての項目とリスト自体に適用されます。フィルタが適用された(ディープ)コピーを返します。元のリストは変更されません。

パラメータ:

self

リスト(Inlines)

lua_filter

フィルタ関数のマップ(テーブル)

結果:

  • フィルタリングされたリスト(Inlines)

使用法:

-- `pandoc.Inlines{pandoc.SmallCaps('SPQR')}` を返します
return pandoc.Inlines{pandoc.Emph('spqr')}:walk {
  Str = function (s) return string.upper(s.text) end,
  Emph = function (e) return pandoc.SmallCaps(e.content) end,
}

要素コンポーネント

Attr

要素属性のセット。この型の値は、pandoc.Attrコンストラクタを使用して作成できます。便宜上、要素の一部である場合、通常は値を直接構築する必要はなく、HTMLのようなテーブルを渡すだけで十分です。例えば、識別子「text」とクラス「a」および「b」を持つspanを作成するには、次のように記述できます。

local span = pandoc.Span('text', {id = 'text', class = 'a b'})

これはattrセッターを使用する場合にも機能します。

local span = pandoc.Span 'text'
span.attr = {id = 'text', class = 'a b', other_attribute = '1'}

Attr値は、Haskellで等しい場合にのみLuaで等しいと見なされます。

フィールド:

identifier

要素識別子(文字列)

classes

要素クラス(文字列のList)

attributes

キー/値ペアのコレクション(Attributes)

Attributes

キー/値ペアのリスト。値は、リストテーブルのインデックスとしてキーを使用してアクセスできます。

Attributes値は、Haskellで等しい場合にのみLuaで等しいと見なされます。

Caption

テーブルのキャプション。オプションで短いキャプションがあります。

フィールド:

long

長いキャプション(Blocks)

short

短い要約キャプション(Inlines)

Cell

テーブルセル。

フィールド:

attr

セル属性

alignment

個々のセル配置(Alignment)。

contents

セルコンテンツ(Blocks)。

col_span

セルが占める列数。列単位のセルの幅(整数)。

row_span

セルが占める行数。セルの高さ、行単位(整数)。

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

Citation

単一の引用エントリ

この型の値は、pandoc.Citationコンストラクタを使用して作成できます。

Citation値は、Haskellで等しい場合にのみLuaで等しいと見なされます。

フィールド:

id

引用識別子、例: bibtexキー(文字列)

mode

引用モード。AuthorInText、SuppressAuthor、またはNormalCitationのいずれか(文字列)

prefix

(Inlines)

suffix

(Inlines)

note_num

注番号(整数)

hash

ハッシュ(整数)

ColSpec

単一のテーブル列の列配置と幅の仕様。

これはペア、つまりプレーンテーブルで、次のコンポーネントがあります。

  1. セル配置(Alignment)。
  2. テーブル列幅。ページ幅の分数として(数値)。
ListAttributes

リスト属性

この型の値は、pandoc.ListAttributesコンストラクタを使用して作成できます。

フィールド:

start

最初のリスト項目の番号(整数)

style

リスト番号に使用されるスタイル。可能な値はDefaultStyle、Example、Decimal、LowerRoman、UpperRoman、LowerAlpha、UpperAlphaです(文字列)

delimiter

リスト番号の区切り文字。DefaultDelim、Period、OneParen、TwoParensのいずれか(文字列)

Row

テーブル行。

フィールド:

attr

要素属性(Attr)

cells

この行のテーブルセルのリスト(CellのList)

TableBody

テーブルのボディ。中間ヘッダーと指定された数の行ヘッダー列があります。

フィールド:

attr

テーブルボディ属性(Attr)

body

テーブルボディ行(RowのList)

head

中間ヘッダー(RowのList)

row_head_columns

TableBodyの各行の行ヘッダーが占める列数。行ボディは残りの列を占めます。

TableFoot

テーブルのフッター。

フィールド:

attr

要素属性(Attr)

rows

行のリスト(RowのList)

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

TableHead

テーブルのヘッダー。

フィールド:

attr

要素属性(Attr)

rows

行のリスト(RowのList)

identifier

attr.identifierのエイリアス(文字列)

classes

attr.classesのエイリアス(文字列のList)

attributes

attr.attributesのエイリアス(Attributes)

ReaderOptions

Pandocリーダーオプション

フィールド:

abbreviations

既知の略語のセット(文字列のセット)

columns

ターミナルの列数(整数)

default_image_extension

画像のデフォルト拡張子(文字列)

extensions

構文拡張ビットフィールドの文字列表現(文字列のシーケンス)

indented_code_classes

インデントされたコードブロックのデフォルトクラス(文字列のリスト)

standalone

入力がヘッダー付きのスタンドアロンドキュメントであったかどうか(ブール値)

strip_comments

HTMLコメントは解析される代わりに削除されます(ブール値)

tab_stop

タブストップの幅(つまり、同等のスペース数)(整数)

track_changes

docxの変更追跡設定。accept-changes、reject-changes、all-changesのいずれか(文字列)

WriterOptions

Pandocライターオプション

フィールド:

chunk_template

チャンク化されたHTMLファイル名を生成するために使用されるテンプレート(文字列)

cite_method

引用の印刷方法 - 'citeproc'、'natbib'、または'biblatex'のいずれか(文字列)

columns

行の文字数(テキスト折り返し用)(整数)

dpi

ピクセルからインチ/cmへの変換に使用するDPI(整数)

email_obfuscation

メールの難読化方法 - 'none'、'references'、または'javascript'のいずれか(文字列)

epub_chapter_level

章のヘッダーレベル、つまりドキュメントが個別のファイルに分割される方法(整数)

epub_fonts

埋め込むフォントへのパス(文字列のシーケンス)

epub_metadata

EPUBに含めるメタデータ(string|nil)

epub_subdirectory

OCF内のEPUBのサブディレクトリ(文字列)

extensions

使用できるMarkdown拡張機能(文字列のシーケンス)

highlight_style

ハイライトに使用するスタイル。pandoc --print-highlight-style=...の出力例を参照してください。値nilは、ハイライトが使用されないことを意味します。(table|nil)

html_math_method

HTMLで数式を印刷する方法 - 'plain'、'mathjax'、'mathml'、'webtex'、'katex'、'gladtex'、またはmethodとurlのキーを持つテーブルのいずれか。(string|table)

html_q_tags

HTMLで引用符に<q>タグを使用します(ブール値)

identifier_prefix

HTMLのセクションと注釈ID、およびMarkdownの脚注マークの接頭辞(文字列)

incremental

リストがインクリメンタルな場合はtrue(ブール値)

listings

コードにlistingsパッケージを使用します(ブール値)

number_offset

セクション、サブセクションなどの開始番号(整数のシーケンス)

number_sections

LaTeXでセクションを番号付けします(ブール値)

prefer_ascii

可能な場合はASCII文字列表現を優先します(ブール値)

reference_doc

指定されている場合は参照ドキュメントへのパス(string|nil)

reference_links

Markdown、rstの書き込み時に参照リンクを使用します(ブール値)

reference_location

Markdown、rstの書き込み時の脚注と参照の場所。end-of-block、end-of-section、end-of-documentのいずれか。共通の接頭辞は、この値を設定するときに省略できます。(文字列)

section_divs

HTMLでセクションをdivタグに入れます(ブール値)

setext_headers

Markdownでレベル1〜2のセットテキストヘッダーを使用します(ブール値)

slide_level

スライドのヘッダーレベルを強制します(integer|nil)

tab_stop

スペースとタブ間の変換のタブストップ(整数)

table_of_contents

目次を含めます(ブール値)

template

使用するテンプレート(Template|nil)

toc_depth

TOCに含めるレベル数(整数)

top_level_division

トップレベルの分割タイプ。top-level-part、top-level-chapter、top-level-section、またはtop-level-defaultのいずれか。top-level接頭辞は、この値を設定するときに省略できます。(文字列)

variables

テンプレートで設定する変数。文字列インデックス付きテーブル(テーブル)

wrap_text

テキスト折り返しのオプション。wrap-auto、wrap-none、またはwrap-preserveのいずれか。wrap-接頭辞は、この値を設定するときに省略できます。(文字列)

CommonState

Pandocが情報を収集し、リーダーとライターに利用可能にするために使用する状態。

フィールド:

input_files

コマンドラインからの入力ファイルリスト(文字列のList)

output_file

コマンドラインからの出力ファイル(stringまたはnil)

log

ログメッセージのリスト(LogMessageのList)

request_headers

HTTPリクエストに追加するヘッダー。ヘッダー名をキー、ヘッダーコンテンツを値とするテーブル(テーブル)

resource_path

リソース(例: 埋め込み画像)を検索するパス(文字列のList)

source_url

最初のソースファイルの絶対URLまたはディレクトリ(stringまたはnil)

user_data_dir

データファイルを検索するディレクトリ(stringまたはnil)

trace

トレースメッセージが発行されるかどうか(ブール値)

verbosity

詳細度レベル。INFO、WARNING、ERRORのいずれか(文字列)

Doc

リフロー可能なプレーンテキストドキュメント。Doc値は、指定された列幅に合わせてレンダリングおよびリフローできます。

pandoc.layoutモジュールを使用して、Doc値を作成および変更できます。Doc値を最初の引数として取るそのモジュールのすべての関数は、Docメソッドとしても利用可能です。例: (pandoc.layout.literal 'text'):render()。

Docを期待する関数に文字列が渡された場合、文字列はリテラル値として扱われます。つまり、次の2行は同等です。

test = pandoc.layout.quotes(pandoc.layout.literal 'this')
test = pandoc.layout.quotes('this')
演算子
..

2つのDoc要素を連結します。

+

2つのDocを連結し、その間にリフロー可能なスペースを挿入します。

/

aとbがDoc要素の場合、a / bはaをbの上に配置します。

//

aとbがDoc要素の場合、a // bはaをbの上に配置し、その間に空行を挿入します。

List

リストは、整数インデックスを持つ任意のLuaテーブルです。インデックスは1から始まります。したがって、alist = {'value'}の場合、alist[1] == 'value'となります。

リストは、要素の一部である場合、またはマーシャリング中に生成される場合、便宜上pandoc.Listインスタンスになります。pandoc.List型はpandoc.Listモジュールで定義されています。利用可能なメソッドについては、そちらを参照してください。

この型の値は、pandoc.Listコンストラクタを使用して作成でき、通常のLuaテーブルをListに変換します。

LogMessage

Pandocログメッセージ。オブジェクトにはフィールドがありませんが、tostringを介して文字列に変換できます。

SimpleTable

SimpleTableは、古い(pandoc 2.10より前)Table型に似たテーブル構造です。Tablesとの双方向変換は、それぞれpandoc.utils.to_simple_tableおよびpandoc.utils.from_simple_table関数を使用して可能です。この型のインスタンスは、pandoc.SimpleTableコンストラクタで直接作成することもできます。

フィールド:

caption

Inlines

aligns

列配置(AlignmentのList)

widths

列幅。数値のList。

headers

テーブルヘッダー行(単純なセルのList、つまりBlocksのList)

rows

テーブル行(行のList、ここで各行は単純なセルのリスト、つまりBlocksのListです)

Template

コンパイルされたテンプレートを保持する不透明な型。

Version

バージョンオブジェクト。これは「2.7.3」のようなソフトウェアバージョンを表します。オブジェクトは数値インデックス付きテーブルのように動作します。つまり、versionがバージョン2.7.3を表す場合、

version[1] == 2
version[2] == 7
version[3] == 3
#version == 3   -- 長さ

比較は要素ごとに実行されます。つまり、

Version '1.12' > Version '1.9'

この型の値は、pandoc.types.Versionコンストラクタを使用して作成できます。

must_be_at_least

must_be_at_least(actual, expected [, error_message])

実際のバージョンが期待されるバージョンよりも古い場合、エラーメッセージを発生させます。actualが期待されるバージョン以上の場合、何も行いません。

パラメータ:

actual

実際のバージョン指定子(Version)

expected

最小期待バージョン(Version)

error_message

オプションのエラーメッセージテンプレート。文字列はフォーマット文字列として使用され、期待されるバージョンと実際のバージョンが引数として渡されます。デフォルトは"expected version %s or newer, got %s"です。

使用法:

PANDOC_VERSION:must_be_at_least '2.7.3'
PANDOC_API_VERSION:must_be_at_least(
  '1.17.4',
  'pandoc-types is too old: expected version %s, got %s'
)

Chunk

ドキュメントの一部。通常、チャンクはそれぞれ別のファイルに書き込まれます。

フィールド:

heading

ヘッダーテキスト(Inlines)

id

識別子(文字列)

level

チャンク内の最上位ヘッダーのレベル(整数)

number

チャンク番号(整数)

section_number

階層的なセクション番号(文字列)

path

このチャンクのターゲットファイルパス(文字列)

up

該当する場合、囲むセクションへのリンク(Chunk|nil)

prev

該当する場合、前のセクションへのリンク(Chunk|nil)

next

該当する場合、次のセクションへのリンク(Chunk|nil)

unlisted

このチャンクのセクションが、チャンクにセクション番号がない場合でもTOCにリストされるべきかどうか。(ブール値)

contents

チャンクのブロックコンテンツ(Blocks)

ChunkedDoc

チャンクに分割されたPandocドキュメント。

フィールドtocの目次情報は、ローズツリー構造で、リストとして表現されます。ノード項目は常にインデックス0に配置され、サブエントリがリストの残りを構成します。各ノード項目には、title(Inlines)、number(string|nil)、id(string)、path(string)、およびlevel(integer)フィールドが含まれます。

フィールド:

chunks

ドキュメントを構成するチャンクのリスト(Chunksのリスト)。

meta

ドキュメントのメタデータ(Meta)

toc

目次情報(テーブル)

Module pandoc

Pandocスクリプト用のフィールドと関数。ドキュメントツリー要素のコンストラクタ、指定されたフォーマットでテキストを解析する関数、サブツリーをフィルタリングおよび変更する関数が含まれます。

フィールド

readers

Pandocが解析できるフォーマットのセット。このテーブルのすべてのキーは、pandoc.readのformat値として使用できます。(テーブル)

writers

Pandocが生成できるフォーマットのセット。このテーブルのすべてのキーは、pandoc.writeのformat値として使用できます。(テーブル)

関数

Pandoc

Pandoc (blocks[, meta])

パラメータ:

blocks

ドキュメントコンテンツ(Blocks)

meta

ドキュメントメタデータ(Meta)

結果:

  • 新しいPandocドキュメント(Pandoc)
Meta

Meta (meta)

パラメータ:

meta

メタ情報を含むテーブル(テーブル)

結果:

  • 新しいMetaテーブル(テーブル)
MetaBlocks

MetaBlocks (content)

メタデータで使用されるMetaBlocks値を作成します。入力リストのコピーをpandoc.Blocksで作成し、リスト以外のすべてのキーを破棄します。

パラメータ:

content

ブロックコンテンツ(Blocks)

結果:

  • Block要素のリスト(Blocks)
MetaBool

MetaBool (bool)

パラメータ:

bool

trueまたはfalse(ブール値)

結果:

  • 入力、変更なし(ブール値)
MetaInlines

MetaInlines (inlines)

メタデータで使用されるMetaInlines値を作成します。入力リストのコピーをpandoc.Inlinesで作成し、リスト以外のすべてのキーを破棄します。

パラメータ:

inlines

インライン要素(Inlines)

結果:

  • Inline要素のリスト(Inlines)
MetaList

MetaList (values)

メタデータで使用されるMetaList値を作成します。入力リストのコピーをpandoc.Listで作成し、リスト以外のすべてのキーを破棄します。

パラメータ:

values

値、または値のリスト(MetaValue|{MetaValue,...})

結果:

  • メタ値のリスト(List)
MetaMap

MetaMap (key_value_map)

メタデータで使用されるMetaMap値を作成します。入力テーブルのコピーを保持し、文字列キーを持つペアのみを保持し、他のすべてのキーを破棄します。

パラメータ:

key_value_map

文字列インデックス付きメタ値マップ(テーブル)

結果:

  • メタ値のマップ(テーブル)
MetaString

MetaString (s)

メタデータで使用されるMetaString値を作成します。これはブール値の恒等関数であり、完全性のためにのみ存在します。

パラメータ:

s

文字列値(文字列)

結果:

  • 変更されていない入力(文字列)
BlockQuote

BlockQuote (content)

ブロック引用要素を作成します。

パラメータ:

content

ブロックコンテンツ(Blocks)

結果:

  • BlockQuote要素(Block)
BulletList

BulletList (items)

箇条書きリストを作成します。

パラメータ:

items

リスト項目({Blocks,...})

結果:

  • BulletList要素(Block)
CodeBlock

CodeBlock (text[, attr])

コードブロック要素を作成します。

パラメータ:

text

コード文字列(文字列)

attr

要素属性(Attr)

結果:

  • CodeBlock要素(Block)
DefinitionList

DefinitionList (content)

定義リストを作成します。用語とその説明を含みます。

パラメータ:

content

定義項目({{Inlines, {Blocks,...}},...})

結果:

  • DefinitionList要素(Block)
Div

Div (content[, attr])

Div要素を作成します。

パラメータ:

content

ブロックコンテンツ(Blocks)

attr

要素属性(Attr)

結果:

Figure

Figure (content[, caption[, attr]])

Figure要素を作成します。

パラメータ:

content

図のブロックコンテンツ(Blocks)

caption

図のキャプション(Caption)

attr

要素属性(Attr)

結果:

  • Figureオブジェクト(Block)
Header

Header (level, content[, attr])

ヘッダー要素を作成します。

パラメータ:

level

見出しレベル(整数)

content

インラインコンテンツ(Inlines)

attr

要素属性(Attr)

結果:

  • Header要素(Block)
HorizontalRule

HorizontalRule ()

水平線を作成します。

結果:

  • HorizontalRule要素(Block)
LineBlock

LineBlock (content)

行ブロック要素を作成します。

パラメータ:

content

行({Inlines,...})

結果:

  • LineBlock要素(Block)
OrderedList

OrderedList (items[, listAttributes])

順序付きリストを作成します。

パラメータ:

items

リスト項目({Blocks,...})

listAttributes

リストパラメータ(ListAttributes)

結果:

  • OrderedList要素(Block)
Para

Para (content)

段落要素を作成します。

パラメータ:

content

インラインコンテンツ(Inlines)

結果:

Plain

Plain (content)

プレーン要素を作成します。

パラメータ:

content

インラインコンテンツ(Inlines)

結果:

RawBlock

RawBlock (format, text)

指定されたフォーマットの生のコンテンツブロックを作成します。

パラメータ:

format

コンテンツのフォーマット(文字列)

text

生のコンテンツ(文字列)

結果:

  • RawBlock要素(Block)
Table

Table (caption, colspecs, head, bodies, foot[, attr])

テーブル要素を作成します。

パラメータ:

caption

テーブルキャプション(Caption)

colspecs

列配置と幅(ColSpecの{...})

head

テーブルヘッダー(TableHead)

bodies

テーブルボディ(TableBodyの{...})

foot

テーブルフッター(TableFoot)

attr

要素属性(Attr)

結果:

Blocks

Blocks (block_like_elements)

Blocksリストを作成します。

パラメータ:

block_like_elements

各要素がBlock値として扱えるリスト、または単一の値。(Blocks)

結果:

  • Block要素のリスト(Blocks)
Cite

Cite (content, citations)

Citeインライン要素を作成します。

パラメータ:

content

プレースホルダーコンテンツ(Inlines)

citations

Citationのリスト(Citation{...})

結果:

Code

Code (code[, attr])

Codeインライン要素を作成します。

パラメータ:

code

コード文字列(文字列)

attr

追加属性(Attr)

結果:

Emph

Emph (content)

強調されたテキストを表すインライン要素を作成します。

パラメータ:

content

インラインコンテンツ(Inlines)

結果:

  • 新しいオブジェクト(Inline)
Image

Image (caption, src[, title[, attr]])

Image要素を作成します。

パラメータ:

caption

画像を説明するために使用されるテキスト(Inlines)

src

画像ファイルへのパス(文字列)

title

簡単な画像の説明(文字列)

attr

画像属性(Attr)

結果:

LineBreak

LineBreak ()

LineBreakインライン要素を作成します。

結果:

Link

Link (content, target[, title[, attr]])

通常はハイパーリンクであるLinkインライン要素を作成します。

パラメータ:

content

このリンクのテキスト(Inlines)

target

リンクターゲット(文字列)

title

簡単なリンクの説明(文字列)

attr

リンク属性(Attr)

結果:

Math

Math (mathtype, text)

インラインまたは表示用のMath要素を作成します。

パラメータ:

mathtype

レンダリング指定子(MathType)

text

数式コンテンツ(文字列)

結果:

Note

Note (content)

Noteインライン要素を作成します。

パラメータ:

content

脚注ブロックコンテンツ(Blocks)

結果:

Quoted

Quoted (quotetype, content)

引用符の種類と引用されたコンテンツを指定して、Quotedインライン要素を作成します。

パラメータ:

quotetype

引用符の種類(QuoteType)

content

引用符内のインライン(Inlines)

結果:

  • 引用された要素(Inline)
RawInline

RawInline (format, text)

生のインライン要素を作成します。

パラメータ:

format

コンテンツのフォーマット(文字列)

text

文字列コンテンツ(文字列)

結果:

  • rawインライン要素(Inline)
SmallCaps

SmallCaps (content)

小型大文字でレンダリングされるテキストを作成します。

パラメータ:

content

インラインコンテンツ(Inlines)

結果:

  • 新しいオブジェクト(Inline)
SoftBreak

SoftBreak ()

SoftBreakインライン要素を作成します。

結果:

Space

Space ()

Spaceインライン要素を作成します。

結果:

  • 新しいスペース(Inline)
Span

Span (content[, attr])

Spanインライン要素を作成します。

パラメータ:

content

インラインコンテンツ(Inlines)

attr

追加属性(Attr)

結果:

Str

Str (text)

Strインライン要素を作成します。

パラメータ:

text

(文字列)

結果:

Strikeout

Strikeout (content)

取り消し線付きのテキストを作成します。

パラメータ:

content

インラインコンテンツ(Inlines)

結果:

  • 新しいオブジェクト(Inline)
Strong

Strong (content)

通常は太字で表示されるテキストを表すStrong要素を作成します。

パラメータ:

content

インラインコンテンツ(Inlines)

結果:

  • 新しいオブジェクト(Inline)
Subscript

Subscript (content)

Subscriptインライン要素を作成します。

パラメータ:

content

インラインコンテンツ(Inlines)

結果:

  • 新しいオブジェクト(Inline)
Superscript

Superscript (content)

Superscriptインライン要素を作成します。

パラメータ:

content

インラインコンテンツ(Inlines)

結果:

  • 新しいオブジェクト(Inline)
Underline

Underline (content)

Underlineインライン要素を作成します。

パラメータ:

content

インラインコンテンツ(Inlines)

結果:

  • 新しいオブジェクト(Inline)

Inlines

Inlines (inline_like_elements)

引数をInlinesリストに変換します。

  • Inline要素のリストを新しいリストにコピーします。リスト内の任意の文字列sはpandoc.Str(s)として扱われます。
  • 単一のInlineをシングルトンリストに変換します。
  • 文字列をStrでラップされた単語に分割し、単語間のスペースをSpaceまたはSoftBreakとして扱います。

パラメータ:

inline_like_elements

各要素がInline値として扱えるリスト、または単一の値。(Inlines)

結果:

  • Inline要素のリスト(Inlines)
Attr

Attr ([identifier[, classes[, attributes]]])

新しい属性セットを作成します。

パラメータ:

identifier

要素識別子(string|table|Attr)

classes

要素クラス(string{...})

attributes

文字列キーと値を含むテーブル(table|AttributeList)

結果:

  • 新しいAttrオブジェクト(Attr)
Caption

Caption ([long[, short]])

新しいCaptionオブジェクトを作成します。

パラメータ:

long

完全なキャプション(Blocks)

short

短い要約キャプション(Inlines)

結果:

  • 新しいCaptionオブジェクト(Caption)

(3.6.1以降)

Cell

Cell (blocks[, align[, rowspan[, colspan[, attr]]]])

新しいテーブルセルを作成します。

パラメータ:

blocks

セルコンテンツ(Blocks)

align

テキスト配置。デフォルトはAlignDefault(Alignment)

rowspan

セルが占める行数。デフォルトは1(整数)

colspan

セルが占める列数。デフォルトは1(整数)

attr

セル属性(Attr)

結果:

  • 新しいCellオブジェクト(Cell)
AttributeList

AttributeList (attribs)

パラメータ:

attribs

属性リスト(table|AttributeList)

結果:

Citation

Citation (id, mode[, prefix[, suffix[, note_num[, hash]]]])

単一の引用を作成します。

パラメータ:

id

引用ID(例: BibTeXキー)(文字列)

mode

引用レンダリングモード(CitationMode)

prefix

(Inlines)

suffix

(Inlines)

note_num

注番号(整数)

hash

ハッシュ番号(整数)

結果:

  • 新しい引用オブジェクト(Citation)
ListAttributes

ListAttributes ([start[, style[, delimiter]]])

新しいListAttributesオブジェクトを作成します。

パラメータ:

start

最初のリスト項目の番号(整数)

style

リスト番号付けに使用されるスタイル(文字列)

delimiter

リスト番号の区切り文字(文字列)

結果:

Row

Row ([cells[, attr]])

テーブル行を作成します。

パラメータ:

cells

この行のテーブルセルのリスト(CellのList)

attr

行属性(Attr)

結果:

  • 新しいRowオブジェクト(Row)
TableBody

TableBody ([body[, head[, row_head_columns[, attr]]]])

テーブルボディを作成します。

パラメータ:

body

テーブル行のリスト(RowのList)

head

中間ヘッダー(RowのList)

row_head_columns

TableBodyの各行の行ヘッダーが占める列数(整数)

attr

テーブルボディ属性(Attr)

結果:

  • 新しいTableBodyオブジェクト(TableBody)
TableFoot

TableFoot ([rows[, attr]])

テーブルフッターを作成します。

パラメータ:

rows

テーブル行のリスト(RowのList)

attr

テーブルフッター属性(Attr)

結果:

  • 新しいTableFootオブジェクト(TableFoot)
TableHead

TableHead ([rows[, attr]])

テーブルヘッダーを作成します。

パラメータ:

rows

テーブル行のリスト(RowのList)

attr

テーブルヘッダー属性(Attr)

結果:

  • 新しいTableHeadオブジェクト(TableHead)
SimpleTable

SimpleTable (caption, align, widths, header, rows)

使用法:

local caption = "Overview"
local aligns = {pandoc.AlignDefault, pandoc.AlignDefault}
local widths = {0, 0} -- pandocに列幅を決定させる
local headers = {{pandoc.Plain({pandoc.Str "Language"})},
                 {pandoc.Plain({pandoc.Str "Typing"})}}
local rows = {
  {{pandoc.Plain "Haskell"}, {pandoc.Plain "static"}},
  {{pandoc.Plain "Lua"}, {pandoc.Plain "Dynamic"}},
}
simple_table = pandoc.SimpleTable(
  caption,
  aligns,
  widths,
  headers,
  rows
)

パラメータ:

caption

テーブルキャプション(Inlines)

align

列配置(Alignmentの{...})

widths

相対列幅(number{...})

header

テーブルヘッダー行(Blocks{...})

rows

テーブル行({Blocks,...}{...})

結果:

  • 新しいSimpleTableオブジェクト(SimpleTable)

定数

著者名はテキストに記載されています。

参照:Citation

SuppressAuthor

著者名は抑制されます。

参照:Citation

NormalCitation

デフォルトの引用スタイルが使用されます。

参照:Citation

DisplayMath

数式スタイル識別子。「表示」スタイル、つまり別行で数式を表示することを示します。

参照:Math

InlineMath

数式スタイル識別子。数式をインラインで表示することを示します。

参照:Math

SingleQuote

Quotedで使用される引用符の種類。文字列が単一引用符で囲まれていることを示します。

参照:Quoted

DoubleQuote

Quotedで使用される引用符の種類。文字列が二重引用符で囲まれていることを示します。

参照:Quoted

AlignLeft

テーブルセルは左揃えです。

参照:Table

AlignRight

テーブルセルは右揃えです。

参照:Table

AlignCenter

テーブルセルのコンテンツは中央揃えです。

参照:Table

AlignDefault

テーブルセルの配置は変更されません。

参照:Table

DefaultDelim

デフォルトのリスト番号区切り文字が使用されます。

参照:ListAttributes

Period

リスト番号はピリオドで区切られます。

参照:ListAttributes

OneParen

リスト番号は単一の括弧で区切られます。

参照:ListAttributes

TwoParens

リスト番号は二重括弧で区切られます。

参照:ListAttributes

DefaultStyle

リストはデフォルトスタイルで番号付けされます。

参照:ListAttributes

Example

リスト項目は例として番号付けされます。

参照:ListAttributes

Decimal

リストは10進整数で番号付けされます。

参照:ListAttributes

LowerRoman

リストは小文字のローマ数字で番号付けされます。

参照:ListAttributes

UpperRoman

リストは大文字のローマ数字で番号付けされます。

参照:ListAttributes

LowerAlpha

リストは小文字のアルファベットで番号付けされます。

参照:ListAttributes

UpperAlpha

リストは大文字のアルファベットで番号付けされます。

参照:ListAttributes

sha1

pandoc.utils.sha1のエイリアス(非推奨、代わりにpandoc.utils.sha1を使用してください)。

その他のコンストラクタ

ReaderOptions (opts)

新しいReaderOptions値を作成します。

パラメータ

opts

ReaderOptionsオブジェクトのプロパティのサブセットを持つテーブル、または別のReaderOptionsオブジェクト。明示的に指定されていないすべてのプロパティには、マニュアルに記載されているデフォルト値が使用されます。テーブルにReaderOptionsオブジェクトに存在しないプロパティが含まれている場合、エラーが発生します。(ReaderOptions|table)

結果:新しいReaderOptionsオブジェクト

使用法:

-- コマンドラインで定義されたリーダーオプションのコピー。
local cli_opts = pandoc.ReaderOptions(PANDOC_READER_OPTIONS)

-- デフォルトのリーダーオプションですが、列数は66に設定されています。
local short_colums_opts = pandoc.ReaderOptions {columns = 66}
WriterOptions (opts)

新しいWriterOptions値を作成します。

パラメータ

opts

WriterOptionsオブジェクトのプロパティのサブセットを持つテーブル、または別のWriterOptionsオブジェクト。明示的に指定されていないすべてのプロパティには、マニュアルに記載されているデフォルト値が使用されます。テーブルにWriterOptionsオブジェクトに存在しないプロパティが含まれている場合、エラーが発生します。(WriterOptions|table)

結果:新しいWriterOptionsオブジェクト

使用法:

-- コマンドラインで定義されたライターオプションのコピー。
local cli_opts = pandoc.WriterOptions(PANDOC_WRITER_OPTIONS)

-- デフォルトのライターオプションですが、DPIは300に設定されています。
local short_colums_opts = pandoc.WriterOptions {dpi = 300}

ヘルパー関数

pipe (command, args, input)

コマンドを引数付きで実行し、入力を渡して、出力を返します。

パラメータ:

command

実行するプログラム。実行可能ファイルは、デフォルトのシステムメソッドを使用して解決されます(文字列)。

args

プログラムに渡す引数のリスト(文字列のリスト)。

input

標準入力経由でプログラムにパイプされるデータ(文字列)。

結果:

  • コマンドの出力、つまり標準出力に印刷されたデータ(文字列)

例外:

  • コマンドがゼロ以外のエラーコードで終了した場合、command、error_code、およびoutputのキーを含むテーブルがスローされます。

使用法:

local output = pandoc.pipe("sed", {"-e","s/a/b/"}, "abc")
walk_block (element, filter)

Block要素内でフィルタを適用し、そのコンテンツをウォークします。フィルタが適用された(ディープ)コピーを返します。元の要素は変更されません。

パラメータ:

element

Block要素

filter

Block要素内で適用するLuaフィルタ(関数のテーブル)

結果:

  • 変換されたBlock要素
walk_inline (element, filter)

Inline要素内でフィルタを適用し、そのコンテンツをウォークします。フィルタが適用された(ディープ)コピーを返します。元の要素は変更されません。

パラメータ:

element

Inline要素

filter

Inline要素内で適用するLuaフィルタ(関数のテーブル)

結果:

  • 変換されたInline要素
with_state (options, callback)

変更されたPandoc状態を持つ関数を実行します。

指定されたコールバックは、Pandoc状態を指定された値に設定した後で呼び出されます。コールバックが返却されると、変更可能なオプションは元の値に戻されます。

制御できる状態変数には以下が含まれます。

  • request_headers(キーと値のタプルのリスト)
  • resource_path(ファイルパスのリスト)
  • user_data_dir(文字列)

他のオプションは無視され、残りの状態は変更されません。

使用法:

local opts = {
  request_headers = {
    {'Authorization', 'Basic my-secret'}
  }
}
pandoc.with_state(opts, function ()
  local mime, contents = pandoc.mediabag.fetch(image_url)
)
read (markup[, format[, reader_options[, read_env]]])

指定された文字列をPandocドキュメントに解析します。

パーサーは、メイン入力ファイルを読み取るために使用されたのと同じ環境で実行されます。ファイルシステムとメディアバッグへのフルアクセス権を持ちます。これは、ドキュメントがLaTeX、reStructuredText、Orgなどのフォーマットで可能であるように、含めるファイルを指定した場合、それらが結果のドキュメントに含まれることを意味します。メディア要素は、他の解析済み入力ファイルから取得されたものに追加されます。この動作を変更するには、read_envパラメータを使用します。

formatパラメータは、解析されるフォーマットのフレーバーを定義します。これは、+と-を使用して拡張機能を有効または無効にする文字列、またはformat(文字列)とextensions(テーブル)のフィールドを持つテーブルのいずれかです。extensionsテーブルは、すべての有効な拡張機能のリスト、または拡張機能をキーとし、それらの有効化ステータスを値(trueまたは'enable'で有効化、falseまたは'disable'で無効化)とするテーブルにすることができます。

注意:reader_optionsのextensionsフィールドは無視されます。この関数は常にformatパラメータを介して指定されたフォーマット拡張機能を使用するためです。

パラメータ:

markup

解析するマークアップ(string|Sources)

format

フォーマット指定。デフォルトは"markdown"です。このパラメータの完全な説明については、上記の説明を参照してください。(string|table)

reader_options

リーダーに渡されるオプション。ReaderOptionsオブジェクトまたはReaderOptionsオブジェクトのキーと値のサブセットを持つテーブルである可能性があります。マニュアルに記載されているデフォルト値にデフォルト設定されます。(ReaderOptions|table)

read_env

値が指定されていないかnilの場合、グローバル環境が使用されます。ファイル名のリストを渡すと、リーダーはサンドボックスで実行されます。指定されたファイルはファイルシステムから読み取られ、偽のファイルシステムを介してサンドボックスに提供されます。テーブルには、ファイル名からコンテンツへのマッピングを含めることもでき、これらは偽のファイルシステムを埋めるために使用されます。

結果:

  • pandocドキュメント(Pandoc)

使用法:

local org_markup = "/emphasis/"  -- 読み込む入力
local document = pandoc.read(org_markup, "org")
-- ドキュメントの最初のブロックを取得
local block = document.blocks[1]
-- そのブロック内のインライン要素は `Emph` です
assert(block.content[1].t == "Emph")
write (doc[, format[, writer_options]])

ドキュメントを指定されたターゲットフォーマットに変換します。

注意:writer_optionsのextensionsフィールドは無視されます。この関数は常にformatパラメータを介して指定されたフォーマット拡張機能を使用するためです。

パラメータ:

doc

変換するドキュメント(Pandoc)

format

フォーマット指定。デフォルトは"html"です。このパラメータの完全な説明については、pandoc.readのドキュメントを参照してください。(string|table)

writer_options

ライターに渡されるオプション。WriterOptionsオブジェクトまたはWriterOptionsオブジェクトのキーと値のサブセットを持つテーブルである可能性があります。マニュアルに記載されているデフォルト値にデフォルト設定されます。(WriterOptions|table)

結果:

  • 変換されたドキュメント(文字列)

使用法:

local doc = pandoc.Pandoc(
  {pandoc.Para {pandoc.Strong 'Tea'}}
)
local html = pandoc.write(doc, 'html')
assert(html == "<p><strong>Tea</strong></p>")
write_classic (doc[, writer_options])

現在の環境で定義された関数を使用して、クラシックなカスタムLuaライターを実行します。

パラメータ:

doc

変換するドキュメント(Pandoc)

writer_options

ライターに渡されるオプション。WriterOptionsオブジェクトまたはWriterOptionsオブジェクトのキーと値のサブセットを持つテーブルである可能性があります。マニュアルに記載されているデフォルト値にデフォルト設定されます。(WriterOptions|table)

結果:

  • 変換されたドキュメント(文字列)

使用法:

-- この関数を追加すると、クラシックライターが
-- 新しいスタイルのカスタムライターに変換されます。
function Writer (doc, opts)
  PANDOC_DOCUMENT = doc
  PANDOC_WRITER_OPTIONS = opts
  loadfile(PANDOC_SCRIPT_FILE)()
  return pandoc.write_classic(doc, opts)
end

Module pandoc.cli

コマンドラインオプションと引数解析。

フィールド

default_options

JSONライクな表現を使用したデフォルトのCLIオプション。(テーブル)

関数

parse_options

parse_options (args)

コマンドライン引数をPandocオプションに解析します。通常、この関数はスタンドアロンPandoc Luaスクリプトで使用され、グローバルargから引数のリストを取得します。

パラメータ:

args

コマンドライン引数のリスト(string{...})

結果:

  • 解析されたオプション。JSONライクな表現を使用します。(テーブル)

(3.0以降)

repl

repl ([env])

Read-Eval-Printループ(REPL)を開始します。この関数は、最後の評価された入力のすべての値を返します。REPLを終了するには、Ctrl-DまたはCtrl-Cを押します。キーバインディングのリストを取得するにはF1を押します。

REPLはグローバル名前空間で開始されますが、envパラメータが指定されている場合は例外です。その場合、グローバル名前空間はこのテーブルにマージされ、結果はREPLの_ENV値として使用されます。

具体的には、ローカル変数は明示的にenvパラメータを介して渡されない限りアクセスできません。例:

function Pandoc (doc)
  -- replで`doc`パラメータにアクセスできるように、replを開始します。
  return pandoc.cli.repl{ doc = doc }
end

注意:Windowsでは、関数はプロンプトなしで即座に終了するようです。

パラメータ:

env

追加環境。グローバル環境はこのテーブルにマージされます。(テーブル)

結果:

最後の評価された入力の結果、または最後の入力がエラーになった場合は何も返しません。

(3.1.2以降)

Module pandoc.utils

このモジュールは、内部Pandoc関数とユーティリティ関数を公開します。

関数

blocks_to_inlines

blocks_to_inlines (blocks[, sep])

BlockのリストをInlineのリストに圧縮します。

使用法

local blocks = {
  pandoc.Para{ pandoc.Str 'Paragraph1' },
  pandoc.Para{ pandoc.Emph 'Paragraph2' }
}
local inlines = pandoc.utils.blocks_to_inlines(blocks)
assert(
  inlines == pandoc.Inlines {
    pandoc.Str 'Paragraph1',
    pandoc.Linebreak(),
    pandoc.Emph{ pandoc.Str 'Paragraph2' }
  }
)

パラメータ:

blocks

平坦化するBlock要素のリスト。(Blocks)

sep

2つの連続するBlockの間に挿入されるInline要素のリスト。デフォルトは{pandoc.LineBreak()}です。(Inlines)

結果:

(2.2.3以降)

citeproc

citeproc (doc)

ファイル内の引用を処理し、レンダリングされた引用に置き換え、参考文献を追加します。詳細については、引用レンダリングに関するマニュアルセクションを参照してください。

使用法:

-- `--citeproc`と同様に動作するLuaフィルタ
function Pandoc (doc)
  return pandoc.utils.citeproc(doc)
end

パラメータ:

doc

ドキュメント(Pandoc)

結果:

  • 処理されたドキュメント(Pandoc)

(2.19.1以降)

documentation

documentation (object[, format])

Pandocによって定義された関数またはモジュールのドキュメントを返します。指定されたオブジェクトのドキュメントがない場合、エラーが発生します。

結果フォーマットは、pandoc.writeが受け入れる任意のテキストフォーマットにすることができ、ドキュメントはそのフォーマットで返されます。さらに、特別なフォーマットblocksが受け入れられ、その場合、ドキュメントはBlocksとして返されます。

パラメータ:

object

このオブジェクトのドキュメントを取得します(any)

format

結果フォーマット。デフォルトは'ansi'です(string|table)

結果:

  • レンダリングされたドキュメント(string|Blocks)

(3.8.4以降)

equals

equals (element1, element2)

AST要素の等価性をテストします。Luaの要素は、アンマーシャリングによって得られたオブジェクトが等しい場合にのみ等しいと見なされます。

この関数は非推奨です。 通常のLua == 等価演算子を使用してください。

パラメータ:

element1

(any)

element2

(any)

結果:

  • 2つのオブジェクトが同じ要素を表すかどうか(ブール値)

(2.5以降)

from_simple_table

from_simple_table (simple_tbl)

SimpleTableからTable Block要素を作成します。これは、pandoc 2.10より前のバージョン用に記述されたレガシーコードを処理する場合に役立ちます。

使用法:

local simple = pandoc.SimpleTable(table)
-- pandoc 2.10より前のメソッドを使用して変更します。
simple.caption = pandoc.SmallCaps(simple.caption)
-- 通常のテーブルブロックを再度作成します。
table = pandoc.utils.from_simple_table(simple)

パラメータ:

simple_tbl

(SimpleTable)

結果:

  • テーブル Block要素(Block)

(2.11以降)

make_sections

make_sections (number_sections, baselevel, blocks)

Block要素のリストをセクションに変換します。各Headerから始まるDivが作成され、次の同等レベルのHeaderまで続くコンテンツが含まれます。number_sectionsがtrueの場合、セクション番号を含むnumber属性が各Headerに追加されます。base_levelがnullでない場合、ギャップがなくなり、ベースレベルが指定されたレベルになるようにHeaderレベルが再編成されます。

パラメータ:

number_sections

セクションdivにセクション番号を含む追加のnumber属性を取得するかどうか。(ブール値)

baselevel

トップレベルの見出しを指定されたレベルにシフトします(integer|nil)

blocks

処理するブロックのリスト(Blocks)

結果:

  • セクション付きのブロック(Blocks)

(2.8以降)

normalize_date

normalize_date (date)

日付を解析し、「YYYY-MM-DD」形式に(可能であれば)変換します。年は1601〜9999の範囲に制限します(ISO 8601は1583以降を許可しますが、MS Wordは1601以降の日付のみを許可します)。変換が失敗した場合、文字列の代わりにnilを返します。

パラメータ:

date

日付文字列(文字列)

結果:

  • 正規化された日付、または正規化が失敗した場合はnil。(string|nil)

(2.0.6以降)

references

references (doc)

メタデータ内でインラインで定義された参照と外部参考文献から参照を取得します。実際にドキュメントで引用されている参照(実際の引用またはnociteを使用)のみが返されます。URL変数はリンクに変換されます。

参照値を表す構造はCSL JSONで使用される構造に対応しており、返り値は参考文献の生成時にpandocとciteprocが使用する値の1つであるreferencesメタデータとして使用できます。

使用法:

-- 引用されたすべての参照をドキュメントに含める
function Pandoc (doc)
  doc.meta.references = pandoc.utils.references(doc)
  doc.meta.bibliography = nil
  return doc
end

パラメータ:

doc

ドキュメント(Pandoc)

結果:

  • 参照のリスト。(テーブル)

(2.17以降)

run_json_filter

run_json_filter (doc, filter[, args])

指定されたドキュメントをJSONフィルタに通してフィルタリングします。

パラメータ:

doc

フィルタリングするPandocドキュメント(Pandoc)

filter

実行するフィルタ(文字列)

args

フィルタに渡される引数のリスト。デフォルトは{FORMAT}です。(string{...})

結果:

  • フィルタリングされたドキュメント(Pandoc)

(2.1.1以降)

run_lua_filter

run_lua_filter (doc, filter[, env])

指定されたドキュメントをLuaフィルタに通してフィルタリングします。

フィルタは現在のLuaプロセスで実行されます。

パラメータ:

doc

フィルタリングするPandocドキュメント(Pandoc)

filter

実行するフィルタのファイルパス(文字列)

env

フィルタをロードして実行する環境(テーブル)

結果:

  • フィルタリングされたドキュメント(Pandoc)

(3.2.1以降)

sha1

sha1 (input)

指定された文字列入力のSHA1ハッシュを計算します。

パラメータ:

input

(文字列)

結果:

  • 16進数ハッシュ値(文字列)

(2.0.6以降)

stringify

stringify (element)

指定された要素(Pandoc、Meta、Block、またはInline)を、フォーマットをすべて削除した文字列に変換します。

パラメータ:

element

Pandoc AST要素(Pandoc|Block|Inline|Caption|Cell|MetaValue)

結果:

  • 指定された要素のプレーンな文字列表現。(文字列)

(2.0.6以降)

to_roman_numeral

to_roman_numeral (n)

整数 < 4000 を大文字のローマ数字に変換します。

使用法:

local to_roman_numeral = pandoc.utils.to_roman_numeral
local pandoc_birth_year = to_roman_numeral(2006)
-- pandoc_birth_year == 'MMVI'

パラメータ:

n

4000未満の正の整数(整数)

結果:

  • ローマ数字。(文字列)

(2.0.6以降)

to_simple_table

to_simple_table (tbl)

テーブルを古い/単純なテーブルに変換します。

使用法:

local simple = pandoc.utils.to_simple_table(table)
-- pandoc 2.10より前のメソッドを使用して変更します。
simple.caption = pandoc.SmallCaps(simple.caption)
-- 通常のテーブルブロックを再度作成します。
table = pandoc.utils.from_simple_table(simple)

パラメータ:

tbl

テーブル(Block)

結果:

(2.11以降)

type

type (value)

Luaのデフォルトのtype関数に似たPandoc対応バージョンで、マニュアルに記載されているような型情報を返します。

この関数は、メタフィールド__nameをチェックすることによって機能します。引数が文字列値のメタフィールド__nameを持っている場合、その文字列を返します。それ以外の場合は、通常のtype関数と同じように動作します。

使用法:

-- 'string'、'boolean'、'Inlines'、'Blocks'、
-- 'table'、および'nil'のいずれかを返します。これは、Haskellコンストラクタ
-- MetaString、MetaBool、MetaInlines、MetaBlocks、MetaMap、
-- および未設定の値に対応します。

function Meta (meta)
  print('type of metavalue `author`:', pandoc.utils.type(meta.author))
end

パラメータ:

value

任意のLua値(any)

結果:

  • 指定された値の型(文字列)

(2.17以降)

Version

Version (v)

Versionオブジェクトを作成します。

パラメータ:

v

バージョン記述子(Version|string|{integer,...}|number)

結果:

  • 新しいVersionオブジェクト(Version)

Module pandoc.mediabag

pandoc.mediabagモジュールは、Pandocのメディアストレージへのアクセスを可能にします。「メディアバッグ」は、Pandocが--extract-mediaまたは(HTMLのみの場合)--embed-resourcesオプション付きで呼び出されたときに使用されます。

このモジュールはモジュールpandocの一部としてロードされ、pandoc.mediabagフィールドを介してアクセスするか、明示的にrequireすることでアクセスできます。例:

local mb = require 'pandoc.mediabag'

関数

delete

delete (filepath)

メディアバッグから単一のエントリを削除します。

パラメータ:

filepath

削除するアイテムのファイルパス。指定されたファイルパスのエントリが存在しない場合、メディアバッグは変更されません。(文字列)

(2.7.3以降)

empty

empty ()

メディアバッグをクリアし、すべてのアイテムを削除します。

(2.7.3以降)

fetch

fetch (source)

指定されたソースをURLまたはローカルファイルから取得します。コンテンツとMIMEタイプ(または空文字列)の2つの値を返します。

この関数は、まずsourceをメディアバッグから取得しようとします。失敗した場合、Pandocのリソースパス設定を尊重しながら、ダウンロードまたはローカルファイルシステムからの読み取りを試みます。

使用法:

local diagram_url = 'https://pandoc.org/diagram.jpg'
local mt, contents = pandoc.mediabag.fetch(diagram_url)

パラメータ:

source

リソースへのパス。ローカルファイルパスまたはURI(文字列)

結果:

  • エントリのMIMEタイプ、またはファイルが見つからなかった場合はnil。(文字列)

  • ファイルのコンテンツ、またはファイルが見つからなかった場合はnil。(文字列)

(2.0以降)

fill

fill (doc)

ドキュメント内の画像でメディアバッグを埋めます。取得できない画像は、画像の説明を含むクラス「image」のSpanに置き換えられます。

メディアバッグに既にエントリがある画像は、再度処理されません。

パラメータ:

doc

メディアバッグを埋めるドキュメント(Pandoc)

結果:

  • 変更されたドキュメント(Pandoc)

(2.19以降)

insert

insert (filepath, mimetype, contents)

Pandocのメディアバッグに新しいエントリを追加します。同じfilepathを持つ既存のメディアバッグエントリを置き換えます。

使用法:

local fp = 'media/hello.txt'
local mt = 'text/plain'
local contents = 'Hello, World!'
pandoc.mediabag.insert(fp, mt, contents)

パラメータ:

filepath

出力フォルダに対するファイル名とパス。(文字列)

mimetype

アイテムのMIMEタイプ。MIMEタイプが不明または利用できない場合はnilを使用します。(string|nil)

contents

ファイルのバイナリコンテンツ。(文字列)

(2.0以降)

items

items ()

Luaのジェネリックforステートメントで使用できるイテレータトリプルを返します。イテレータは、呼び出しごとにメディアバッグアイテムのファイルパス、MIMEタイプ、およびコンテンツを返します。コンテンツへの完全なアクセスが必要な場合を除き、アイテムは1つずつ処理されます。他のすべてのケースでは、listを使用する必要があります。

使用法:

for fp, mt, contents in pandoc.mediabag.items() do
  -- print(fp, mt, contents)
end

結果:

イテレータトリプル:

  • イテレータ関数。イテレータの状態と現在のイテレータ値を渡して呼び出す必要があります。
  • イテレータ状態 - イテレータ関数に渡される不透明な値。
  • 初期イテレータ値。

(2.7.3以降)

list

list ()

現在のメディアバッグコンテンツの概要を取得します。

使用法:

-- メディアバッグのサイズを計算します。
local mb_items = pandoc.mediabag.list()
local sum = 0
for i = 1, #mb_items do
    sum = sum + mb_items[i].length
end
print(sum)

結果:

  • メディアバッグの各エントリを要約する要素のリスト。要約項目には、それぞれファイルパス、MIMEタイプ、およびバイト単位のコンテンツ長を示すpath、type、lengthキーが含まれます。(テーブル)

(2.0以降)

lookup

lookup (filepath)

メディアバッグ内のメディアアイテムを検索し、そのMIMEタイプとコンテンツを返します。

使用法:

local filename = 'media/diagram.png'
local mt, contents = pandoc.mediabag.lookup(filename)

パラメータ:

filepath

検索するファイルの名前。(文字列)

結果:

  • エントリのMIMEタイプ、またはファイルが見つからなかった場合はnil。(文字列)

  • ファイルのコンテンツ、またはファイルが見つからなかった場合はnil。(文字列)

(2.0以降)

make_data_uri

make_data_uri (mime_type, raw_data)

入力データをRFC 2397で定義されているデータURIに変換します。

例:

-- 非公式のPandocロゴを埋め込む
local pandoc_logo_url = 'https://raw.githubusercontent.com/'
  .. 'tarleb/pandoc-logo/main/pandoc.svg'

local datauri = pandoc.mediabag.make_data_uri(
  pandoc.mediabag.fetch(pandoc_logo_url)
)

local image = pandoc.Image('Logo', datauri)

パラメータ:

mime_type

データのMIMEタイプ(文字列)

raw_data

エンコードするデータ(文字列)

結果:

  • データURI(文字列)

(3.7.1以降)

write

write (dir[, fp])

メディアバッグのコンテンツを指定されたターゲットディレクトリに書き込みます。fpが指定されている場合、指定された名前のリソースのみが抽出されます。このパラメータを省略すると、メディアバッグ全体が抽出されます。fpが指定されているがメディアバッグで見つからない場合、エラーが発生します。

パラメータ:

dir

ターゲットディレクトリのパス(文字列)

fp

リソースの正規名(相対パス)(文字列)

(3.0以降)

Module pandoc.List

このモジュールはPandocのリスト型を定義します。便利なメソッドと関数が付属しています。

コンストラクタ

pandoc.List([table])

新しいListを作成します。オプションの引数tableが指定されている場合、その値のメタテーブルをpandoc.Listに設定します。これはpandoc.List:new([table])のエイリアスです。

メタメソッド

pandoc.List:__concat (list)

2つのリストを連結します。

パラメータ:

list

最初のリストに連結される2番目のリスト

結果:

  • list1とlist2のすべての要素を含む新しいリスト
pandoc.List:__eq (a, b)

2つのリストの等価性を比較します。リストは、同じタイプ(つまり、同じ非nilメタテーブルを持つ)、同じ長さ、およびすべての要素が等しい場合にのみ等しいと見なされます。

パラメータ:

a, b

任意のLuaオブジェクト

結果:

  • 2つのリストが等しい場合はtrue、それ以外の場合はfalse。

メソッド

pandoc.List:at

:at (index[, default])

指定されたインデックスの要素、またはリストにその位置のアイテムがない場合はdefaultを返します。

負の整数はリストの最後のアイテムから逆方向にカウントします。

パラメータ:

index

要素の位置(整数)

default

インデックスが範囲外の場合に返されるデフォルト値(any)

結果:

  • indexのリストアイテム、またはdefault。
pandoc.List:clone ()

リストの(浅い)コピーを返します。(リストのディープコピーを取得するには、空のフィルタでwalkを使用します。)

pandoc.List:extend (list)