oaktree-sapling 0.0.1

package/templates/typst/frontmatter.typ

@@ -0,0 +1,244 @@
+#let orcidLogo(
+  // The ORCID identifier with no URL, e.g. `0000-0000-0000-0000`
+  orcid: none,
+) = {
+  /* Logos */
+  let orcidSvg = ```<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 24 24"><path fill="#AECD54" d="M21.8,12c0,5.4-4.4,9.8-9.8,9.8S2.2,17.4,2.2,12S6.6,2.2,12,2.2S21.8,6.6,21.8,12z M8.2,5.8c-0.4,0-0.8,0.3-0.8,0.8s0.3,0.8,0.8,0.8S9,7,9,6.6S8.7,5.8,8.2,5.8z M10.5,15.4h1.2v-6c0,0-0.5,0,1.8,0s3.3,1.4,3.3,3s-1.5,3-3.3,3s-1.9,0-1.9,0H10.5v1.1H9V8.3H7.7v8.2h2.9c0,0-0.3,0,3,0s4.5-2.2,4.5-4.1s-1.2-4.1-4.3-4.1s-3.2,0-3.2,0L10.5,15.4z"/></svg>```.text
+
+  if (orcid == none) {
+    // Do not
+    box(height: 1.1em, baseline: 13.5%, [#image.decode(orcidSvg)])
+    return
+  }
+
+  link("https://orcid.org/" + orcid)[#box(height: 1.1em, baseline: 13.5%)[#image(bytes(orcidSvg))]]
+}
+
+#let validateString(raw, name, alias: none) = {
+  if (name in raw) {
+    assert(type(raw.at(name)) == str, message: name + " must be a string")
+    return raw.at(name)
+  }
+  if (type(alias) != array) {
+    return
+  }
+  for a in alias {
+    if (a in raw) {
+      assert(type(raw.at(a)) == str, message: a + " must be a string")
+      return raw.at(a)
+    }
+  }
+}
+
+#let validateBoolean(raw, name, alias: none) = {
+  if (name in raw) {
+    assert(type(raw.at(name)) == bool, message: name + " must be a boolean")
+    return raw.at(name)
+  }
+  if (type(alias) != array) {
+    return
+  }
+  for a in alias {
+    if (a in raw) {
+      assert(type(raw.at(a)) == bool, message: a + " must be a boolean")
+      return raw.at(a)
+    }
+  }
+}
+
+
+#let validateAffiliation(raw) = {
+  let out = (:)
+  if (type(raw) == str) {
+    out.name = raw;
+    return out;
+  }
+  let id = validateString(raw, "id")
+  if (id != none) { out.id = id }
+  let name = validateString(raw, "name")
+  if (name != none) { out.name = name }
+  let institution = validateString(raw, "institution")
+  if (institution != none) { out.institution = institution }
+  let department = validateString(raw, "department")
+  if (department != none) { out.department = department }
+  let doi = validateString(raw, "doi")
+  if (doi != none) { out.doi = doi }
+  let ror = validateString(raw, "ror")
+  if (ror != none) { out.ror = ror }
+  let address = validateString(raw, "address")
+  if (address != none) { out.address = address }
+  let city = validateString(raw, "city")
+  if (city != none) { out.city = city }
+  let region = validateString(raw, "region", alias: ("state", "province"))
+  if (region != none) { out.region = region }
+  let postal-code = validateString(raw, "postal-code", alias: ("postal_code", "postalCode", "zip_code", "zip-code", "zipcode", "zipCode"))
+  if (postal-code != none) { out.postal-code = postal-code }
+  let country = validateString(raw, "country")
+  if (country != none) { out.country = country }
+  let phone = validateString(raw, "phone")
+  if (phone != none) { out.phone = phone }
+  let fax = validateString(raw, "fax")
+  if (fax != none) { out.fax = fax }
+  let email = validateString(raw, "email")
+  if (email != none) { out.email = email }
+  let url = validateString(raw, "url")
+  if (url != none) { out.url = url }
+  let collaboration = validateBoolean(raw, "collaboration")
+  if (collaboration != none) { out.collaboration = collaboration }
+  return out;
+}
+
+#let pickAffiliationsObject(raw) = {
+  if ("affiliation" in raw and "affiliations" in raw) {
+    panic("You can only use `affiliation` or `affiliations`, not both")
+  }
+  if ("affiliation" in raw) {
+    raw.affiliations = raw.affiliation
+  }
+  if ("affiliations" not in raw) { return; }
+  if (type(raw.affiliations) == str or type(raw.affiliations) == dictionary) {
+    // convert to a list
+    return (validateAffiliation(raw.affiliations),)
+  } else if (type(raw.affiliations) == array) {
+    // validate each entry
+    return raw.affiliations.map(validateAffiliation)
+  } else {
+    panic("The `affiliation` or `affiliations` must be a array, dictionary or string, got:", type(raw.affiliations))
+  }
+}
+
+
+#let validateAuthor(raw) = {
+  let out = (:)
+  if (type(raw) == str) {
+    out.name = raw;
+    return out;
+  }
+  let name = validateString(raw, "name")
+  if (name != none) { out.name = name }
+  let orcid = validateString(raw, "orcid")
+  if (orcid != none) { out.orcid = orcid }
+  let email = validateString(raw, "email")
+  if (email != none) { out.email = email }
+  let url = validateString(raw, "url")
+  if (url != none) { out.url = url }
+
+  let affiliations = pickAffiliationsObject(raw);
+  if (affiliations != none) { out.affiliations = affiliations } else { out.affiliations = () }
+
+  return out;
+}
+
+#let consolidateAffiliations(authors, affiliations) = {
+  let cnt = 0
+  for affiliation in affiliations {
+    if ("id" not in affiliation) {
+      affiliation.insert("id", "aff-" + str(cnt + 1))
+    }
+    affiliations.at(cnt) = affiliation
+    cnt += 1
+  }
+
+  let authorCnt = 0
+  for author in authors {
+    let affCnt = 0
+    for affiliation in author.affiliations {
+      let pos = affiliations.position(item => { ("id" in item and item.id == affiliation.name) or ("name" in item and item.name == affiliation.name) })
+      if (pos != none) {
+        affiliation.remove("name")
+        affiliation.id = affiliations.at(pos).id
+        affiliations.at(pos) = affiliations.at(pos) + affiliation
+      } else {
+        affiliation.id = if ("id" in affiliation) { affiliation.id } else { affiliation.name }
+        affiliations.push(affiliation)
+      }
+      author.affiliations.at(affCnt) = (id: affiliation.id)
+      affCnt += 1
+    }
+    authors.at(authorCnt) = author
+    authorCnt += 1
+  }
+
+  // Now that they are normalized, loop again and update the numbers
+  let fullAffCnt = 0
+  let authorCnt = 0
+  for author in authors {
+    let affCnt = 0
+    for affiliation in author.affiliations {
+      let pos = affiliations.position(item => { item.id == affiliation.id })
+      let aff = affiliations.at(pos)
+      if ("index" not in aff) {
+        fullAffCnt += 1
+        aff.index = fullAffCnt
+        affiliations.at(pos) = affiliations.at(pos) + (index: fullAffCnt)
+      }
+      author.affiliations.at(affCnt) = (id: affiliation.id, index: aff.index)
+      affCnt += 1
+    }
+    authors.at(authorCnt) = author
+    authorCnt += 1
+  }
+  return (authors: authors, affiliations: affiliations)
+}
+
+#let loadFrontmatter(raw) = {
+  let out = (:)
+  let title = validateString(raw, "title")
+  if (title != none) { out.title = title }
+  let subtitle = validateString(raw, "subtitle")
+  if (subtitle != none) { out.subtitle = subtitle }
+  let short-title = validateString(raw, "short-title", alias: ("short_title", "shortTitle", "runningHead",))
+  if (short-title != none) { out.short-title = short-title }
+
+  // author information
+  if ("author" in raw and "authors" in raw) {
+    panic("You can only use `author` or `authors`, not both")
+  }
+  if ("author" in raw) {
+    raw.authors = raw.author
+  }
+  if ("authors" in raw) {
+    if (type(raw.authors) == str or type(raw.authors) == dictionary) {
+      // convert to a list
+      out.authors = (validateAuthor(raw.authors),)
+    } else if (type(raw.authors) == array) {
+      // validate each entry
+      out.authors = raw.authors.map(validateAuthor)
+    } else {
+      panic("The `author` or `authors` must be a array, dictionary or string, got:", type(raw.authors))
+    }
+  }
+
+  let affiliations = pickAffiliationsObject(raw);
+  if (affiliations != none) { out.affiliations = affiliations } else { out.affiliations = () }
+
+  let open-access = validateBoolean(raw, "open-access", alias: ("open_access", "openAccess",))
+  if (open-access != none) { out.open-access = open-access }
+  let doi = validateString(raw, "doi")
+  if (doi != none) {
+    assert(not doi.starts-with("http"), message: "DOIs should not include the link, use only the part after `https://doi.org/[]`")
+    out.doi = doi
+  }
+
+  let date = none;
+  let citation = validateString(raw, "citation")
+  if (citation != none) {
+    out.citation = citation;
+  } else {
+    // Create a citation, e.g. Cockett et al., 2023
+    let year = if (date != none) { ", " + date.display("[year]") } else { ", " + datetime.today().display("[year]") }
+    if (out.authors.len() == 1) {
+      out.citation = out.authors.at(0).name.split(" ").last() + year
+    } else if (out.authors.len() == 2) {
+      out.citation = out.authors.at(0).name.split(" ").last() + " & " + out.authors.at(1).name.split(" ").last() + year
+    } else if (out.authors.len() > 2) {
+      out.citation = out.authors.at(0).name.split(" ").last() + " " + emph("et al.") + year
+    }
+  }
+
+  let consolidated = consolidateAffiliations(out.authors, out.affiliations)
+  out.authors = consolidated.authors
+  out.affiliations = consolidated.affiliations
+
+  return out
+}

