LoginSignup
4

More than 5 years have passed since last update.

R Markdownで定義リストをRのヘルプのArgumentsっぽくする

Last updated at Posted at 2017-04-05

タイトルの通りです。うまくコンパクトに表現できなかったので,どういう感じなのかは完成例を見てください。

完成例

具体的には以下のような感じです:

231.png

引数リストを説明するのに,Rのヘルプと同じようにしたほうが見やすいなぁと思い,やってみました。

実装

定義リストの準備

R Markdownで定義リストを作成する方法については,こちらを参照してください。

例えば,以下のような感じで定義リストになります:

項目その1(<dt>の内容)

: 項目その1の内容(<dd>の内容)

項目その2(<dt>の内容)

: 項目その2の内容(<dd>の内容)

こんな感じにしておくと,R Markdownならこれらのまとまりを自動的に定義リストにまとめてくれます。

cssの準備

結局のところ,定義リスト(

)に対してcssで適切なスタイルを指定すればいけます。私はよくcssチャンクをyamlフロントマターの直後に差し込んでスタイルを読み込ませています。具体的には以下のような感じです:
```{css}
dt {
  clear: left;
  float: left;
  width: 15%;
  font-weight: bold;
  text-align: right;
  padding: 3px 15px 3px 0;
}
dd {
  margin: 0 0 0 20%;
  padding-top: 3px;
  padding-bottom: 3px;
}
```

重要なのはdtタグに当てているclear: left;float: leftです。これでdtタグとddタグが横に並ぶようになります。またdtにclearが付与されていますから,次の項目がどんどんつながらずに下の段へといくようになります。

あと,気をつけるのはdt,ddのwidth(幅)です。元々レスポンシブなのでpx固定は避けましょう。dtの方にwidth: 20%とか指定しとけば,横のddは自動で残りをつかうようになります。それ以外はお好みで設定すれば大丈夫です。

留意事項

もちろんこれはhtml_document出力を想定しています。html形式以外では機能しませんし,色々と設定してある独自テーマのものだとcssが競合して想定外の表示となるかも知れません。その場合は頑張ってください。

Enjoy!

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
4