@alisio/plugin-thesis 0.1.0

package/templates/palettes.json

@@ -0,0 +1,57 @@
+{
+  "schemaVersion": 1,
+  "palettes": {
+    "okabe-ito": {
+      "kind": "categorical",
+      "description": "Color-blind safe default (Okabe and Ito). Yellow is excluded for lines.",
+      "colors": [
+        "#000000",
+        "#E69F00",
+        "#56B4E9",
+        "#009E73",
+        "#F0E442",
+        "#0072B2",
+        "#D55E00",
+        "#CC79A7"
+      ],
+      "excludeForLines": ["#F0E442"]
+    },
+    "tol-bright": {
+      "kind": "categorical",
+      "description": "Paul Tol bright qualitative scheme, color-blind safe.",
+      "colors": ["#4477AA", "#EE6677", "#228833", "#CCBB44", "#66CCEE", "#AA3377", "#BBBBBB"]
+    },
+    "tol-muted": {
+      "kind": "categorical",
+      "description": "Paul Tol muted qualitative scheme, for many categories.",
+      "colors": [
+        "#CC6677",
+        "#332288",
+        "#DDCC77",
+        "#117733",
+        "#88CCEE",
+        "#882255",
+        "#44AA99",
+        "#999933",
+        "#AA4499",
+        "#DDDDDD"
+      ]
+    },
+    "tol-high-contrast": {
+      "kind": "categorical",
+      "description": "Paul Tol high-contrast scheme, grayscale-print safe, at most three series.",
+      "colors": ["#004488", "#DDAA33", "#BB5566"],
+      "maxSeries": 3
+    },
+    "viridis": {
+      "kind": "sequential",
+      "description": "Perceptually uniform sequential scale.",
+      "colors": ["#440154", "#3B528B", "#21918C", "#5EC962", "#FDE725"]
+    },
+    "cividis": {
+      "kind": "sequential",
+      "description": "Color-blind optimized sequential scale.",
+      "colors": ["#00204D", "#414D6B", "#7C7B78", "#BCAF6F", "#FFEA46"]
+    }
+  }
+}

package/templates/profiles/apa-7.profile.yaml

@@ -0,0 +1,15 @@
+# APA 7 student-paper style: double spacing, 1 in margins, captions above with the note below.
+id: apa-7
+description: APA 7 layout with double spacing, one inch margins and notes below floats.
+extends: generic
+margins: { top: 2.54cm, bottom: 2.54cm, inside: 2.54cm, outside: 2.54cm }
+lineSpacing: 2
+paragraph: { indent: 1.27cm, spacing: 0.65em, justify: false }
+headings:
+  - { level: 1, size: 12, weight: bold, case: none, numbering: "1", align: center, spaceBefore: 1.4em, spaceAfter: 1em, newPage: true }
+  - { level: 2, size: 12, weight: bold, case: none, numbering: "1.1", align: left, spaceBefore: 1.2em, spaceAfter: 0.8em, newPage: false }
+  - { level: 3, size: 12, weight: bold, case: none, numbering: "1.1.1", align: left, spaceBefore: 1.2em, spaceAfter: 0.7em, newPage: false }
+  - { level: 4, size: 12, weight: bold, case: none, numbering: "1.1.1.1", align: left, spaceBefore: 1.1em, spaceAfter: 0.6em, newPage: false }
+captions: { figurePosition: top, tablePosition: top, sourceBelow: true }
+pageNumbers: { position: right }
+header: none

package/templates/profiles/generic.profile.yaml

