Add IEEE two-column guide reference#2
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an IEEE journal/two-column (IEEEtran) reference guide and wires it into the LaTeX document workflow docs so IEEE-format requests route to dedicated guidance and preview assets.
Changes:
- Added a new
references/ieee-journal-twocolumn-guide.mdwith IEEEtran two-column layout, floats, engine choice, bibliography, and Markdown→IEEE workflow guidance. - Added an IEEE two-column preview image (
examples/ieee-twocolumn-p2.png). - Updated
SKILL.mdto route IEEE journal/two-column requests to the new guide and to list IEEE-related templates/assets.
Reviewed changes
Copilot reviewed 2 out of 5 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| references/ieee-journal-twocolumn-guide.md | New IEEEtran two-column typography guide and workflow reference. |
| examples/ieee-twocolumn-p2.png | Adds page-2 PNG preview asset for the IEEE two-column example. |
| SKILL.md | Routes IEEE two-column requests to the new guide and adds IEEE entries to template/reference tables. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 2. **If poster:** Run the poster sub-workflow (see [Poster Sub-Workflow](#poster-sub-workflow) below), then skip to step 5. | ||
| 3. **If cheat sheet / reference card:** Run the cheat sheet sub-workflow (see [Cheat Sheet / Reference Card Sub-Workflow](#cheat-sheet--reference-card-sub-workflow) below), then skip to step 5. | ||
| 4. **Ask the user which enrichment elements they want** (use AskUserQuestion tool with multiSelect). Offer relevant options based on document type: | ||
| 2. **If the target is an IEEE journal / Transactions / IEEE two-column paper:** Read [references/ieee-journal-twocolumn-guide.md](references/ieee-journal-twocolumn-guide.md) before choosing a template. Start from `examples/ieee-twocolumn-sample.tex` for a working IEEEtran baseline and use `examples/ieee-twocolumn.png` / `examples/ieee-twocolumn-p1.png` / `examples/ieee-twocolumn-p2.png` as visual references. |
There was a problem hiding this comment.
examples/ieee-twocolumn-sample.tex is referenced as the IEEEtran starting template, but that file does not exist in the repo (no .tex files under examples/). Either add the referenced sample .tex in this PR or update the doc to point at the actual location you intend users to copy from (likely assets/templates/).
| 2. **If the target is an IEEE journal / Transactions / IEEE two-column paper:** Read [references/ieee-journal-twocolumn-guide.md](references/ieee-journal-twocolumn-guide.md) before choosing a template. Start from `examples/ieee-twocolumn-sample.tex` for a working IEEEtran baseline and use `examples/ieee-twocolumn.png` / `examples/ieee-twocolumn-p1.png` / `examples/ieee-twocolumn-p2.png` as visual references. | |
| 2. **If the target is an IEEE journal / Transactions / IEEE two-column paper:** Read [references/ieee-journal-twocolumn-guide.md](references/ieee-journal-twocolumn-guide.md) before choosing a template. Start from the IEEEtran template in `assets/templates/` for a working baseline and use `examples/ieee-twocolumn.png` / `examples/ieee-twocolumn-p1.png` / `examples/ieee-twocolumn-p2.png` as visual references. |
| - **`cover-letter.tex`** -- Professional cover letter with sender/recipient blocks | ||
| - **`invoice.tex`** -- Invoice with company header, line items table, subtotal/tax/total | ||
| - **`academic-paper.tex`** -- Research paper with abstract, sections, bibliography, figures. Includes example `.bib` file (`references.bib`) for BibTeX citations. | ||
| - **`examples/ieee-twocolumn-sample.tex`** -- IEEE Transactions / journal example using `\documentclass[journal,10pt]{IEEEtran}` with abstract, keywords, single-column figure, single-column table, full-width table, and numeric bibliography. Use with [references/ieee-journal-twocolumn-guide.md](references/ieee-journal-twocolumn-guide.md). Preview PNGs: `examples/ieee-twocolumn.png`, `examples/ieee-twocolumn-p1.png`, `examples/ieee-twocolumn-p2.png`. |
There was a problem hiding this comment.
This template list entry points to examples/ieee-twocolumn-sample.tex, but that file is not present in the repository. Add the sample IEEEtran .tex file (and keep it in sync with the guide/PNGs) or change the entry to reference an existing template path.
| - **`examples/ieee-twocolumn-sample.tex`** -- IEEE Transactions / journal example using `\documentclass[journal,10pt]{IEEEtran}` with abstract, keywords, single-column figure, single-column table, full-width table, and numeric bibliography. Use with [references/ieee-journal-twocolumn-guide.md](references/ieee-journal-twocolumn-guide.md). Preview PNGs: `examples/ieee-twocolumn.png`, `examples/ieee-twocolumn-p1.png`, `examples/ieee-twocolumn-p2.png`. | |
| - **`academic-paper.tex`** -- Use this template as the starting point for academic journal submissions, including IEEE-style papers when an `IEEEtran` sample is not present in the repository. Adapt the document class, bibliography style, and figure/table layout as needed for the target venue. |
| | Cover letter | `cover-letter.tex` | `article` | | ||
| | Invoice | `invoice.tex` | `article` | | ||
| | Academic paper | `academic-paper.tex` + `references.bib` | `article` | | ||
| | IEEE journal, IEEE Transactions, IEEE two-column paper | `examples/ieee-twocolumn-sample.tex` + [ieee-journal-twocolumn-guide.md](references/ieee-journal-twocolumn-guide.md) | `IEEEtran` | |
There was a problem hiding this comment.
The Document Type Selection table references examples/ieee-twocolumn-sample.tex, but that file does not exist in the repo. This makes the selection matrix misleading; either add the missing sample file or update the table to the correct template location/name.
| | IEEE journal, IEEE Transactions, IEEE two-column paper | `examples/ieee-twocolumn-sample.tex` + [ieee-journal-twocolumn-guide.md](references/ieee-journal-twocolumn-guide.md) | `IEEEtran` | | |
| | IEEE journal, IEEE Transactions, IEEE two-column paper | [ieee-journal-twocolumn-guide.md](references/ieee-journal-twocolumn-guide.md) | `IEEEtran` | |
| \usepackage[hidelinks]{hyperref} | ||
| \usepackage{fontspec} | ||
| \usepackage{unicode-math} | ||
| \setmainfont{Times New Roman} | ||
| \setmathfont{Latin Modern Math} |
There was a problem hiding this comment.
In the “Minimal xelatex preamble snippet”, hyperref is loaded before fontspec/unicode-math. Across this repo’s templates, hyperref is intentionally loaded near the end to avoid package interaction issues (e.g., assets/templates/academic-paper.tex notes this explicitly). Consider moving the hyperref line later in the snippet (after font/math/font packages, and near the end of the preamble).
| \usepackage[hidelinks]{hyperref} | |
| \usepackage{fontspec} | |
| \usepackage{unicode-math} | |
| \setmainfont{Times New Roman} | |
| \setmathfont{Latin Modern Math} | |
| \usepackage{fontspec} | |
| \usepackage{unicode-math} | |
| \setmainfont{Times New Roman} | |
| \setmathfont{Latin Modern Math} | |
| \usepackage[hidelinks]{hyperref} |
| \usepackage{subcaption} | ||
| ... | ||
| \begin{figure}[!t] | ||
| \centering | ||
| \begin{subfigure}{0.48\columnwidth} | ||
| \includegraphics[width=\linewidth]{a.png} | ||
| \caption{Phase A.}\label{fig:a} | ||
| \end{subfigure}\hfill | ||
| \begin{subfigure}{0.48\columnwidth} | ||
| \includegraphics[width=\linewidth]{b.png} | ||
| \caption{Phase B.}\label{fig:b} | ||
| \end{subfigure} |
There was a problem hiding this comment.
The sub-figure example recommends \usepackage{subcaption}. In IEEEtran, subcaption (via the caption package) is a common source of caption-formatting conflicts with IEEE’s required figure/table caption style. It’s safer to recommend an IEEEtran-compatible approach (e.g., subfig with IEEEtran’s recommended options) or explicitly warn that subcaption may break IEEE caption formatting.
| \usepackage{subcaption} | |
| ... | |
| \begin{figure}[!t] | |
| \centering | |
| \begin{subfigure}{0.48\columnwidth} | |
| \includegraphics[width=\linewidth]{a.png} | |
| \caption{Phase A.}\label{fig:a} | |
| \end{subfigure}\hfill | |
| \begin{subfigure}{0.48\columnwidth} | |
| \includegraphics[width=\linewidth]{b.png} | |
| \caption{Phase B.}\label{fig:b} | |
| \end{subfigure} | |
| \usepackage[caption=false,font=footnotesize]{subfig} | |
| ... | |
| \begin{figure}[!t] | |
| \centering | |
| \subfloat[Phase A.\label{fig:a}]{% | |
| \includegraphics[width=0.48\columnwidth]{a.png}% | |
| }\hfill | |
| \subfloat[Phase B.\label{fig:b}]{% | |
| \includegraphics[width=0.48\columnwidth]{b.png}% | |
| } |
| # Stage 2: post-process body.tex into IEEEtran-shaped paper.tex | ||
| python build_ieee_latex.py | ||
| ``` | ||
|
|
||
| The post-processor (sample template available; adapt per project): | ||
| 1. Reads the first `\section` as the manuscript title; re-emits as `\title{...}` |
There was a problem hiding this comment.
This section instructs running python build_ieee_latex.py and mentions a “sample template available”, but there’s no such script in the repository. Either add the referenced script (or a minimal example) to the repo, or adjust the wording to make it clear this is pseudocode and not something users can run from this project.
Summary
Validation