Phabricator のプロジェクト名 #cite

Extension:Cite

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:Cite and the translation is 48% complete.

Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎català • ‎dansk • ‎español • ‎français • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎sicilianu • ‎suomi • ‎Ελληνικά • ‎русский • ‎فارسی • ‎中文 • ‎日本語 • ‎한국어
このページでは拡張機能について記述しています。 その使用方法については脚注のヘルプ引用のヘルプを参照して下さい。
この拡張機能は MediaWiki 1.21 以降に同梱されています。 そのため再度ダウンロードする必要はありません。 しかし、提供されているその他の手順に従う必要はあります。
このページでも以前説明されていた "Special:Cite" 機能は MediaWiki 1.25 以降 "Cite" 拡張機能の一部ではなくなりました。 MediaWiki 1.24 からアップデートする場合、以下の行は "LocalSettings.php" ファイルから 取り除かれる べきです:
require_once "$IP/extensions/Cite/SpecialCite.php";
"Special:Cite" 拡張機能は現在では CiteThisPage 拡張機能として知られており、個別にインストールすることができます。
MediaWiki 拡張機能マニュアル
Crystal Clear action run.svg
Cite
リリースの状態: 安定
Cite extension screenshot.png
実装 Tag
説明 情報源を挙げるための脚注を提供し、オフライン媒体の内容の正しい引用を支援する
作者 Ævar Arnfjörð Bjarmasontalk
最新バージョン 継続的な更新
MediaWiki 1.25+
PHP 5.4+
データベースの変更 いいえ
ライセンス GNU General Public License 2.0 or later
ダウンロード
Wikipedia:Footnotes
使用するフック
BeforePageDisplay
Debug
ParserBeforeTidy
ParserClearState
ParserFirstCallInit
ParserGetVariableValueTs
ParserGetVariableValueVarCache
SkinTemplateBuildNavUrlsNav_urlsAfterPermalink
SkinTemplateToolboxEnd
User
translatewiki.net で翻訳を利用できる場合は、Cite 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
問題点 未解決のタスク · バグを報告

Cite拡張機能によって、利用者がページの脚注として参考文献を作成することができます。それはMediaWikiに2つのパーサーフック<ref><references /> を追加し、これらはページに引用を加えるために連動します。

ダウンロード

拡張機能は、Git から直接取得できる場合があります [?]:

  • コードを参照
  • 一部の拡張機能には安定版リリースのタグがあります。
    • タグを参照
    • タグを選択します
    • 「スナップショット」をクリックします
  • 各ブランチは過去の MediaWiki リリースと関連付けられています。 最新のアルファ バージョンを含む「master」ブランチもあります (MediaWiki のアルファ バージョンが必要な場合用)。

スナップショットを展開して、MediaWiki インストレーション内の extensions/Cite/ ディレクトリに配置します。

git に馴染みがあり、かつサーバーにシェルでアクセスできる場合は、拡張機能を以下のようにして取得することもできます:

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

インストール

  • Vagrant を使用している場合は、vagrant roles enable cite --provision でインストールしてください
手動インストール
  • ダウンロードして、ファイルを extensions/ フォルダー内の Cite という名前のディレクトリ内に配置します。
  • 以下のコードを LocalSettings.php の末尾に追加します:
    wfLoadExtension( 'Cite' );
    
  • Yes 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

使用法

<references/>タグを記して脚注を表示するよう指定された節に<ref>タグで囲まれた文書を挿入するのが基本的な考えです。この書式は古い書式とは互換性がありません。どちらか一方を選ぶ必要があります。

文書に複数の <references/> を記述することもできます。その場合、 <references/> タグを記した箇所よりも上にあるすべての <ref> タグの内容が挿入されます。

記事の中に <references/> を記述し忘れた場合、脚注がなくなることはなくページの最後に脚注が表示されます。

このページ自体でもこの文の末尾にあるような脚注を使っています。[note 1] (英語ページで)「編集」をクリックしてソースを見ると、脚注がどのように動作しているのかをみることができます。

ウィキテキスト レンダリング
太陽はかなり大きい。<ref>E. Miller, ''The Sun'', (New York: Academic Press, 2005), 23-5.</ref> しかし、月はそれほど大きくはない。<ref>''R. Smith, "Size of the Moon", ''Scientific American'', 46 (April 1978): 44-6.</ref>

==注記==
<references />

太陽はかなり大きい。[1] しかし、月はそれほど大きくはない。[2]

注記
  1. E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.
  2. R. Smith, "Size of the Moon", Scientific American, 46 (April 1978): 44-6.

同じ脚注の複数回の使用

