Skip to content

Commit

Permalink
Merge pull request #1380 from kmuto/warn-column-footnote
Browse files Browse the repository at this point in the history
PDFMaker: //footnoteがコラム内にあったときに警告
  • Loading branch information
kmuto authored Aug 25, 2019
2 parents 386ba66 + cc17a9d commit c2461c2
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
5 changes: 2 additions & 3 deletions doc/format.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -505,14 +505,13 @@ complexmatrixという識別子に基づく画像ファイルが貼り込まれ

本文中のインライン命令「`@<fn>{site}`」は脚注番号に置換され、「本書のサポートサイト……」という文は実際の脚注に変換されます。

注意: TeX PDF において、コラムや表など平文でないところで「`@<fn>{~}`」を使うには、`footnotetext` オプションを使う必要があります
注意: TeX PDF において、コラムの中で脚注を利用する場合、`//footnote` 行はコラムの終わり(`==[/column]` など)の後ろに記述することをお勧めします。Re:VIEW の標準提供のコラム表現では問題ありませんが、サードパーティのコラムの実装によってはおかしな採番表現になることがあります

### footnotetext オプション
TeX PDF において、コラム以外の `//note` などの囲み記事の中で「`@<fn>{~}`」を使うには、`footnotetext` オプションを使う必要があります。

`footnotetext` オプションを使うには、`config.yml` ファイルに`footnotetext: true` を追加します。

これで PDF のコラムや表のなかでも脚注が使えるようになります。

ただし、通常の脚注(footnote)ではなく、footnotemark と footnotetext を使うため、本文と脚注が別ページに分かれる可能性があるなど、いろいろな制約があります。また、採番が別々になるため、footnote と footnotemark/footnotetext を両立させることはできません。

## 参考文献の定義
Expand Down
3 changes: 2 additions & 1 deletion doc/format.md
Original file line number Diff line number Diff line change
Expand Up @@ -546,9 +546,10 @@ You should get and install it before reading the book.
`@<fn>{site}` in source are replaced by footnote marks, and the phrase "support site of .."
is in footnotes.

Note that In LATEXBuilder, you should use `footnotetext` option to use `@<fn>{...}` in columns and tables.
Note that in LATEXBuilder, it is highly recommended to place `//footnote` after the end line of column (`==[/column]`) to avoid problems when using third party's style file.

### `footnotetext` option
Note that in LATEXBuilder, you should use `footnotetext` option to use `@<fn>{...}` in `//note` or other short column blocks.

By adding `footnotetext:true` in config.yml, you can use footnote in tables and short notes.

Expand Down
3 changes: 3 additions & 0 deletions lib/review/latexbuilder.rb
Original file line number Diff line number Diff line change
Expand Up @@ -995,6 +995,9 @@ def inline_eq(id)

def footnote(id, content)
if @book.config['footnotetext'] || @foottext[id]
if @doc_status[:column]
warn "//footnote[#{id}] is in the column block. It is recommended to move out of the column block."
end
puts macro("footnotetext[#{@chapter.footnote(id).number}]", compile_inline(content.strip))
end
end
Expand Down

0 comments on commit c2461c2

Please sign in to comment.