Phabricator のプロジェクト名 #cite

Extension:Cite

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

Other languages:
català • ‎Deutsch • ‎English • ‎español • ‎فارسی • ‎suomi • ‎français • ‎magyar • ‎italiano • ‎日本語 • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎sicilianu • ‎中文
このページでは拡張機能について記述しています。 その使用方法については脚注のヘルプ引用のヘルプを参照して下さい。
This extension is bundled with MediaWiki 1.21 and above. Thus you do not have to download it again.
このページでも以前説明されていた "Special:Cite" 機能は MediaWiki 1.25 以降 "Cite" 拡張機能の一部ではなくなりました。 MediaWiki 1.24 からアップデートする場合、以下の行は "LocalSettings.php" ファイルから 取り除かれる べきです:
require_once "$IP/extensions/Cite/SpecialCite.php";
"Special:Cite" 拡張機能は現在では CiteThisPage 拡張機能として知られており、個別にインストールすることができます。
MediaWiki 拡張機能マニュアルManual:Extensions
Crystal Clear action run.png
Cite

リリースの状態:Extension status 安定

実装Template:Extension#type Tag
説明Template:Extension#description 情報源を挙げるための脚注を提供し、オフライン媒体の内容の正しい引用を支援する
作者Template:Extension#username Ævar Arnfjörð Bjarmasontalk
最新バージョンTemplate:Extension#version 継続的な更新
MediaWikiTemplate:Extension#mediawiki 1.23+
PHPTemplate:Extension#php 5.3+
データベースの変更Template:Extension#needs-updatephp いいえ
ライセンスTemplate:Extension#license GNU General Public License 2.0 or later
ダウンロード
Template:Extension#example Wikipedia:Footnotes
使用するフックTemplate:Extension#hook
BeforePageDisplayManual:Hooks/BeforePageDisplay
DebugManual:Hooks/Debug
ParserBeforeTidyManual:Hooks/ParserBeforeTidy
ParserClearStateManual:Hooks/ParserClearState
ParserFirstCallInitManual:Hooks/ParserFirstCallInit
ParserGetVariableValueTsManual:Hooks/ParserGetVariableValueTs
ParserGetVariableValueVarCacheManual:Hooks/ParserGetVariableValueVarCache
SkinTemplateBuildNavUrlsNav_urlsAfterPermalinkManual:Hooks/SkinTemplateBuildNavUrlsNav_urlsAfterPermalink
SkinTemplateToolboxEndManual:Hooks/SkinTemplateToolboxEnd
User

translatewiki.net で翻訳を利用できる場合は、Cite 拡張機能の翻訳にご協力ください

使用状況とバージョン マトリクスを確認してください。

問題点Phabricator

未解決のタスク · バグを報告

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

ダウンロード[edit]

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

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

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

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

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

インストール[edit]

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

MediaWiki 1.24 以前を稼働させている利用者へ:

上記の手順では、MediaWiki 1.25 から導入された、wfLoadExtension() を使用して拡張機能をインストールする新しい方法を記載しています。 この拡張機能を過去のバージョンにインストールする必要がある場合は、wfLoadExtension( 'Cite' ); の代わりに以下を使用する必要があります:

require_once "$IP/extensions/Cite/Cite.php";

使用法[edit]

The basic concept of the <ref> tag is that it inserts the text enclosed by the ref tags as a footnote in a designated section, which you indicate with the placeholder tag <references />. This format cannot be used interchangeably with the older format — you must pick one or the other.

Additional placeholder tags <references /> can be inserted in the text, and all <ref> tags up to that point will be inserted there.

If you forget to include <references /> in the article, the footnotes will not disappear, but the references will be displayed at the end of the page.

This page itself uses footnotes, such as the one at the end of this sentence.[note 1] If you view the source of this page by clicking "Edit this page", you can see a working example of footnotes.

ウィキテキスト レンダリング
The Sun is pretty big.<ref>E. Miller, ''The Sun'', (New York: Academic Press, 2005), 23-5.</ref> The Moon, however, is not so big.<ref>''R. Smith, "Size of the Moon", ''Scientific American'', 46 (April 1978): 44-6.</ref>

==注記==
<references />

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.

同じ脚注の複数回の使用[edit]

To give a footnote a unique identifier, use <ref name="name">. You can then refer to the same footnote again by using a ref tag with the same name. The text inside the second tag doesn't matter, because the text already exists in the first reference. You can either copy the whole footnote, or you can use a terminated empty ref tag that looks like this: <ref name="name" />. The quotes are not required (but still correct) if the name contains no embedded spaces. The space before the closing "/" may be omitted.

In the following example, the same source is cited three times.


ウィキテキスト 結果
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.

注 : Note that identifiers used in the name attribute require alphabetic characters; solely relying on numerals will generate an error message.

Merging two texts into a single reference[edit]

A typical wikisource issue is, how to merge into one reference texts split into different pages. This can be done using a <ref name="name"> tag for the first part of the reference, and tagging the following parts into different pages with a tag <ref follow="name">.

Here an example, deriving the text used into previous section:

ウィキテキスト レンダリング
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 /> タグ[edit]

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. This footnote is used as an example in the "How to use" section.

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[edit]

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.

Separating references from text[edit]

In-text references make it easy to copy the text to another page; on the other hand, they make it hard to read. References containing a lot of data, quotes or elaborate citation templates can make up a significantly larger fraction of the source than the text that will actually be visible. To avoid this, recent versions of the extension allow moving some or all of the references into the <references /> section, to the place where they will actually appear to the reader.

ウィキテキスト 結果
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[edit]

Since <ref> is parsed before substitution (i.e., subst:) or parser functions, e.g., {{#if:}}, those will not work inside of citation references. Instead, you have to use the magic word {{#tag:}}.

動作しない例 動作する例
Foo<ref name="resource">Content that can include subst: and parser functions like {{#if:}} and {{PAGENAME}}</ref> bar baz…
Foo{{#tag:ref|Content that can include subst: and parser functions like {{#if:}} and {{PAGENAME}}|name="resource"}} bar baz…

At this time, there is no way to create an "empty" tag, i.e., <ref name="resource" />, without triggering Cite's complaint about empty content. The workaround is to simply redefine the full tag each time you use this feature. Since such usage is likely limited to templates or other semi-automated process, this may not be too onerous. Bookmarklet example for Cite web:

ウィキテキスト 結果
Foo{{#tag:ref|{{cite web|url= |title= |author= |date= |accessdate={{subst:#time:Y-m-d|now}}}}}} bar baz…
<references />
Foo[1] bar baz…
  1. Template:Cite web


カスタマイズ[edit]

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[edit]

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[edit]

注 : 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[edit]

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.

関連項目[edit]