Skip to content

kotobuki/pandoc-ruby-filter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

pandoc-ruby-filter

このPandoc用フィルターは、文章中のルビ表記を処理して、LaTeXやHTMLなどの出力形式に合わせて変換します。このフィルターを制作するにあたり、minokiさんのpandoc-aozora-rubyを参照しています。ただし、pandoc-aozora-rubyでサポートされていた省略記法(漢字から始まる文字列に対して|を省略できる)には対応していません。

入力形式

フィルターは、次の形式のルビ表記を認識します。

|単語《よみがな》

出力形式

フィルターは、出力形式に応じて次のようにルビ表記を変換します。

  • LaTeXの場合:\ruby{単語}{よみがな}
  • HTMLの場合:<ruby>単語<rp>《</rp><rt>よみがな</rt><rp>》</rp></ruby>
  • 上記以外の場合:入力形式と同じまま維持されます。

使い方

  1. Pandocがインストールされていることを確認してください(Pandocのインストール方法)。
  2. 本リポジトリをダウンロードし、Luaスクリプト(ruby_filter.lua)をパスの通っている場所に移動するか、適当な場所に移動してパスを通します。
  3. Pandocコマンドで、--lua-filterオプションを使用してフィルターを適用します。例:
pandoc input.md --lua-filter=ruby_filter.lua -o output.html

この例では、input.mdというMarkdownファイルを入力として使用し、フィルターを適用してoutput.htmlというHTMLファイルを生成しています。

注意事項

このフィルターは、PandocのStr要素(文字列)を処理します。そのため、ルビ表記が複数のStr要素にまたがっている場合、正しく処理されないことがあります。ルビ表記が正しく認識されるように、適切な場所で改行や空白を挿入してください。

備考

本リポジトリのコードおよびREADMEはChatGPT(モデル:GPT-4)との対話を通じて生成したものです。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages