Difference between revisions of "Help:Footnotes"
(→Introducing footnotes) |
|||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | '''Footnotes''' is a supplementary ornament used | + | __NOTOC__ |
| + | '''Footnotes''' is a supplementary ornament used in MediaWiki-based documenting. This can be divided into both '''Notes''' and '''References''' segments where respective information can be specified. | ||
In short, the references section provides citations of reliable sources of any kind of information; meanwhile the scope of notes can be slightly loose as some explanatory or inferred content can be addressed. The references feature is a built-in HTML-like function that can be called directly using <code><nowiki><ref>...</ref></nowiki></code>, <code><nowiki><references /></nowiki></code> and <code><nowiki><references>...</references></nowiki></code> (the latter ones are analogous). To ease editing, some useful templates can be used, for example, the most common instance is the template <code><nowiki>{{reflist}}</nowiki></code> whereby it acts as a better replacement of the <code><nowiki><references /></nowiki></code> (yet their effects are interchangeable). | In short, the references section provides citations of reliable sources of any kind of information; meanwhile the scope of notes can be slightly loose as some explanatory or inferred content can be addressed. The references feature is a built-in HTML-like function that can be called directly using <code><nowiki><ref>...</ref></nowiki></code>, <code><nowiki><references /></nowiki></code> and <code><nowiki><references>...</references></nowiki></code> (the latter ones are analogous). To ease editing, some useful templates can be used, for example, the most common instance is the template <code><nowiki>{{reflist}}</nowiki></code> whereby it acts as a better replacement of the <code><nowiki><references /></nowiki></code> (yet their effects are interchangeable). | ||
== How to use it == | == How to use it == | ||
| − | The general format for ref tags is <code><nowiki><ref>text</ref></nowiki></code>. If utilised, a square-bracketed number will appear as a superscript | + | The general format for ref tags is <code><nowiki><ref>text</ref></nowiki></code>. If utilised, a square-bracketed number will appear as a superscript; when the wiki user clicks on it, they will be automatically redirected to the references section. However, each ref tag can be assigned a unique identifier, using <code><nowiki>name="xx"</nowiki></code>, thus it can be reused on the same page with <code><nowiki><ref name="xx" /></nowiki></code>, rather than citing it again, which would cause unnecessary duplication within the references section. |
| + | |||
| + | <div style="display: flex; gap: 10px;"><div style="padding: 10px; width: 45%;"><h4>Markup</h4><pre> | ||
| + | Shinichi Kudo solves the roller coaster case<ref>Episode 1</ref>. | ||
| + | <references /></pre></div><div style="padding: 10px; width: 45%;"><h4>Renders as</h4> | ||
| + | Shinichi Kudo solves the roller coaster case<ref>Episode 1</ref>. | ||
| + | <references /></div></div> | ||
| + | |||
| + | The template <code><nowiki>{{reflist}}</nowiki></code> can be used instead of <code><nowiki><references /></nowiki></code> as it contains many more features. Using this template, the column width of the references' list can be regulated by assigning it with a parameter <code><nowiki>{{Reflist|xxem}}</nowiki></code>. For example, <code><nowiki>{{Reflist|30em}}</nowiki></code> will force the list columns to be of a width of 30 em. | ||
| + | |||
| + | <div style="display: flex; gap: 10px;"><div style="padding: 10px; width: 45%;"><h4>Markup</h4><pre> | ||
| + | Kenji Kodama directed the series at an early stage<ref>[https://www.ytv.co.jp/conan/staff/ Detective Conan Staff]</ref>; however, he is currently not involved in the production<ref>[https://www.ytv.co.jp/conan/news/ Detective Conan News]</ref>. | ||
| + | |||
| + | ==References== | ||
| + | {{Reflist|30em}}</pre></div><div style="padding: 10px; width: 45%;"><h4>Renders as</h4> | ||
| + | Kenji Kodama directed the series at an early stage<ref name"staff">[https://www.ytv.co.jp/conan/staff/ Detective Conan Staff]</ref>; however, he is currently not involved in the production<ref>[https://www.ytv.co.jp/conan/news/ Detective Conan News]</ref>. | ||
| + | |||
| + | ==References== | ||
| + | {{Reflist|30em}}</div></div> | ||
| + | |||
| + | Aside from directly inserting the ref tags in the main text of the wiki page, another notation of references can be applied where all the text to be cited are moved to the bottom of the page, namely, the footnotes section as a mediagraphy. This version attains the exact same appearance with the above methods yet it makes the source code itself more user-friendly, since at times the citation links may get huge. | ||
| + | <pre> | ||
| + | <references> | ||
| + | <ref name="name1">Content</ref> | ||
| + | <ref name="name2">Content</ref> | ||
| + | <ref name="name...n">Content</ref> | ||
| + | </references> | ||
| + | </pre> | ||
| + | |||
| + | The same logic goes for the notes section; it is allowed to assign specific "groups" for ref tags, in the format of <code><nowiki><ref group="groupname" name="name">...</ref></nowiki></code>. Many notations can be used for notes, the most common one is '''Note'''; occasionally solely '''N''' is utilised as well (this substantially diminishes the ambiguity as a four-character superscript may become too long; in Japanese Wikipedia, '''注''' is used, which is of one character only). Note that in this wiki, both cases exist: | ||
| + | |||
| + | * In all '''anime pages''', the ref group "N" is used (along with the footnotes section) | ||
| + | * In all '''staff pages''', the ref group "Note" is used (without the footnotes section) | ||
| + | |||
| + | <div style="display: flex; gap: 10px;"><div style="padding: 10px; width: 45%;"><h4>Markup</h4><pre> | ||
| + | The Mystery Tour is a series in which the anime-original episodes undergo special planning<ref group="Note">It is an tourism event organised by JR West.</ref>. | ||
| + | |||
| + | The first Mystery Tour case is titled "The Nanki Shirahama Mystery Tour"<ref group="N">Screenplay written by [[Kazunari Kouchi]].</ref>. | ||
| + | |||
| + | == Notes == | ||
| + | <references group="Note" /> | ||
| + | <references group="N" /></pre></div><div style="padding: 10px; width: 45%;"><h4>Renders as</h4> | ||
| + | The Mystery Tour is a series in which the anime-original episodes undergo special planning<ref group="Note">It is an tourism event organised by JR West.</ref>. | ||
| + | |||
| + | The first Mystery Tour case is titled "The Nanki Shirahama Mystery Tour"<ref group="N">Screenplay written by [[Kazunari Kouchi]].</ref>. | ||
| + | |||
| + | == Notes == | ||
| + | <references group="Note" /> | ||
| + | <references group="N" /></div></div> | ||
| + | |||
| + | == Introducing footnotes == | ||
| + | Now, by combining the two sections, footnotes can be formed. One might often find footnotes section in some pages where the tile "Footnotes" is <code><nowiki>== Heading level 2 ==</nowiki></code> and the rest ("Notes" and "References") being <code><nowiki>=== Heading level 3 ===</nowiki></code>. This is the standard way of representation in the Wikipedia of the Japanese version. Incidentally, the footnotes section should only be activated when both "Notes" and "References" are present, otherwise individual sections should be used. Here is the format of the footnotes section utilised in this wiki: | ||
| + | |||
| + | <pre> | ||
| + | == Footnotes == | ||
| + | {{FH}} | ||
| + | === Notes === | ||
| + | {{reflist|group="N"}} | ||
| + | |||
| + | === References === | ||
| + | {{reflist}} | ||
| + | </pre> | ||
[[Category:Help]] | [[Category:Help]] | ||
Latest revision as of 19:39, 22 November 2024
Footnotes is a supplementary ornament used in MediaWiki-based documenting. This can be divided into both Notes and References segments where respective information can be specified.
In short, the references section provides citations of reliable sources of any kind of information; meanwhile the scope of notes can be slightly loose as some explanatory or inferred content can be addressed. The references feature is a built-in HTML-like function that can be called directly using <ref>...</ref>, <references /> and <references>...</references> (the latter ones are analogous). To ease editing, some useful templates can be used, for example, the most common instance is the template {{reflist}} whereby it acts as a better replacement of the <references /> (yet their effects are interchangeable).
How to use it
The general format for ref tags is <ref>text</ref>. If utilised, a square-bracketed number will appear as a superscript; when the wiki user clicks on it, they will be automatically redirected to the references section. However, each ref tag can be assigned a unique identifier, using name="xx", thus it can be reused on the same page with <ref name="xx" />, rather than citing it again, which would cause unnecessary duplication within the references section.
Markup
Shinichi Kudo solves the roller coaster case<ref>Episode 1</ref>. <references />
The template {{reflist}} can be used instead of <references /> as it contains many more features. Using this template, the column width of the references' list can be regulated by assigning it with a parameter {{Reflist|xxem}}. For example, {{Reflist|30em}} will force the list columns to be of a width of 30 em.
Markup
Kenji Kodama directed the series at an early stage<ref>[https://www.ytv.co.jp/conan/staff/ Detective Conan Staff]</ref>; however, he is currently not involved in the production<ref>[https://www.ytv.co.jp/conan/news/ Detective Conan News]</ref>.
==References==
{{Reflist|30em}}Aside from directly inserting the ref tags in the main text of the wiki page, another notation of references can be applied where all the text to be cited are moved to the bottom of the page, namely, the footnotes section as a mediagraphy. This version attains the exact same appearance with the above methods yet it makes the source code itself more user-friendly, since at times the citation links may get huge.
<references> <ref name="name1">Content</ref> <ref name="name2">Content</ref> <ref name="name...n">Content</ref> </references>
The same logic goes for the notes section; it is allowed to assign specific "groups" for ref tags, in the format of <ref group="groupname" name="name">...</ref>. Many notations can be used for notes, the most common one is Note; occasionally solely N is utilised as well (this substantially diminishes the ambiguity as a four-character superscript may become too long; in Japanese Wikipedia, 注 is used, which is of one character only). Note that in this wiki, both cases exist:
- In all anime pages, the ref group "N" is used (along with the footnotes section)
- In all staff pages, the ref group "Note" is used (without the footnotes section)
Markup
The Mystery Tour is a series in which the anime-original episodes undergo special planning<ref group="Note">It is an tourism event organised by JR West.</ref>. The first Mystery Tour case is titled "The Nanki Shirahama Mystery Tour"<ref group="N">Screenplay written by [[Kazunari Kouchi]].</ref>. == Notes == <references group="Note" /> <references group="N" />
Renders as
The Mystery Tour is a series in which the anime-original episodes undergo special planning[Note 1].
The first Mystery Tour case is titled "The Nanki Shirahama Mystery Tour"[N 1].
Notes
- ^ It is an tourism event organised by JR West.
- ^ Screenplay written by Kazunari Kouchi.
Introducing footnotes
Now, by combining the two sections, footnotes can be formed. One might often find footnotes section in some pages where the tile "Footnotes" is == Heading level 2 == and the rest ("Notes" and "References") being === Heading level 3 ===. This is the standard way of representation in the Wikipedia of the Japanese version. Incidentally, the footnotes section should only be activated when both "Notes" and "References" are present, otherwise individual sections should be used. Here is the format of the footnotes section utilised in this wiki:
== Footnotes ==
{{FH}}
=== Notes ===
{{reflist|group="N"}}
=== References ===
{{reflist}}
