天地有情

mdframed 入門　～初歩の初歩～

mdframed 入門　～初歩の初歩～

§１．まずは特徴から
mdframed package は定義や証明などを強調したい場合などにカラフルなフレーム環境を提供する．

その特徴は
（１）　自動分割フレーム環境である．フレームがページをまたがる場合には自動的にフレームが分割される．
（２）　フレームの装飾が多彩である．フレームの枠色や枠線サイズ，背景色や文字色などが自由に設定できる．
（３）　tikz や pstricks に対応している．勿論，LaTeX にも対応しており，
（４）　framemthod オプションに応じて次がロードされる．---（xcolor tikz pstricks）
（５）　mdframed パッケージ自体が必要とする次のパッケージをロードする．---（kvoptions xparse etoolbox color）

§２．自動分割フレーム環境とは
　　　　下図のように，フレームがページをまたがる場合には自動的にフレームが分割される．

§３．構文 (Syntax) などの説明

　　　\usepackage[ < GLOBAL OPTIONS > ]{mdframed}

● GLOBAL OPTIONS

（１） xcolor
　　　　このキーを設定することで，パッケージの xcolor は与えられた値がロードされる．

（２） framemethod = <キー名称>
　　　　=====================================================
　　　　Method　　　　　　　　　許されるキー名称
　　　　=====================================================
　　　　LATEX-commands　　default, tex, latex, none, 0
　　　　TikZ　　　　　　　　　　　tikz, pgf 　　　　　　　　　, 1
　　　　PSTricks　　　　　　　　pstricks, ps, postscript , 2
　　　　=====================================================

　　　　例：　\usepackage[framemethod=tikz]{mdframed}

　　　　※ framemethod = tikz を指定すると，フレームの表現が豊かになるので，お薦めである．

（３）提供される環境

　　　次の構文のみ1つの環境を定義している．

　　　\begin{mdframed} [< LOCAL OPTIONS >]
　　　　 < Contents >
　　　\end{mdframed}

● LOCAL OPTIONS

　　よく利用されるものをリストアップする．
　　
　　　　linecolor=　　　　枠の色
　　　　linewidth=　　　　枠の太さ
　　　　backgroundcolor=　背景色
　　　　roundcorner=　　　四つ角の丸み
　　　　fontcolor=　　　　フォントの色
　　　　shadowsize=　　　フレームの影サイズ
　　　　shadowcolor=　　　フレームの影の色
　　　　frametitle=　　　フレームの標題
　　　　frametitlefont=　フレームの標題のフォント
　　　　userdefinedwidth=　フレームの横幅

§４．基本的な書式例

　　■ lualatex の場合　
　　　　\documentclass{ltjsarticle}
　　　　\usepackage[framemethod=tikz]{mdframed}
　　　　\begin{document}
　　　　　\begin{mdframed}[options]
　　　　　　 < Contents >
　　　　　\end{mdframed}
　　　　\end{document}

　　■ コンパイル　
　　　　lualatex source-file.tex

§５．サンプルと実行例

■ mdfsetup でフレーム仕様を指定する例

Syntax: \mdfsetup{ < options > }

-------------------------------------------------
\documentclass{ltjsarticle}
\usepackage[xcolor,framemethod=tikz]{mdframed}
%
\mdfsetup{%
frametitle=星落秋風五丈原,
linecolor=red,linewidth=3pt,
backgroundcolor=red!10,
roundcorner=10pt}
%
\begin{document}
　\begin{mdframed}
　　祁山(キザン)悲秋の風更けて　
　　陣雲暗し五丈原，　
　　零露の文(アヤ)は繁くして　
　　草枯れ馬は肥ゆれども　
　　蜀軍の旗光無く　
　　鼓角の音も今しづか．　
　　丞相(ジョウショウ)病あつかりき．
　\end{mdframed}
\end{document}
-------------------------------------------------

\begin{mdframed}[default]
[default]を付加すると framemethod=default と同じ．

\mdfsetupのオプションを設定するには，プリアンブルに限定されるものではなく，
環境内の設定は，ローカルに動作する．

■ mdframed環境オプションでフレーム仕様を指定する例

Syntax: \begin{mdframed} [< LOCAL OPTIONS > ]～\end{mdframed}

-------------------------------------------------
\documentclass{ltjsarticle}
\usepackage[xcolor,framemethod=tikz]{mdframed}
\begin{document}
　\begin{mdframed} [userdefinedwidth=5cm,align=center,linecolor=blue,linewidth=4pt,roundcorner=5pt]
　　\includegraphics[width=4cm]{./IMAGE/gardeninglion.jpg}
　\end{mdframed}
\end{document}
-------------------------------------------------