@@ -0,0 +1,20 @@
+# Generic thesis layout: roman preliminaries, arabic body, chapter-numbered floats.
+id: generic
+description: Neutral layout with roman preliminaries and chapter-numbered figures and tables.
+margins: { top: 2.5cm, bottom: 2.5cm, inside: 3cm, outside: 2.5cm }
+binding: left
+font: { size: 12 }
+lineSpacing: 1.5
+paragraph: { indent: 1.25cm, spacing: 0.9em, justify: true }
+headings:
+  - { level: 1, size: 17, weight: bold, case: none, numbering: "1", align: left, spaceBefore: 1.6em, spaceAfter: 1em, newPage: true }
+  - { level: 2, size: 14, weight: bold, case: none, numbering: "1.1", align: left, spaceBefore: 1.4em, spaceAfter: 0.8em, newPage: false }
+  - { level: 3, size: 12, weight: bold, case: none, numbering: "1.1.1", align: left, spaceBefore: 1.2em, spaceAfter: 0.7em, newPage: false }
+  - { level: 4, size: 12, weight: bold, case: none, numbering: "1.1.1.1", align: left, spaceBefore: 1.1em, spaceAfter: 0.6em, newPage: false }
+captions: { figurePosition: bottom, tablePosition: top, labelStyle: plain, separator: ". ", sourceBelow: false, numbering: chapter }
+pageNumbers: { front: roman, body: arabic, position: center, continuous: false }
+frontMatter: [dedication, acknowledgments, ai-declaration, abstract, toc]
+footnotes: { size: 10 }
+toc: { depth: 3 }
+header: chapter
+annexNumbering: "A.1.1"

package/templates/profiles/icontec-ntc1486-2022.profile.yaml

@@ -0,0 +1,36 @@
+# ICONTEC NTC 1486:2022 layout. Every value below comes from the policy rules in
+# policy-packs/countries/CO/academic-standards/ntc-1486-2022.yaml (basis: secondary_source):
+#   CO.NTC1486.2022.FORMAT.PAPER.01        letter paper (the brief decides; not set here)
+#   CO.NTC1486.2022.FORMAT.MARGIN.01       2 cm on every side
+#   CO.NTC1486.2022.FORMAT.FONT.01         12 pt (family disputed: asked in the interview)
+#   CO.NTC1486.2022.FORMAT.ALIGNMENT.01    justified body
+#   CO.NTC1486.2022.FORMAT.PAGINATION.01   arabic numbers throughout, bottom centre; the cover and
+#                                          title page are counted but not printed; "pag." column in
+#                                          the table of contents
+#   CO.NTC1486.2022.STRUCTURE.FRONT_MATTER.01  portada, dedicatoria, agradecimientos, contenido,
+#                                          listas, resumen
+#   CO.NTC1486.2022.FORMAT.HEADINGS.01     decimal numbering to level 4, level 1 uppercase centred
+#                                          on a new page, levels 3 and 4 run in with a final period
+#   CO.NTC1486.2022.FORMAT.CAPTIONS.01     table and figure captions above, source line below;
+#                                          numbered consecutively ("Tabla 1.")
+# Disputed values (font family, body line spacing, level-2 heading case) come from the brief
+# (presentation.bodyFont, presentation.lineSpacing) or an institution rule; the defaults below only
+# apply until then.
+id: icontec-ntc1486-2022
+description: ICONTEC NTC 1486:2022 layout from secondary sources; provisional.
+extends: generic
+margins: { top: 2cm, bottom: 2cm, inside: 2cm, outside: 2cm }
+font: { size: 12 }
+lineSpacing: 1.5
+paragraph: { indent: 0cm, spacing: 1em, justify: true }
+headings:
+  - { level: 1, size: 12, weight: bold, case: upper, numbering: "1", align: center, spaceBefore: 1em, spaceAfter: 1.2em, newPage: true }
+  - { level: 2, size: 12, weight: bold, case: none, numbering: "1.1", align: left, spaceBefore: 1.2em, spaceAfter: 0.8em, newPage: false }
+  - { level: 3, size: 12, weight: bold, case: none, numbering: "1.1.1", align: left, spaceBefore: 1.1em, spaceAfter: 0.7em, newPage: false, runIn: true, endsWith: "." }
+  - { level: 4, size: 12, weight: bold, case: none, numbering: "1.1.1.1", align: left, spaceBefore: 1em, spaceAfter: 0.6em, newPage: false, runIn: true, endsWith: "." }
+captions: { figurePosition: top, tablePosition: top, sourceBelow: true, numbering: continuous }
+pageNumbers: { front: arabic, body: arabic, position: center, continuous: true }
+frontMatter: [dedication, acknowledgments, toc, abstract]
+toc: { depth: 4, pageLabel: { value: true, ruleId: CO.NTC1486.2022.FORMAT.PAGINATION.01 } }
+header: none
+ruleId: CO.NTC1486.2022.FORMAT.MARGIN.01

package/templates/profiles/ieee.profile.yaml