package/templates/typst/lapreprint.typ

@@ -0,0 +1,310 @@
+#import "frontmatter.typ": orcidLogo, loadFrontmatter
+
+#let template(
+  // The paper's title.
+  title: "Paper Title",
+  subtitle: none,
+
+  // An array of authors. For each author you can specify a name, orcid, and affiliations.
+  // affiliations should be content, e.g. "1", which is shown in superscript and should match the affiliations list.
+  // Everything but but the name is optional.
+  authors: (),
+  // This is the affiliations list. Include an id and `name` in each affiliation. These are shown below the authors.
+  affiliations: (),
+  // The paper's abstract. Can be omitted if you don't have one.
+  abstract: none,
+  // The short-title is shown in the running header
+  short-title: none,
+  // The short-citation is shown in the running header, if set to auto it will show the author(s) and the year in APA format.
+  short-citation: auto,
+  // The venue is show in the footer
+  venue: none,
+  // An image path that is shown in the top right of the page. Can also be content.
+  logo: none,
+  // A DOI link, shown in the header on the first page. Should be just the DOI, e.g. `10.10123/123456` ,not a URL
+  doi: none,
+  heading-numbering: "1.a.i",
+  // Show an Open Access badge on the first page, and support open science, default is true, because that is what the default should be.
+  open-access: true,
+  // A list of keywords to display after the abstract
+  keywords: (),
+  // The "kind" of the content, e.g. "Original Research", this is shown as the title of the margin content on the first page.
+  kind: none,
+  // Content to put on the margin of the first page
+  // Should be a list of dicts with `title` and `content`
+  margin: (),
+  paper-size: "us-letter",
+  // A color for the theme of the document
+  theme: blue.darken(30%),
+  // Date published, for example, when you publish your preprint to an archive server.
+  // To hide the date, set this to `none`. You can also supply a list of dicts with `title` and `date`.
+  date: datetime.today(),
+  // Feel free to change this, the font applies to the whole document
+  font-face: none,
+  // The path to a bibliography file if you want to cite some external works.
+  bibliography-file: none,
+  bibliography-style: "apa",
+  // The paper's content.
+  body
+) = {
+  let spacer = text(fill: gray)[#h(8pt) | #h(8pt)]
+
+  let dates;
+  if (type(date) == datetime) {
+    dates = ((title: "Published", date: date),)
+  } else if (type(date) == dictionary) {
+    dates = (date,)
+  } else {
+    dates = date
+  }
+  date = dates.at(0).date
+
+  // Create a short-citation, e.g. Cockett et al., 2023
+  let year = if (date != none) { ", " + date.display("[year]") }
+  if (short-citation == auto and authors.len() == 1) {
+    short-citation = authors.at(0).name.split(" ").last() + year
+  } else if (short-citation == auto and authors.len() == 2) {
+    short-citation = authors.at(0).name.split(" ").last() + " & " + authors.at(1).name.split(" ").last() + year
+  } else if (short-citation == auto and authors.len() > 2) {
+    short-citation = authors.at(0).name.split(" ").last() + " " + emph("et al.") + year
+  } else if (short-citation == auto) {
+    short-citation = none
+  }
+
+  // Set document metadata.
+  set document(title: title, author: authors.map(author => author.name))
+
+  show link: it => [#text(fill: theme)[#it]]
+  show ref: it => [#text(fill: theme)[#it]]
+
+  set page(
+    paper-size,
+    margin: (left: 25%),
+    header: context {
+      let loc = here()
+      if(loc.page() == 1) {
+        let headers = (
+          if (open-access) {smallcaps[Open Access]},
+          if (doi != none) { link("https://doi.org/" + doi, "https://doi.org/" + doi)}
+        )
+        return align(left, text(size: 8pt, fill: gray, headers.filter(header => header != none).join(spacer)))
+      } else {
+        return align(right, text(size: 8pt, fill: gray.darken(50%),
+          (short-title, short-citation).join(spacer)
+        ))
+      }
+    },
+    footer: block(
+      width: 100%,
+      stroke: (top: 1pt + gray),
+      inset: (top: 8pt, right: 2pt),
+      context [
+        #grid(columns: (75%, 25%),
+          align(left, text(size: 9pt, fill: gray.darken(50%),
+              (
+                if(venue != none) {emph(venue)},
+                if(date != none) {date.display("[month repr:long] [day], [year]")}
+              ).filter(t => t != none).join(spacer)
+          )),
+          align(right)[
+            #text(
+              size: 9pt, fill: gray.darken(50%)
+            )[
+              #counter(page).display() of #counter(page).final().first()
+            ]
+          ]
+        )
+      ]
+    )
+  )
+
+  // Set the body font.
+  if (font-face != none) {
+    set text(font: font-face, size: 10pt)
+  } else {
+    set text(size: 10pt)
+  }
+  // Configure equation numbering and spacing.
+  set math.equation(numbering: "(1)")
+  show math.equation: set block(spacing: 1em)
+
+  // Configure lists.
+  set enum(indent: 10pt, body-indent: 9pt)
+  set list(indent: 10pt, body-indent: 9pt)
+
+  // Configure headings.
+  set heading(numbering: heading-numbering)
+  show heading: it => context {
+    let loc = here()
+    // Find out the final number of the heading counter.
+    let levels = counter(heading).at(loc)
+    set text(10pt, weight: 400)
+    if it.level == 1 [
+      // First-level headings are centered smallcaps.
+      // We don't want to number of the acknowledgment section.
+      #let is-ack = it.body in ([Acknowledgment], [Acknowledgement])
+      // #set align(center)
+      #set text(if is-ack { 10pt } else { 12pt })
+      #show: smallcaps
+      #v(20pt, weak: true)
+      #if it.numbering != none and not is-ack {
+        numbering(heading-numbering, ..levels)
+        [.]
+        h(7pt, weak: true)
+      }
+      #it.body
+      #v(13.75pt, weak: true)
+    ] else if it.level == 2 [
+      // Second-level headings are run-ins.
+      #set par(first-line-indent: 0pt)
+      #set text(style: "italic")
+      #v(10pt, weak: true)
+      #if it.numbering != none {
+        numbering(heading-numbering, ..levels)
+        [.]
+        h(7pt, weak: true)
+      }
+      #it.body
+      #v(10pt, weak: true)
+    ] else [
+      // Third level headings are run-ins too, but different.
+      #if it.level == 3 {
+        numbering(heading-numbering, ..levels)
+        [. ]
+      }
+      _#(it.body):_
+    ]
+  }
+
+
+  if (logo != none) {
+    place(
+      top,
+      dx: -33%,
+      float: false,
+      box(
+        width: 27%,
+        {
+          if (type(logo) == content) {
+            logo
+          } else {
+            image(logo, width: 100%)
+          }
+        },
+      ),
+    )
+  }
+
+
+  // Title and subtitle
+  box(inset: (bottom: 2pt), width: 100%, text(17pt, weight: "bold", fill: theme, title))
+  if subtitle != none {
+    parbreak()
+    box(width: 100%, text(14pt, fill: gray.darken(30%), subtitle))
+  }
+  // Authors and affiliations
+  if authors.len() > 0 {
+    box(inset: (y: 10pt), {
+      authors.map(author => {
+        text(11pt, weight: "semibold", author.name)
+        h(1pt)
+        if "affiliations" in author {
+          super(author.affiliations)
+        }
+        if "orcid" in author {
+          orcidLogo(orcid: author.orcid)
+        }
+      }).join(", ", last: ", and ")
+    })
+  }
+  if affiliations.len() > 0 {
+    box(inset: (bottom: 10pt), {
+      affiliations.map(affiliation => {
+        super(affiliation.id)
+        h(1pt)
+        affiliation.name
+      }).join(", ")
+    })
+  }
+
+
+  place(
+    left + bottom,
+    dx: -33%,
+    dy: -10pt,
+    box(width: 27%, {
+      if (kind != none) {
+        show par: set par(spacing: 0em)
+        text(11pt, fill: theme, weight: "semibold", smallcaps(kind))
+        parbreak()
+      }
+      if (dates != none) {
+        let formatted-dates
+
+        grid(columns: (40%, 60%), gutter: 7pt,
+          ..dates.zip(range(dates.len())).map((formatted-dates) => {
+            let d = formatted-dates.at(0);
+            let i = formatted-dates.at(1);
+            let weight = "light"
+            if (i == 0) {
+              weight = "bold"
+            }
+            return (
+              text(size: 7pt, fill: theme, weight: weight, d.title),
+              text(size: 7pt, d.date.display("[month repr:short] [day], [year]"))
+            )
+          }).flatten()
+        )
+      }
+      v(2em)
+      grid(columns: 1, gutter: 2em, ..margin.map(side => {
+        text(size: 7pt, {
+          if ("title" in side) {
+            text(fill: theme, weight: "bold", side.title)
+            [\ ]
+          }
+          set enum(indent: 0.1em, body-indent: 0.25em)
+          set list(indent: 0.1em, body-indent: 0.25em)
+          side.content
+        })
+      }))
+    }),
+  )
+
+
+  let abstracts
+  if (type(abstract) == content or type(abstract) == str) {
+    abstracts = ((title: "Abstract", content: abstract),)
+  } else {
+    abstracts = abstract
+  }
+
+if (abstracts != none and abstracts.len() > 0) {
+    box(inset: (top: 16pt, bottom: 16pt), width: 100%, stroke: (top: 1pt + gray, bottom: 1pt + gray), {
+      abstracts.map(abs => {
+        set par(justify: true)
+        text(fill: theme, weight: "semibold", size: 9pt, abs.title)
+        parbreak()
+        abs.content
+      }).join(parbreak())
+    })
+  }
+  if (keywords.len() > 0) {
+    text(size: 9pt, {
+      text(fill: theme, weight: "semibold", "Keywords")
+      h(8pt)
+      keywords.join(", ")
+    })
+  }
+  v(10pt)
+
+  show par: set par(spacing: 1.5em)
+
+  // Display the paper's contents.
+  body
+
+  if (bibliography-file != none) {
+    show bibliography: set text(8pt)
+    bibliography(bibliography-file, title: text(10pt, "References"), style: bibliography-style)
+  }
+}

