Skip to content
sachsmc edited this page Oct 30, 2014 · 7 revisions

Using the templates

Citations

The templates all use natbib to create the citations and reference list, except for AMSTAT, which requires the reference list be contained in the .tex file. In either case, references should be contained in a single bibtex file.

To create in-text citations, use the following guide. Pandoc automatically converts to the natbib style. The following is quoted from the Pandoc README

Citations go inside square brackets and are separated by semicolons. Each citation must have a key, composed of '@' + the citation identifier from the database, and may optionally have a prefix, a locator, and a suffix. The citation key must begin with a letter or _, and may contain alphanumerics, _, and internal punctuation characters (:.#$%&-+?<>~/). Here are some examples:

Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1].

Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].

Blah blah [@smith04; @doe99].

A minus sign (-) before the @ will suppress mention of the author in the citation. This can be useful when the author is already mentioned in the text:

Smith says blah [-@smith04].

You can also write an in-text citation, as follows:

@smith04 says blah.

@smith04 [p. 33] says blah.

If the style calls for a list of works cited, it will be placed at the end of the document. Normally, you will want to end your document with an appropriate header:

last paragraph...

# References

The bibliography will be inserted after this header. Note that the unnumbered class will be added to this header, so that the section will not be numbered.

YAML header

The md document needs to have a YAML header which contains metadata that will be rendered into the final document. This includes the title, abstract, author names, addresses, and so on. Each journal uses these items in unique ways in their Latex templates. Therefore, the headers differ slightly. The common entries are listed in the table below.

field description
title Every journal uses the title field. If your title contains a colon (:), enclose it in double-quotes (")
abstract Every journal uses the abstract field. If your title contains a colon (:), enclose it in double-quotes ("). Be sure to check the word limits.
bibliography Path to the .bib file. With the exception of AMSTAT, omit the .bib extension from the filename.

Details on the possible fields and options for each journal are listed in their own Wikis (see the sidebar). Some entries are allowed to be lists, which follow the following syntax. The list name is at the top. Each element of the list starts with - followed by the first named entry. Every element must contain the same named entries in the key: value syntax.

authors:
- name: Michael C. Sachs
  affiliation: National Cancer Institute, Bethesda, MD 20892
  email: [email protected]
- name: Homer J. Simpson
  affiliation: Moe's Tavern, Springfield, USA
  email: [email protected]
Clone this wiki locally