Bibtex Extension

The bibtex extension allows you to cite references stored in BibTeX database(s).

Configuration

The bibtex extension is enabled by default. The only thing necessary for using the citation commands is to provide properly-formatted .bib file(s) within the included content in your configuration file.

The inline citation style is controlled by the citation_style configuration option, which applies to every page:

author-year (default): inline citations render as author and year, e.g. "Slaughter et al. (2014)".
number: inline citations render as bracketed numbers, numbered in the order they are first cited. The reference list is ordered to match, so [1] always points to the first entry. This is useful on pages that cite many works by the same authors or year, where author-year labels are hard to tell apart.


Extensions:
    MooseDocs.extensions.bibtex:
        citation_style: number

Usage

Two commands are provided for citing BibTeX references: !cite and !citep. !cite is textual, so the citation reads as part of the sentence, while !citep is parenthetical, for use inside or at the end of a sentence. How each renders depends on the citation_style configured above:

With author-year, !cite reads as "Slaughter et al. (2014)" and !citep wraps the author and year in parentheses, e.g. "(Slaughter et al., 2014)".
With number, !citep renders just the bracketed number, e.g. [1], while !cite keeps the author so it still reads in running text, e.g. "Slaughter et al. [1]".

To cite multiple references, they are separated with a comma.

To generate the list of references cited on a page, the !bibtex bibliography command is used. If it is not used, then it will automatically be placed at the bottom of the page.

Each entry in the reference list provides an [Export] link that opens the citation in three formats: BibTeX, RIS (for import into Microsoft Word, EndNote, Zotero, or Mendeley), and a plain-text reference string. The RIS and plain-text formats are intended for those who do not write in LaTeX.

The examples in Example 1 use the default author-year style, which is the style used throughout the MOOSE documentation website.

Example 1: Citation examples using the default author-year style.

Markdown
HTML

[!cite](slaughter2014framework)

[!cite](slaughter2014framework, slaughter2015continuous)

[!cite](slaughter2014framework, slaughter2015continuous, gaston2015physics)

[!citep](slaughter2014framework)

[!citep](slaughter2014framework, slaughter2015continuous)

!bibtex bibliography

Some text after the references.

Slaughter et al. (2014)

Slaughter et al. (2014) and Slaughter et al. (2015)

Slaughter et al. (2014), Slaughter et al. (2015), and Gaston et al. (2015)

(Slaughter et al., 2014)

(Slaughter et al., 2014; Slaughter et al., 2015)

References

D. R. Gaston, C. J. Permann, J. W. Peterson, A. E. Slaughter, D. Andrš, Y. Wang, M. P. Short, D. M. Perez, M. R. Tonks, J. Ortensi, and R. C. Martineau. Physics-based multiscale coupling for full core nuclear reactor simulation. Annals of Nuclear Energy, Special Issue on Multi-Physics Modelling of LWR Static and Transient Behaviour, 84:45–54, October 2015. URL: http://dx.doi.org/10.1016/j.anucene.2014.09.060.

BibTeX

@article{gaston2015physics,
    author = "Gaston, D. R. and Permann, C. J. and Peterson, J. W. and Slaughter, A. E. and Andr\v{s}, D. and Wang, Y. and Short, M. P. and Perez, D. M. and Tonks, M. R. and Ortensi, J. and Martineau, R. C.",
    title = "Physics-based multiscale coupling for full core nuclear reactor simulation",
    journal = "Annals of Nuclear Energy, Special Issue on Multi-Physics Modelling of LWR Static and Transient Behaviour",
    month = "October",
    year = "2015",
    volume = "84",
    pages = "45--54",
    url = "http://dx.doi.org/10.1016/j.anucene.2014.09.060"
}

RIS

TY  - JOUR
AU  - Gaston, D. R.
AU  - Permann, C. J.
AU  - Peterson, J. W.
AU  - Slaughter, A. E.
AU  - Andrš, D.
AU  - Wang, Y.
AU  - Short, M. P.
AU  - Perez, D. M.
AU  - Tonks, M. R.
AU  - Ortensi, J.
AU  - Martineau, R. C.
TI  - Physics-based multiscale coupling for full core nuclear reactor simulation
JO  - Annals of Nuclear Energy, Special Issue on Multi-Physics Modelling of LWR Static and Transient Behaviour
PY  - 2015
VL  - 84
UR  - http://dx.doi.org/10.1016/j.anucene.2014.09.060
SP  - 45
EP  - 54
ER  -

