Skip to content

Latest commit

 

History

History
134 lines (96 loc) · 5.15 KB

README.md

File metadata and controls

134 lines (96 loc) · 5.15 KB
Raw

pandoc2review

Gem Version Build Status

pandoc2review is Re:VIEW Filter/Writer for Pandoc. You can convert any documents to Re:VIEW format.

  • Use case 1: It can be used to first convert a manuscript such as Markdown or Docx into Re:VIEW format (.re) for an editing and typesetting environment using Re:VIEW.
  • Use case 2: It can be used to continue to use Markdown as your writing format, but use Re:VIEW for typesetting.

Installation

RubyGems. Recommended

  1. Setup Ruby (any versions) and Pandoc (newer is better).
  2. Do gem install pandoc2review.

Custom

  1. Setup Ruby (any versions) and Pandoc (newer is better).
  2. Clone this repository, or download release file and extract somewhere.
  3. Do bundle install in extracted pandoc2review folder.
  4. (Optional) Modify PATH environment variable to point the extracted pandoc2review folder, to ease to call pandoc2review command without its absolute path.

Usage

For Markdown:

pandoc2review file.md > file.re

For other files (such as Microsoft docx, LaTeX, etc.):

pandoc2review file > file.re

Options

  • --shiftheading <num>: Add to heading level. (pandoc >= 2.8)
  • --disable-eaw: Disable compositing a paragraph with Ruby's EAW library.
  • --hideraw: Hide raw inline/block with no review format specified.

Specification etc.

Copyright

Copyright 2020-2023 Kenshi Muto and atusy

GNU General Public License Version 2

Special Thanks

Changelog

2.0.0

  • Full refactoring for Pandoc 3 model. Thanks atusy for your hard work!
  • Introduce rubocop and regression tests.

1.6.0

  • Fix inline raw.
  • Refactoring.

1.5.0

  • Support Pandoc 3.

1.4.0

  • Fix an error when empty div block is received.
  • Introduce '--strip-emptydev' to strip empty block //{-//}, produced by TeX file.

1.3.0

  • Fix "attempt to index global 'first' (a nil value)" error in a docx file.

1.2.0

  • Release gem file for RubyGems.
  • Refactoring for gem style.

1.1.0

  • Improve block (Div) convertion, in particular of caption and texequation.
  • Add sample how you can integrate Markdown files to your Re:VIEW project folder.
  • Add blankline support.
  • Add noindent support.
  • Use @<br>{} for Linebreak instead of linefeed.
  • Refactoring.

1.0.0

  • Initial Release.

日本語での説明

pandoc2review は、Pandoc の Re:VIEW Filter/Writer です。各種のドキュメントから Re:VIEW 形式に変換できます。

  • ユースケース 1: Re:VIEW の編集・組版環境向けに、Markdown や Docx などの原稿を最初に Re:VIEW 形式 (.re) に変換できます。
  • ユースケース 2: Markdown を原稿形式として使い続けながら、Re:VIEW の組版環境を使うことができます。

インストール

RubyGems (推奨)

  1. Ruby (バージョンは問いません) および Pandoc (新しいものほどよいです) をセットアップします。
  2. gem install pandoc2review を実行します。

カスタム

  1. Ruby (バージョンは問いません) および Pandoc (新しいものほどよいです) をセットアップします。
  2. このリポジトリをクローンするか、リリースファイルをダウンロードして適当な場所に展開します。
  3. 展開した pandoc2review フォルダ内で、bundle install を実行します。
  4. (必要であれば) pandoc2review コマンドを絶対パス指定なしで呼び出せるよう、PATH 環境変数に展開した pandoc2review フォルダのパスを追加します。

使い方

Markdown の場合:

pandoc2review ファイル.md > ファイル.re

その他のファイル (Microsoft docx, LaTeX, など) の場合:

pandoc2review ファイル名 > ファイル名.re

オプション

  • --shiftheading <数>: 見出しレベルに <数> だけ加えます (pandoc >= 2.8)
  • --disable-eaw: Ruby の EAW ライブラリを使った段落構築を使いません
  • --hideraw: raw 判定されたインライン・ブロックを出力に含めません
  • --classic-writer: Pandoc 3 で Pando 2 互換のクラシックカスタム Writer モードを使います

仕様など