Update templates for ts jtex implementation

README.md

@@ -4,11 +4,11 @@
 
 A community curated collection of Curvenote compatible templates.
 
-These templates allow us to export Articles and Notebooks in Curvenote as typeset and formatted documents. This means we can export to PDF and LaTeX formats while complying with an original source template, that would have been provided by a particular journal, conference organizer or university.
+These templates allow Articles and Notebooks in Curvenote to be exported as typeset, formatted documents. This means we can export to PDF and LaTeX formats while complying with an original source template, that would have been provided by a particular journal, conference organizer, or university.
 
 The templates here can also be browsed on the [Curvenote website](https://curvenote.com/templates).
 
-Currently, all templates are LaTeX based but as of October'21, Curvenote can now [export to Microsoft Word](https://curvenote.com/blog/curvenote-microsoft-word-export). As this beta feature progresses, MS Word templates will appear here too.
+Currently, all templates are LaTeX based, Curvenote can also [export to Microsoft Word](https://curvenote.com/blog/curvenote-microsoft-word-export) and PDF directly. This repository will also be used for HTML templates in the future.
 
 ## Contributing
 
@@ -23,8 +23,8 @@ There are a couple of different ways to get a template added to this repository:
 - 📝 [open an issue](https://github.com/curvenote/templates/issues) - tell us about the template you'd like added. Provide a link to the template if it's online, or attach the files if you have them.
 - 🏋🏽‍♀️ [open a PR](https://github.com/curvenote/templates/pulls) - with a port of the template. Even if it's partial or barely started we'll help test and get it over the line.
 
-Templates in this repo can be tested and used in conjunction with [curvenote-template](https://github.com/curvenote/curvenote-template) a python based command line tool.
-You'll need `python >= 3.6` to use it but you'll not need to write any code.
+Templates in this repo can be tested and used in conjunction with [jtex](https://github.com/curvenote/jtex) a Python based command line tool.
+You'll need `python >= 3.6` to use it but you will not need to write any code.
 
 The README in that repository has plently of details on the basic templating syntax we use (which is based on our own custom Jinja environment) and how to run the tool.
 

latex/agu2019/template.tex

@@ -20,14 +20,13 @@
 [# else #]
 \documentclass{agujournal2019}
 [# endif #]
-[# if lipsum #]
-\usepackage{lipsum}
-[# endif #]
+
 \usepackage{lineno}
 \usepackage[inline]{trackchanges} %for better track changes. final new option will compile document with changes incorporated.
 \usepackage{soul}
 \linenumbers
-\input{curvenote.def}
+
+[- IMPORTS -]
 %%%%%%%
 % As of 2018 we recommend use of the TrackChanges package to mark revisions.
 % The trackchanges package adds five new LaTeX commands:
@@ -70,11 +69,7 @@
 %
 % ie, \journalname{Water Resources Research}
 
-[# if options.journal_name#]
 \journalname{[-options.journal_name-]}
-[# else #]
-\journalname{Geophysical Research Letters}
-[# endif #]
 
 \begin{document}
 
@@ -111,21 +106,25 @@
 % Example: \authors{A. B. Author\affil{1}\thanks{Current address, Antartica}, B. C. Author\affil{2,3}, and D. E.
 % Author\affil{3,4}\thanks{Also funded by Monsanto.}}
 
-[# set count=[1] #]
 \authors{
-[# for author in doc.authors #]
-[-author.name-][# if author.affiliation #]\affil{[-count|length-]}[# set __ = count.append(1) #][# endif #][# if not loop.last #],[# endif #]
-[# endfor #]
+[#- for author in doc.authors -#]
+[-- author.name --]
+[#- if author.affiliations -#]
+\affil{
+[-- author.affiliations|join(",", "index") --]
+}
+[#- endif -#]
+[#- if not loop.last #], [# endif -#]
+[#- endfor -#]
 }
 
 % \affiliation{1}{First Affiliation}
 % \affiliation{2}{Second Affiliation}
 % \affiliation{3}{Third Affiliation}
 % \affiliation{4}{Fourth Affiliation}
 
-[# set count = [1] #]
-[# for author in doc.authors #]
-[# if author.affiliation #]\affiliation{[-count|length-]}{[-author.affiliation-]}[# set __ = count.append(1) #][# endif #]
+[# for affiliation in doc.affiliations #]
+\affiliation{[-affiliation.index-]}{[-affiliation.value-]}
 [# endfor #]
 %(repeat as many times as is necessary)
 
@@ -140,7 +139,7 @@
 % Example: \correspondingauthor{First and Last Name}{[email protected]}
 
 [# for author in doc.authors #]
-[# if author.is_corresponding #]
+[# if author.corresponding #]
 \correspondingauthor{[-author.name-]}{[-author.email-]}
 [# endif #]
 [# endfor #]
@@ -158,19 +157,15 @@
 % \item	Each must be 140 characters or fewer with no special characters or punctuation and must be complete sentences
 % \end{keypoints}
 
-[# if tagged.keypoints #]
 \begin{keypoints}
-[# for keypoint in tagged.keypoints #]
-  \item [-keypoint-]
-[# endfor #]
-\end{keypoints}
-[# else #]
-\begin{keypoints}
-  \item enter point 1 here
-  \item enter point 2 here
-  \item enter point 3 here
-\end{keypoints}
+  \item [-options.keypoint_1-]
+[# if options.keypoint_2 #]
+  \item [-options.keypoint_2-]
 [# endif #]
+[# if options.keypoint_3 #]
+  \item [-options.keypoint_3-]
+[# endif #]
+\end{keypoints}
 
 %% ------------------------------------------------------------------------ %%
 %
@@ -193,27 +188,21 @@
 
 %% \begin{abstract} starts the second page
 
-[# if tagged.abstract #]
+[# if parts.abstract #]
 \begin{abstract}
-  [-tagged.abstract-]
+[-parts.abstract-]
 \end{abstract}
 [# else #]
 \begin{abstract}
-  enter your Abstract here
+  Your abstract here!
 \end{abstract}
 [# endif #]
 
-[# if tagged.plain_language_summary #]
+[# if parts.summary #]
 \section*{Plain Language Summary}
-[-tagged.plain_language_summary-]
+[-parts.summary-]
 [# endif #]
 
-%% ------------------------------------------------------------------------ %%
-%
-%  TEXT
-%
-%% ------------------------------------------------------------------------ %%
-
 [-CONTENT-]
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -226,18 +215,18 @@ \section*{Plain Language Summary}
 %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 #]
+[# if parts.availability #]
 \section*{Open Research}
-[-tagged.availability-]
+[-parts.availability-]
 [# endif #]
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
 
-[# if tagged.acknowledgments #]
+[# if parts.acknowledgments #]
 \acknowledgments
 % This section is optional. Include any Acknowledgments here.
-[-tagged.acknowledgments-]
+[-parts.acknowledgments-]
 [# endif #]
 
 %% ------------------------------------------------------------------------ %%

latex/agu2019/template.yml

@@ -1,103 +1,117 @@
-metadata:
-  title: AGU Journal
-  description: The offical 2019 AGU Journal template
-  version: 1.0.0
-  license: "GPL-3"
-  author:
-    name: American Geophysical Union
+jtex: v1
+title: AGU Journal
+description: The offical 2019 AGU Journal template
+version: 1.0.0
+license: 'GPL-3.0-OR-LATER'
+authors:
+  - name: American Geophysical Union
     website: https://agu.org
-    affiliation: American Geophysical Union
-  contributor:
-    name: Curvenote
+    affiliations:
+      - American Geophysical Union
+  - name: Curvenote
     github: curvenote
     twitter: curvenote
-    affiliation: Curvenote
-  tags:
-    - paper
-    - journal
-    - geoscience
-    - earthscience
-  links:
-    source: https://www.agu.org/Publish-with-AGU/Publish/Author-Resources/Text-requirements
+    affiliations:
+      - Curvenote
+tags:
+  - paper
+  - journal
+  - geoscience
+  - earthscience
+source: https://www.agu.org/Publish-with-AGU/Publish/Author-Resources/Text-requirements
 
 # options that can be offered to users to customise how this template is rendered
-config:
-  build:
-    layout: compact
+build:
+  layout: compact
 
-  schema:
-    aside: framed
-    callout: framed
-    code: verbatim
-    raggedbottom: false
-    sloppy: false
-    hidelinks: false
-    natbib: false
-    bibstyle: false
-    citestyle: false
+schema:
+  aside: framed
+  callout: framed
+  code: verbatim
+  raggedbottom: false
+  sloppy: false
+  hidelinks: false
+  natbib: false
+  bibstyle: false
+  citestyle: false
 
-  tagged:
-    - id: abstract
-      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: |
-        The Plain Language Summary should be written for a broad audience, 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, JGR: Oceans, G-Cubed, Reviews of Geophysics, and JAMES.
-        see http://sharingscience.agu.org/creating-plain-language-summary/)
-    - id: acknowledgments
-      required: false
-      description: |
-        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).
-          - All funding sources related to this work from all authors
-          - Any real or perceived financial conflicts of interests for any author
-          - Other affiliations for any author that may be perceived as 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.
+parts:
+  - id: abstract
+    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: |
+      The Plain Language Summary should be written for a broad audience, 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, JGR: Oceans, G-Cubed, Reviews of Geophysics, and JAMES.
+      see http://sharingscience.agu.org/creating-plain-language-summary/)
+  - id: acknowledgments
+    required: false
+    description: |
+      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).
+        - All funding sources related to this work from all authors
+        - Any real or perceived financial conflicts of interests for any author
+        - Other affiliations for any author that may be perceived as 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.
+doc:
+  - id: title
+    required: true
+  - id: authors
+    required: true
 
-  options:
-    - type: choice
-      id: journal_name
-      title: AGU Journal Name
-      options:
-        - "JGR: Atmospheres"
-        - "JGR: Biogeosciences"
-        - "JGR: Earth Surface"
-        - "JGR: Oceans"
-        - "JGR: Planets"
-        - "JGR: Solid Earth"
-        - "JGR: Space Physics"
-        - Global Biogeochemical Cycles
-        - Geophysical Research Letters
-        - Paleoceanography and Paleoclimatology
-        - Radio Science
-        - Reviews of Geophysics
-        - Tectonics
-        - Space Weather
-        - Water Resources Research
-        - Geochemistry, Geophysics, Geosystems
-        - Journal of Advances in Modeling Earth Systems (JAMES)
-        - Earth's Future
-        - Earth and Space Science
-        - Geohealth
-      required: true
-    - id: corresponding_author
-      type: corresponding_author
-      required: true
-      multiple: true
-      description: |
-        Include name and email addresses of the corresponding author.  More than one corresponding author is allowed in this LaTeX file and for publication; but only one corresponding author is allowed in our editorial system.)
-    - type: bool
-      id: draft
-      description: Mark the document as draft
+options:
+  - type: choice
+    id: journal_name
+    required: true
+    description: AGU Journal name selection
+    choices:
+      - 'JGR: Atmospheres'
+      - 'JGR: Biogeosciences'
+      - 'JGR: Earth Surface'
+      - 'JGR: Oceans'
+      - 'JGR: Planets'
+      - 'JGR: Solid Earth'
+      - 'JGR: Space Physics'
+      - Global Biogeochemical Cycles
+      - Geophysical Research Letters
+      - Paleoceanography and Paleoclimatology
+      - Radio Science
+      - Reviews of Geophysics
+      - Tectonics
+      - Space Weather
+      - Water Resources Research
+      - Geochemistry, Geophysics, Geosystems
+      - Journal of Advances in Modeling Earth Systems (JAMES)
+      - Earth's Future
+      - Earth and Space Science
+      - Geohealth
+  - type: boolean
+    id: draft
+    description: Mark the document as draft
+  - type: string
+    id: keypoint_1
+    description: |
+      First of up to three key points (at least one is required)
+      Key Points summarize the main points and conclusions of the article
+      Each must be 140 characters or fewer with no special characters or punctuation and must be complete sentences
+    required: true
+    max_chars: 140
+  - type: string
+    id: keypoint_2
+    description: Second key point
+    max_chars: 140
+  - type: string
+    id: keypoint_3
+    description: Third key point
+    max_chars: 140