add documentation

Author: kmuto

doc/pdfmaker.ja.md

@@ -109,6 +109,48 @@ Re:VIEW 3.0 から review-jlreq.cls という別のクラスファイルも用
 
 その他の詳細な設定については、sty フォルダにある README.md を参照してください。
 
+### カスタムパラメータの引き渡し
+
+技術的な都合で、config.yml の YAML 設定から TeX のマクロへの変換はすべての設定について行われるわけではなく、ごく限られた値のみに制限しています。これは Re:VIEW 内部の `config.erb` ( https://github.com/kmuto/review/blob/master/templates/latex/config.erb ) の ERB スクリプトによって処理されており、この挙動を変更することは許容していません。
+
+任意の YAML 設定を TeX に引き渡すには、`config.erb` と同様に YAML から TeX への変換を行う固有の ERB スクリプトを作成して配置します。このためには、プロジェクトフォルダに `layouts` フォルダを作成し、そこに固有の ERB スクリプトを `config-local.tex.erb` という名前で置きます。
+
+`config-local.tex.erb` は `config.erb` の評価・埋め込みの後、評価・埋め込みされます。
+
+config.yml を次のようにして、これを TeX に渡したいとします。
+
+```
+mycustom:
+  mystring: HELLO_#1
+  mybool: true
+```
+
+`layouts/config-local.tex.erb` はたとえば次のようになります。
+
+```
+\def\mystring{<%= escape(@config['mycustom']['mystring']) %>}
+<%- if @config['mycustom']['mybool'] -%>
+\def\mybool{true}
+<%- end -%>
+```
+
+次のように展開されます。
+```
+ …
+\makeatother
+%% BEGIN: config-local.tex.erb
+\def\mystring{HELLO\textunderscore{}\#1}
+\def\mybool{true}
+%% END: config-local.tex.erb
+
+\usepackage{reviewmacro}
+ …
+```
+
+こうして定義されたマクロを sty ファイルなどで参照します。
+
+なお、ERB での YAML 解析、および TeX マクロの記述において誤りがあると、極めてわかりにくいエラーになることがあります。`--debug` オプション付きで実行して展開された `__REVIEW_BOOK__.tex` を確認して原因を調査するのがよいでしょう。
+
 ## Re:VIEW 2.0 以前の情報
 
 ### upLaTeX について

doc/pdfmaker.md

@@ -84,6 +84,47 @@ Since Re:VIEW 3.0, review-jlreq.cls is also provided. This class file extends jl
 
 `review-init --latex-template=review-jlreq` command copies the review-jlreq.cls set to `sty` folder.
 
+### Handing over custom parameters
+
+For technical reasons, only a small part of the YAML parameters in config.yml is converted to TeX macros. Re:VIEW's internal `config.erb` ( https://github.com/ kmuto/review/blob/master/templates/latex/ config.erb ) ERB script manages this. You cannot change this script.
+
+If you want to give YAML parameters to TeX, you can use your own ERB script that do the YAML to TeX conversion. This is done by creating `layouts/config-local.tex.erb` in the project folder.
+
+After evaluation and embedding of `config.erb`, `config-local.tex. erb` will be evaluated and embedded as well. For example,
+
+`config.yml`:
+
+```
+mycustom:
+  mystring: HELLO_#1
+  mybool: true
+```
+
+`layouts/config-local.tex.erb`:
+
+```
+\def\mystring{<%= escape(@config['mycustom']['mystring']) %>}
+<%- if @config['mycustom']['mybool'] -%>
+\def\mybool{true}
+<%- end -%>
+```
+
+will be parsed:
+
+```
+ …
+\makeatother
+%% BEGIN: config-local.tex.erb
+\def\mystring{HELLO\textunderscore{}\#1}
+\def\mybool{true}
+%% END: config-local.tex.erb
+
+\usepackage{reviewmacro}
+ …
+```
+
+Refer to these macros in your sty file.
+
 ## Important Changes about LaTeX in Re:VIEW 2.0
 
 * Default LaTeX compiler is upLaTeX, not pLaTeX.

lib/review/pdfmaker.rb

@@ -477,7 +477,9 @@ def latex_config
       result = erb_content(File.expand_path('./latex/config.erb', ReVIEW::Template::TEMPLATE_DIR))
       local_config_file = File.join(@basedir, 'layouts', 'config-local.tex.erb')
       if File.exist?(local_config_file)
+        result << "%% BEGIN: config-local.tex.erb\n"
         result << erb_content(local_config_file)
+        result << "%% END: config-local.tex.erb\n"
       end
       result
     end

test/test_pdfmaker.rb

@@ -154,13 +154,13 @@ def test_template_content_with_localconfig
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do
         Dir.mkdir('layouts')
-        File.write(File.join('layouts', 'config-local.tex.erb'), %q(\def\customvalue{<%= escape(@config['mycustom']['value']) %>}))
+        File.write(File.join('layouts', 'config-local.tex.erb'), %q(\def\customvalue{<%= escape(@config['mycustom']['value']) %>}) + "\n")
         @maker.basedir = Dir.pwd
         @maker.erb_config
         tmpl = @maker.template_content
         expect = File.read(File.join(assets_dir, 'test_template.tex'))
         expect.gsub!(/\\def\\review@reviewversion{[^\}]+}/, "\\def\\review@reviewversion{#{ReVIEW::VERSION}}")
-        expect.sub!("\\makeatother\n", '\&' + '\def\customvalue{\#\textunderscore{}TEST\textunderscore{}}')
+        expect.sub!("\\makeatother\n", '\&' + "%% BEGIN: config-local.tex.erb\n\\def\\customvalue{\\#\\textunderscore{}TEST\\textunderscore{}}\n%% END: config-local.tex.erb\n")
         assert_equal(expect, tmpl)
       end
     end