■ \newmdenv 新環境を定義してフレーム仕様を指定する例

Syntax: \newmdenv [ < MDFRAMED OPTIONS > ] {Name of the environment}

-------------------------------------------------
\documentclass{ltjsarticle}
\usepackage[xcolor,framemethod=tikz]{mdframed}
\newmdenv [linecolor=red,linewidth=3pt,frametitle=星落秋風五丈原,fontcolor=red]{infobox}
\begin{document}
　\begin{infobox}[backgroundcolor=yellow]
　　祁山(キザン)悲秋の風更けて　
　　陣雲暗し五丈原，　
　　零露の文(アヤ)は繁くして　
　　草枯れ馬は肥ゆれども　
　　蜀軍の旗光無く　
　　鼓角の音も今しづか．　
　　丞相(ジョウショウ)病あつかりき．
　\end{infobox}
\end{document}
-------------------------------------------------

Syntax: \renewmdenv [ < MDFRAMED OPTIONS> ] {Name of the renew-environment}
このコマンドを使用することで，\newmdenvによって作成されている環境を再定義することができる．

■ \mdfdefinestyle スタイルを定義してフレーム仕様を指定する例

Syntax: \mdfdefinestyle {style name}{ < options > }

　　　　\mdfdefinestyle{mystyle}{leftmargin=1cm,linecolor=blue}
　　　　\begin{mdframed}[style=mystyle] ～ \end{mdframed}

-------------------------------------------------
\documentclass{ltjsarticle}
\usepackage[xcolor,framemethod=tikz]{mdframed}
\mdfdefinestyle {mystyle}%
{frametitle=星落秋風五丈原,linecolor=blue,linewidth=3pt,backgroundcolor=yellow}
\begin{document}
　\begin{mdframed}[style=mystyle]
　　祁山(キザン)悲秋の風更けて　
　　陣雲暗し五丈原，　
　　零露の文(アヤ)は繁くして　
　　草枯れ馬は肥ゆれども　
　　蜀軍の旗光無く　
　　鼓角の音も今しづか．　
　　丞相(ジョウショウ)病あつかりき．
　\end{mdframed}
\end{document}
-------------------------------------------------

\mdfdefinestyleは，ユーザーが style= を経由してmdframedのオプションとして使用することができ，
異なるスタイルを定義することができる．

■ Shadow

フレームを強調表示するにはshadowがあり mdframedパッケージは，基本的なオプションをサポートしている．
framemethod= TikZ のための shadowは \usetikzlibrary{shadow} により，ユーザによりロードされなければならない．

●shadowに関する幾つかのコマンド
　　shadowsize= 8 pt (default)
　　shadowcolor= black!50 (default)

-------------------------------------------------
\documentclass{ltjsarticle}
\usepackage[framemethod=tikz]{mdframed}
%
\usetikzlibrary{shadows}
\begin{document}
　\begin{mdframed}[shadow=true,roundcorner=8pt,backgroundcolor=red!30]
　　吾輩は猫である．名前はまだ無い．

　　どこで生れたかとんと見当がつかぬ．
　　何でも薄暗いじめじめした所でニャーニャー泣いていた事だけは記憶している．
　　吾輩はここで始めて人間というものを見た．
　　しかもあとで聞くとそれは書生という人間中で一番獰悪な種族であったそうだ．
　　この書生というのは時々我々を捕えて煮て食うという話である．
　　しかしその当時は何という考もなかったから別段恐しいとも思わなかった．
　　ただ彼の掌に載せられてスーと持ち上げられた時何だかフワフワした感じがあった
ばかりである．
　\end{mdframed}
\end{document}
-------------------------------------------------

§６．その他

■ Options with lengths

（１）defaultunit
　　　///////////////////////////////////////////////////
　　　skipabove = 0pt　 skipbelow = 0pt
　　　leftmargin = 0pt　 rightmargin = 0pt
　　　innerleftmargin = 10pt　 innerrightmargin = 10pt
　　　innertopmargin = 5pt　 innerbottommargin = 5pt
　　　///////////////////////////////////////////////////

（２）line manipulate(default)
　　　///////////////////////////////////////////////////
　　　linewidth = 0.4pt　　innerlinewidth = 0pt
　　　middlelinewidth = 0.4pt
　　　outerlinewidth = 0pt　　roundcorner = 0pt
　　　///////////////////////////////////////////////////

■Colored Options(default)

　　　///////////////////////////////////////////////////
　　　linecolor = black　　innerlinecolor = black
　　　middlelinecolor = black　　outerlinecolor = black
　　　backgroundcolor = white　　fontcolor = black
　　　fontcolor =black
　　　///////////////////////////////////////////////////

EOT