@@ -0,0 +1,14 @@
+# IEEE-flavoured thesis layout: compact spacing, captions below figures and above tables.
+id: ieee
+description: Compact layout with captions below figures and above tables.
+extends: generic
+margins: { top: 2.5cm, bottom: 2.5cm, inside: 2.5cm, outside: 2.5cm }
+font: { size: 11 }
+lineSpacing: 1.15
+paragraph: { indent: 0cm, spacing: 0.9em, justify: true }
+headings:
+  - { level: 1, size: 16, weight: bold, case: none, numbering: "1", align: left, spaceBefore: 1.6em, spaceAfter: 1em, newPage: true }
+  - { level: 2, size: 13, weight: bold, case: none, numbering: "1.1", align: left, spaceBefore: 1.3em, spaceAfter: 0.7em, newPage: false }
+  - { level: 3, size: 11, weight: bold, case: none, numbering: "1.1.1", align: left, spaceBefore: 1.1em, spaceAfter: 0.6em, newPage: false }
+  - { level: 4, size: 11, weight: bold, case: none, numbering: "1.1.1.1", align: left, spaceBefore: 1em, spaceAfter: 0.5em, newPage: false }
+header: chapter

package/templates/typst/i18n/en.yaml

@@ -0,0 +1,31 @@
+# Labels used by the thesis template. Keep every key present in every language file.
+figure: Figure
+table: Table
+equation: Equation
+section: Section
+chapter: Chapter
+annex: Annex
+annexes: Annexes
+contents: Contents
+list_of_figures: List of figures
+list_of_tables: List of tables
+abstract: Abstract
+keywords: Keywords
+references: References
+dedication: Dedication
+acknowledgments: Acknowledgments
+ai_declaration: AI-use declaration
+advisor: Advisor
+program: Program
+faculty: Faculty
+page_abbr: p.
+work_undergraduate_thesis: Undergraduate thesis
+work_degree_project: Degree project
+work_monograph: Monograph
+work_master_thesis: Master's thesis
+work_doctoral_dissertation: Doctoral dissertation
+evidence_law: Law
+evidence_standard: Standard
+evidence_dataset: Dataset
+evidence_thesis: Thesis
+evidence_preprint: Preprint

package/templates/typst/i18n/es.yaml

@@ -0,0 +1,31 @@
+# Labels used by the thesis template. Keep every key present in every language file.
+figure: Figura
+table: Tabla
+equation: Ecuación
+section: Sección
+chapter: Capítulo
+annex: Anexo
+annexes: Anexos
+contents: Contenido
+list_of_figures: Lista de figuras
+list_of_tables: Lista de tablas
+abstract: Resumen
+keywords: Palabras clave
+references: Referencias
+dedication: Dedicatoria
+acknowledgments: Agradecimientos
+ai_declaration: Declaración de uso de inteligencia artificial
+advisor: Director
+program: Programa
+faculty: Facultad
+page_abbr: pág.
+work_undergraduate_thesis: Trabajo de grado
+work_degree_project: Proyecto de grado
+work_monograph: Monografía
+work_master_thesis: Tesis de maestría
+work_doctoral_dissertation: Tesis doctoral
+evidence_law: Ley
+evidence_standard: Norma técnica
+evidence_dataset: Conjunto de datos
+evidence_thesis: Tesis
+evidence_preprint: Preprint

package/templates/typst/i18n/pt.yaml

@@ -0,0 +1,31 @@
+# Labels used by the thesis template. Keep every key present in every language file.
+figure: Figura
+table: Tabela
+equation: Equação
+section: Seção
+chapter: Capítulo
+annex: Anexo
+annexes: Anexos
+contents: Sumário
+list_of_figures: Lista de figuras
+list_of_tables: Lista de tabelas
+abstract: Resumo
+keywords: Palavras-chave
+references: Referências
+dedication: Dedicatória
+acknowledgments: Agradecimentos
+ai_declaration: Declaração de uso de inteligência artificial
+advisor: Orientador
+program: Programa
+faculty: Faculdade
+page_abbr: p.
+work_undergraduate_thesis: Trabalho de conclusão de curso
+work_degree_project: Projeto de graduação
+work_monograph: Monografia
+work_master_thesis: Dissertação de mestrado
+work_doctoral_dissertation: Tese de doutorado
+evidence_law: Lei
+evidence_standard: Norma técnica
+evidence_dataset: Conjunto de dados
+evidence_thesis: Tese
+evidence_preprint: Preprint

