🗂

よく使うRe:Viewタグお道具箱

2024/09/30に公開

いつも忘れる

技術書典が近づくたびに、執筆手順を思い出しながら始まるので、何かと効率が悪くて悩みどころだった。
現状、表題が「よく使うRe:Viewタグお道具箱」となっているのだが、技術書執筆ワークフローに変えてみようと思う(この間10数秒)

Re:Viewバージョン

なんちゃらブースター、MerkDownからの変換など色々手法はあるものの、性格からかデフォルトで使用することに決めている。
とにかくバグ対応、使えるタグの勘違いなど多岐にわたるからだ。

現在のバージョンは、5.8.0だ。
これといってこだわりはない。

初期化

review init [プロジェクト名] で指定フォルダにプロジェクトを作成。
自分はイベントごとにフォルダを設け、そこで作業するようにしている。そうですイベント駆動です。

まずは各章ごとにRe:Viewファイルを作成し、カタログを整理して始めることにしている。

章立て

基本的に、

┗ 節
┗ 項
までに収めるように努力をしている。
ネストしすぎると、とにかく読みづらくなる&目次が汚くなる。

初めに

元の挨拶はちゃんと載せようと心がけるためにも、以下のフォーマットを習慣づけたい。
プロフとかはコピペでええやろにする。

PREDEF:

  • 00_00_preface.re

適切な改行

改行がないと、オタの早口のような見栄えになるので、ちゃんと適切に改行を入れていく。
Re:Viewでは、1行開けないと反映されないので、プレビューでしっかり確認orビルドして確認する。

太字、箇条書き、ナンバリング

太字は@<b>{文字}で行けるはず。
箇条書きは*1.で書いていく。

画像

いつも使っているのは、//image[sample][サンプル][scale=0.5]これ。

コード

ラベルは重複しないように。

//list[ラベル][説明]{
def fib(n):
return n if n <= 1 else fib(n-1) + fib(n-2)
//}

confyg.ymlを編集

18行目のタイトル

# ブック名(ファイル名になるもの。ASCII範囲の文字を使用)
bookname: Prototyping's Role

23行目の書名

# 書名
# 読みを入れる例 booktitle: {name: "Re:VIEW EPUBサンプル", file-as: "リビューイーパブサンプル"}
booktitle: Prototyping's Role

27行目の著者名

# 著者名。「, 」で区切って複数指定できる
# 読みを入れる例 aut: [{name: "青木峰郎", file-as: "アオキミネロウ"}, {name: "武藤健志", file-as: "ムトウケンシ"}, {name: "高橋征義", file-as: "タカハシマサヨシ"}, {name: "角征典", file-as: "カドマサノリ"}]
aut: ["塚田 大介"]

69行目からの刊行日その他

# 刊行日(省略した場合は実行時の日付)
date: 2024-11-3
# 発行年月。YYYY-MM-DD形式による配列指定。省略した場合はdateを使用する
# 複数指定する場合は次のように記述する
# [["初版第1刷の日付", "初版第2刷の日付"], ["第2版第1刷の日付"]]
# 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
history: [["2024-11-03"]]
# 権利表記(配列で複数指定可)
 rights: (C) 2024 dsgarage

364行目のdocumentclass指定

# デフォルトは印刷用。電子配布版を作るには media=ebook とする
texdocumentclass: ["review-jsbook", "media=ebook,paper=a5"]

Discussion