Skip to content

Align charged-ieee with IEEEtran conference mode - #95

Closed
charlesbmi wants to merge 4 commits into
typst:mainfrom
charlesbmi:fix/charged-ieee-ieeetran-conference
Closed

charlesbmi wants to merge 4 commits into
typst:mainfrom
charlesbmi:fix/charged-ieee-ieeetran-conference

Conversation

@charlesbmi

Copy link
Copy Markdown

Motivation

charged-ieee is meant to match IEEE conference proceedings, but several layout details still differ from \documentclass[conference]{IEEEtran}. IEEE’s own conference kit says to use that class in conference mode, and the June 2024 LaTeX zip still ships IEEEtran.cls V1.8b (2015-08-26) — the same class, not a newer geometry.

This PR takes that class as the source of truth.

Related: #85, #87. #50 already moved some metrics toward IEEEtran (interword spacing, heading size 12pt → 11pt) using V1.8b as the reference.

Summary

Four focused commits:

  1. Page metrics — letter/A4 margins were the original 2023 Typst approximation (50pt/216mm, …) and were never updated from IEEEtran. Use the conference-mode text block: \textwidth 43pc, \textheight 9.25in, top 0.75in, \columnsep 1pc. A4 keeps that block and only changes leftover margins (as the class documents).
  2. Section heading size — IEEEtran conference \section is \normalfont\normalsize\scshape (10pt). Get closer to the standard IEEE conference template #50 went 12pt → 11pt; this finishes the step to 10pt.
  3. Cross-references — heading display was already I. / A.; refs used I.A.a) and printed Section II.B. IEEEtran \thesubsection is I-A.
  4. Third-level markersMake style closer to IEEE template #31 switched run-in subsubsections from 1) to a). That was intentional but it does not match \thesubsubsectiondis (1)). Restores the pre-Make style closer to IEEE template #31 form. Fixes charged-ieee: incorrect 3rd level heading format #85.

Out of scope

  • Version bump (typst.toml / template import): maintainers bump that on release (Get closer to the standard IEEE conference template #50 review).
  • Thumbnail refresh.
  • Author-side manuscript issues (ALL-CAPS heading source, abstract special characters, draft footers).
  • Matching TeX’s line-quantization fudge of the 9.25in \textheight (integer lines per column). The documented 0.75in / 9.25in / 1in letter box is used instead.

History: stale vs intentional

Delta When it landed Intentional IEEE choice? Verdict
Letter/A4 margins Original 2023-03-27 (81fad3d) No citation of IEEEtran Stale approximation
12pt → 11pt section heads #50 (2024-10, j95io), citing IEEEtran V1.8b Yes, toward the class Incomplete — class is 10pt
I.A.a) numbering / Section II.B refs #31 (2024-04) Yes, “closer to IEEE” Wrong form — refs should be I-A; display third level should be 1)
1)a) subsubsection #31, on top of an earlier 1) Yes, but opposite of IEEEtran Regression vs the class and the HOWTO

#87 also aims at IEEE fidelity but uses the IEEE-IES 2016 Word margin sheet (0.625in sides, 0.25in gutter). That is the Word kit, not IEEEtran conference mode (43pc text, 1pc gutter). This PR keeps the 12pt gutter from #52 and does not take that Word geometry.

References

Validation

  • Local Typst compile of a probe document importing charged-ieee/lib.typ (Typst 0.14.2)
  • Local Typst compile of charged-ieee/template/main.typ rewritten to import the local lib.typ (2 pages, US Letter)
typst compile charged-ieee/_probe.typ /tmp/charged-ieee-local.pdf
pdftotext -layout /tmp/charged-ieee-local.pdf -

Observed:

  • Page size 612 × 792 pt (letter)
  • Left text edge 48 pt = 0.667 in (IEEEtran side margin (8.5in − 43pc) / 2)
  • Cross-refs print Section I-A and Section II (not Section I.A)
  • Run-in third-level head prints 1) Detail:
  • Sample still shows I. Introduction, A. Paper overview, Fig. 1, TABLE I, Section II

The letter/A4 margins were the original 2023 Typst approximation and were
never taken from IEEEtran.cls. IEEE's 2024 conference zip still ships that
class (V1.8b), so use its conference-mode text block: 43 pc × 9.25 in,
0.75 in top, 1 pc gutter.
IEEEtran conference mode sets \section to \normalsize\scshape (10pt). The
template started at 12pt and typst#50 moved it to 11pt as a visual step toward
the class; finish that step.
Heading display already uses I. / A., but refs took the numbering pattern
I.A.a), which prints Section II.B. IEEEtran's \thesubsection is I-A.
typst#31 switched the run-in subsubsection marker from 1) to a), but IEEEtran
\thesubsubsectiondis is arabic 1). Restores the pre-typst#31 form and matches
the HOWTO.
@laurmaedje

Copy link
Copy Markdown
Member

While I appreciate the intent to align the template with guidelines, we do not accept PRs that are implemented or described with AI. This is currently unfortunately only spelled out in our main repository's CONTRIBUTING.md.

@laurmaedje laurmaedje closed this Sep 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

charged-ieee: incorrect 3rd level heading format

2 participants