Extension:Citoid

MediaWiki 拡張機能マニュアル

Citoid リリースの状態: 安定
実装	ユーザー インターフェイス
説明	Citoid サービスを VisualEditor 内で使用できるようにする。
作者	Marielle Volz Moriel Schottlender Ed Sanders
最新バージョン	0.3.0
互換性の方針	スナップショットが MediaWiki とともにリリースされます。 master には後方互換性がありません。
パラメーター $wgCitoidFullRestbaseURL $wgWBCitoidFullRestbaseURL $wgCitoidServiceUrl $wgCitoidIsbnScannerEnabled
使用するフック BeforePageDisplay GetPreferences ResourceLoaderGetConfigVars
ライセンス	MIT ライセンス
ダウンロード	拡張機能をダウンロード Git [?]: リポジトリを参照 (GitHub) Gerrit コード レビュー Git コミット ログ Download source tarball
translatewiki.net で翻訳を利用できる場合は、Citoid 拡張機能の翻訳にご協力ください
問題点	未解決のタスク · バグを報告

Citoid は、MediaWiki 拡張機能であり、URL や他の識別子から引用を生成する Citoid サービスを有効にするものであり、VisualEditor 内で使用できます。

このページは Citoid 拡張機能のダウンロードとインストール方法に関するものです。Citoid の実際の使用方法についての詳細情報は、Citoid ページを参照してください。

要件

この拡張機能を実行するには、以下の必須の拡張機能をインストールする必要があります:

• VisualEditor
• TemplateData
• Cite

Citoid の実行には必須ではないものの、いずれかのウィキペディアから引用テンプレートをインポートしている場合に推奨される追加の拡張機能は以下の通りです:

• Scribunto
• TemplateStyles
• ParserFunctions

インストール

• ダウンロードして、ファイルをextensions/フォルダー内のCitoidという名前のディレクトリ内に配置します。
  開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Citoid
  

• 以下のコードを LocalSettings.php ファイルの末尾に追加します:

  wfLoadExtension( 'Citoid' );
  

• 必要に応じて設定します。
• 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

設定

Citoid サービスのインスタンスの場所は、お使いのウィキの LocalSettings.php に設定します。

// ウィキが https 経由で提供されている場合、Citoid サービスの URL には https プロトコルが必要です。さもないと、ブラウザーはリクエストをブロックします。
$wgCitoidServiceUrl = 'http://localhost:1970';

オプション	既定値	対象者	説明
$wgCitoidServiceUrl	false	システム管理者	Full or relative url where citoid is deployed with no trailing slash i.e. http://localhost:1970 , https://en.wikipedia.org/api/rest_v1/data/citation, or /api/rest_v1/data/citation For version of mediawiki 1.44.0 and above, the trailing /api in http://localhost:1970/api will be ignored as the restful pattern is supported naively as of citoid 1.2.0; older configs should be updated to remove the trailing /api as backwards compatibility may be removed at some point. If your version of citoid < 1.2.0, you must use versions of mediawiki < 1.44.0, as higher versions are not compatible.
Deprecated $wgCitoidFullRestbaseURL	false	システム管理者	Despite its name, full or relative partial url to use a citoid service running behind restbase or using a restful pattern, excluding the restbase version number i.e. https://en.wikipedia.org/api/rest_ or /api/rest_ (including the trailing _). On Wikimedia wikis, Citoid is now served behind Rest Gateway and not Restbase so "restbase" is currently a misnomer. This config is deprecated since 1.46 and you should use $wgCitoidServiceUrl instead.