User:John R. Brews/Sample: Difference between revisions

From Citizendium
Jump to navigation Jump to search
imported>John R. Brews
imported>John R. Brews
(Replaced content with "{{TOC|right} In the theory of electrical circuits, '''Thévenin's theorem''' allows the replacement of a two-terminal portion of a linear circuit by a simplified circuit con...")
Line 1: Line 1:
''See also'' [[Help:Index/Formatting/References]]
{{TOC|right}
{{TOC|right}}
'''List-defined references''' (LDR) is a referencing method that moves the text of the references out of the main body of an article and into the ''References'' section at the bottom of the article.


LDR is a way to make referencing of article contents with a great deal less cluttering of the article's main body text in the edit page. Reduced clutter makes reading and revising text in the edit page much easier, and it also makes it possible to edit all the citations directly in the ''References'' section, instead of searching for them individually through the text. Creating LDR is not only cleaner than previous methods such as the [[Help:Index/Formatting/References|<nowiki><ref>-</ref></nowiki> method]], it is a method that will be more easily understood by new users.
In the theory of electrical circuits, '''Thévenin's theorem''' allows the replacement of a two-terminal portion of a linear circuit by a simplified circuit consisting of a voltage source, called the Thévenin voltage source, in series with an impedance, called the Thévenin impedance.
 
==Overview of how LDR works==
 
This section explains the steps and coding to be used in the '''''edit page''''' of a Citizendium article in order to cite references as the sources for words or statements (sentences or paragraphs) in the main body of the article.
 
The user creates a short unique ''<font color=green>id</font>'' (identifier or name) for each individual reference which is formatted like this:
:<font color=green><nowiki><ref name=id/></nowiki></font> &nbsp; Note the forward slash (&thinsp;<font color=green>/</font>&thinsp;) at the end of the ''<font color=green>id</font>''.
 
The ''<font color=green>id</font>'' is arbitrary, but must be one word, and cannot include punctuation marks or letters like ''à'' with diacritical marks.
 
To cite a reference in the main body of the article, the user places <font color=green><nowiki><ref name=id/></nowiki></font> for that reference immediately to the right of the statement. The same insertion may be used in multiple locations in an article however many times that reference is needed.
 
Then in the ''References'' section at the bottom of the article, the user lists each reference formatted like this:
 
:<font color=green><nowiki><ref name=id>xxxx</ref></nowiki></font> &nbsp;Where ''xxxx'' is the reference's full description. Quotation marks enclosing the ''<font color=green>id</font>'' are '''''not''''' needed.
 
Note that the forward slash (&thinsp;<font color=green>/</font>&thinsp;) is '''''not''''' included after the ''<font color=green>id</font>'' in the ''References'' section.
 
===Some rules===
 
*Where the user wants to locate a reference for text that is followed by punctuation like a period or a comma, the insertion <font color=green><nowiki><ref name=id/></nowiki></font> should be located immediately to the right of that punctuation, and should be separated from the next word or next sentence by a single blank character space.
 
*In the ''References'' section, a blank line space '''must''' be provided between each listed reference.
 
*Note that the list in the ''References'' section is within a template. The list '''must''' start with <font color=green><nowiki>{{reflist|refs=</nowiki></font> and it '''must''' end with <font color=green><nowiki>}}</nowiki></font> exactly as shown in the example coding below.
 
===Putting it together===
To summarize, the basic templates used for bibliographic information are the same {{tl|cite book}}, {{tl|cite journal}}  and {{tl|cite web}}  templates used with the <nowiki><ref>-</ref></nowiki> method.<ref name=template  group=Notes/> However, these templates are placed ''not'' in the text, but at the end of the article following a ''References'' header using {{tl|reflist}} and the format:
 
:<font color=green><nowiki>{{reflist|refs=</nowiki></font> &emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;(notice the vertical separator and <font color=green>refs=</font>)
 
:<font color=green><nowiki><ref name=Ref1> {{cite book ...}} </ref></nowiki></font>&emsp; (this is first reference)
 
:<font color=green><nowiki><ref name=Ref2> {{cite book ...}} </ref></nowiki></font>&emsp; (this is second reference, <u>separated by a space</u>)
 
:<font color=green><nowiki>}}</nowiki></font>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;(these are additional final braces)
 
where the names "Ref1", "Ref2" are arbitrary creations of the writer. Connection to these definitions from the text is done with an insertion, such as <font color=green><nowiki><ref name=Ref1/></nowiki></font>, but notice, with a forward slash.
 
Although not necessary to its functionality, for ease in editing, the list of named notes in the ''References'' section can be put in alphabetical order. That makes finding the note in this list easier in the event the note should be edited, for example to update a link or add to descriptive material.
 
Of course, in the ''References'' section one just can type in the information ''<font color=green>xxx</font>'' in <font color=green><nowiki><ref name = MyRefName></nowiki>&ensp;''xxx''&ensp;<nowiki></ref></nowiki></font>, but an alternative is to copy and paste one of the listings below and fill it in by copying and pasting the information.
{{col-begin|width=90%}}
{{col-break|width=20%}}
{{tl|cite book}} &emsp;
<br/><font color=green>°°°°°°°°°°°°°°°°°°°°</font>
<br/><nowiki>{{</nowiki>cite book
<br/><nowiki>|</nowiki> author =
<br/><nowiki>|</nowiki> editor =
<br/><nowiki>|</nowiki> title =
<br/><nowiki>|</nowiki> chapter =
<br/><nowiki>|</nowiki> edition =
<br/><nowiki>|</nowiki> publisher =
<br/><nowiki>|</nowiki> year =
<br/><nowiki>|</nowiki> pages =
<br/><nowiki>|</nowiki> url =
<br/><nowiki>|</nowiki> isbn =
<br/>}}
{{col-break|width=20%}}
{{tl|cite journal}}
<br/><font color=green>°°°°°°°°°°°°°°°°°°°°</font>
<br/><nowiki>{{</nowiki>cite journal
<br/><nowiki>|</nowiki> author=
<br/><nowiki>|</nowiki> title =
<br/><nowiki>|</nowiki> journal =
<br/><nowiki>|</nowiki> volume =
<br/><nowiki>|</nowiki> issue =
<br/><nowiki>|</nowiki> pages =
<br/><nowiki>|</nowiki> date =
<br/><nowiki>|</nowiki> url =
<br/><nowiki>|</nowiki> doi =
<br/>}}
{{col-break|width=20%}}
{{tl|cite web}}
<br/><font color=green>°°°°°°°°°°°°°°°°°°°°</font>
<br/>{{cite web
<br/><nowiki>|</nowiki> author =
<br/><nowiki>|</nowiki> title =
<br/><nowiki>|</nowiki> work =
<br/><nowiki>|</nowiki> publisher =
<br/><nowiki>|</nowiki> date =
<br/><nowiki>|</nowiki> url =
<br/><nowiki>|</nowiki> doi =
<br/><nowiki>|</nowiki> accessdate = 
<br/>}}
{{col-end}}
 
One fills in the fields one wants to use, and leaves the rest blank. Other fields can be found in [[CZ:Citation templates]].
 
==Example==
Using the copy and paste technique, the ''References'' section for an article might appear as follows:
 
::<br/><font color=green><nowiki>==References==</nowiki>
::<nowiki>{{reflist|refs=</nowiki></font>
{{col-begin|width=90%}}
{{col-break|width=20%}}
<font color=green>
<br/><nowiki><</nowiki>ref name=Vasavada1999>
<br/><nowiki>{{</nowiki>cite journal
<br/><nowiki>| </nowiki> author=Ashwin R. Vasavadaa, David A. Paige and Stephen E. Wood
<br/><nowiki>| </nowiki>title= Near-Surface Temperatures on Mercury and the Moon and the Stability of Polar Ice Deposits
<br/><nowiki>| journal= Icarus </nowiki>
<br/><nowiki>| volume=141</nowiki>
<br/><nowiki>| issue=2 </nowiki>
<br/><nowiki>| pages=pp. 179-193 </nowiki>
<br/><nowiki>| date= October 1999 </nowiki>
<br/><nowiki>|doi=10.1006/icar.1999.6175</nowiki>
<br/><nowiki>}}</nowiki>
<br/><nowiki></ref></nowiki>
{{col-break|width=20%}}
<font color=green><br/><nowiki><ref name=Weissman2007p3></nowiki>
<br/><nowiki>{{cite book</nowiki>
<br/><nowiki>| author=Paul R Weissman </nowiki>
<br/><nowiki>| editor=Lucy-Ann McFadden, Paul Robert Weissman, Torrence V. Johnson, editors </nowiki>
<br/><nowiki>| title=Encyclopedia of the solar system </nowiki>
<br/><nowiki>| chapter=Chapter 1: The solar system and its place in the galaxy</nowiki>
<br/><nowiki>| edition= 2nd Edition </nowiki>
<br/><nowiki>| publisher=Academic Press </nowiki>
<br/><nowiki>| year=2007 </nowiki>
<br/><nowiki>| pages= pp. 3 ''ff''</nowiki>
<br/><nowiki>| url=http://books.google.com/books?id=G7UtYkLQoYoC&pg=PA3  </nowiki>
<br/><nowiki>| isbn= 0120885891</nowiki>
<br/><nowiki>}}</nowiki>
<br/><nowiki></ref></nowiki>
{{col-break|width=20%}}
<font color=green><br/><nowiki><ref name=Weissman2007p71></nowiki>
<br/><nowiki>{{cite book </nowiki>
<br/><nowiki>| author=Markus J Aschwanden </nowiki>
<br/><nowiki>| editor=Lucy-Ann McFadden, Paul Robert Weissman, Torrence V. Johnson, editors </nowiki>
<br/><nowiki>| title=Encyclopedia of the solar system </nowiki>
<br/><nowiki>| chapter=Chapter 4: The Sun </nowiki>
<br/><nowiki>| edition= 2nd Edition </nowiki>
<br/><nowiki>| publisher=Academic Press</nowiki>
<br/><nowiki>| year=2007</nowiki>
<br/><nowiki>| pages= pp. 71 ''ff''</nowiki>
<br/><nowiki>| url=http://books.google.com/books?id=G7UtYkLQoYoC&pg=PA71 </nowiki>
<br/><nowiki>| isbn= 0120885891</nowiki>
<br/><nowiki>}}</nowiki>
<br/><nowiki></ref></nowiki>
{{col-break|width=20%}}
<font color=green><br/><nowiki><ref name=Weissman2007p72></nowiki>
<br/><nowiki>{{cite book </nowiki>
<br/><nowiki>| author=Markus J Aschwanden </nowiki>
<br/><nowiki>| editor=Lucy-Ann McFadden, Paul Robert Weissman, Torrence V. Johnson, editors </nowiki>
<br/><nowiki>| title=Encyclopedia of the solar system </nowiki>
<br/><nowiki>| chapter=Table 1: Basic physical properties of the sun </nowiki>
<br/><nowiki>| edition= 2nd Edition </nowiki>
<br/><nowiki>| publisher=Academic Press </nowiki>
<br/><nowiki>| year=2007 </nowiki>
<br/><nowiki>| pages= p. 72 </nowiki>
<br/><nowiki>| url=http://books.google.com/books?id=G7UtYkLQoYoC&pg=PA72 </nowiki>
<br/><nowiki>| isbn= 0120885891</nowiki>
<br/><nowiki>}}</nowiki>
<br/><nowiki></ref></nowiki>
{{col-end}}
::<font color=green>}}</font>
These entries would be stacked with a space between each reference (not in a multiple column format as above), or each reference could be placed upon a single line with blank lines between them. Using these references, this is how they appear on an edit page of an article using "List-Defined References"&thinsp;:
:{|cellpadding=8 align=center style="background:#fffaf5; width:99%; border:1px dotted; margin:5px;"
 
|The '''Sun''' is the dwarf star<font color=green><nowiki><ref name=Weissman2007p71/></nowiki></font> at the center of the Solar System. There are eight major planets and other celestial bodies orbiting it.<font color=green><nowiki><ref name=Weissman2007p3/></nowiki></font> It is extremely hot, with surface temperatures in excess of 6,000 K and a central core temperature of about 15,700,000 K.<font color=green><nowiki><ref name=Weissman2007p72/></nowiki></font>
 
Since the Sun is about 150,000,000 kilometers away,<font color=green><nowiki><ref name=Weissman2007p72/></nowiki></font> only a very small amount of its heat and light reach the Earth. By contrast, the Earth's Moon is very much smaller and very much colder.<font color=green><nowiki><ref name=Vasavada1999/></nowiki></font>
|}
 
This is what the above coding produces on the article page&thinsp;:
 
:{|cellpadding=8 align=center style="background:#fffaf5; width:99%; border:1px dotted; margin:5px;"
 
|The '''Sun''' is the dwarf star<ref name=Weissman2007p71/> at the center of the Solar System. There are eight major planets and other celestial bodies orbiting it.<ref name=Weissman2007p3/> It is extremely hot, with surface temperatures in excess of 6,000 K and a central core temperature of about 15,700,000 K.<ref name=Weissman2007p72/>
 
Since the Sun is about 150,000,000 kilometers away,<ref name=Weissman2007p72/> only a very small amount of its heat and light reach the Earth. By contrast, the Earth's Moon is very much smaller and very much colder.<ref name=Vasavada1999/>
 
'''<big>References</big>'''
 
{{reflist|refs=
 
<ref name=Vasavada1999>{{cite journal | author=Ashwin R. Vasavadaa, David A. Paige and Stephen E. Wood | title= Near-Surface Temperatures on Mercury and the Moon and the Stability of Polar Ice Deposits | journal= Icarus | volume=141 | issue=2 |pages=pp. 179-193 | date= October 1999 |doi=10.1006/icar.1999.6175}}</ref>
 
<ref name=Weissman2007p3>{{cite book | author=Paul R Weissman |url=http://books.google.com/books?id=G7UtYkLQoYoC&pg=PA3 | title=Encyclopedia of the solar system |chapter=Chapter 1: The solar system and its place in the galaxy| edition= 2nd Edition |editor=Lucy-Ann McFadden, Paul Robert Weissman, Torrence V. Johnson, editors | publisher=Academic Press | year=2007 | pages= pp. 3 ''ff'' | isbn= 0120885891}}</ref>
 
<ref name=Weissman2007p71>{{cite book | author=Markus J Aschwanden |url=http://books.google.com/books?id=G7UtYkLQoYoC&pg=PA71 | title=Encyclopedia of the solar system |chapter=Chapter 4: The Sun | edition= 2nd Edition |editor=Lucy-Ann McFadden, Paul Robert Weissman, Torrence V. Johnson, editors | publisher=Academic Press | year=2007 | pages= pp. 71 ''ff'' | isbn= 0120885891}}</ref>
 
<ref name=Weissman2007p72>{{cite book | author=Markus J Aschwanden |url=http://books.google.com/books?id=G7UtYkLQoYoC&pg=PA72 | title=Encyclopedia of the solar system |chapter=Table 1: Basic physical properties of the sun | edition= 2nd Edition |editor=Lucy-Ann McFadden, Paul Robert Weissman, Torrence V. Johnson, editors | publisher=Academic Press | year=2007 | pages= p. 72 | isbn= 0120885891}}</ref>
 
}}
|}
 
Additional examples can be seen in the article [[Set (mathematics)]], which is formatted using the ''CZ:List-defined references'' methodology. The article [[Coriolis force]] also is formatted using the ''CZ:List-defined references'' method, but using the template {{tl|reflist2}}, which works in exactly the same way, but results in a two-column format for the reference listing.
 
===A style note===
 
Note that the {{tl|cite book}} and {{tl|cite journal}} templates used in the above coding example are formatted with the cells in a vertical style rather than a horizontal style where the cells are all sequential in the same single line. The horizontal style looks neater and definitely uses less space. However, the vertical style makes for a clearer explanation of the role of the various information fields.
 
The information fields in the templates do not have to be filled in in any particular order (the template puts them in standard order automatically), and fields can be left blank. For readers looking for sources, the ''url'' links that the template imbeds in the titles of books and papers are helpful, and ''isbn'' or ''doi'' entries will assist readers even if the ''url'' links expire.
 
==Notes==
{{Reflist|group=Notes|refs=
 
<ref name=template group=Notes> For details and other templates, see [[CZ:Citation templates]]</ref>
 
}}

Revision as of 09:14, 21 May 2011

{{TOC|right}

In the theory of electrical circuits, Thévenin's theorem allows the replacement of a two-terminal portion of a linear circuit by a simplified circuit consisting of a voltage source, called the Thévenin voltage source, in series with an impedance, called the Thévenin impedance.

Retrieved from "https://citizendium.org/wiki/index.php?title=User:John_R._Brews/Sample&oldid=817337"