Difference between revisions of "Template:Cnote/doc"

From blackwiki
Jump to navigation Jump to search
imported>ChyranandChloe
(Cite new and Cite book are for references, these are for notes; prose)
imported>Trialpears
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
{{esoteric}}
+
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
  
This template is used to contain explanatory notes. It is often used with {{tl|Ref}} or {{tl|Cref}}. There is also another version {{tl|Cnote2}}.
+
== Purpose ==
 +
This template is used to create the content note, in conjunction with [[Template:Cref]]. For multiple uses of the same footnote, see [[Template:Cnote2]].
  
==Purpose==
+
<table width=80% align=center border=1><tr><td>
 +
<blockquote>Note: '''Content Notes''' created using {{tl|cref}} and {{tl|cnote}} can co-exist in an article along with '''Source Notes''' using the [[mw:Extension:Cite/Cite.php|cite.php]] system. The two systems do not interfere with each other in any way.</blockquote>
 +
</td></tr></table>
  
'''Content footnotes''' created using {{tlx|hcref}} or {{tlx|cref}}, with {{tlx|cnote}}, can co-exist in an article along with '''source notes''' using the [[m:Cite/Cite.php|Cite.php (<code>&lt;ref&gt;</code>)]] and/or {{tlx|Ref}} systems, without interfering with them in any way.  
+
== Usage ==
 +
<code><nowiki>* {{</nowiki>cnote|''Note name''|''Note text''<nowiki>}}</nowiki></code>
 +
 
 +
To create the marker to place in the text at the point where the content note is to be attached, use [[Template:Cref]].
  
==Usage==
+
===Example of output===
=== Required parameters ===
 
  
<code><nowiki>* {{</nowiki>cnote|''Note name''|''Note text''<nowiki>}}</nowiki></code>
+
(With bullet, as shown above.)
  
To create the marker to place in the text at the point where the content note is to be attached, use [[Template:Cref]].
+
* {{cnote | Note name | Note text }}
  
 +
=== Required parameters ===
 
#''Note name'': Name of content note; must be the same name assigned to this note using {{tl|cref}}.
 
#''Note name'': Name of content note; must be the same name assigned to this note using {{tl|cref}}.
 
#''Note text'': Text (body) of content note.
 
#''Note text'': Text (body) of content note.
  
===Placement===
+
=== Placement ===
 
 
 
* If a "Notes" or "Notes and references" section already exists in the article you are working on, simply determine where among the existing notes the one you are going to create should be listed and insert the {{tlx|cnote}} template there.
 
* If a "Notes" or "Notes and references" section already exists in the article you are working on, simply determine where among the existing notes the one you are going to create should be listed and insert the {{tlx|cnote}} template there.
* If such a section does not already exist in the article you are working on, you must create one by typing <nowiki>==Notes==</nowiki>. (The "Notes" section should immediately precede the "References" section.) Then create the first content note by inserting the {{tlx|cnote}} template below the section header.
+
* If such a section does not already exist in the article you are working on, you must create one by typing <code><nowiki>==Notes==</nowiki></code>&nbsp;. (The "Notes" section should immediately precede the "References" section.) Then create the first content note by inserting the {{tlx|cnote}} template below the section header.
*Alternatively, you can change the existing "References" section to "Notes and references" ''if'' the article consistently uses only the {{tlx|Ref}} and {{tlx|Note}} reference footnote system instead of the <nowiki><ref></nowiki> and <nowiki><references /></nowiki> inline citation system.
+
*Alternatively, you can change the existing "References" section to "Notes and references" ''if'' the article consistently uses only the {{tlx|Ref}} and {{tlx|Note}} reference footnote system instead of the <code>&lt;ref></code> and <code>&lt;references /></code> inline citation system.
 
 
===Error prevention===
 
# Once a content note has been created using {{tl|cnote}}, you can edit it just as you would ordinary wikipedia text. Ensure, however, that all the cnote text is enclosed by the final  '''<nowiki>}}</nowiki>'''.<br>
 
# Occasionally an equal sign may be needed in the text. If an equals sign is needed in the cnote text, use the code <nowiki>&amp;#61;</nowiki> in its place. Another option is to set the parameter name to "2=" such that <nowiki>{{Cnote|a|2=some text with an "=" sign.}}</nowiki>.
 
 
 
