src/papers/guide.md

# Research papers templates

Three templates for scholarly papers: an IEEE conference paper (`charged-ieee`), an AMS mathematics
article (`unequivocal-ams`) and an arXiv-style preprint (`arkheion`). A page uses one of them; check
its header to see which, and use only that template's section below.

## Templates

### IEEE paper
`charged-ieee` 0.1.4. Two-column IEEE layout. Parameters of `ieee`:
- `title` (`[Paper Title]`), `abstract` (`none`), `index-terms` (`()`, shown after the abstract).
- `authors` (`()`): dictionaries with `name` and optional `department`, `organization`, `location`,
  `email`.
- `paper-size` (`"us-letter"`), `bibliography` (`none`), `figure-supplement` (`[Fig.]`, the word
  used when referring to image figures).

### AMS article
`unequivocal-ams` 0.1.2. One-column American Mathematical Society style. Parameters of
`ams-article`:
- `title` (`[Paper title]`), `abstract` (`none`), `paper-size` (`"us-letter"`), `bibliography` (`none`).
- `authors` (`()`): dictionaries with `name` and optional `department`, `organization`, `location`,
  `email`, `url`. Affiliations and emails are printed at the end of the article.

### Preprint
`arkheion` 0.1.2. One-column arXiv-style preprint. Parameters of `arkheion`:
- `title` (`""`), `abstract` (`none`), `keywords` (`()`), `date` (`none`).
- `authors` (`()`): dictionaries with `name`, `email`, `affiliation` and optional `orcid`.
- `custom-authors` (`none`): content that replaces the author block.

These values live in the header. Write the page body below it.

## Writing a page

All three print the title, authors and abstract from the header. Do not repeat them in the body.
Label things with `<name>` and refer to them with `@name`.

### IEEE paper
- `=` is a section: centred small caps, numbered `I.`, `II.`. A section titled `Acknowledgment`
  (or `Acknowledgement(s)`) is not numbered.
- `==` is a subsection: italic, numbered `A.`. `===` is a run-in italic heading numbered `a)`.
- Text is two columns, 10pt, justified. Numbered lists use `1)`, `a)`, `i)`.
- Block equations are numbered `(1)`; `@eq` prints just `(1)`.
- Image figures are captioned `Fig. 1.`; table figures `TABLE I` with the caption above.
- A figure can float with `placement: top` or `bottom`; add `scope: "parent"` to span both columns.
- References use the IEEE style with the title "References". The bibliography appears only if a
  `.bib` file is set in the header or written as `#bibliography("file.bib")` at the end of the body.

### AMS article
- `=` is a section: centred small caps, numbered `1.`. `==` is a bold run-in heading (`1.1. Title.`),
  `===` an italic run-in heading.
- Block equations are not numbered.
- Figure captions read `Figure 1. Caption`, tables `Table 1. Caption`, with small-caps labels.
- Use `theorem` and `proof` (see Helpers) for results. Theorem numbering restarts at every `=`.
- References use the `springer-mathphys` style with the title "References".

### Preprint
- Headings are numbered `1`, `1.1`, `1.1.1`. `====` and deeper become bold run-in paragraph
  headings without a number.
- Block equations are numbered `(1)`. For one unnumbered equation use
  `#math.equation(block: true, numbering: none, $ ... $)`.
- Page numbers are centred at the bottom.
- Use plain `#figure(table(...), caption: [...])` and `#figure(image(...), caption: [...])`.
- Appendices go at the very end with `arkheion-appendices` (see Helpers).

## Helpers

### IEEE paper
The header imports only `ieee`. There are no helpers; use plain markup.
```typ
= Introduction
Typesetting slows researchers down.

== Overview
We measure the effect in @tab:times and derive @eq:speed.

$ v = d / t $ <eq:speed>

#figure(
  table(
    columns: 2,
    table.header[System][Time (s)],
    [A], [12],
    [B], [7],
  ),
  caption: [Compile times],
) <tab:times>

= Acknowledgment
We thank our colleagues.
```

### AMS article
The header imports `ams-article`, `theorem` and `proof`.

`theorem(body, numbered: true)`: a numbered theorem with a bold "Theorem" label and italic text.
Pass `numbered: false` for no number. Label it to refer to it.
```typ
= Results
#theorem[
  The square of any real number is non-negative.
] <thm:square>

#theorem(numbered: false)[Every bounded monotone sequence converges.]
```

`proof(body)`: an italic "Proof." label and the body, ending with a square at the right margin.
```typ
#proof[
  If $x >= 0$ then $x^2 = x x >= 0$. If $x < 0$ then $x^2 = (-x)^2 > 0$.
]
```

There are no lemma or definition helpers. Write those as a normal paragraph, e.g.
`*Definition.* A set is ...`.

### Preprint
The header imports `arkheion` and `arkheion-appendices`.

`arkheion-appendices`: apply as a show rule after the main text. It starts a new page and renumbers
headings: `=` becomes `APPENDIX A`, `B`, ... and `==` becomes `A.1`. Everything after it is appendix,
so put it last.
```typ
= Conclusion
The method works.

#show: arkheion-appendices
= Proofs
== Proof of the main lemma
The argument follows.
```

## Do not
- Do not add `#set page`, `#set text`, `#set par`, `#set heading` or font changes; the template sets
  them.
- Do not pick your own colours (`fill:`, `rgb(...)`, `text(fill: ...)`).
- Do not draw your own boxes or blocks for theorems, proofs, abstracts or keywords: the header prints
  the abstract, and AMS has `theorem` and `proof`.
- Do not remove or edit the template header between `// znote:template` and `// znote:end`.
- Do not write the title, author names or abstract again in the body.
- Do not number headings by hand (`= 1. Introduction`); numbering is automatic.
- Do not use helpers from another template: `theorem` and `proof` exist only in AMS article,
  `arkheion-appendices` only in Preprint.
- Do not add `#bibliography(...)` or `@citations` unless the user has a `.bib` file.
- Preprint: use `#show: arkheion-appendices` at most once.