Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing the documentation #227

Merged
merged 4 commits into from
Nov 3, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions doc/source/BIB_TEMPLATE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Format for a standard journal entry into master_list.bib

% ** example template **
@Article{LASTNAME1YY
author = "F.N.1 LASTNAME1 and F.N.2 LASTNAME2 and ...",
title = "{TITLE}",
journal = ACRONYMN,
year = {YYYY},
volume = {N},
issue = {I},
pages = {PP-PP},
url = {http://dx.doi.org/XXXXX}
}


NOTES:
- Format for "author" entry you must use just
quote marks " " around list. The names are
separated just by the word 'and'
- Format for "title" is to use BOTH quotes and
curly braces "{ }"
- Format for "journal" MUST use an acronym
defined at the top of master_list.bib. Do not
use anything around the acronym
- Format for "year", "volume", "issue", "pages",
and "url" are all just curly braces { }
- All entries must have a comma at the end EXCEPT
after final entry (url)
38 changes: 10 additions & 28 deletions doc/source/master_list.bib
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@
% * requests that you only add references that*
% * are cited in the text. *
% * -------*
% * See 'example' below for the format for *
% * how to enter information for new bibliographic*
% * entries. *
% * See 'example' in BIB_TEMPLATE.txt for new *
% * entries to the list and how to enter *
% * information for bibliography in a way *
% * required to build properly. *
% * ------*
% * Then put your new entry in the list below *
% * which is organized as: sequential from *
Expand Down Expand Up @@ -59,21 +60,10 @@ @string{IJHPCA=
@string{PTRSA={Philos. Trans. Royal Soc. A}}


% ****************************************
% **********************************************
% List of individual sources and their meta data
% ****************************************
% ** example template **
%@Article{LASTNAME1YY
% author = "F.N.1 LASTNAME1 and F.N.2 LASTNAME2 and ...", %%% NOTE: REQUIRED FORMAT IS ONLY " "
% title = "{TITLE}", %%% NOTE: REQUIRED FORMAT IS "{ }"
% journal = ACRONYMN, %%% NOTE: REQUIRED FORMAT USES ACRONYM WITHOUT {}
% year = {YYYY},
% volume = {N},
% issue = {I},
% pages = {PP-PP},
% url = {http://dx.doi.org/XXXXX}
% }

% For new entries, see example entry in BIB_TEMPLATE.txt
% **********************************************
@incollection{Assur58,
author = "A. Assur",
title = "Composition of sea ice and its tensile strength",
Expand Down Expand Up @@ -880,14 +870,6 @@ @Article{Roberts18
volume = {376},
url = {http://dx.doi.org/10.1098/rsta.2017.0344}
}
% ** example template **
%@Article{LASTNAME1YY
% author = "F.N.1 LASTNAME1 and F.N.2 LASTNAME2 and ...", %%% NOTE: REQUIRED FORMAT IS ONLY " "
% title = "{TITLE}", %%% NOTE: REQUIRED FORMAT IS "{ }"
% journal = ACRONYMN, %%% NOTE: REQUIRED FORMAT USES ACRONYM WITHOUT {}
% year = {YYYY},
% volume = {N},
% issue = {I},
% pages = {PP-PP},
% url = {http://dx.doi.org/XXXXX}
% }
% **********************************************
% For new entries, see example entry in BIB_TEMPLATE.txt
% **********************************************