技術書を書こう!~はじめてのRe:VIEW~

キーフレーズ

review Re:VIEW TechBooster リスト PDF ファイル pdfmaker yml 箇条書き 場合 config language 出力 技術書 https compile マークアップ VIEW コマンド sample キャプション github 参照 identifier otf ソースコード target ファイル名 Atom pdf 設定ファイル インストール FirstStepReVIEW 指定 Library sudo articles 執筆 ページ Ruby book preproc LaTeX オプション 必要 HTML html Docker ワークフロー Fonts list epubmaker 記述 番号 利用 epub マリスト vvakame レビュー ビルド 見出し 表示 文章 命令 rake ヒラギノ 変更 本文 master lib catalog リポジトリ image range ディレクトリ 内容 ツール com writing 設定 フォーマット docker サンプル 環境 実行 文字列 GitHub 形式 生成 techbooster 印刷所 スペース コマンドライン http:// abcdefg chapter tabwidth C89

目次

5.1 review-compile で技術書がつくれる優れものです。く /p> . ( 以下省略 ) HTML 向け出力は、執筆時に「大まかにどのような出力になるのか」を確認するため に使います。その他にもプレーンテキスト形式にする --target=text 、 PDF を出力する ために必要な TeX 形式のファイルを出力する一一 target = latex 、軽量マークアップ言語 である Markdown 形式を出力する --target=markdown などがあります。 読者の環境で一 target で指定できるフォーマットを調べるには、 Re:VIEW 本体のイ ンストール先にある lib/review/???builder. rb というファイル名のファイルを確認す るのが早道です。 > ls lib/review/*builder . rb lib/review/builder . rb lib/review/ewbbuilder. rb lib/review/idgxmlbuilder. rb lib/review/latexbuilder. rb lib/review/textbuilder. rb lib/review/epubbuilder. rb lib/review/htmlbuilder . rb lib/review/inaobuilder . rb lib/review/markdownbuilder . rb lib/review/topbuilder . rb 対応する出力形式の多くは Re : VIEW 開発者らが仕事上利用するために用意されまし た。執筆時には一一 target = html を指定する機会が多いでしよう。 --check を指定すると結果は出力せず、そのフォーマットで人力したファイルが正しく 変換できるかを確認します。たとえば、 footnote と f Ⅱで対応がとれていなければ、その 旨が表示されます。これもまた執筆中にエラーを前もって避けるために便利です * 1 出力された html を、執筆時のデバッグ用途としてではなく見栄えのよい公開用ファイ ルにすることもできます。ーー y 1 = ( ファイル名 ) で Re : VIEW プロジェクトの設定を読 みこませることでスタイルを変更するとよいでしよう。 ~ a11 を指定すると、指定したファイルだけではなく、 catalog. yml に記載されている すべてのファイルを一気にコンパイルすることもできます。 @く chapref>{chapter} や@く hd>{head} などの章・見出しの参照をリンクにする一一 c hapterlink というオプションもあります。 > review—compile —check ——target=html build. re build. re : 11 : error : ReVIEW : : KeyError * 1 review-pdfmaker にはこの機能がない一方、前述したとおり review-compile では直接は PDF を出力 しません。対策として review-compile--check--target=latex とすると PDF で問題が起こる前に 修正できます 45

第 5 章 コンバイルの仕方 本章では Re:VIEW ファイルをコンパイルする方法を解説します。フォーマットを変 換する review-compile 、 PDF を出力する review-pdfmaker 、 EPUB を出力する rev iew-epubmaker を順番に紹介します。 人稿に利用する形式は review-pdfmaker コマンドでの PDF 形式ですが、 Re:VIEW は、プレーンテキスト、 HTML や EPUB など多様なフォーマットに対応しています。 5 review-compile review-compi1eRe:VIEW ファイル 1 つを --target オプションで指定するフォー マットに変換します。 もっとも簡単な例として、 HTML を出力する例をリスト 5.1 に示します。 review-compile で HTML を出力する例 リスト 5.1 > review—compile ——target=html preface. re く ?xml version="l . 0 ” encoding='tUTF—8"?> く ! DOCTYPE html PUBLIC "—//W3C//DTD XHTML 1 . I//EN" "http : //www.w3.org/TR/xhtm111/DTD/xhtmIII.dtd" > く html xmlns="http : //www.w3.org/1999/xhtm1" xmlns:ops="http://www. idpf . 0 て g / 2007 / ops " xml : lang="ja"> く head> く meta http—equiv='℃ ontent—Type" content="text/html ; charset=UTF¯8"/> く meta http—equiv="Content—StyIe—Type" content="text/css"/> く meta name= 'generator" content="Re:VIEW"/> く title> はじめにく /title> く /head> く body> く hl > く a id = " h " > く / a > はじめにく / hl > く p> はじめての Re:VEIW 第 2 版を手に取っていただき、ありがとうございます。本書は色々な種類・ 性質の技術書がもっと世の中に溢れてほしい、という気持ちから生まれました。最新の Re:VIEW にあ わせたアップデートはもちろん、技術書を書くことにフォーカスをあてたガイドブックです。く /p> く p > タイトルにもある Re : VIEW は書籍制作のためのツールセットです。すこしの文法をおぼえるだけ 44

4.4 目次に表示する項目をカスタマイズする 第 5 章 ReVlEW スタイル解説 5.1 スタイルファイルの種類 5.2 ページサイズを変更する 目次に表示する項目をカスタマイズする . 5.3 5.4 余白を調節する . 5.5 章のページ起こしを指定する 5.6 ヘッダとフッタをカスタマイズする 5.7 既存のスタイルを変更する . 5.8 本の構成を変更する まとめ 5.9 △図 4.1 tocIevel:2 を指定した場合の目次 第 5 章 ReVIEW スタイル解説 5.1 スタイルファイルの種類 . . yml 8 8 8 5 5 5 6 6 8 9 1 4 スタイルファイルまとめ . 5.2 ページサイズを変更する 目次に表示する項目をカスタマイズする . 5.3 5.4 余白を調節する . 5.5 章のページ起こしを指定する 5.6 ヘッダとフッタをカスタマイズする 5.7 既存のスタイルを変更する . 5.8 本の構成を変更する 構成の変更事例 - 通しノンプル . まとめ 5.9 △図 4.2 tocIeveI:3 を指定した場合の目次 43