« Movable Type 3.0 プラグイン開発コンテスト受賞作品 Markdown | メイン | MovableType用TextFormatプラグイン mt-sukeroku-plus.pl Ver.1.00公開 »

MovableType用TextFormatプラグイン mt-sukeroku-plus.pl 設定ガイド

何も設定しなくても標準状態でmt-sukeroku-plusは動作します。
しかし、「出力結果がポリシーに反している」とか「美しくない」とかいうことがあるのではないかと思われます。

またamazonアソシエイトプログラムのIDを設定したいけどどうしたらいいのか、とかいう内容についてもマニュアルの記載がされていないのが現状なので、ユーザの方で簡単に修正していただける部分についてご紹介します。

尚、配布しているプラグインファイルを編集することになるので、エディタ(メモ帳でも可)が必要になります。

*設定パラメータ

mt-sukeroku-plusの動作を設定する部分が「設定パラメータ」になります。

変更するべき箇所はmt-sukeroku-plus.plの先頭数十行の位置にある

#######################################################
## ■ 設定パラメータの記述                           ##
##      => '...'の...の箇所を修正する                ##
#######################################################
my $sysParam = {
					:
					:
					:
};

となっている部分です。
その中にあるそれぞれの項目が設定箇所になります(コメントも記載しております)。

*一般的な設定

*強調表示に使うHTML要素の指定

脚注の表示の際にどのようなHTML要素として出力するのかを指定します。
標準では以下のように出力されます。

強調(太字系)
<strong>...</strong>
強調(斜体系)
<em>...</em>
取消・削除
<del>...</ins>
挿入
<ins>...</ins>

裏技というほどではないですけど、「自分は"挿入"なんか使わない」という向きは適当な要素に置き換えると、別の表現を簡単に実現できたりします。

 # ■強調表示に使うHTML要素の指定
 htmlTagEmphasisBold   => 'strong',
 htmlTagEmphasisItalic => 'em',
 htmlTagDelete         => 'del',
 htmlTagInsert         => 'ins',

*論理行末は強制的に<br />を挟む設定

PukiWiki風フォーマットなどでは改行時に改行が有効になりませんが、毎行末に<br/>を挟むようにも設定できます。
標準では無効になっています。

 # ■論理行末は強制的に<br />を挟む。
 #   ・対応する… 1, 対応しない… 0
 convert_line_break  => 0,

*XHTML1.1にできるだけ対応する設定

標準である程度、XHTMLでの出力を想定した挙動をしていますが、XHTML 1.1で廃止された属性などを使わないようにするための設定がこれになります。
標準で有効になっております。

 # ■XHTML 1.1にできるだけ対応する(^^;;
 #   ・対応する… 1, 対応しない… 0
 xhtml11mode         => 1,

*見出し関連

*見出し先頭文字列

見出しの先頭につける文字列を指定します。標準では「*」が出力されます。
「■」のような、いわゆる全角文字を出力したい場合はHTMLの実体参照と呼ばれるもので設定する必要があります。 「■」の場合 '&#9632;' としなければなりません。

 # ■見出しの先頭につける文字列(加工なく出力されます)
 #   ※出力をUTFにしている場合には実体参照でお願いします。
 symbolHeading1        => '*',      # ■…&#9632;
 symbolHeading2        => '*',      # ■…&#9632;
 symbolHeading3        => '*',      # ■…&#9632;

*見出しリンクアンカーの種類

見出し部分にリンクを設定しますが、そのリンクアンカーへの名前付けが自動的にされます。
標準では見出し文字列から生成されますが、見出しの章・節・項番号から生成するという形も選択できます。
見出しに同じ文字列を繰り返し使うことが想定される場合以外ではあまり意味がないかもしれません。

 # ■見出しリンクアンカーの種類(typeHeadingAnchor)
 #   ・見出し文字列から生成………………… 1
 #   ・見出し番号(章・節・項)から生成… 0
 typeHeadingAnchor     => 1,

*リンク関連

*リンク時に画像ファイルなら自動展開

リンクされるURIの末尾がgifやjpg、png等である場合、自動的に画像として展開するかどうかを設定できます。
標準では画像展開するとしています。

 # ■リンク時に画像ファイルなら自動展開(linkAutoImage)
 #   ・画像展開する… 1, 画像展開しない… 0
 linkAutoImage         => 1,

*リンク時のtarget指定

リンク時に新しいウィンドウで表示するかどうか、ウィンドウ名で設定できます。
標準では _blank を設定していますが、_selfと_blank(もしくは_new)以外が来ることを考えておりませんので、フレーム内に表示されている場合はご注意ください。

 # ■リンク時のtarget指定(linkAnchorTarget)
 #   ・同じウィンドウに展開する…… '_self'
 #   ・新しいウィンドウに展開する… '_blank'
 #     (※xhtml11modeが1のとき_self以外の場合、新規ウィンドウで開きます)
 linkAnchorTarget      => '_blank',

*リンク時のAmazonアソシエイトID

ASINコードやISBNコードを併用したAmazon.co.jpへのアクセスの際にAmazonアソシエイトプログラムのIDを付加できます。
標準では(自サイトでも利用してるので勝手ながら)当サイトのアソシエイトIDとなっていますので、アソシエイトIDをお持ちではない場合は空に設定してください。

 # ■リンク時のAmazonアソシエイトID(linkAmazonAssociate)
 #   ※契約されていない場合は空欄''にしておいてください。
 linkAmazonAssociate   => 'hsjjp-22',

