Re:VIEWとSphinxと、時々、ボク

お前だれよ

若山史郎 / @r_rudi

「Sphinxをはじめよう」著者の一人

最近全然動けてません…

軽量マークアップは星の数ほど

• Markdown
• CommonMark
• Wiki記法
• Re:VIEW
• reStructuredText
• AsciiDoc
• LaTeX

etc, etc….

軽量マークアップの傾向

カバー範囲がそれぞれ異なる

• Markdown
  • Web
• Re:VIEW
  • 技術書籍
• reStructuredText/Sphinx
  • Web、PDF(not 組版)

reSTはPDFにはできるが、日本語組版にはそこまでではない。Re:VIEWは強力だし、実績も多数。

しかし、執筆はSphinxでやりたい。reSTからRe:VIEW経由すれば印刷もいけるんじゃね！

作りました

reSTからRe:VIEWへの変換

sphinxcontrib-reviewbuilder

% pip install sphinxcontrib-reviewbuilder
% emacsclient -n conf.py

書き加える
extensions = ['sphinxcontrib.reviewbuilder']


% make review

review形式で書きだしてくれるすごい拡張です

できあがり (1/2)

=={id1} お前だれよ

若山史郎 / @r_rudi

「Sphinxをはじめよう」著者の一人

//image[r_rudi][]{
//}

最近全然動けてません…

できあがり (2/2)

=={id4} 作りました

reSTからRe:VIEWへの変換

@<code>{sphinxcontrib-reviewbuilder}

//cmd{
% pip install sphinxcontrib-reviewbuilder
% emacsclient -n conf.py

書き加える
extensions = ['sphinxcontrib.reviewbuilder']

% make review
//}

review形式で書きだしてくれるすごい拡張です

Sphinxをはじめよう 第二版

仕事ではじめる機械学習

Real World HTTP

Re:VIEWからreSTへの変換

Re:VIEW本体にrst builderを追加 (PR #733)

% review-compile --target=rst

Re:VIEW からreST形式に出力

そのままSphinxでビルド可能

Big Mouth Data 2017 Spring (技術書店2で頒布)

Re:ViEW形式とreST形式の違い

• そもそもの設計思想が違うため、1:1変換は不可能
  • 機能が対応していない
• Re:VIEW
  • 組版用コマンドが多数
• reST
  • 汎用的
  • 拡張が可能

例(1/4): コラム

Re:VIEW

===[column] コンパイラコンパイラ

コラムの内容

===[/column]

reST/Sphinxには標準でコラムはありません

例(2/4): コマンドラインのキャプチャ

Re:VIEW

//cmd{
$ @<b>{ls /}
//}

コマンドライン操作を表すための専用命令があります

reST/Sphinxには標準でコマンドライン操作を表す命令はありません

例(3/4): 参照

Re:VIEWでは、参照対象によって異なる命令を使います

@<chap>{章番号を参照する場合}
@<chapref>{章番号とタイトルを含むテキストを参照する場合}
@<hd>{節や項を参照する場合}
@<column>{コラムを参照する場合}

reSTではrefのみで自動的に判断します

また、番号だけだったりテキストも含めたりと参照方法を変えることはできません

例(4/4): 番号付きリスト

Re:VIEWもSphinxも同じです。

1. 第1の条件
2. 第2の条件
3. 第3の条件

ただし、Re:VIEWはネストをサポートしていません

reSTはネストをサポートしており、柔軟な書き方ができます

まとめ

• Re:VIEWからreST、reSTからRe:VIEWの両方向で変換できるようにしました
• 1:1変換ではないので、完全相互はできません
  • 設計思想の違いであって、優劣ではありません
  • reST -> Re:VIEW -> reST
    • だめ、絶対
• (sphinxconなので言うと)、reSTで書いておくといろいろ変換できて良いかもです
  • 拡張も豊富
  • 拡張を書くのも容易。変換がなければ自分で書けばいいじゃない！