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

🪄 updates to SGU and SPIE templates #51

Merged
merged 12 commits into from
Nov 22, 2021
80 changes: 49 additions & 31 deletions latex/agu2019/original/agujournaltemplate.tex
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@
% uncertainties.

% The Plain Language Summary should be written for a broad audience,
% including journalists and the science-interested public, that will not have
% including journalists and the science-interested public, that will not have
% a background in your field.
%
% A Plain Language Summary is required in GRL, JGR: Planets, JGR: Biogeosciences,
Expand Down Expand Up @@ -254,26 +254,29 @@ \section{= enter section title =}
%
% ---------------
% EXAMPLE TABLE
%
% \begin{table}
% \caption{Time of the Transition Between Phase 1 and Phase 2$^{a}$}
% \centering
% \begin{tabular}{l c}
% \hline
% Run & Time (min) \\
% \hline
% $l1$ & 260 \\
% $l2$ & 300 \\
% $l3$ & 340 \\
% $h1$ & 270 \\
% $h2$ & 250 \\
% $h3$ & 380 \\
% $r1$ & 370 \\
% $r2$ & 390 \\
% \hline
% \multicolumn{2}{l}{$^{a}$Footnote text here.}
% \end{tabular}
% \end{table}
% Please do NOT include vertical lines in tables
% if the paper is accepted, Wiley will replace vertical lines with white space
% the CLS file modifies table padding and vertical lines may not display well
%
\begin{table}
\caption{Time of the Transition Between Phase 1 and Phase 2$^{a}$}
\centering
\begin{tabular}{l c}
\hline
Run & Time (min) \\
\hline
$l1$ & 260 \\
$l2$ & 300 \\
$l3$ & 340 \\
$h1$ & 270 \\
$h2$ & 250 \\
$h3$ & 380 \\
$r1$ & 370 \\
$r2$ & 390 \\
\hline
\multicolumn{2}{l}{$^{a}$Footnote text here.}
\end{tabular}
\end{table}

%% SIDEWAYS FIGURE and TABLE
% AGU prefers the use of {sidewaystable} over {landscapetable} as it causes fewer problems.
Expand Down Expand Up @@ -362,11 +365,7 @@ \section{= enter section title =}
%
% ACKNOWLEDGMENTS
%
% The acknowledgments must list:
%
% >>>> A statement that indicates to the reader where the data
% supporting the conclusions can be obtained (for example, in the
% references, tables, supporting information, and other databases).
% The acknowledgments should list:
%
% All funding sources related to this work from all authors
%
Expand All @@ -377,13 +376,25 @@ \section{= enter section title =}
% having a conflict of interest with respect to the results of this
% paper.
%
%
% It is also the appropriate place to thank colleagues and other contributors.
% AGU does not normally allow dedications.
% It is also the appropriate place to thank colleagues and other contributors.
% AGU does not normally allow dedications.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section*{Open Research}

%Open Research
% AGU requires an Availability Statement for the underlying data needed to understand, evaluate, and build upon the reported research at the time of peer review and publication.

%Additionally, authors should include an Availability Statement for the software that has a significant impact on the research. Details and templates are in the Availability Statement section of the Data & Software for Authors Guidance:
% https://www.agu.org/Publish-with-AGU/Publish/Author-Resources/Data-and-Software-for-Authors#availability

%For physical samples, use the IGSN persistent identifier, see the International Geo Sample Numbers section:
https://www.agu.org/Publish-with-AGU/Publish/Author-Resources/Data-and-Software-for-Authors#IGSN
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\acknowledgments
Enter acknowledgments, including your data availability statement, here.
This section is optional. Include any Acknowledgments here.


%% ------------------------------------------------------------------------ %%
Expand All @@ -394,6 +405,10 @@ \section{= enter section title =}
% \bibliography{<name of your .bib file>} don't specify the file extension
%
% don't specify bibliographystyle

