Extension:Citoid

MediaWiki 拡張機能マニュアル

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

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

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

要件

この拡張機能を実行するには、VisualEditor 拡張機能をインストールし、ビジュアルエディター引用ツール を有効にする必要があります。

Citoid の実行には必須ではないものの、推奨される追加の拡張機能は以下の通りです:

• Scribunto
• TemplateStyles
• Cite
• TemplateData
• ParserFunctions

インストール

• ダウンロードして、ファイルをextensions/フォルダー内のCitoidという名前のディレクトリ内に配置します。
  開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Citoid
• 以下のコードを LocalSettings.php ファイルの末尾に追加します:

  wfLoadExtension( 'Citoid' );
  

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

Configuration

その後、ウィキの LocalSettings.php に Citoid サービス インスタンスの場所を設定します。

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

オプション	既定値	対象者	説明
$wgCitoidServiceUrl	false	システム管理者	Full url to use the native citoid api , i.e. http://localhost:1970/api. Only used if VisualEditorFullRestbaseURL is null.
$wgCitoidFullRestbaseURL	false	システム管理者	Full url to use a citoid service running behind restbase, i.e. https://en.wikipedia.org/api/rest_ (including the trailing _). Overwrites default, which is to use VisualEditorFullRestbaseURL (now deprecated). Does not need to be set if you are running citoid behind the same restbase instance as parsoid/VisualEditor; mostly useful for point to a cross domain restbase citoid installation.