BugTrack-plugin/387

Wiki記法説明用スタイルを適用する複数行プラグイン

• 投稿者： A_M
• カテゴリ： 新規
• 優先度： 緊急
• 状態： 提案
• 日時： 2008年08月20日 23時03分04秒

 内容

HTMLParserの出力でclass属性を埋めないFSWikiに、汎用要素（DIV要素）で囲って出力し、スタイルを適用する複数行プラグイン活用例として公開します。

以下のように編集画面をイメージし易い画像をPRE要素に適用します。

 パッケージ

プラグイン・アーカイブの内容

• wikinotation_(yyyymmdd).zip - yyyymmdd は公開年月日
  • plugin/wd_style_fswiki/Install.pm
  • plugin/wd_style_fswiki/wikiNotation.pm
  • theme/wiki_notation.css
  • theme/plugin_wikinotation.gif

ダウンロードは更新履歴の項目からお願いします。

• wikiNotation.pm の冒頭コメント部は「関連」の項で説明する改変に対応済みです。
• 同梱のテーマは、BugTrack-plugin/224を適用したものになります。

 インストール

1. アーカイブをFSWiki設置ディレクトリに展開します。
2. 管理画面のプラグイン設定から、wd_style_fswikiを有効にしてください。
3. 使用中のテーマに次の1行を記述します。
   • 未変更の場合、theme/default/defaultc.css

@import "../wiki_notation.css";

同様に読み込むテーマが有る場合は、common.css などにまとめておくと、1つのCSSを読み込むだけになります。

 使い方

FSWikiの編集画面として表示したい整形済みテキスト記法を本プラグイン内で記述してください。

以下のように「画面イメージで表現したい整形済みテキスト記法を挟む形」で記述します。

{{notation
 !!!整形済みテキスト
 Wikiの記法
}}

HTMLParserを通すと、以下のHTMLになります。

<div class="wikiNotation">
<pre>
<h2>整形済みテキスト</h2>
<p>Wikiの記法</p>
</pre>
</div>

 関連

プラグインヘルプは、インライン記法、パラグラフ記法、複数行記法の書かれた *.pm ファイルの冒頭コメント部を読み込んで表示しますので、plugin/info/PluginHelpHandler.pm に修正を加えるとともに、全プラグインの冒頭コメント部を修正することで、編集画面をイメージさせる表現ができます。

plugin/info/PluginHelpHandler.pm

sub get_comment {
	my $wiki   = shift;
	my $plugin = shift;
	my $comment = "";
	my $fname = $wiki->config("plugin_dir").'/'.&Util::get_module_file($plugin);
	open(MODULE,$fname) || die "$fnameのオープンに失敗しました。";
	my $comment = "";
	my $flag = 0;
	while(<MODULE>){
		if(!/^#/ || /^##/){
			if($flag==0){ next; } else { last; }
		}
		$flag = 1;
		s/\#+//;
		s/\=+//;
		s/^\s+//; s/\s+$//;
+		s/class&#x3D;/class\=/;
		if($_ ne ""){
			$comment .= $_."\n";
		}
	}
	close(MODULE);
	return $comment;
}

インライン、パラグラフのコメント部分
# <div class&#x3D;"wikiNotation">
# <pre>
# {{plugincommand}}
# </pre>
# </div>
# <p></p>

複数行のコメント部分
# <div class&#x3D;"wikiNotation">
# <pre>
# {{plugincommand
# (FSWikiソース)
# }}
# </pre>
# </div>
# <p></p>

Install.pmで以下のAPIを利用しているファイルがコメント部の修正対象になります。

1. add_inline_plugin
2. add_paragraph_plugin
3. add_block_plugin

• BugTrack-plugin/386初版は、この対応を済ませています。
  • (修正版を公開しましたので、参考程度に留めるよう、お願い致します)

 ライセンス

GPL

 更新履歴

wikinotation_20080820.zip(463)

初版公開

 コメント

• プラグインヘルプでの説明が文字化けしています。UTF8で記述されているようですが、なんとかなりませんか？ - とおりすがり (2008年09月11日 15時56分27秒)