Difference between revisions of "Template:PlanckPapers"

From Planck PLA Wiki
Jump to: navigation, search
(Citing a paper with a custom link)
(Examples)
Line 24: Line 24:
 
</pre>
 
</pre>
 
'''How it appears'''
 
'''How it appears'''
 +
 
A very interesting result can be found in {{PlanckPapers|planck2013-p01}}.
 
A very interesting result can be found in {{PlanckPapers|planck2013-p01}}.
  
Line 32: Line 33:
 
</pre>
 
</pre>
 
'''How it appears'''
 
'''How it appears'''
 +
 
On the other hand in {{PlanckPapers|planck2011-1-1|10}} a demonstration is given of a most interesting fact.
 
On the other hand in {{PlanckPapers|planck2011-1-1|10}} a demonstration is given of a most interesting fact.
  
Line 44: Line 46:
  
 
Note that in this last case, the second argument (the page number where the paper should open) does not need to have a value and it is perfectly fine for the corresponding slot in the template syntax (delimited by the <tt>||</tt> in the template syntax) to be emtpy. It is however mandatory to use the two <tt>|</tt> in order for the template to be interpreted correctly.
 
Note that in this last case, the second argument (the page number where the paper should open) does not need to have a value and it is perfectly fine for the corresponding slot in the template syntax (delimited by the <tt>||</tt> in the template syntax) to be emtpy. It is however mandatory to use the two <tt>|</tt> in order for the template to be interpreted correctly.
 +
 +
==+Displaying the list of references at the end of the page===
 +
In order to have a list of references at the end of the page the <tt><references /></tt> must be used. The convention followed in the Planck Explanatory Supplement is for the references to appear in the last section of the page labelled '''References'''. In order to achieve this, we suggest using:
 +
<pre>
 +
==References==
 +
<references />
 +
</pre>
 +
This is how the list of referecnes below was created.
  
 
= References =
 
= References =

Revision as of 12:47, 25 July 2014

Description

The template PlanckPapers produces references for Planck papers in the text. There are three differences between this template and the BibCite.

  • PlanckPapers creates in the text a direct link to the papers being cited;
  • With PlanckPapers, it is possible to create a link to a specific page of the paper;
  • With PlanckPapers it is possible to create a link with text defined by the user;

The syntax of PlanckPapers is

{{PlanckPapers|label|page|link}}

where the thre parameters are as follows:

label
label used to cite the paper in LaTeX;
page
(optional parameter) page number where the paper paper should open when the user clicks on the link. When this parameter is not provided the paperwill open in page 1;
link
(optional parameter) text of the link to the paper. If not supplied the default text is one of Planck-2013-X, Planck-Early-X or Planck-Int-X or Planck-PreLaunch-X, for the Planck 2013 papers, Planck early papers, Planck internediate papers or Planck pre launch papers. The X stands for a roman numeral identifying the paper being cited;

Examples

Citing a paper using all the default values for optional parameters

What you type

{{PlanckPapers|planck2013-p01}}

How it appears

A very interesting result can be found in Planck-2013-I[1].

Citing a paper and opening it in a given page

What you type

{{PlanckPapers|planck2011-1-1|10}}

How it appears

On the other hand in Planck-Early-I[2] a demonstration is given of a most interesting fact.

Citing a paper with a custom link

What you type

{{PlanckPapers|planck2013-p09||blablabla}}

How it appears

On the other hand it is shown in the and statistics paper Planck-2013-XXIII[3] that the above mentioned result is rubish.

Note that in this last case, the second argument (the page number where the paper should open) does not need to have a value and it is perfectly fine for the corresponding slot in the template syntax (delimited by the || in the template syntax) to be emtpy. It is however mandatory to use the two | in order for the template to be interpreted correctly.

+Displaying the list of references at the end of the page=

In order to have a list of references at the end of the page the

  1. Planck 2013 results: Overview of Planck Products and Scientific Results, Planck Collaboration 2013 I, A&A, in press, (2014).
  2. Planck early results. I. The Planck mission, Planck Collaboration I, A&A, 536, A1, (2011).
  3. and statistics paperPlanck 2013 results: Isotropy and statistics of the CMB, Planck Collaboration XXIII, A&A, in press, (2014).

must be used. The convention followed in the Planck Explanatory Supplement is for the references to appear in the last section of the page labelled References. In order to achieve this, we suggest using:

==References==
<references />

This is how the list of referecnes below was created.

References