ある脚注に他の重複しないIDを割り振るには <ref name="name"> を使います。そして同じname値を持つ ref タグを使えば同じ脚注を再度参照することができます。2つ目のタグの中に書かれた文書は脚注の内容に影響しません。なぜなら脚注の内容は最初の参照で既に書かれているからです。脚注を再利用するには、脚注全体をコピーしても、<ref name="name" />のように空の ref タグを書いても構いません。nameに何も値が設定されていない場合、引用符はなくても構いません(しかしあった方が正しい表記法です)。閉じ記号 "/" の前の空白は省略できます。

以下の例では同じ情報源を3回引用しています。

ウィキテキスト 結果
This is an example of multiple references to the same footnote.<ref name="multiple">Remember that when you refer to the same footnote multiple times, the text from the first reference is used.</ref>

Such references are particularly useful when citing sources, if different statements come from the same source.<ref name="multiple" /> Any reused tag should not contain extra content, that will spawn an error. Only use empty tags in this role.

A concise way to make multiple references is to use empty ref tags, which have a slash at the end. Although this may reduce redundant work, please be aware that if a future editor removes the first reference, this will result in the loss of all references using the empty ref tags.<ref name="multiple" />

==注記==
<references />
This is an example of multiple references to the same footnote.[1]

Such references are particularly useful when citing sources, if different statements come from the same source.[1] Any reused tag should not contain extra content, that will spawn an error. Only use empty tags in this role.

A concise way to make multiple references is to use empty ref tags, which have a slash at the end. Although this may reduce redundant work, please be aware that if a future editor removes the first reference, this will result in the loss of all references using the empty ref tags.[1]

注記
  1. 1.0 1.1 1.2 Remember that when you refer to the same footnote multiple times, the text from the first reference is used.
name属性に指定する識別子には英字を含める必要があります。数字だけを使うとエラーメッセージが表示されます。


2つの参照文書を1つの参照に統合する

一つの参照文書を複数のページに分けるにはどうすればいいか、というのはウィキソースでよくある問題です。これは <ref name="name"> タグを使って最初の参照部分を書き、<ref follow="name"> タグを使い別のページに残りの部分を書くことで実現できます。

引用の一部を前の節で使った文書から取り出している一例をここに示します。

ウィキテキスト レンダリング
This is an example of merging multiple texts into the same footnote.<ref name="main">Remember that all the texts will be included into the reference containing the ''name='' attribute.<br /></ref>

<ref follow="main">Simply include the text to be merged into the first <ref name="main"> reference with a tag <ref follow="name"><br />This paragraph is included into a similar tag and it will be merged into the reference in former paragraph.</ref>

==References==
<references/>

This is an example of merging multiple texts into the same footnote.[1]


References
  1. Remember that all the texts will be included into the reference containing the name= attribute.
    Simply include the text to be merged into the first <ref name="name"> reference with a tag <ref follow="name">
    This paragraph is included into a similar tag and it will be merged into the reference in former paragraph.

When using this syntax into Page: namespace, take care that the ref follow part of the footnote is transcluded too into the same ns0 page, where the first part of footnote is transcluded. Use appropriately section tags to get this result. To also remind users that reference names should not solely be numbers, eg. <ref name="p32"> and <ref follow="p32">.

<references /> タグ

The <references /> tag inserts the text of all the citations which have defined in <ref> tags up to that point in the page. For example, based on the citations above, there should be reference for the note group.

ウィキテキスト 結果
<references group="note"/>
  1. この脚注は「使用法」の節で使われています。

In some language editions of Wikipedia, long reference lists may be placed using the template {{Reflist}}, which incorporates <references />. It provides an optional parameter to display the reference list in multiple columns. For instance, the English, Hindi and Interlingua Wikipedias use the CSS selector references-small to make the reference text smaller than normal text.

If a page includes more than one <references /> list, each list includes the <ref> tags defined after the previous references list. If these references lists are produced by templates, each one lists the ref tags defined before the first references list, and there is an error message saying that there is a ref tag but not a references list.

Grouped references

This may be disabled by $wgAllowCiteGroups = false; if desired.

The following example generates separate reference lists for citations and miscellaneous footnotes:

ウィキテキスト 結果
According to scientists, the Sun is pretty big <ref>E. Miller, ''The Sun'', (New York: Academic Press, 2005), 23-5.</ref> In fact, it is very big <ref group="footnotes"> Take their word for it. Don't look directly at the sun!</ref>

==注記==
<references group="footnotes" />

==References==
<references />
According to scientists, the Sun is pretty big [1] In fact, it is very big [footnotes 1]
注記
  1. Take their word for it. Don't look directly at the sun!
References
  1. E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.

The anonymous group works as before, while references destined for the named group will only show up in the designated <references /> element.

文書から参照情報を分離する

文書中に書かれた参照情報は別のページにたやすくコピーできますが、読みにくくなります。多くのデータ、引用情報、手の込んだ引用テンプレートを含む参照があると、ソースに書かれた文書は実際ページに表示される内容よりもかなり多いものになることがあります。これを避けるため、この拡張機能の最近のバージョンでは参照情報の一部または全部を <references /> を書いた節(ページで実際に脚注が表示される位置)に移動することができるようになっています。

