RD でも書いてみようか 【第 2 回】 インライン

書いた人:mput

※この記事は前回の「RD でも書いてみようか 【第 1 回】 ブロックレベル」で説明した RD フォーマットで書かれています。通常の Hiki フォーマットで整形した結果はこちら:RD でも書いてみようか 【第 2 回】 インライン (整形済み)

= 再び、文章の構造について
前回の復習なのですが、文章には構造を持たせて書くと良い、というお話をしま
した。文が集まって段落になり、段落が集まって節になり、節が集まって章にな
るように書くと良いという話です。

では、文より小さい構造は存在しないのでしょうか?

もちろんそんなことはありませんね。日本語の文には文節であるとか、単語であ
るとかの文よりも小さい構文要素が存在します。

そこで今回はこのような小さな要素をRDではどのように書けばよいかを見ていき
ます。

= インラインとは
さて、RDではこのような小さい要素のことをインラインと呼ぶわけですが、実際
にはインラインの範囲というのは日本語のそれとは完全に一致するわけではあり
ません。より具体的に言うと、RDのインラインは文を含むことができます。また、
何も特別な書き方をしない、いわば地の文も存在できます(今読んでいるこの文
は地の文です)。つまり、RDのインラインは

               段落よりも小さい、特に意識して記された箇所

であると言えます。なぜ特に記されているのかといえば、その箇所に特別な意味
があるからです。たとえばハイパーリンクであれば、その箇所はハイパーテキス
トであり、他の資源への参照を含んでいますから、そのハイパーリンクは他の部
分に比べて特別な意味を持っています。インラインはこのような用途に使われま
す。

= 具体的なインラインたち
では実際に、よく使うインラインの用法を例を交えつつ見ていきましょう。

== 強調
強調の意味論は単純です:その箇所を強調したいというときに使われるべき記法
というわけです。伝統的な日本語文章の記法では、強調したい部分には傍点をふ
るとかかぎ括弧で括るなどの方法で強調を表していましたが、RDでは強調したい
箇所にはきちんと専用の構文でそのように書いておくのです。

強調の構文は二重の括弧とアスタリスクで強調したい箇所を括るというものです。

      「エリーゼのために」は、実は((*テレーゼのために*))とベートー
      ヴェンが書いたものが、その悪筆のために「エリーゼ」と間違えら
      れたと言われる。

(上記の文章はウィキペディアから引用しました)
なおRDに限った話ではありませんが、強調は使いすぎると目立たなくなります。
あくまで周囲との対比が重要です。使いすぎに注意しましょう。

== 脚注
脚注は本文の流れとは直接繋がらないけれど、本文に関連してちょっと書いてお
きたいことを書くのに向いています。たとえばこのRubyist Magazineでは、本文
中で脚注を参照する箇所には*1などの記号がふってあり、脚注自体は記事の末尾
にまとめて書いてあります。RDでは、このような方式ではなく、本文の中に脚注
の文章を割り込ませて記述する方式になっています。具体的には、脚注の文章を
二重括弧とハイフンで括って本文中に記します。

     江戸時代の和算では円周率としてルート10を採用する場合が多かった
     ((-「塵劫記」など-))が、円周率のより精密な値を求めた人もいた。

脚注を用いるべきかについては議論があります。もともと日本語にはなかったも
のであり、できるだけ用いないほうがよいという意見もあります。ただ、脚注を
使ったほうが効率的な場面があるのも事実です。いずれにせよ使いすぎるのは嫌
われることがありますから、注意して使いましょう。

== ハイパーリンク
ハイパーリンクはウェブ上の文章で特徴的な概念です(ウェブに必ずしも限定さ
れませんが)。ある文章の一部分が、別の資源へのリンクになっているという仕
組みです。RDはウェブが発展してから考案されたものなので、ハイパーリンクの
仕組みがあります。しかし、その記法に関して批判も多く、欠点とみなされるこ
とも多いです。実際にはRDはさまざまなハイパーリンク書式を備えていますが、
ここではその中でも一番一般的に用いられる、URLを用いた形式のリンクを紹介
します。URLを用いる方式では、リンクを指定したい文字列とリンク先URLを
"|URL:"で挟んで、その両側を二重括弧と不等号<>で括ります。

            ((<日本Rubyの会|URL:http://jp.rubyist.net>))

タイトルはいらない、というときには、前半部分は省略できます。

                   ((<URL:http://jp.rubyist.net>))

== 翻訳停止
ところでRDの文章の中でたまたま上記のような二重括弧+不等号が現れてしまっ
たときにはどうすればいいのでしょうか。というシチュエーションで活躍するの
が翻訳停止インラインです。翻訳停止インラインは二重括弧とシングルクオート
で該当部分を括ります。

     たとえば脚注じゃないけど脚注開始と同じ文字が必要になったとき
     は(('((-'))のようにして回避します

= 次回予告
さて、ここまでRDを文章生成のための一般的なツールとして説明してきましたが、
RDにはもうひとつ、Rubyスクリプトのドキュメントを書くためのツールとしての
側面があります。RDにはドキュメントを書くための豊富な機能がありますので、
次回はドキュメント記述言語RDを解説したいと思います。

RD でも書いてみようか連載一覧