Skip to content

Commit

Permalink
編集しています。
Browse files Browse the repository at this point in the history
  • Loading branch information
mhidaka committed Nov 4, 2023
1 parent 2d10f41 commit ec3497c
Show file tree
Hide file tree
Showing 6 changed files with 117 additions and 106 deletions.
39 changes: 21 additions & 18 deletions articles/configure.re
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ POSTDEF:
後書きを指定します

加えて@<code>{CHAPS}はネストすることで部を構成できます。
部を構成するには、@<list>{catalog_yml_nested_chaps}のように、部のタイトル名や.reファイル名の下に章のファイルを記述します
部を構成するには、@<list>{catalog_yml_nested_chaps}のように、部のタイトル名や@<tt>{.re}ファイル名の下に章のファイルを記述します

//list[catalog_yml_nested_chaps][部を構成するCHAPSの記述]{
CHAPS:
Expand All @@ -53,7 +53,7 @@ CHAPS:
- chapter5.re
//}

YAMLに馴染みがないと忘れがちですがCollection@<fn>{url_yaml_collection}にするのでコロン記号(:)を付け忘れないようにしましょう。
YAMLの記法に馴染みがないと忘れがちですがCollection@<fn>{url_yaml_collection}にするのでコロン記号(:)を付け忘れないようにしましょう。

//footnote[url_yaml_collection][@<href>{http://www.yaml.org/spec/1.2/spec.html#id2759963}]

Expand All @@ -67,9 +67,9 @@ Re:VIEWでは本を生成(コンパイル)するときのメタデータ
ファイル名に決まりはありませんが慣例的に@<tt>{config.yml}としています。
書名や奥付の内容、どの深さまで目次に含めるかなどを設定できます。

@<list>{config_yml}は本書で使っている@<tt>{config.yml}です
@<list>{config_yml}は本書で使っている@<tt>{config.yml}の一部を抜粋したものです

//list[config_yml][config.yml]{
//list[config_yml][config.ymlの中身]{
# ブック名(ファイル名になるもの。ASCII範囲の文字を使用)
bookname: C89-FirstStepReVIEW-v2
# 記述言語。省略した場合はja
Expand All @@ -86,11 +86,13 @@ pbl: TechBooster

# 刊行日(省略した場合は実行時の日付)
date: 2023-10-31

# 発行年月。YYYY-MM-DD形式による配列指定。省略した場合はdateを使用する
# 複数指定する場合は次のように記述する
# [["初版第1刷の日付", "初版第2刷の日付"], ["第2版第1刷の日付"]]
# 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
history: [["2015-12-31 C89版 v1.0.0"],["2017-8-11 C92版 v2.0.0"],["2023-10-31 技術書典15版 v3.0.0"]]

# 権利表記(配列で複数指定可)
# rights: (C) 2016 Re:VIEW Developers
rights: (C) 2017-2023 TechBooster
Expand Down Expand Up @@ -128,7 +130,7 @@ colophon: true

== 目次に表示する項目をカスタマイズする

目次として抽出する章や節の深さを変更するには、@<tt>{config.yml}の@<code>{toclevel:}項目を設定します(@<list>{toclevel})。
目次として抽出する章や節の深さを変更するには、@<tt>{config.yml}の@<code>{toclevel}項目を設定します(@<list>{toclevel})。

//list[toclevel][抽出レベルを設定]{
toclevel: 2
Expand All @@ -144,19 +146,19 @@ toclevel: 2

=={layout} 用紙サイズやデザインを変更する

PDF形式で出力する紙面のデザインは差し替え可能です。@<tt>{config.yml}の@<code>{texstyle:}項目の値を変更します(@<list>{change_layout})。
PDF形式で出力する紙面のデザインは差し替え可能です。@<tt>{config.yml}の@<code>{texstyle}項目の値を変更します(@<list>{change_layout})。

//list[change_layout][config.ymlにてスタイルファイルを指定]{
# LaTeX用のスタイルファイル(styディレクトリ以下に置くこと)
# texstyle: ["reviewmacro"]
//}