ウィキテキスト 結果
According to scientists, the Sun is pretty big.<ref name="miller" /> The Moon, however, is not so big.<ref name="smith" />

==注記==
<references>
<ref name="miller">E. Miller, ''The Sun'', (New York: Academic Press, 2005), 23-5.</ref>
<ref name="smith">R. Smith, "Size of the Moon", ''Scientific American'', 46 (April 1978): 44-6.</ref>
</references>
According to scientists, the Sun is pretty big.[1] The Moon, however, is not so big.[2]
注記
  1. E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.
  2. R. Smith, "Size of the Moon", Scientific American, 46 (April 1978): 44-6.

Thus, the code above will have the same output as the first example above, although the numbering and order of the references will not in general be the same.

Substitution and embedded parser functions

Since Cite's <ref> tag is parsed before MediaWiki's parser functions (e.g. {{#ifexpr:…}}) or variables (e.g. {{PAGENAME}}) or before subst:, these will not work inside of citation references. Instead, you have to use the magic word {{#tag:…}}.

ウィキテキスト 結果
Foo <ref>This is not working, see {{cite journal|url=https://www.google.com |title=Search |author= |date= |accessdate={{subst:#time:Y-m-d|now}}}}</ref> bar baz… 
Foo{{#tag:ref| Whereas this does, see {{cite journal|url=https://www.google.com |title=Search |author= |date= |accessdate={{subst:#time:Y-m-d|now}}}}}} bar baz…
<references />

Foo [1] bar baz… Foo[2] bar baz…

  1. This is not working, see "Search" . Retrieved on [[{{subst:#time:Y-m-d|now}}]]. 
  2. Whereas this does, see "Search" . Retrieved on 2017-01-27. 

カスタマイズ

The format of the output of <ref> and <references> is almost completely customizable through MediaWiki messages, that can be modified, for example, through the MediaWiki namespace depending on the configuration of the wiki.

For a list of messages that control the output of <ref> and <references> and the values, if any, that are passed to them ($1, $2, $3 ...), see here for an up-to-date listing of their default contents.

Incomplete list
  • cite_reference_link_key_with_num
    1. key
    2. num
  • cite_reference_link_prefix
  • cite_reference_link_suffix
  • cite_references_link_prefix
  • cite_references_link_suffix
  • cite_reference_link
    1. ref ID
    2. backlink ID
    3. count to display
  • cite_references_link_one
    • Used to format the source list that <references /> outputs, it configures 3 things: the backlink ID, the ref ID, and text of note.
    1. backlink ID - used for creating the number order of the source list.
    2. ref ID - used to link back to the actual reference in the text, this is where you can configure the <bold>^</bold> symbol
    3. text of note - text used above describing the source info
  • cite_references_link_many
    1. backlink ID
    2. list of links
    3. text of note
  • cite_references_link_many_format
    1. ref ID
    2. numeric value to use as a backlink
    3. custom value (as defined in cite_references_link_many_format_backlink_labels to use as a backlink)
  • cite_references_link_many_format_backlink_labels
  • cite_references_link_many_sep
  • cite_references_link_many_and
  • cite_references_prefix
  • cite_references_suffix

Set references to use ^ and letters

To replace the default uparrow (↑) with caret (^), modify the following system messages. All of these pages can be found on Special:Allmessages.

MediaWiki:Cite references link one
From To
<li id="$1">[[#$2|↑]] $3</li>
<li id="$1">[[#$2|^]] $3</li>
MediaWiki:Cite references link many
From To
<li id="$1">↑ $2 $3</li>
<li id="$1">^ $2 $3</li>
MediaWiki:Cite references link many format

Putting $3 between the <sup> </sup> tags changes the links from 1.0, 1.1, 1.2 to a, b, c etc…

From To
[[#$1|<sup>$2</sup>]]
[[#$1|<sup>$3</sup>]]

Searching for these 3 pages for the first time will result in no matches. Simply click "Create this page" to edit the code. The changes will not show up until a page with references is rebuilt.

Set reference and reference number highlighting

Starting with MW 1.26 the selectors for highlighting are now incorporated into Cite/modules/ext.cite.css. Thus the CSS code below no longer needs to be added manually.

Add the following code to the MediaWiki:Common.css page.

/* make the Cite extension list of references look smaller and highlight clicked reference in blue */
ol.references { font-size: 90%; }
ol.references li:target { background-color: #ddeeff; }
sup.reference:target { background-color: #ddeeff; }

API

An API is available when correctly configured by the following.

$wgCiteCacheRawReferencesOnParse = true;
$wgCiteStoreReferencesData = true;

a Raw JSON for a given page will now be accessible via: /wiki/Special:ApiSandbox?useformat=desktop#action=query&format=json&prop=references&titles=Doctor+Who

You will need to purge existing pages for this to become available.

関連項目