Template:Cnote/doc: Difference between revisions

Revision as of 00:23, 31 March 2018

This is a documentation subpage for Template:Cnote.
It contains usage information, categories and other content that is not part of the original template page.

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
You can conduct experiments, and should test all major changes, in either , the general template sandbox, or your user space before changing anything here.

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

Note name: Name of content note; must be the same name assigned to this note using {{cref}}.
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:

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 }}.
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 = 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".