書籍執筆支援システム Re:VIEWの設定ファイルについて

Re:VIEWとは

Re:VIEWとは

Re:VIEW サンプル書籍について

2018年5月、Windows10で書籍執筆支援システムRe:VIEWをインストールして、設定ファイルを変更することで自分用サンプル書籍のひな型を作成しました。Re:VIEW のバージョンは2.5.0です。

Re:VIEWの概要とインストール方法は、下記ブログを参照してください。

Windows10に Re:VIEW 執筆支援システムをインストールする方法

review-init コマンドでひな型を取得すると「Re:VIEWサンプル書籍」という原稿を取得できます。原稿(.re)をマークアップ書式で記述し、設定ファイル(catalog.yml、config.yml)を変更してサンプル書籍を仕上げていきます。

Re:VIEW 執筆支援システムの原稿ひな形

Re:VIEWの原稿を作成するためにひな型を取得します。

原稿名を sampleとします。

review-init コマンドで取得したひな型の原稿ディレクトリを下記に示します。

ファイル名 用途
catalog.yml カタログ 章立て(目次構成)の記述
config.yml ドキュメントの設定の記述
Gemfile Ruby言語のパッケージ管理用ファイル
Rakefile Ruby言語のビルド用タスク定義(rake)ファイル
sample.re Re:VIEW 原稿の本文ファイル
style.css HTMLファイルや ePubファイルのスタイルファイル
images/ 画像の配置フォルダ
layouts/ HTMLファイルや ePubファイルのレイアウト設定を記述
sty/ Tex用スタイルファイル配置フォルダ
  • config.ymlファイルで、ドキュメントの設定を記述します。
  • catalog.ymlファイルで、原稿の章立てなどを記述します。

原稿や設定ファイルは、UTF-8エンコーディングで記述します。

本の構成と設定ファイル

本の構成と設定ファイル

コンフィグ設定ファイル

config.yml 設定ファイルは、ドキュメントの設定を記述します。config.yml内にコメントで設定方法を書いてありますので、目的により変更します。

主な設定項目を以下に示します。

バージョン

キーワード 意味
epubversion: ePUBバージョン (2 or 3)
htmlversion: HTMLバージョン (4 or 5)

書名、著者

キーワード 意味
bookname: ブック名(ASCIIファイル名)
booktitle: 書籍タイトル名
aut: 著者名
date: 刊行日(YYYY-MM-DD形式)
history: 発行年月(YYYY-MM-DD形式)

本の構成

キーワード 意味
coverimage: 表紙画像ファイル名
titlepage: 大扉ページ(true:する、null:しない)
toc: 目次生成(true:する、null:しない)
toclevel: 目次抽出の見出しレベル
colophon: 奥付生成(true:する、null:しない)

config.ymlのサンプル

カタログ設定ファイル

catalog.yml カタログファイルは、章立てを記述します。

詳細は、Re:VIEW カタログファイル ガイドを参照してください。

カタログファイルは、Re:VIEW フォーマットで記述された各ファイルを1冊の本(たとえば PDF や EPUB)にまとめる際に、どのようにそれらのファイルを構造化するかを指定するファイルです。現在はカタログファイルと言えば catalog.yml のことを指します。

サンプル原稿のカタログファイルを以下に示します。

キーワード 意味
PREDEF: 前付け
CHAPS: 本編
APPENDIX: 付録
POSTDEF: 後付け

原稿は Re:VIEWのマークアップ書式で記述した .reファイルに書きます。マークアップ書式の詳細は、Re:VIEW フォーマットガイドを参照してください。

本編は、CHAPS:キーワードに続いて章ごとの文章ファイルを並べます。本編を部構成にする場合は、CHAPS: を階層的に定義します。

原稿ファイル

前付け(00_preface.re)の原稿サンプルを示します。

本編(01_chapter.re、02_chapter.re)の原稿サンプルを示します。

付録(08_appendix.re)の原稿サンプルを示します。

後付け(09_postface.re)の原稿サンプルを示します。

EPUBとPDFの生成

EPUBとPDFの生成します。

サンプル書籍

生成したbook.epubを Microsoft Edgeで閲覧してみます。


生成したbook.pdfをAdobe Acrobat Reader DC で閲覧してみます。

PDFサンプル

PDFサンプル

 

まとめ

書籍執筆支援システム「Re:VIEW」の設定ファイルを変更することで自分用サンプル書籍のひな型を作成しました。

Re:VIEWは素晴らしいツールです。技術用ドキュメントを簡単に記述することができます。

 

このエントリーをはてなブックマークに追加