% In the References section, cite the data/software described in the Availability Statement (this includes primary and processed data used for your research). For details on data/software citation as well as examples, see the Data & Software Citation section of the Data & Software for Authors guidance
% https://www.agu.org/Publish-with-AGU/Publish/Author-Resources/Data-and-Software-for-Authors#citation

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\bibliography{ enter your bibtex bibliography filename here }
Expand All @@ -417,9 +432,12 @@ \section{= enter section title =}
%...has been shown by \cite <e.g.,>[and others]{lewin76}.
%
% apacite uses < > for prenotes and [ ] for postnotes
% DO NOT use other cite commands (e.g., \citet, \citep, \citeyear, \nocite, \citealp, etc.).
% DO NOT use other cite commands (e.g., \citet, \citep, \citeyear, \citealp, etc.).
% \nocite is okay to use to add references from your Supporting Information
%



\end{document}


Expand Down
23 changes: 21 additions & 2 deletions latex/agu2019/template.tex
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,27 @@ \section*{Plain Language Summary}

[-CONTENT-]

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%Open Research
% AGU requires an Availability Statement for the underlying data needed to understand, evaluate, and build upon the reported research at the time of peer review and publication.

%Additionally, authors should include an Availability Statement for the software that has a significant impact on the research. Details and templates are in the Availability Statement section of the Data & Software for Authors Guidance:
% https://www.agu.org/Publish-with-AGU/Publish/Author-Resources/Data-and-Software-for-Authors#availability

%For physical samples, use the IGSN persistent identifier, see the International Geo Sample Numbers section:
% https://www.agu.org/Publish-with-AGU/Publish/Author-Resources/Data-and-Software-for-Authors#IGSN