*脚注関連

*脚注の先頭につける文字列

脚注の先頭につける文字列を指定します。標準では「*」が出力されます。
「†」のような、いわゆる全角文字を出力したい場合はHTMLの実体参照と呼ばれるもので設定する必要があります。 「†」の場合 '&#8224;'

 # ■脚注の先頭につける文字列(加工なく出力されます)
 #   ※出力をUTFにしている場合には実体参照でお願いします。
 symbolFootnote1       => '*',             # †…&#8224;
 symbolFootnote2       => '*',             # ‡…&#8225;
 symbolFootnote3       => '*',             # * 

*脚注表示に使うHTML要素と属性の指定

脚注の表示の際にどのようなHTML要素として出力するのかを指定します。
標準では以下のように出力されます。

脚注シンボル
<span class="footnote">...</span>
脚注本文リスト
<ul class="footnote">...</ul>
脚注本文それぞれ
<li class="footnote">...</li>

 # ■脚注表示に使うHTML要素と属性の指定
 htmlTagFootnoteList   => 'ul',
 htmlAttrFootnoteList  => 'class="footnote"',
 htmlTagFootnoteItem   => 'li',
 htmlAttrFootnoteItem  => 'class="footnote"',
 htmlTagFootnoteRoot   => 'span',
 htmlAttrFootnoteRoot  => 'class="footnote"',

*各フォーマット固有の設定

*PukiWiki風フォーマット利用時の逐語出力(バーベイタム)モードの設定

PukiWiki風フォーマットの独自実装機能の逐語出力(バーベイタム)モードを利用するかしないかを設定できます。
標準では有効としています。

また、逐語出力モードの開始・終了文字列を正規表現で指定できます。
標準では論理行頭の「///」で開始し、同じく論路行頭の「///」で終了します(ソフトモード)。

 # ■PukiWikiのコメント内逐語出力モードの利用
 #   ・逐語出力する… 1, 逐語出力しない… 0
 pukiwikiVerbatimEnabled         => 1,
 pukiwikiHardVerbatimOpenRegexp  => "^\/\/\/\/",
 pukiwikiHardVerbatimCloseRegexp => "^\/\/\/\/",
 pukiwikiSoftVerbatimOpenRegexp  => "^\/\/\/",
 pukiwikiSoftVerbatimCloseRegexp => "^\/\/\/",

*はてなダイアリー風フォーマットの整形済みテキストのハードモード利用

はてなダイアリー風フォーマットでもともとある「整形済みテキスト」内で < や > などがある場合、わざわざ &$1; などに自力でエスケープする必要がありましたが、そういった文字を自動的にエスケープする「ハードモード」を利用するかどうかの設定です。
標準では有効になります。

 # ■はてなダイアリー風フォーマットの整形済みテキストのハードモード利用
 #   ※整形済みの入れ子でHTMLエスケープが自動的にされるかどうか。
 #   ・エスケープ展開する… 1, エスケープ展開しない… 0
 hatenaPreHTMLEscape => 1,

*各種HTML要素に対する属性指定

mt-sukeroku-plusの出力結果はHTMLとなりますが、そのHTMLに対して特定の属性を付与することができます。

例えば、YukiWiki風やPukiWiki風フォーマットに存在する表組みのための表現がありますが、その際出力されるtable要素の属性として border="1" としたり、水平線のhr要素に対して width="5" size="5"などとすることもできます。

# ■各種HTML要素に対する属性指定(CSSのクラス指定などを想定)
my $htmlAttribute = {
 bold       =>  '',  # htmlTagEmphasisBoldに並行適用
 italic     =>  '',  # htmlTagEmphasisItalicに並行適用
 del        =>  '',  # htmlTagDeleteに並行適用
 ins        =>  '',  # htmlTagInsertに並行適用
 blockquote =>  '',
 pre        =>  '',
 p          =>  '',
 heading1   =>  '',  # * 章に対応
 heading2   =>  '',  # ** 節に対応
 heading3   =>  '',  # *** 項に対応
 a          =>  '',
 ul         =>  '',
 ul_li      =>  '',
 ol         =>  '',
 ol_li      =>  '',
 dl         =>  '',
 dl_dt      =>  'style="text-decoration:underline;"',
 dl_dd      =>  '',
 hr         =>  'width="50%"',
 table      =>  'border="1"',
};

トラックバック

このエントリーのトラックバックURL:
http://hsj.jp/blog/mt-tb.cgi/1181

コメントを投稿

(いままで、ここでコメントしたことがないときは、コメントを表示する前にこのブログのオーナーの承認が必要になることがあります。承認されるまではコメントは表示されません。そのときはしばらく待ってください。)

About

2004年07月28日 22:58に投稿されたエントリーのページです。

ひとつ前の投稿は「Movable Type 3.0 プラグイン開発コンテスト受賞作品 Markdown」です。

次の投稿は「MovableType用TextFormatプラグイン mt-sukeroku-plus.pl Ver.1.00公開」です。

他にも多くのエントリーがあります。メインページアーカイブページも見てください。

Powered by
Movable Type