package/templates/typst/thesis.typ

@@ -0,0 +1,276 @@
+// Thesis template (spec 10.3). `make` returns the functions main.typ uses; it never reads the
+// workspace. Layout values come from a presentation profile (profiles/*.typ); text labels from the
+// i18n strings. Generated main.typ calls: setup, cover, front, body-mode, annex-mode, t-figure,
+// t-table and references.
+
+#let font-stacks = (
+  serif: ("Libertinus Serif", "New Computer Modern"),
+  sans: ("Liberation Sans", "Arimo", "DejaVu Sans", "Libertinus Serif"),
+  institutional: ("Libertinus Serif",),
+)
+
+#let make(meta, profile, strings) = {
+  let paper = if meta.paper == "a4" { "a4" } else { "us-letter" }
+  let size = profile.font-size
+  let multiple = if meta.lineSpacing != none { meta.lineSpacing } else { profile.line-spacing }
+  // Typst's default leading (0.65em) is single spacing; each extra line of spacing adds ~1.2em.
+  let leading = 0.65em + (multiple - 1) * 1.2em
+  let body-fonts = {
+    let base = font-stacks.at(meta.fontProfile, default: font-stacks.serif)
+    let named = if meta.bodyFont != none { meta.bodyFont } else { profile.font.body }
+    if named != none { (named,) + base } else { base }
+  }
+  let lang = meta.languageCode
+  let region = if "region" in meta { meta.region } else { none }
+  let margins = profile.margins
+  let heading-font = if profile.font.headings != none { (profile.font.headings,) + body-fonts } else { body-fonts }
+
+  let page-footer(fmt) = context {
+    if fmt == none { none } else {
+      align(profile.page-numbers.position, counter(page).display(fmt))
+    }
+  }
+
+  let page-header() = context {
+    if profile.header == none { none } else {
+      let here-page = here().page()
+      let starts = query(heading.where(level: 1)).any(h => h.location().page() == here-page)
+      let current = query(heading.where(level: 1).before(here()))
+      if starts or current.len() == 0 { none } else {
+        set text(size: 0.85 * size, style: "italic")
+        align(right, current.last().body)
+        v(-0.4em)
+        line(length: 100%, stroke: 0.4pt)
+      }
+    }
+  }
+
+  // Float numbers are computed by the emitter and passed in as (chapter, index-in-chapter,
+  // sequence): numbering functions that read counters would be evaluated at the reference site.
+  let float-label(number) = {
+    let (chapter, index, sequence) = number
+    if profile.captions.per-chapter and chapter != none { [#chapter.#index] } else { [#sequence] }
+  }
+  let float-numbering(number) = _ => float-label(number)
+  let num-eq(chapter, index, sequence) = _ => [(#float-label((chapter, index, sequence)))]
+
+  // Heading numbers follow the pattern of each level (for example `1.1.1`).
+  let heading-number(..nums) = {
+    let level = calc.min(nums.pos().len(), 4)
+    numbering(profile.headings.at(level - 1).numbering, ..nums)
+  }
+
+  let heading-style(it) = {
+    let level = calc.min(it.level, 4)
+    let spec = profile.headings.at(level - 1)
+    let titled = if spec.case == "upper" { upper(it.body) } else if spec.case == "lower" { lower(it.body) } else { it.body }
+    let number = if it.numbering != none { [#counter(heading).display(it.numbering)#h(0.6em)] }
+    if spec.run-in {
+      // Run-in heading: inline output joins the first line of the following paragraph.
+      text(size: spec.size, weight: spec.weight, hyphenate: false, font: heading-font)[#number#titled#spec.ends-with#h(0.4em)]
+    } else {
+      if level == 1 and spec.new-page { pagebreak(weak: true) }
+      block(width: 100%, above: spec.above, below: spec.below, sticky: true)[
+        #set text(size: spec.size, weight: spec.weight, hyphenate: false, font: heading-font)
+        #set align(spec.align)
+        #set par(first-line-indent: 0pt, justify: false)
+        #number#titled
+      ]
+    }
+  }
+
+  let setup(body) = {
+    set document(title: meta.title, author: meta.authors)
+    set text(lang: lang, region: region, font: body-fonts, size: size, hyphenate: true)
+    set par(
+      justify: profile.paragraph.justify,
+      leading: leading,
+      spacing: profile.paragraph.spacing,
+      first-line-indent: profile.paragraph.indent,
+    )
+    set page(paper: paper, margin: margins)
+    set heading(numbering: heading-number, supplement: strings.section)
+    set math.equation(supplement: strings.equation)
+    set figure.caption(separator: profile.captions.separator)
+    show figure.where(kind: image): set figure(supplement: strings.figure)
+    show figure.where(kind: table): set figure(supplement: strings.table)
+    show figure.where(kind: table): set figure.caption(position: profile.captions.table)
+    show figure.where(kind: image): set figure.caption(position: profile.captions.figure)
+    show figure.caption: it => {
+      set par(justify: false, first-line-indent: 0pt)
+      set text(size: size * 0.9)
+      if profile.captions.label-style == "plain" { it } else {
+        let label = [#it.supplement#sym.space.nobreak#context it.counter.display(it.numbering)#it.separator]
+        if profile.captions.label-style == "bold" { strong(label) } else { emph(label) }
+        it.body
+      }
+    }
+    show footnote.entry: set text(size: profile.footnote-size * 1pt)
+    show raw: it => if profile.font.mono != none {
+      set text(font: (profile.font.mono, "DejaVu Sans Mono", "Liberation Mono"))
+      it
+    } else { it }
+    show figure: set block(breakable: false)
+    show heading: heading-style
+    show raw.where(block: true): it => block(fill: luma(245), inset: 8pt, radius: 2pt, width: 100%, it)
+    show link: set text(fill: rgb("#0b4f8a"))
+    show quote.where(block: true): set pad(left: 1cm)
+    show table: set text(size: size * 0.9)
+    show table: set par(justify: false, first-line-indent: 0pt)
+    set table(
+      stroke: (x, y) => (
+        top: if y == 0 { 0.8pt } else if y == 1 { 0.5pt } else { 0pt },
+        bottom: 0.8pt,
+      ),
+      inset: (x: 6pt, y: 4pt),
+    )
+    body
+  }
+
+  // Source line next to a figure or table, below it or inside the caption (profile choice).
+  let with-source(content, source) = if source == none { content } else {
+    set text(size: size * 0.9)
+    set par(first-line-indent: 0pt, justify: false)
+    align(left, source)
+  }
+
+  // The source line either sits below the float (inside its body) or closes the caption. In the
+  // second case it is marked <float-source> so the lists of figures and tables can leave it out.
+  let float(body, caption, source, number, kind) = {
+    let numbering = float-numbering(number)
+    if source != none and profile.captions.source-below {
+      figure(stack(spacing: 0.8em, body, with-source(none, source)), caption: caption, kind: kind, numbering: numbering)
+    } else if source != none {
+      figure(body, caption: [#caption #box(source) <float-source>], kind: kind, numbering: numbering)
+    } else {
+      figure(body, caption: caption, kind: kind, numbering: numbering)
+    }
+  }
+  let t-figure(body, caption: none, source: none, number: (none, 1, 1)) = float(body, caption, source, number, image)
+  let t-table(body, caption: none, source: none, number: (none, 1, 1)) = float(body, caption, source, number, table)
+
+  // A vector image at its natural size, shrunk to the text block when it would overflow.
+  let t-image(path, natural) = layout(size => align(center, image("/" + path, width: calc.min(size.width, natural))))
+
+  let cover() = {
+    let org = meta.institution
+    let place = if profile.cover.layout == "left" { left } else { center }
+    let cline(content, ..args) = if content != none and content != "" {
+      align(place, text(..args, content))
+      v(0.6em)
+    }
+    // Fields in the same group stay together; the gaps between groups stretch.
+    let groups = (institution: 0, faculty: 0, program: 0, title: 1, subtitle: 1, workType: 2, authors: 2, advisors: 2, cityYear: 3)
+    let gaps = (2fr, 1.5fr, 2fr)
+    let field(name) = {
+      if name == "institution" { cline(org.name, size: 1.15 * size, weight: "bold") }
+      else if name == "faculty" { cline(org.faculty, size: size) }
+      else if name == "program" { cline(org.program, size: size) }
+      else if name == "title" { align(place, text(size: 1.7 * size, weight: "bold", meta.title)) }
+      else if name == "subtitle" { if meta.subtitle != none { v(0.8em); cline(meta.subtitle, size: 1.2 * size) } }
+      else if name == "workType" { cline(strings.at("work_" + meta.workType, default: meta.workType), size: size) }
+      else if name == "authors" { for author in meta.authors { cline(author, size: 1.1 * size, weight: "bold") } }
+      else if name == "advisors" { for advisor in meta.advisors { cline([#strings.advisor: #advisor.name], size: size) } }
+      else if name == "cityYear" { cline(if org.city != none { [#org.city, #meta.year] } else { str(meta.year) }, size: size) }
+    }
+    page(numbering: none, margin: margins, header: none, footer: none)[
+      #set par(first-line-indent: 0pt, justify: false, leading: 0.65em)
+      #set text(hyphenate: false)
+      #v(1fr)
+      #{
+        let previous = none
+        for name in profile.cover.fields {
+          let group = groups.at(name)
+          if previous != none and group != previous { v(gaps.at(calc.min(previous, 2))) }
+          previous = group
+          field(name)
+        }
+      }
+    ]
+  }
+
+  let unnumbered(title, body, outlined: true) = {
+    heading(level: 1, numbering: none, outlined: outlined, title)
+    body
+  }
+
+  let list-of(title, kind) = context {
+    if query(figure.where(kind: kind)).len() > 0 {
+      pagebreak(weak: true)
+      heading(level: 1, numbering: none, outlined: false, title)
+      {
+        show <float-source>: none
+        outline(title: none, target: figure.where(kind: kind))
+      }
+    }
+  }
+
+  let front(dedication: none, acknowledgments: none, ai-declaration: none, abstracts: ()) = {
+    let fmt = profile.page-numbers.front
+    set page(numbering: fmt, footer: page-footer(fmt), header: none)
+    if profile.page-numbers.restart-front { counter(page).update(1) }
+    set par(first-line-indent: 0pt)
+    let parts = (
+      dedication: () => if dedication != none { unnumbered(strings.dedication, dedication, outlined: false) },
+      acknowledgments: () => if acknowledgments != none { unnumbered(strings.acknowledgments, acknowledgments) },
+      ai-declaration: () => if ai-declaration != none { unnumbered(strings.ai_declaration, ai-declaration) },
+      abstract: () => for a in abstracts {
+        set text(lang: a.lang)
+        unnumbered(a.title, {
+          a.body
+          if a.keywords.len() > 0 [
+            #v(0.6em)
+            #strong[#a.keywords-label:] #a.keywords.join(", ")
+          ]
+        })
+      },
+      toc: () => {
+        heading(level: 1, numbering: none, outlined: false, strings.contents)
+        if profile.toc-page-label { align(right, strong(strings.page_abbr)) }
+        outline(title: none, depth: profile.toc-depth)
+        pagebreak(weak: true)
+        list-of(strings.list_of_figures, image)
+        list-of(strings.list_of_tables, table)
+      },
+    )
+    for name in profile.front-order {
+      (parts.at(name))()
+    }
+  }
+
+  let body-mode(body) = {
+    let fmt = profile.page-numbers.body
+    set page(numbering: fmt, footer: page-footer(fmt), header: page-header())
+    if profile.page-numbers.restart-body { counter(page).update(1) }
+    set par(first-line-indent: profile.paragraph.indent)
+    body
+  }
+
+  let annex-mode(body) = {
+    set heading(numbering: profile.annex-numbering, supplement: strings.annex)
+    pagebreak(weak: true)
+    counter(heading).update(0)
+    body
+  }
+
+  let references(style) = {
+    pagebreak(weak: true)
+    set par(first-line-indent: 0pt, justify: false)
+    set heading(numbering: none)
+    show bibliography: set par(spacing: 1.2em)
+    bibliography("/references.bib", style: style, title: strings.references)
+  }
+
+  (
+    setup: setup,
+    cover: cover,
+    front: front,
+    body-mode: body-mode,
+    annex-mode: annex-mode,
+    t-figure: t-figure,
+    t-table: t-table,
+    t-image: t-image,
+    num-eq: num-eq,
+    references: references,
+  )
+}