[# if tagged.availability #]
\section*{Open Research}
[-tagged.availability-]
[# endif #]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%



[# if tagged.acknowledgments #]
\acknowledgments
% Enter acknowledgments, including your data availability statement, here.
% This section is optional. Include any Acknowledgments here.
[-tagged.acknowledgments-]
[# endif #]

Expand Down Expand Up @@ -251,7 +269,8 @@ \section*{Plain Language Summary}
%...has been shown by \cite <e.g.,>[and others]{lewin76}.
%
% apacite uses < > for prenotes and [ ] for postnotes
% DO NOT use other cite commands (e.g., \citet, \citep, \citeyear, \nocite, \citealp, etc.).
% DO NOT use other cite commands (e.g., \citet, \citep, \citeyear, \citealp, etc.).
% \nocite is okay to use to add references from your Supporting Information
%

\end{document}
8 changes: 8 additions & 0 deletions latex/agu2019/template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ config:
required: true
description: |
A good Abstract will begin with a short description of the problem being addressed, briefly describe the new data or analyses, then briefly states the main conclusion(s) and how they are supported and uncertainties.
- id: availability
required: true
description: |
AGU requires an Availability Statement for the underlying data needed to understand, evaluate, and build upon the reported research at the time of peer review and publication.
Additionally, authors should include an Availability Statement for the software that has a significant impact on the research. Details and templates are in the Availability Statement section of the Data & Software for Authors Guidance:
https://www.agu.org/Publish-with-AGU/Publish/Author-Resources/Data-and-Software-for-Authors#availability
For physical samples, use the IGSN persistent identifier, see the International Geo Sample Numbers section:
https://www.agu.org/Publish-with-AGU/Publish/Author-Resources/Data-and-Software-for-Authors#IGSN
- id: summary
required: false
description: |
Expand Down
9 changes: 9 additions & 0 deletions latex/default/template.tex
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,14 @@

[-CONTENT-]

[# if options.footnote_link #]
% Optional footnote with a link back to the online version of your article
\newcommand{\documentnote}[1]{{%
\let\thempfn\relax% Remove footnote number printing mechanism
\footnotetext[0]{\emph{#1}}% Print footnote text
}}
\documentnote{Available online at:\\ \href{[-doc.oxalink-]}{[-doc.oxalink-]}}
[# endif #]

\bibliography{main}
\end{document}
5 changes: 5 additions & 0 deletions latex/default/template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,8 @@ config:
type: keywords
description: |
Choose between 3 and 10 keywords that relate to the article
- id: footnote_link
type: bool
description: |
Add a visible link to the article on Curvenote as a footnote on the first page
default: true
2 changes: 1 addition & 1 deletion latex/plain_latex/template.tex
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
\let\thempfn\relax% Remove footnote number printing mechanism
\footnotetext[0]{\emph{#1}}% Print footnote text
}}
\documentnote{Online at: \href{[-doc.oxalink-]}{[-doc.oxalink-]}}
\documentnote{Available online at:\\ \href{[-doc.oxalink-]}{[-doc.oxalink-]}}
[# endif #]

[-CONTENT-]
Expand Down
2 changes: 0 additions & 2 deletions latex/plain_latex/template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@ config:
An abstract is a short summary of your research paper or report. A good abstract will prepare readers for
the detailed information to follow, communicate the essence of the article and help readers take away and
remember key points.
words:
max: 600

options:
- id: footnote_link
Expand Down
5 changes: 0 additions & 5 deletions latex/spie_proceedings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,3 @@ A template using the styles provided by the SPIE for publications in their proce
- Author: [SPIE](https://www.spie.org/)
- License: CC-BY-4.0
- [Source](https://spie.org/Documents/Publications/spie-proceedings-style.zip)
- [List of changes](PORT.md) made while porting the template

## TODO

- [ ] make affiliations optional, and counts correct when missing
13 changes: 11 additions & 2 deletions latex/spie_proceedings/template.tex
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
\documentclass[ [-options.doc_class-] ]{spie} %>>> use for US letter paper
[# if options.paper_size == "usletter" #]
\documentclass[[-options.nocompress-] ]{spie} %>>> use for US letter paper
[# else #]
\documentclass[[-options.paper_size-][# if options.nocompress #], nocompress[# endif #]]{spie} %>>> use for US letter paper
[# endif #]
%\documentclass[a4paper]{spie} %>>> use this instead for A4 paper
%\documentclass[nocompress]{spie} %>>> to avoid compression of citations

\PassOptionsToPackage{colorlinks, allcolors=blue}{hyperref}

\input{curvenote.def}

\renewcommand{\baselinestretch}{1.0} % Change to 1.65 for double spacing
[# if options.double_spacing #]
% Change to 1.65 for double spacing
\renewcommand{\baselinestretch}{1.65}
[# else #]
\renewcommand{\baselinestretch}{1.0}
[# endif #]

\title{[-doc.title-]}

Expand Down
47 changes: 40 additions & 7 deletions latex/spie_proceedings/template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ metadata:
contributor:
name: Curvenote
affiliation: curvenote
version: 3.40.0
version: 3.40.1
license: CC-BY-4.0
tags:
- paper
Expand All @@ -35,15 +35,48 @@ config:
tagged:
- id: abstract
required: true
description: No description
words:
max: 500
description: |
An abstract is a short summary of your research paper or report. A good abstract will prepare readers for
the detailed information to follow, communicate the essence of the article and help readers take away and
remember key points.
- id: appendix
description: No description
description: Include one of more blocks in the appendix section, rendered after the main body of the article but before the bibliography.
- id: acknowledgments
description: |
This unnumbered section is used to identify those who have aided the authors in understanding or accomplishing the work presented and to acknowledge sources of funding.

options:
- id: paper_size
title: Paper Size
type: choice
description: Set the paper size for the document
required: true
default: usletter
options:
- usletter
- a4paper
- id: keywords
type: keywords
description: |
Include a list of keywords after the abstract (minimum 3)
required: true
- id: double_spacing
title: Double line spacing
type: bool
description: Enable double line spacing
default: false
- id: page_numbers
title: Page Numbers
type: bool
description: No description
description: Enable page numbers
default: false
- id: start_page
title: Start Page
type: str
description: Set the starting page number, only used when page numbers are enabled
default: 1
- id: backlink
title: Backlink
type: bool
description: Include a link back to the version of the article online in Curvenote.
default: true
required: true