トップ 差分 一覧 ソース 検索 ヘルプ RSS ログイン

BugTrack-plugin/430

ページの作成や編集にはユーザ登録が必要です。

コメント付きキーワードプラグイン

  • 投稿者: ぐぅます
  • カテゴリ: 新規
  • 優先度: 低
  • 状態: 提案
  • 日時: 2018年02月12日 21時03分00秒

 内容

コメント付きキーワードを使用できるようにするプラグインです。

解決したい問題:一般的なワードをキーワード登録することによる問題

FSWiki で運用しているサイトにおいて、キーワードとして登録したいワードがあっても、それが一般の文章でよく現れるワードである場合、キーワード登録してしまうと不要なキーワードリンクが発生してしまうことから、キーワード登録を諦めざるを得ない場合があります。

例:「18th single『ありがとう』」という名前のページへキーワードリンクされるように「ありがとう」というキーワードを登録したいが、曲名とは関係ない普通の文脈中に現れるお礼の言葉「ありがとう」からもキーワードリンクが張られてしまうのが煩わしいので、キーワード登録をためらう。

本プラグインでできること

コメントを付加したキーワードを登録することができます。コメント記号 '///' を含んだ形でキーワードを登録しておくと、Wiki ページで表示する際にはコメント記号以降の文字を表示しないでキーワードリンクを生成します。

例:ページ「Keyword」に次のようにコメント付きでキーワード登録しておき、

*[[ありがとう///曲名|18th single『ありがとう』]]

Wiki ソース中でコメント付きキーワードを次のように使用すると、

『ありがとう///曲名』って、とってもいい曲ですよね。詳細なレポートありがとうございます。

次のようなイメージで表示されます。コメント付きのキーワードなので、普通の文脈中に現れるお礼の言葉「ありがとう」とは区別され、不要なキーワードリンクが発生しません。

ありがとう』って、とってもいい曲ですよね。詳細なレポートありがとうございます。

キーワード内コメントの認識

登録されたコメント付きキーワードの中で、キーワード末尾から調べて最初に現れるコメント記号 '///' 以降をコメントとみなし、キーワードリンクでは表示しません。

やっていること

Wiki ソース文字列を与えられたとき、登録キーワードが含まれるか否か、もし含まれるならどの部分か、を調べる関数 Wiki::Keyword::exists_keyword() 内において、検出したキーワードを返却する直前に、コメント記号以降を削除して返却します。

--- lib/Wiki/Keyword.pm.orig	2011-07-28 20:16:09.000000000 +0900
+++ lib/Wiki/Keyword.pm	2018-02-12 19:16:56.471476800 +0900
@@ -90,6 +90,13 @@ sub exists_keyword {
 				$self->{g_url}  = undef;
 				$self->{g_page} = $word->{'value'};
 			}
+
+                        # コメント付きキーワード:
+                        # コメント記号 '///' を含むキーワードなら、
+                        # 語尾に一番近いコメント記号以降の文字を表示しない。
+                        my $cpos = rindex $label, '///';
+                        $self->{g_label} = ($cpos > 0) ? substr($label, 0, $cpos) : $label;
+
 			return 1;
 		}
 	}

 プラグイン版

適用可能な FSWiki バージョン

FreeStyleWiki3.6.5

本プラグインパッケージの構成とインストール

  • 構成:添付ファイル keywordwc.20180212.zip(43) に含まれるファイルは、次の 1 つです。
    • plugin/keywordwc/Install.pm
  • インストール:
    1. keywordwc.20180212.zip(43) をダウンロードし、FSWiki の動作しているサーバに展開してください。
    2. 管理メニューのプラグイン設定ページから、keywordwc プラグインパッケージを有効にしてください。

更新履歴

2018-02-12 版:keywordwc.20180212.zip(43)
初版公開

 非プラグイン版

FreeStyleWiki3.6.4 では、lib/Wiki/Keyword.pm が最新版とは異なるので、上記プラグイン版を適用することはできません。そこで、添付ファイル Keyword.pm.20180212.zip(35) に含まれる Keyword.pm と差し替えてください。最新版の lib/Wiki/Keyword.pm に対し、上記プラグイン版相当の機能を直接追加したものになります。

FreeStyleWiki3.6.4 よりも古い版では、一部のコア機能が不足していますので適用できません。

更新履歴

2018-02-12 版:Keyword.pm.20180212.zip(35)
初版公開

 コメント

  • なるほど、名前空間のような使い方ですね。 - KG (2018年02月13日 13時52分07秒)
お名前: コメント:
Keyword.pm.20180212.zip Keyword.pm.diff keywordwc.20180212.zip

最終更新時間:2018年02月13日 13時52分07秒