見出し画像

【Asciidoc】TIP拾い ー 訓示ブロック ー

今回から細かいテクニック
「なくてもいいけどあるから使う。」タイプの道具集
まず、訓示ブロック
脚注と訳している方もいますが「foot note」が別にあるので別訳を探す。
 ・ 戒めブロック
 ・ 注記ブロック
 ・ 訓示ブロック
候補はこんなところ。
取り敢えず「訓示ブロック」と呼ぼう。
チートシートには良く下記のようなブロック処理の記述を紹介している。

[NOTE]
====
NOTEは注釈、注記、注意

====

[TIP]
====
TIPはヒント、助言

====

[IMPORTANT]
====
IMPORTANTは重要な、重大な、大切な

====

[CAUTION]
====
CAUTIONは注意、用心、警戒、警告

====

[WARNING]
====
WARNINGは警告、警報、警鐘

====

結果は

アイコン設定をしてない例

こうなります。(期待したとおりではない)
文頭に属性設定が必要です。

:icons: font

以前、紹介した「アイコン」を利用できるように属性設定しましょう。

アイコン設定を行った例

想像したとおりの表現になりました。

なお、欧米人は「Caution」と「Warning」の用法で悩むようです。ちなみに「AsciiDoc Language Documentation」では
 ・ 読者に注意深く行動を勧めるには「Caution」を利用する
 ・ 読者に危険や危害等の結果を知らせるには「Warning」を利用する
とありました。(参考までに。。。)

本来、この機能はアイコン機能マクロを利用したものなので、そちらの記述方法も紹介しておきます。

:scripts: cjk
:pdf-theme: default-with-font-fallbacks
:icons: font

NOTE: NOTEは注釈、注記、注意。アイコンを見ると情報的なインフォメーションとして利用されている様なイメージがあります。

TIP: TIPはヒント、助言。アイコン的には閃きも含むのでしょう。「気付き」などの呼び方をする人もいますが個人的には「助言」や「ヒント」のほうが好きです。

IMPORTANT: IMPORTANTは重要な、重大な、大切な。「重要事項」危険ではない重要な事。

CAUTION: CAUTIONは注意、用心、警戒、警告。

WARNING: WARNINGは警告、警報、警鐘

HTML変換すると

HTML例

PDFに変換すると

PDF例

「Caution」の画像が「HTML」と「PDF」では少し違いますね。
訓示アイコンの色や形の好みは「国柄」によっても違いそうですね。「万国」受けするものはあまりないのではと思います。

自分は最近、アイコン記述形式に慣れたのでブロック形式の利用頻度が減っています。

さて、今回はこのあたりまで・・・・・・
次回は、アイコンの取りこぼしTIPを拾ってみましょう。
…ではまた。
当Noteは下記の「AsciiDoc Language Documentation」の文法に従っています。


いいなと思ったら応援しよう!