Re:VIEWのVer2系からVer3系への移行に関する覚書き

Re:VIEWのVer2系からVer3系への移行に関する覚書き

概要

Re:VIEWを、Ver2.5からVer3.5環境へ移行した。その際の覚書きをメモ。

なお「Ver2.5系の環境も残せば？」ってのはその通りなのだが、、、モバイル側はストレージ容量の都合もあるので私は削除した。メインPCにはVer2.5系を残した。

調べものするときは

Google先生に聞いても、Review以外のネタがヒットしやすい。
なので、公式の「Re:VIEWナレッジベース」をまず最初に検索するのがおススメ。

3系へのアップデートへの対応は以下とする

• 新規の作成分は Re:VIEW 3.x とする。現時点なら3.1を利用。
  • 可能な範囲で、新しい方が良い。改善もされているはず。
• 新規の作成分は、テクブさん（Teckboosterさん）のテンプレートをベースとする。
  • まだ検証が済んでるテンプレが少ない。本家さんのでも良いんだけど、好みの問題。
• 過去のソースは、移行しない。
  • 大半は、Re:VIEW 3.x環境の「バージョン2のモード」を利用することでコンパイル可能。

なお、公式のアップデート履歴は以下を確認のこと。
バージョン間の破壊的な変更内容は「非互換の変更」として記載がある。
https://github.com/kmuto/review/blob/master/NEWS.ja.md

せっかくなので、公式のクイックスタートの記載も( ..)φメモメモ。
コンパイルコマンドなどは変更なし。
https://github.com/kmuto/review/blob/master/doc/quickstart.md

Dockerイメージは、いつものワカメさんのリポジトリから取れる。
https://github.com/vvakame/docker-review

shdo docker pull vvakame/review:3.1

※当方は、Windows 10 + WSL + Docker環境を利用。参考までにその際の構築手順はこちら「Windows 10 HomeでWSL越しにDocker for Ubuntu+Re VIEWを使う（VM不要）」。

コマンドメモ

クイックスタートのreview-initコマンドで検証するより、
テクブさんのテンプレートで検証した方が、捉えやすい。

Re:VIEW環境のdockerイメージ取得済みの、次の環境を前提とする。

$ docker image ls
REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
vvakame/review      3.1                 e78ab97266ca        2 weeks ago         1.81 GB
vvakame/review      2.5                 b5134aad394f        8 months ago        1.79 GB

この状態で、それぞれの過去のRe:VIEWのソースファイルを置いてるフォルダに移動して、
直下に articles フォルダがある状態とする。次のそれぞれのコンパイルコマンドで、
Re:VIEWのv2.5とv3.1でコンパイル確認する。
v2.5は既存環境なので、失敗はしないはずだが、念のため。

docker run --rm -v `pwd`/articles:/work vvakame/review:2.5 /bin/sh -c "cd /work && review-pdfmaker config.yml"
docker run --rm -v `pwd`/articles:/work vvakame/review:3.1 /bin/sh -c "cd /work && review-pdfmaker config.yml"

参考までに、その他のコマンドもメモ。

docker run -v /mnt/d/GitHub_MobileRepo:/work -it vvakame/review:2.5 /bin/sh
docker run -v /mnt/d/GitHub_MobileRepo:/work -it vvakame/review:3.1 /bin/sh

アップデート周りで確認済み事項

• テクブさんのテンプレートを、3.x系でコンパイル出来ること。

  • https://github.com/TechBooster/ReVIEW-Template

• 一部を除いて、config.yaml に「review_version: 2.0」を指定しておけば、Review 3.1環境でもReview 2.xをコンパイル可能であることを確認した。

  • 「一部、だめなケース」は実際にコンパイルして確認にするしかない。私は５個？中の1つがダメだった。
  • なお、ページ数などは若干(10ページくらい)変動する。出力は完全には同じではない、ことに注意。

config.yml パラメータの review_version が 2 （Re:VIEW 2 のプロジェクト）のときには、
バージョン2のモードとして動作するようにし、できるだけ生成結果がこれまでと変わらないようにしています。
https://review-knowledge-ja.readthedocs.io/ja/latest/latex/review3-latex.html?highlight=review_version

「メジャーバージョンが異なる」場合の挙動は、Re:VIEW 2.xまでと3.xとで変わったようだ。

# この設定ファイルでサポートするRe:VIEWのバージョン番号。
# major versionが違うときにはエラーを出す。
review_version: 2.0

# この設定ファイルでサポートするRe:VIEWのバージョン番号。
review_version: 3.0

• 独自のtexstyleは駄目な場合が多いようだ。
  • しばらくは、標準の texstyle: ["reviewmacro"] を使うのが面倒が少ない気配。
  • review-updateコマンドも、この"reviewmacro"に対する動作のようだ。

バージョン2→バージョン3の更新は、review-update コマンドで実施できます。
重要なプロジェクトの場合は慎重に更新し、生成結果に不都合な差異が発生していないか、再調整が必要かどうかを確認しましょう。
https://review-knowledge-ja.readthedocs.io/ja/latest/latex/review3-latex.html?highlight=review_version

以上ー。