package/templates/typst/template.typ

@@ -0,0 +1,112 @@
+#import "lapreprint.typ": *
+#show: template.with(
+  title: "[-doc.title-]",
+[# if parts.abstract or parts.summary #]
+  abstract: (
+[# if parts.abstract #]
+    (
+      title: "Abstract",
+      content: [
+[-parts.abstract-]
+      ]
+    ),
+[# endif #]
+[# if parts.summary #]
+    (
+      title: "Plain Language Summary",
+      content: [
+[-parts.summary-]
+      ]
+    ),
+[# endif #]
+  ),
+[# endif #]
+[# if doc.subtitle #]
+  subtitle: "[-doc.subtitle-]",
+[# endif #]
+[# if doc.short_title #]
+  short-title: "[-doc.short_title-]",
+[# endif #]
+[# if options.short_citation #]
+  short-citation: "[-options.short_citation-]",
+[# endif #]
+[# if options.heading_numbering #]
+  heading-numbering: "[-options.heading_numbering-]",
+[# endif #]
+[# if options.theme #]
+  theme: [-options.theme-],
+[# endif #]
+[# if doc.open_access !== undefined #]
+  open-access: [-doc.open_access-],
+[# endif #]
+[# if doc.doi #]
+  doi: "[-doc.doi-]",
+[# endif #]
+[# if doc.date #]
+  date: datetime(
+    year: [-doc.date.year-],
+    month: [-doc.date.month-],
+    day: [-doc.date.day-],
+  ),
+[# endif #]
+[# if doc.keywords #]
+  keywords: (
+    [#- for keyword in doc.keywords -#]"[-keyword-]",[#- endfor -#]
+  ),
+[# endif #]
+[# if doc.bibtex #]
+  bibliography-file: "[-doc.bibtex-]",
+[# endif #]
+  authors: (
+[# for author in doc.authors #]
+    (
+      name: "[-author.name-]",
+[# if author.orcid #]
+      orcid: "[-author.orcid-]",
+[# endif #]
+[# if author.affiliations #]
+      affiliations: "[#- for aff in author.affiliations -#][-aff.index-][#- if not loop.last -#],[#- endif -#][#- endfor -#]",
+[# endif #]
+    ),
+[# endfor #]
+  ),
+  affiliations: (
+[# for aff in doc.affiliations #]
+    (
+      id: "[-aff.index-]",
+      name: "[-aff.name-]",
+    ),
+[# endfor #]
+  ),
+[# if doc.venue.title #]
+  venue: "[-doc.venue.title-]",
+[# endif #]
+[# if options.logo #]
+  logo: "[-options.logo-]",
+[# endif #]
+[# if options.kind #]
+  kind: "[-options.kind-]",
+[# endif #]
+  margin: (
+[# if parts.acknowledgements #]
+    (
+      title: "Acknowledgements",
+      content: [
+[-parts.acknowledgements-]
+      ],
+    ),
+[# endif #]
+[# if parts.availability #]
+    (
+      title: "Data Availability",
+      content: [
+[-parts.availability-]
+      ],
+    ),
+[# endif #]
+  ),
+)
+
+[-IMPORTS-]
+
+[-CONTENT-]