DokuWiki

It's better when it's simple

ユーザ用ツール

サイト用ツール


サイドバー

この翻訳は元のページよりも更新日が古く、内容が古い可能性があります。 変更点を参照して下さい。
このページの翻訳?:

DokuWiki について知る

開発

法人利用

我々のコミュニティ


FacebookTwitterや他のソーシャル・ネットワークからフォローしてください。

ja:plugin:interwikiformatting

Interwiki 書式設定プラグイン

互換性のある DokuWiki バージョン

  • 2018-04-22 "Greebo" 不明
  • 2017-02-19 "Frusterick Manners" 確認済
  • 2016-06-26 "Elenor Of Tsort" 確認済
  • 2015-08-10 "Detritus" 不明

plugin Interwiki 書式設定プラグインは、Interwiki リンク用に書式を設定したタイトルを自動的に生成します。

最終更新日
2016-11-19
種類
Syntax
リポジトリ
ソース
作者 jeckel

インストール

最新バージョンのプラグインを指している上記のダウンロード URL拡張機能管理を使用してプラグインをインストールして下さい。 手動でプラグインをインストールする方法については、プラグインを参照してください。

概要

Interwiki リンクは、Dokuwiki 編集画面のツールバーの中の強力な時間を節約するツールです。 Dokuwiki 編集画面のツールバーはサイト内で特に頻繁に使用されるさまざまなカスタムショートカットを提供します。 しかし、Interwiki リンクには一つの欠点があります。 関連するサイトに必要な形式で URL 部分を表示することを受け入れるか、URL 部分とは書式設定の異なるタイトルを常に追加する必要が有ります。

このプラグインは、タイトルを手動で定義しない Interwiki リンクの書式設定を自動化することによってその問題を解決しようとします。 Tv Tropesのように複数の単語をスペース抜きで一緒にしてページ ID を構成するサイトの場合、プラグインはスペースを再度挿入します。 Wikipediaのようにアンダースコアやその他の区切り文字で区切られた単語でページ ID を構成するサイトの場合、プラグインはスペースで置き換えます。 表示タイトルは、一般的なタイトル例として標準化された大文字使用になります。 冠詞、接続詞、前置詞、大文字略語以外の全ての単語は大文字で始まります。

この書式設定の自動化とプラグイン設定の変更可能性は、Interwiki リンクの利用を簡素化し、見た目を標準化し、利用する編集者の時間を節約するはずです。

使用方法

