LoginSignup
11
11

More than 5 years have passed since last update.

Asciidoctor 1.5.6 で :xrefstyle が新規実装

Last updated at Posted at 2017-08-18

概要

表題通りですが、最近、Asciidoctorが1.5.6.1にVer UPされ、クロスリファレンステキストのスタイルを決めるアトリビュートの:xrefstyleが実装されました。

もう少し詳しい説明

もう少し説明すると、Asciidoctor 1.5.5までは、章節番号や図表番号は自動採番されていましたが、この自動採番された章節図表番号を呼び出す仕組みがありませんでした。つまり、”表**に示すように”、”結果を図**に示す”といった、報告書類などで多用する書き方が出来ませんでした。
(この点、例えばsphinxでは既に可能だったので、明確な弱点となっていたと思います。)

これに対して、user manualに示すように、v1.5.6から可能になった、ということですね。

使い方は簡単で、ドキュメントアトリビュートとして、xrefstyleを定義したあと、本文中でクロスリファレンスを呼び出すだけ。

:xrefstyle: full

上記では、fullで定義しています。それ以外にshort、basicが選べます。詳しくはuser manualで!

<<fig_azarasi>>による。

[[fig_azarasi]]
.close up the azarasi
image::azarasi.jpg[]

本文で上記のようにすると、<>の部分が置換され、

図 1, “close up the azarasi”による。

となります。
コンマとキャプションが邪魔ならshortを選ぶと、

図 1による。

となります。

pdfも

asciidoctor-pdfも同時にver upし、1.5.0.alpha.16となっており、この版でxrefstyleが動作するようです。クライアント提出分も書けそうですね。

追記

でもうちの環境ではasciidoctor-diagram v1.5.5でうまく動きませんでした。
もともとsvg出力時の日本語使用に難があり、あまり使っていませんが。

追記2(2017.9.25)

asciidoctor-diagram v1.5.5ではリグレッションの問題が起きていたようです。⇒#164
ここに示されたPRを暫定的に適用したら解決しました。

ついでに再確認したところ、SVG出力時の日本語使用の問題についても、asciidoctor-diagramとasciidoctor-pdfで同じ日本語フォントを指定することにより、普通に動作しているようです。
これで、少々気になるなあと思っていた穴が、ふさがった、かな。

11
11
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
11
11