Plain Text

D. R. Gaston, C. J. Permann, J. W. Peterson, A. E. Slaughter, D. Andrš, Y. Wang, M. P. Short, D. M. Perez, M. R. Tonks, J. Ortensi, and R. C. Martineau. Physics-based multiscale coupling for full core nuclear reactor simulation. Annals of Nuclear Energy, Special Issue on Multi-Physics Modelling of LWR Static and Transient Behaviour, 84:45–54, October 2015. URL: http://dx.doi.org/10.1016/j.anucene.2014.09.060.

A.E. Slaughter, M.J. Johnson, M.R. Tonks, D.R. Gaston, C.J. Permann, J.W. Peterson, D. Andrš, J.M. Miller, E.E. Adams, and D.J. Walters. MOOSE: a framework to enable rapid advances and collaboration in modeling snow and avalanches. In International Snow Science Workshop. Banff, AB, 2014. URL: http://arc.lib.montana.edu/snow-science/item.php?id=2120.

BibTeX

@inproceedings{slaughter2014framework,
    author = "Slaughter, A.E. and Johnson, M.J. and Tonks, M.R. and Gaston, D.R. and Permann, C.J. and Peterson, J.W. and Andr\v{s}, D. and Miller, J.M. and Adams, E.E. and Walters, D.J.",
    title = "{MOOSE}: A Framework to Enable Rapid Advances and Collaboration in Modeling Snow and Avalanches",
    booktitle = "International Snow Science Workshop",
    year = "2014",
    address = "Banff, AB",
    url = "http://arc.lib.montana.edu/snow-science/item.php?id=2120"
}

RIS

TY  - CPAPER
AU  - Slaughter, A.E.
AU  - Johnson, M.J.
AU  - Tonks, M.R.
AU  - Gaston, D.R.
AU  - Permann, C.J.
AU  - Peterson, J.W.
AU  - Andrš, D.
AU  - Miller, J.M.
AU  - Adams, E.E.
AU  - Walters, D.J.
TI  - MOOSE: A Framework to Enable Rapid Advances and Collaboration in Modeling Snow and Avalanches
T2  - International Snow Science Workshop
PY  - 2014
CY  - Banff, AB
UR  - http://arc.lib.montana.edu/snow-science/item.php?id=2120
ER  -

Plain Text

A.E. Slaughter, M.J. Johnson, M.R. Tonks, D.R. Gaston, C.J. Permann, J.W. Peterson, D. Andrš, J.M. Miller, E.E. Adams, and D.J. Walters. MOOSE: a framework to enable rapid advances and collaboration in modeling snow and avalanches. In International Snow Science Workshop. Banff, AB, 2014. URL: http://arc.lib.montana.edu/snow-science/item.php?id=2120.

Andrew E Slaughter, John W Peterson, Derek R Gaston, Cody J Permann, David Andrš, and Jason M Miller. Continuous integration for concurrent moose framework and application development on github. Journal of Open Research Software, 2015. URL: http://doi.org/10.5334/jors.bx.

BibTeX

@article{slaughter2015continuous,
    author = "Slaughter, Andrew E and Peterson, John W and Gaston, Derek R and Permann, Cody J and Andr{\v{s}}, David and Miller, Jason M",
    title = "Continuous integration for concurrent MOOSE framework and application development on GitHub",
    journal = "Journal of Open Research Software",
    volume = "3",
    number = "1",
    year = "2015",
    publisher = "Ubiquity Press",
    url = "http://doi.org/10.5334/jors.bx"
}

RIS

TY  - JOUR
AU  - Slaughter, Andrew E
AU  - Peterson, John W
AU  - Gaston, Derek R
AU  - Permann, Cody J
AU  - Andrš, David
AU  - Miller, Jason M
TI  - Continuous integration for concurrent MOOSE framework and application development on GitHub
JO  - Journal of Open Research Software
PY  - 2015
VL  - 3
IS  - 1
PB  - Ubiquity Press
UR  - http://doi.org/10.5334/jors.bx
ER  -

Plain Text

Andrew E Slaughter, John W Peterson, Derek R Gaston, Cody J Permann, David Andrš, and Jason M Miller. Continuous integration for concurrent moose framework and application development on github. Journal of Open Research Software, 2015. URL: http://doi.org/10.5334/jors.bx.

Some text after the references.

Configuration
Usage