このプラグインは特別な構文を必要とせず、Interwiki リンクを使用するだけで、普通に自動的に書式設定を適用します。
[[ショートカット>あるページ#任意のアンカー]]

Interwiki リンクに既にタイトルを定義した場合は適用しません。
[[ショートカット>あるページ#任意のアンカー|既にタイトルがあるため、ここでは書式設定を適用しません]]

実際のプラグインの例を参照してください。

設定

Interwiki 書式設定プラグインには Dokuwiki の設定管理で設定可能な 8 個の設定があります:

  1. 無視するショートカット一覧 (ignored_shortcuts) - 自動書式設定をしない Interwiki ショートカットの空白区切り一覧。デフォルト一覧には userskype ショートカットが含まれています。
  2. クエリーを削除する (strip_query) - 表示タイトルからInterwiki リンクのクエリー部分を削除するかどうかを指定します。この設定のデフォルトは有効になっています。
  3. 削除する拡張子一覧 (strippable_extensions) - Interwiki リンクタイトルの末尾から削除する必要がある拡張子の空白区切り一覧。デフォルト一覧には asphtmhtmlphp が含まれます。
  4. 区切り文字一覧 (word_separators) - タイトルの書式設定時に空白で置き換える文字の空白区切り一覧。デフォルト一覧には _:.- が含まれます。
  5. アンカー置換文字列 (anchor_replacement) - アンカー記号 (#) を置き換える文字列。ただし文字列の最初か最後にある場合は完全に削除されます。デフォルト値は前後が空白のダッシュ ( - ) です。
  6. スラッシュ置換文字列 (slash_replacement) - 一般的なパス区切り記号 (/) を置き換える文字列。ただし文字列の最初か最後にある場合は完全に削除されます。デフォルト値は前後が空白のダッシュ( - )です。
  7. 単語を大文字で始める (capitalize_words) - Interwiki リンクタイトルの全ての単語を大文字で始めるか否か。この設定のデフォルトは有効になっています。
  8. 大文字開始例外一覧 (capitalize_exceptions) - 大文字で始めない単語の空白区切り一覧。単語を大文字で始めるが無効の場合、この設定は無視されます。タイトルの最初か最後の単語、アンカー・スラッシュ置換文字列の直前・直後の単語の場合、この一覧の単語でも大文字で始めます。デフォルト一覧には theofaanandbutorfornorareinat が含まれます。

今後の計画

  • 報告されたバグを修正する。
  • 将来の Dokuwiki のバージョンに必要な更新。
  • 現在、新機能の計画はありません。

セキュリティ

現時点では、このモジュールの通常の使用に関連する既知の脆弱性は存在しません。 このモジュールは Interwiki リンクを作成するための組み込みメソッドを利用し、ユーザー定義のタイトルの代わりに生成されたタイトルを提供します。 これは、通常の Interwiki リンクとほぼ同等に安全なはずです。 プラグインの設定値を保護または検証するための特別な手段は実装されていませんが、 Wiki の管理者と設定管理画面へのアクセスを許されているユーザーだけが設定できるはずなので、他の設定と同等の安全性なはずです。

バグ

バグは Gitlab Issue Tracker を使用して報告して下さい。

  • 現在、既知のバグはありません。

書式設定の問題

このプラグインの利用者が自動的に書式設定された見栄えの悪い Interwiki リンクを発見し、代わりに明瞭なタイトルを手動で付けることになるのは自明です。 これは常にあることで完全に回避することはできません。 コードの改善とは無関係に URL とページ ID は単に多様化するだけです。 参入障壁が低いので Web 開発は、クエリ文字列を要求したりファイル拡張子を隠さないみたいな、悪習を培う傾向にある雰囲気です。

ありがたいことに、これらの問題のいくつかはプラグインの利用者自身がとても簡単に解決できます。 以下の phpfn Interwiki リンクを参照してください。 主な問題は明白です。 php 関数ページ (そのために phpfn の fn) へのショートカットのように見えますがそうではありません。 それは PHP ウェブサイトへのショートカットであり、manual/en/function.count.php 全部を入力する必要があり、Manual - En - Function.php がタイトルに含まれることになります。

[[phpfn>manual/en/function.count.php]] Manual - En - Function Count Php

Interwiki 書式設定プラグインは、タイトルの書式設定時に PHP や他の一般的な拡張子を削除するように設定できます(デフォルトではそうなっています)。 しかし、前者の問題はプラグインで解決することはできませんが、最初にあったショートカット自体を再定義することで修正できます。 {NAME} の前に manual/en/function. を後ろに .php を追加するだけです。 これでショートカットがより直感的で使いやすくなり、プラグインの自動書式設定が意図どおりに機能するようになります。

修正前 修正後
phpfn     https://secure.php.net/{NAME}
phpfn     https://secure.php.net/manual/en/function.{NAME}.php
Manual - En - Function Count Php Count

On the other hand, take the mess that is the following amazon links. The first example has a bunch of gunk at the end, dp/B00DBYBNEE, and there is no way to create rules to automatically remove such clutter. The second link is both better and worse; the plugin (with default settings) will strip the question mark and everything after it, but there is still a trailing b there. While, theoretically, that b could be removed with a rule about single characters that aren't a or i, that is far too prone to cause unwanted removals, making it an addition that is as much or more costly to include than to leave out. Perhaps, again theoretically, the plugin could extend interwiki links to include some kind of substring arguments that could strip x number of characters from the end or beginning, but changing interlink syntax is outside the scope of this plugin.

[[amazon>Amazon-Prime-One-Year-Membership/dp/B00DBYBNEE]] Amazon Prime One Year Membership - Dp - B00 DBYBNEE
[[amazon>Black-Friday/b?ie=UTF8&node=384082011]] Black Friday - B?ie=UT F8&node=384082011

結論として、このプラグインには短所があります。 これらの問題のいくつかは、Interwiki のショートカットをより適切な方法で再定義することで解決できます。 Interwiki 書式設定プラグインの設定で解決できる問題もあります。 残りの問題は、明瞭なタイトルを手動でリンクに付けることで常に代替することができます。 leaving the plugin to automatically format the majority of commonly used links which tend to be well behaved.

議論

議論はプラグインに関する議論のページに保存して下さい。

ja/plugin/interwikiformatting.txt · 最終更新: 2017-03-15 01:09 by sawachan