==Example==
 
===Output===
 
  
<pre>
+
'''Important:'''
* {{cnote|a|Here is some text}}
+
#Once a content note has been created using {{tl|cnote}}, you can edit it just as you would ordinary Wikipedia text. Ensure, however, that all the cnote text is enclosed by the final  '''<nowiki>}}</nowiki>'''.
* {{cnote|b|2=Here is some text with an equal sign =}}
+
#The character "=" (equals sign) must not be entered in cnote text, as it will generate an error call. If an equals sign is needed in the cnote text, use the code <code>&amp;#61;</code> in its place.
</pre>
 
  
<div style="padding:10px; border:1px solid #ddd; background:#fff;">
+
==See it in action==
* {{cnote|a|Here is some text}}
+
Please look at [[Early life of Plato#ref a]] to see a content note attached to the word "brother".
* {{cnote|b|2=Here is some text with an equal sign =}}
 
</div>
 
 
 
===Article use===
 
 
 
Approximately 300 articles use this template.[http://en.wikipedia.org/w/index.php?title=Special:WhatLinksHere/Template:Cnote&namespace=0&hideredirs=1&hidelinks=1&limit=500] Please See [[Early life of Plato#ref_a|Early life of Plato]] for an example.
 
  
 
==See also==
 
==See also==
 
+
* [[Wikipedia:Citation templates]] – related templates
* [[Template:Cnote2]]
+
* [[Wikipedia:Citing sources]] – style guide
* [[Wikipedia:Cite sources]] — Style guide
 
* [[Wikipedia:Template messages/Sources of articles/Generic citations]] — Related templates
 
 
* [[Wikipedia:WikiProject Wikicite]]
 
* [[Wikipedia:WikiProject Wikicite]]
 +
* [[Template:Cite book]]
 +
* [[Template:Cite news]]
  
<includeonly>
+
<includeonly>{{Sandbox other||
 +
<!-- CATEGORIES AND INTERWIKIS BELOW THIS LINE PLEASE -->
 +
[[Category:Explanatory footnote templates]]
 
[[Category:Inline templates|{{PAGENAME}}]]
 
[[Category:Inline templates|{{PAGENAME}}]]
[[Category:Deprecated citation templates]]
+
 
[[ar:قالب:محتوى طبعة]]
 
[[fr:template:Cnote]]
 
 
[[he:תבנית:Cnote]]
 
[[he:תבנית:Cnote]]
 
[[ja:Template:Cnote]]
 
[[ja:Template:Cnote]]
</includeonly>
+
}}</includeonly>

Latest revision as of 22:23, 9 July 2020

Purpose

This template is used to create the content note, in conjunction with Template:Cref. For multiple uses of the same footnote, see Template:Cnote2.

Note: Content Notes created using {{cref}} and {{cnote}} can co-exist in an article along with Source Notes using the cite.php system. The two systems do not interfere with each other in any way.

Usage

* {{cnote|Note name|Note text}}

To create the marker to place in the text at the point where the content note is to be attached, use Template:Cref.

Example of output

(With bullet, as shown above.)

  • ^  Note name :  Note text

Required parameters

  1. Note name: Name of content note; must be the same name assigned to this note using {{cref}}.
  2. Note text: Text (body) of content note.

Placement

  • If a "Notes" or "Notes and references" section already exists in the article you are working on, simply determine where among the existing notes the one you are going to create should be listed and insert the {{cnote}} template there.
  • If such a section does not already exist in the article you are working on, you must create one by typing ==Notes== . (The "Notes" section should immediately precede the "References" section.) Then create the first content note by inserting the {{cnote}} template below the section header.
  • Alternatively, you can change the existing "References" section to "Notes and references" if the article consistently uses only the {{Ref}} and {{Note}} reference footnote system instead of the <ref> and <references /> inline citation system.

Important:

  1. Once a content note has been created using {{cnote}}, you can edit it just as you would ordinary Wikipedia text. Ensure, however, that all the cnote text is enclosed by the final }}.
  2. The character "=" (equals sign) must not be entered in cnote text, as it will generate an error call. If an equals sign is needed in the cnote text, use the code &#61; in its place.

See it in action

Please look at Early life of Plato#ref a to see a content note attached to the word "brother".

See also