: reviewmacro
Re:VIEWのデフォルトスタイルです
Re:VIEWのデフォルトスタイルです
: viewermacro
電子書籍向けのスタイルです。タブレットなどで見やすいように余白やフォントサイズを調整しています。TechBooster製のスタイルです
電子書籍向けのスタイルです。タブレットなどで見やすいように余白やフォントサイズを調整しています。TechBooster製のスタイルです

ReVIEW-Templateテンプレートリポジトリまたは本書のリポジトリには次の4つの@<code>{texdocumentclass:}が用意されています。
ReVIEW-Templateテンプレートリポジトリまたは本書のリポジトリには次の4つの@<code>{texdocumentclass}が用意されています。

* B5の設定(10pt 40文字×35行) - 紙版
* B5の設定(10pt 40文字×35行) - 電子版
Expand All @@ -168,25 +170,25 @@ ReVIEW-Templateテンプレートリポジトリまたは本書のリポジト
//emlist[config.ymlの印刷用設定]{
texstyle: ["reviewmacro"]
texdocumentclass: ["review-jsbook", "media=print,paper=b5,serial_pagination=true,
hiddenfolio=nikko-pc,openany,fontsize=10pt,baselineskip=15.4pt,line_length=40zw,
number_of_lines=35,head_space=30mm,headsep=10mm,headheight=5mm,footskip=10mm"]
hiddenfolio=nikko-pc,openany,fontsize=10pt,baselineskip=15.4pt,line_length=40zw,
number_of_lines=35,head_space=30mm,headsep=10mm,headheight=5mm,footskip=10mm"]
//}

==== 電子書籍(PDF)での標準設定

//emlist[config.ymlの電子書籍用設定]{
texstyle: ["reviewmacro"]
texdocumentclass: ["review-jsbook", "media=ebook,paper=b5,serial_pagination=true,
openany,fontsize=10pt,baselineskip=15.4pt,line_length=40zw,
number_of_lines=35,head_space=30mm,headsep=10mm,headheight=5mm,footskip=10mm"]
openany,fontsize=10pt,baselineskip=15.4pt,line_length=40zw,
number_of_lines=35,head_space=30mm,headsep=10mm,headheight=5mm,footskip=10mm"]
//}

B5ではなく少し小さいA5にしたい等で書籍にあった用紙サイズへ変更するだけであれば、これらのプリセットの利用を強く推奨します。
B5ではなく少し小さいA5にしたいなど書籍に合う用紙サイズへ変更するのであれば、これらのプリセットの利用を強く推奨します。

== スタイルにカスタマイズを加える

@<tt>{config.yml}の@<code>{textdocumentclass}はLaTeXにおけるドキュメントのクラスオプションに相当します。
複数のオプションがある場合は、カンマで区切って列挙でき、ある程度のカスタマイズも可能です。
複数のオプションがある場合はカンマで区切って列挙でき、ある程度のカスタマイズも可能です。

前節で触れた標準設定でも多くのクラスオプションが登場していました。たとえば出力するページサイズを指定するには@<tt>{config.yml}の@<code>{textdocumentclass}を次のようにします(@<list>{change_pagesize})。

Expand All @@ -209,11 +211,12 @@ b6 JIS B6

=== review-jsbookに設定できる主な設定項目

@<code>{review-jsbook}に設定可能なクラスオプションは公式ドキュメントにまとまっています。@<table>{review-jsbook}では、
どのようなカスタマイズができるのか理解しやすいものを挙げています。
@<code>{review-jsbook}に設定可能なクラスオプションは公式ドキュメントにまとまっています。

* @<href>{https://github.com/kmuto/review/blob/master/templates/latex/review-jsbook/README.md}

@<table>{review-jsbook}では、どのようなカスタマイズができるのか理解しやすいものを挙げています。

//table[review-jsbook][設定できる主なクラスオプションと説明]{
オプション名 説明
------------
Expand All @@ -225,7 +228,7 @@ startpage ページ開始番号。デフォルトは1
//}

Re:VIEWで利用している@<code>{review-jsbook}はドキュメントクラスは標準的な@<code>{jsbook}ドキュメントクラスを含んでいるので、一部のオプションはそのまま指定できます。
たとえば@<code>{onecolumn}であれば1段組の体裁、@<code>{twocolumn}であれば2段組の体裁を実現します。
ここに@<code>{onecolumn}を指定すれば1段組の体裁、@<code>{twocolumn}であれば2段組の体裁を実現します。
ただし、このようなドキュメントの見た目に対して調整を行うにはTeXと書籍の専門知識が要求されます。

たとえば本のルールには章の始まりを左ページ(偶数)、右ページ(奇数)に固定できるというものがあります。一般人からすると改ページの位置が左右どっちにくるのかという問題自体に馴染みがありませんよね。@<code>{openany}を指定すると左右どちらからでも章を開始できる!と気づいてしまい、ページ数を減らせるから印刷代もちょっと安くなるじゃないか?と考えたとしても入稿直前の疲れたタイミングで変更することは推奨しません。期せず発生する副作用に悩まないように十分検証期間を設けるなど余裕を持って作業してください。
Expand Down
Binary file removed articles/images/tips/how_to_convert_re_to_pdf.png
Binary file not shown.
Binary file removed articles/images/tips/how_to_convert_re_to_pdf2.png
Binary file not shown.
34 changes: 14 additions & 20 deletions articles/review-introduction.re
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,13 @@ Re:VIEWにはリストや図版の採番を自動的にするための仕組み
このリストは参照されています。
//}

@<list>{@<code>{identifier}}で、@<kw>{identifier,識別子}が示すリストを参照できます。
参照は、出力時に「@<list>{list_refs}」のようにリスト番号に置き換わります。

連番つきリストにするとRe:VIEWは、リストごとに一意な番号を割り振ります。
一方、連番なしリストは、リストに番号を割り当てず、本文からは参照できません。

一般的にソースコードリストのように本文から参照する場合には、連番付きリスト(@<code>{list})を推奨します。
一般的にソースコードリストなどを本文から参照したい場合には、連番付きリスト(@<code>{list})を推奨します。
参照関係が明らかな場合のみ、連番なしリスト(@<code>{emlist})を利用するといいでしょう。


Expand Down Expand Up @@ -445,7 +448,6 @@ PNG、JPEG、@<kw>{SVG,Scalable Vector Graphics}など、基本的なフォー
罫線で区切られた表をマークアップする構文です。

Re:VIEWでは、行は改行、セルとセルの間にはタブで区切ります。

空白のセルは、ピリオド(@<code>{.})を入力します。
セルにピリオドを表示したい、またはセルの内容をピリオドから始めたい場合、ピリオドを2つ続けて(@<code>{..})入力します。

Expand Down Expand Up @@ -488,7 +490,6 @@ Re:VIEWでは、行は改行、セルとセルの間にはタブで区切りま
#@# //footnote[not_reffered_footnote][参照されない脚注は表示されません]

脚注は、記述した場所に関係なく「脚注の領域」に表示されます。

脚注を有効にするには、本文で参照している必要があります。本文で参照されていない脚注は出力されません。

@<list>{footnote_refer_sample}では、記述した脚注を参照しています。
Expand Down Expand Up @@ -519,7 +520,6 @@ Re:VIEWでは、行は改行、セルとセルの間にはタブで区切りま
//}

このように、リード文としてマークアップした内容は、本文に比べて左側の余白が大きくなります。

Re:VIEWでは、リード文のマークアップは文章のどこにでも置けます。
しかし、基本的には見出し、特に章見出しのすぐあとに置くことを想定しています。

Expand All @@ -528,7 +528,6 @@ Re:VIEWでは、リード文のマークアップは文章のどこにでも置
Re:VIEW記法では文字を装飾できます。

文字の装飾は適用したい範囲を@<code>{@<修飾子>{...}}で指定するだけです。

また文字の装飾は、本文だけでなくリストや脚注、表などの中でも有効です。
利用頻度の高い文字の装飾について@<table>{character_decorations}にまとめています。

Expand All @@ -552,10 +551,10 @@ Re:VIEW記法では文字を装飾できます。

== 参照

他の見出しを参照し、文章中で利用できます。
ほかの見出しを参照し、文章中で利用できます。
参照を使わず、見出しのキャプションや番号を直接記述した場合、変更が発生するたび関連箇所を漏れなく探し出し、すべてに修正を加えなくてはなりません。

見出しの参照を使うと、章や節の順番の入れ替え、タイトルの変更などは自動的に反映されます。
見出しの参照を使うと章や節の順番の入れ替え、タイトルの変更などは自動的に反映されます。
見出しの参照は、大きく「章の参照」と「節の参照」の2つに分類できます。

=== 章の参照
Expand All @@ -579,9 +578,8 @@ Re:VIEW記法では文字を装飾できます。
@<code>{chapref}は、その章の見出し番号とキャプションになります(@<chapref>{writing-book})。

これらの構文の参照先には、Re:VIEWの章の識別子を指定します。

章の識別子は、Re:VIEWの章のファイル名から拡張子@<tt>{.re}を取り除いた名前です。
たとえば@<tt>{writing-book.re}の章を参照する場合、@<code>{writing-book}が識別子になります。
たとえば@<tt>{writing-book.re}の章を参照する場合は@<code>{writing-book}が識別子になります。

=== 節の参照

Expand All @@ -593,18 +591,15 @@ Re:VIEW記法では文字を装飾できます。
@<hd>{writing-book|Re:VIEWの特色}
//}

同じ章の節を参照する場合、参照先には、節のキャプションだけを記載します。

異なる章の見出しを参照する場合、章の識別子を指定した上で、縦棒@<code>{|}で区切って節のキャプションを記述します。
同じ章の中にある節を参照する場合、参照先には節のキャプションだけを記載します。

章の識別子は、Re:VIEWの章のファイル名から拡張子@<tt>{.re}を取り除いた名前です。
たとえば、@<tt>{writing-book.re}の章を参照する場合、@<code>{writing-book}が識別子になります。
異なる章の見出しを参照する場合、先述した章の識別子を指定した上で縦棒@<code>{|}で区切って節のキャプションを記述します。

=== 見出しラベル

節の参照では、見出しのキャプションをそのまま記述するので、キャプションを変更したときに参照を更新する必要があります。

Re:VIEWでは、見出しキャプションとは別に、参照用のラベルを指定できます
Re:VIEWでは、見出しキャプションとは別に参照用のラベルを指定できます

//list[section_label][見出しの参照用ラベル]{
=={commandline} コマンドライン
Expand Down Expand Up @@ -638,9 +633,8 @@ Re:VIEW記法は「ブロック命令」と「インライン命令」の2つ
//}

ブロック命令には複数のオプションを指定できる場合があります。
オプションは、命令に続けて括弧[]の中に記述します(@<list>{block_directive_with_option})。

指定可能なオプションの数や省略の可否は、命令によって違います。
オプションは、命令に続けて括弧[]の中に記述します(@<list>{block_directive_with_option})。

//list[block_directive_with_option][ブロック命令]{
//命令[オプション1][オプション2][オプション3]{
Expand All @@ -650,15 +644,15 @@ Re:VIEW記法は「ブロック命令」と「インライン命令」の2つ

ブロック命令はリストや図など本文とは独立した内容を掲載する際に使います。

ブロック命令を文の途中から開始することはできません。ブロック命令の開始と終了は、必ず行頭に記述します
行頭に半角スペースなどが入った場合、Re:VIEWは、その行をブロック命令として扱いません。
ブロック命令を文の途中から開始することはできず、ブロック命令の開始と終了は必ず行頭に記述します
行頭に半角スペースなどが入った場合Re:VIEWは、その行をブロック命令として扱いません。

==== インライン命令

インライン命令は@<code>{@<命令>{...}}のように、@<kw>{@,アットマーク}に続けて括弧<>内に命令名を指定します。
続く括弧{}の中が、インライン命令の効果が及ぶ範囲になります。

インライン命令は、文章の装飾やリストや図の参照など表示や内容に影響します。
文中に直接記入することができますが、改行をまたぐことやインライン命令のネストはできません。
文中に直接記入できますが、改行をまたぐことやインライン命令のネストはできません。

==[/column]
Loading

0 comments on commit ec3497c

Please sign in to comment.