Difference between revisions of "Template:Cnote/doc"

From blackwiki
Jump to navigation Jump to search
imported>Email4mobile
imported>ChyranandChloe
(Cite new and Cite book are for references, these are for notes; prose)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
 
{{esoteric}}
 
{{esoteric}}
  
== Purpose ==
+
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==
 +
 
 
'''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.  
 
'''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 ==
+
==Usage==
 +
=== Required parameters ===
 +
 
 
<code><nowiki>* {{</nowiki>cnote|''Note name''|''Note text''<nowiki>}}</nowiki></code>
 
<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]].
 
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===
+
#''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.
  
(With bullet, as shown above.)
+
===Placement===
  
* {{cnote | Note name | Note text }}
+
* 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.
 +
*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.
  
=== Required parameters ===
+
===Error prevention===
#''Note name'': Name of content note; must be the same name assigned to this note using {{tl|cref}}.
+
# 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>
#''Note text'': Text (body) of content note.
+
# 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>
 +
* {{cnote|a|Here is some text}}
 +
* {{cnote|b|2=Here is some text with an equal sign =}}
 +
</pre>
  
=== Placement ===
+
<div style="padding:10px; border:1px solid #ddd; background:#fff;">
* 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.
+
* {{cnote|a|Here is some text}}
* 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.
+
* {{cnote|b|2=Here is some text with an equal sign =}}
*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.
+
</div>
  
'''Important:'''
+
===Article use===
#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>
 
#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.
 
  
==See it in action==
+
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.
  
Please look at [[Early life of Plato#ref_a|Early_life_of_Plato#ref_a]]  to see a content note attached to the word "brother".
+
==See also==
  
=== See also ===
+
* [[Template:Cnote2]]
* [[Wikipedia:Cite sources]]: Style guide
+
* [[Wikipedia:Cite sources]] Style guide
* [[Wikipedia:Template messages/Sources of articles/Generic citations]]: Related templates
+
* [[Wikipedia:Template messages/Sources of articles/Generic citations]] Related templates
 
* [[Wikipedia:WikiProject Wikicite]]
 
* [[Wikipedia:WikiProject Wikicite]]
* [[Template:Cite news]]
 
* [[Template:Cite book]]
 
  
 
<includeonly>
 
<includeonly>
<!-- CATEGORIES AND INTERWIKIS BELOW THIS LINE PLEASE -->
 
 
[[Category:Inline templates|{{PAGENAME}}]]
 
[[Category:Inline templates|{{PAGENAME}}]]
 
[[Category:Deprecated citation templates]]
 
[[Category:Deprecated citation templates]]

Revision as of 23:50, 25 September 2009

This template is used to contain explanatory notes. It is often used with {{Ref}} or {{Cref}}. There is also another version {{Cnote2}}.

Purpose

Content footnotes created using {{hcref}} or {{cref}}, with {{cnote}}, can co-exist in an article along with source notes using the Cite.php (<ref>) and/or {{Ref}} systems, without interfering with them in any way.

Usage

Required parameters

* {{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.

  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.

Error prevention

  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. Occasionally an equal sign may be needed in the text. If an equals sign is needed in the cnote text, use the code &#61; in its place. Another option is to set the parameter name to "2=" such that {{Cnote|a|2=some text with an "=" sign.}}.

Example

Output

* {{cnote|a|Here is some text}}
* {{cnote|b|2=Here is some text with an equal sign =}}
  • ^ a: Here is some text
  • ^ b: Here is some text with an equal sign =

Article use

Approximately 300 articles use this template.[1] Please See Early life of Plato for an example.

See also