PubSuite Classic

PubSuite Classic is a professional XML-to-PDF editor. You write your document in a structured XML format, style each element through the sidebar panels, and export a pixel-perfect PDF — with a live preview that matches the output exactly. It includes full mathematics typesetting and five specialised editor modes: Scientific Paper, Magazine Editor, Label Creator, Carousel Creator and Technical Docs.

Getting Started

The start screen has an Engine switch (Classic engine or NextGen engine, the Classic 2 editor) and six cards: Classic Editor plus the five modes. Pick a card to open the editor with that mode's templates and panel. See Editor Modes.

When the editor opens you see three main areas:

Sidebar
Controls
XML Editor
Source
Live Preview
PDF output
  • Sidebar — tabs for every document setting: Document, Styles, H/F, TOC, Footnotes, Assets, Mapping, Inline, Presets, plus the Math tab and the Mode tab (the current mode's panel and the settings shared by every mode).
  • XML Editor — Monaco-powered editor with syntax highlighting. Every change re-renders the preview in real time.
  • Live Preview — a canvas rendering that matches the exported PDF exactly. Click any text to edit it in place — paragraphs, table cells and footnotes.
Note: PubSuite Classic uses XML, not Markdown or HTML. The tag names you invent become your style names — <paragraph>, <heading1>, <pullquote> — and you style each one in the Typography panel. Markdown and LaTeX can be imported (see Technical Docs and LaTeX Import).

XML Editor

The editor uses Monaco (the engine behind VS Code) with full XML syntax highlighting, bracket matching, and auto-indentation.

Basic Document Structure

<?xml version="1.0"?>
<document>
  <heading1>Chapter One</heading1>
  <paragraph>Your text goes here, with a formula $e^{i\pi} + 1 = 0$.</paragraph>
  <heading2>A Sub-heading</heading2>
  <paragraph>More text.</paragraph>
</document>

Inline Markup

TagResultExample
<b>Bold<b>important</b>
<i>Italic<i>emphasis</i>
<u>Underline<u>link text</u>
<fn>Footnoteword<fn>This appears at the bottom.</fn>
$…$ / <math>Inline formula$x^2 + y^2$
<cite>, <xref>, <eqref>Citation, cross-reference, equation reference<cite key="knuth1984"/>
<code>, <kbd>Inline code, key cap<kbd>Ctrl</kbd>
<smallcaps>, <nobr>Small capitals, no line break<nobr>10 km</nobr>

Keyboard Shortcuts

ShortcutAction
Ctrl+ZUndo
Ctrl+Shift+ZRedo
Ctrl+FFind in editor
Ctrl+HFind & Replace
Ctrl+/Toggle comment
Alt+Shift+FFormat / pretty-print XML
Ctrl+MEquation editor — inline formula
Ctrl+Shift+MEquation editor — display equation
Ctrl+Shift+HArabic vowel-sign palette
Double-click a formulaEdit it in the equation editor

Live Preview & Editing

The preview renders your document exactly as it will appear in the exported PDF — same fonts, same layout engine, same measurements.

  • Click to edit in place — click any text to edit it directly without switching to the XML editor. A click goes to the block under the pointer, also in multi-column layouts, next to frames and in a label's second column.
  • Select a whole block — move the pointer into the free space where a block's lines start: the page margin for the first column, the gutter between columns for the others. The pointer turns into an arrow pointing at the text — to the right beside a left-to-right block, to the left in the right-hand margin of a right-to-left (Arabic, Hebrew) block, where a light stripe also marks the page's right edge; click to select the whole paragraph, heading or list item. Every column has its own selection bar.
  • Table cells — edited one by one: click, type, select inside the cell. Enter adds nothing to a cell.
  • Footnotes — edited where they are printed, at the foot of the page. The footnote mark in the text is generated, so typing, Enter and bold/italic land exactly where you click.
  • Formulas, citations and references behave as one character: a click puts the caret before or after them, and they disappear only when selected and deleted as a whole. Editing never turns a formula or a footnote into plain text.
  • Selection is drawn only over the characters of the element being edited — never over generated numbers, bullets or labels — and always reaches the last selected letter, also in bold, upper-case, letter-spaced or justified text. A paragraph that continues on the next page is highlighted on both pages.
  • Section and list numbers are generated: the caret never stops inside "1.2" or a bullet.
  • Generated text is lighter while editing — the header and footer, page numbers, section, list and equation numbers, labels such as Chapter 1 or Definition 1, bullets, the table of contents and other generated lists, citations, cross-references and footnote marks are drawn in grey, so the text you type stands out. They change elsewhere (H/F and Doc tabs, Mode tab, the citation list), not by typing in them. Exports are never dimmed.
  • Print preview — the printer button in the toolbar, or Ctrl+Alt+P, shows the pages exactly as they print: nothing grey, no caret, selection or editing handles. Press Esc or the button again to edit.
  • Zoom controls — use the − / + buttons, or Fit to fit the page width (or the spread in the Magazine Editor).
  • Page count — shown in the toolbar. Long documents paginate automatically.
  • Real-time update — the preview refreshes as you type, after a short debounce delay.

Document Panel

The Doc tab controls the page itself.

Page Size & Margins

Set width and height in mm, pt, or inches. Common presets include A4, A5, Letter, Legal, and book trim sizes. Margins can be set independently on all four sides.

Base Typography

  • Base font — default font for any tag without its own style. Built-in: Helvetica, Times-Roman, Courier.
  • Base size — default font size in pt.
  • Smart quotes — converts " and ' to typographic quotes.
  • Ligatures — enables fi, fl, ff ligature substitutions for uploaded OpenType fonts.
  • Top reference — controls whether line leading is measured from cap height, x-height, or full em.

Document Metadata

Title, author, subject, and language. These appear in PDF metadata and are available as {{title}} and {{author}} variables in headers and footers. The document language (Mode tab → Typography) also sets hyphenation, index sorting and the citation language.

Typography & Styles

The Styles tab defines how each XML tag looks. Every tag can have its own style. New tags from the editor modes come with sensible default styles, so you only style them when you want something different.

Style Properties

PropertyDescription
Font / SizeFont family and size in pt
Bold / ItalicWeight and style
ColorHex color for the text
AlignmentLeft, center, right, or justify
Line spacingMultiplier (1.0 = single, 2.0 = double)
Space before / afterVertical space around the block, in pt. Large type measures its space-before from its cap height
First-line indentIndent for the first line only, in pt
Left / Right indentBlock indent from the margin, in pt
HyphenationAuto-hyphenate long words at line breaks; language, minimum word length and characters before/after the hyphen (Advanced)
Advanced JustificationMin / Desired / Max word-space %, and extra letter spacing when justifying (see Justification)
Align to gridThe block joins the baseline grid
Keep with nextPrevents a page break between this block and the next
UppercaseForces all text to uppercase
Drop cap linesNumber of lines the first character spans
ColumnsNumber of text columns within this block
Running titleText to show in the header/footer for sections using this style
Section level / formatNumbering of headings: {1}, {1}.{2}; formats 1, i, a, I, A
BorderWidth and color of a rule around the block
PaddingSpace inside the border
Background colorFill color behind the block

Style Mapping

The Map tab lets you create tag aliases — e.g. map p → paragraph.

Inline Styles

The Inline tab defines styles for inline elements within a parent tag.

Presets

Ready-made document configurations for common use cases. Includes citation standards (Chicago, APA, MLA, Harvard, IEEE) and document structures (Novel, Report, Newsletter, Screenplay, Dissertation).

Apply Modes

  • Apply — applies everything: page size, margins, base typography, and all style definitions.
  • Page — applies only page size and margins.
  • Styles — applies only typography settings.

Preset Configurator

Click + New Preset to build a preset visually using intent cards, page size slider, margin and line-spacing controls, font style buttons, column count, and header/footer settings.

Each editor mode also has complete starter templates (Mode tab → Template → Load). See Editor Modes.

Table of Contents

The TOC tab generates an automatic table of contents from your headings. Choose which tags to include, configure per-level styles, and set the leader style (dots, lines, or none).

  • By default the TOC is inserted before the first page. Put <toc/> where you want it instead — for example after a title page — and it is printed there on a page of its own.
  • Page numbers are exact: the document is laid out again until every number is stable.
  • <heading1 numbered="false"> gives an unnumbered heading that still appears in the TOC.
  • Lists of figures, tables, listings and algorithms work the same way (see Notes, Glossaries & Index).
  • In the PDF every TOC entry is a link, and every heading is a bookmark.

Footnotes

Use the <fn> tag inline:

<paragraph>This claim is disputed<fn>See Johnson, 2019, p. 42.</fn>.</paragraph>

The FN tab controls font, separator rule, reference mark style, and line spacing.

  • Rich content — formatting, formulas ($…$, <math>), citations and references inside a footnote are typeset like body text.
  • Edit in place — click the footnote text at the foot of the page to edit it; double-click a formula inside it to open the equation editor.
  • Numbering (Mode tab → Footnotes & endnotes) — continuous, restart each page, or restart each chapter; marks 1 2 3, i ii iii, a b c or * † ‡.
  • Endnotes — <endnote> and <endnotes/>, see Notes, Glossaries & Index.
  • In the PDF a footnote mark is a link to its note.

Assets

Custom Fonts

Upload TTF or OTF font files. Once uploaded, the font name is available in the style editor. Ligatures and kerning are applied automatically. Fonts are embedded in the exported PDF. An uploaded font with an OpenType MATH table (Cambria Math, Asana Math, Fira Math, Libertinus Math …) also appears in the Math tab's font list.

Images

<image src="my-photo.jpg" width="120" height="80" />

Width and height are in points. Images are embedded in the PDF. For numbered figures with captions use <figure> (see Figures, Tables & Floats).

Arabic & Right-to-Left

Classic writes Arabic and Hebrew right to left and mixes them with Latin text in the same paragraph. Letter joining, ligatures and mark placement come from the font's own OpenType rules, on screen and in the PDF.

  • Amiri is built in — Regular, Bold, Italic and Bold Italic. It loads by itself when the document contains Arabic text or a style uses it, and it is listed in the style editor's font list. Arabic letters, Arabic punctuation (، ؛ ؟) and Arabic-Indic digits typed into a paragraph set in a Latin font are drawn in Amiri automatically; Hebrew uses an uploaded Hebrew font.
  • Paragraph direction — set by dir="rtl" or dir="ltr" on the element, by a language block such as <arabic>, or else by the paragraph's first letter. A right-to-left paragraph is set flush right (left alignment becomes right, the last line of justified text goes to the right) and its indent, border and padding are mirrored.
  • Mixed text — words are ordered with the Unicode bidirectional algorithm: Latin words and numbers inside Arabic read left to right in place, brackets are mirrored, and punctuation stays with its sentence.
  • Editing — the caret, click position and selection follow the text as drawn; in right-to-left text ← moves forward and → moves back. While you type, the caret of a right-to-left paragraph grows from its right edge.
  • PDF — Arabic words are shaped with the embedded font's OpenType features (joining forms, ligatures, mark positioning) and stay selectable and searchable. Spacing around brackets and digits is the font's own.

The vowel-sign tools appear only when the document contains Arabic text:

  • Show (Mode tab → Arabic vowel signs) — all vowel signs; none (hamza and madda stay, they are spelling); shadda only; all except case endings; the skeleton without dots; or the bare skeleton (rasm). Set it for the document, for a style (For a style), or for a passage with an attribute such as tashkeel="none" on any element. Only the drawing changes; the text keeps every mark.
  • Spelling conventions — As typed, or As the font's style writes them (naskh puts fathatan on the letter before alef). Attribute: tashkeel-conventions="style".
  • Vowel-sign palette — toolbar button حَ or Ctrl+Shift+H. Click just after a letter (or select letters); drag the palette by its title bar to move it. The palette shows that letter in its word in blue and lights up the signs it already has. Click a sign to add it, click it again to remove it; a vowel replaces the existing one; Remove marks clears them. ◄ next letter / previous ► step through the word. Marks are always kept in the correct order.
  • Below the signs the palette has the letters of the document's language, Normalise letters and Type in Latin letters — see Languages & Letters, which also covers searching with letter variants in Find & Replace.
Smart mark placement, moving marks by hand, the font's tashkeel options, Qurʾānic orthography and the Arabic templates are available in Classic 2.

AI Assistant

Click the AI button in the toolbar to open the AI drawer. The assistant makes changes to your document settings using natural language.

What the AI can do

  • Apply a citation style or document structure preset
  • Set page size and margins
  • Change base font, size, and line spacing
  • Edit style properties for any tag
  • Enable headers, footers, and page numbers
  • Enable the table of contents
  • Find and replace text in the document

Example prompts

Apply Chicago style 17th edition
Set page to A5 with 20mm margins
Make heading1 bold, 18pt, centered with 24pt space before
Enable page numbers in the footer centered
Add a table of contents for heading1 and heading2

PDF Export

Click ↓ PDF in the toolbar. All fonts and images are embedded. The layout engine that generates the PDF is the same one that renders the live preview — output matches exactly.

  • Formulas, barcodes and hazard symbols are exported as sharp vector outlines, with an invisible text layer so the PDF can be searched and copied.
  • Cross-references, citations, footnote marks and TOC entries are clickable links; headings become bookmarks.
  • Optional Tagged PDF (accessibility) and PDF/A-2 (archiving) — see PDF Output Options.
  • Label and carousel modes add their own exports (label sheets, PNG slides).
PDF export is available on paid plans. Trial users can use the live preview but cannot export.

Projects

  • Save — saves the current XML and all settings as a .json file: styles, Math tab, editor mode, mode settings, bibliography and shared settings (see Saved Project Data).
  • Load — opens a saved project file and restores everything exactly. Older projects load unchanged and get the defaults for new settings.
  • New — clears the editor and starts a blank document.
Projects are saved locally as files — they are not stored on the server.

XML Reference

Document Root

Every document must start with <?xml version="1.0"?> and have a single root element. By convention this is <document> but any name works.

Common Block Tags

Suggested tagTypical use
<paragraph>Body text
<heading1>Chapter title
<heading2>Section heading
<blockquote>Extended quotation
<pullquote>Highlighted quote
<caption>Image or figure caption
<bullet>Bulleted list item
<numbered>Numbered list item
<image>Embedded image
<equation>Numbered display equation
<figure>, <table>Numbered figure or table with caption
<codeblock>Highlighted code listing

The tags of every mode work in every document — see the sections under Both editors in the navigation, and General-purpose Tags.

Well-formed XML Rules

  • Every opening tag must have a closing tag
  • Self-closing tags end with />
  • Tags must be properly nested — they cannot overlap
  • Attribute values must be quoted
  • Use &amp; for &, &lt; for <, &gt; for > (also inside formulas: the alignment & of align is written &amp;)

Lengths in attributes accept mm, cm, in, pt, px or %. A bare number means points; % is relative to the available width.

Features in both editors Everything below works the same in Classic and Classic 2 unless noted.

Editor Modes

The start screen offers Classic Editor and five modes. Every mode works on both engines and opens with its own templates, styles and Mode-tab panel. The current mode is shown as a badge in the toolbar.

  • Changing mode — use ← Menu in the toolbar (or ← Back to menu in the Mode tab). It asks for confirmation and opens the start screen; picking a card starts that mode with a new document. ← Return to the open document goes back without changes. Save first if you need the current document.
  • Nothing is locked — every tag from every mode works in any document, and all panels stay available.
  • Templates — Mode tab → Template → Load replaces the document with a complete template: all settings are reset first, so nothing is left over. Uploaded images and fonts stay.
ModeTemplates
Scientific PaperJournal article (A4) · Two-column conference paper (Letter) · Thesis / dissertation
Magazine EditorFeature spread · Newsletter
Label CreatorChemical product (GHS/CLP) · Food product (EU 1169/2011) · Shipping 4 × 6 in · Pallet A5 · Shelf-edge strips · Label strips · Cable wraps · Rack locations · Asset tags · File spines · Address labels
Carousel CreatorTips carousel · Story / case study
Technical DocsAPI reference · User manual

Classic 2 additionally offers Arabic versions of the templates (see Bilingual & RTL).

The templates are complete examples about PubSuite and TeX: the scientific ones typeset mathematics with a figure of the Gaussian curve (plot.png, added to Assets with the template — replace it with your own image), the magazine feature is about grids and TeX's line breaking, the newsletter is PubSuite project news, the carousel case study moves a lab from LaTeX templates to PubSuite, the API reference documents an example typesetting service (XML in, PDF out — not a real service), and the user manual explains PubSuite itself. The labels carry example product data.

Settings shared by every mode appear below the mode's panel, in collapsible sections:

SectionSettings
TypographyDocument language, hyphenation exceptions, baseline grid; Classic 2: collision fixing
Arabic vowel signsShow, placement, Qurʾān mode … (Classic: Show only)
Footnotes & endnotesNumbering (continuous / per page / per chapter), chapter tag, mark styles, endnotes title
FloatsLet figures and tables float; top and bottom shares; space around floats
TablesGrid or booktabs rules; repeat header rows; "continued" label
Glossary, acronyms & indexFirst-use form, titles, page numbers, index columns and letter headings
PDF outputClickable links, Tagged PDF, PDF/A-2

Mathematics

Formulas are typeset with TeX's rules and the font's OpenType MATH data, in the preview and as vector outlines in the PDF.

Writing Formulas

FormResult
$x^2$, \(x^2\) or <math>x^2</math>Inline formula
$$…$$ or \[…\] inside textDisplay-style formula kept in the line
<equation>…</equation>Numbered display equation
<equation*>, <displaymath>, block-level <math>Unnumbered display equation
<math><mrow>…</mrow></math>Presentation MathML
<eqref ref="id"/>Equation reference: (3)
<paragraph>Euler's identity $e^{i\pi} + 1 = 0$ links five constants.</paragraph>

<equation id="eq:gauss">\int_{-\infty}^{\infty} e^{-x^2}\,dx = \sqrt{\pi}</equation>

<equation env="align">
  a &amp;= b + c \label{eq:first} \\
  d &amp;= e + f \notag
</equation>

Write \$ for a literal dollar sign. In XML, & is written &amp; and < as &lt;.

Equation Attributes

AttributeMeaning
id (or label)Label for <eqref>, <xref> and \eqref{…}
envalign, gather, multline, alignat, flalign, eqnarray (and starred forms)
numbered="false" / nonumberNo number
tagCustom label, e.g. tag="*" gives (*)
aligncenter or left for this equation

Supported TeX

  • Structures — fractions (\frac \dfrac \tfrac \cfrac \genfrac), binomials, roots, scripts and primes, \sideset \overset \underset \stackrel \substack \limits \nolimits.
  • Operators — big operators with limits, integrals with italic correction, named operators (\sin \lim \argmax …), \operatorname, \DeclareMathOperator, \bmod \pmod.
  • Delimiters — \left … \middle … \right with all standard delimiters, \big … \Bigg; they stretch with the font's size variants and glyph assemblies.
  • Accents — all standard and wide accents, over/under arrows, braces and brackets with labels, \overline \underline; stretchy arrows \xrightarrow[below]{above} and relatives.
  • Environments — matrices (pmatrix bmatrix vmatrix …), cases, array, aligned gathered split, align gather multline …, rules (\hline \toprule \midrule), \intertext; page breaks between rows of align.
  • Per-row control — \tag \tag* \label \notag \nonumber; \ref and \eqref inside formulas.
  • Letter styles — \mathrm \mathbf \boldsymbol \mathcal \mathscr \mathfrak \mathbb \mathsf \mathtt and more, mapped to Unicode so copied text keeps the style.
  • Text and spacing — \text \textbf \emph \mbox, all TeX spaces, \phantom \smash \raisebox; TeX's spacing table between atom classes.
  • Decoration — \color \textcolor \colorbox \boxed \cancel \bcancel \xcancel \not.
  • Symbols — full Greek, AMS relations, arrows and operators; any Unicode math character can be typed directly.
  • Macros — \newcommand \renewcommand \providecommand \def in a formula, or for the whole document in the Math tab.
  • Commutative diagrams — tikzcd (directions, labels, hooks, dashed, bends, shifts …) and amscd CD (@>>>, @VVV, @= …).
  • Chemistry (mhchem) — \ce{2H2 + O2 -> 2H2O}, charges, states, isotopes, reaction arrows with labels; \pu.
  • Units (siunitx) — \num \si \SI \qty \unit \ang, ranges and lists, with exponents, uncertainties, digit grouping and decimal marker.

Script-size alternates (ssty) are used in superscripts and subscripts where the font has them, as LuaLaTeX does.

Line Breaking

  • Inline formulas may break after a relation or binary operator at the outer level, as TeX does. {…} around a formula prevents breaking.
  • Display equations wider than the text break automatically at relations (then operators); continuation rows are indented and the number goes on the last row.

Numbering and References

  • Numbering: Auto, Number every equation, or No numbers. In multline only the last row is numbered; in align/gather every row.
  • Format: ({n}) by default; {s} is the section counter, so ({s}.{n}) gives (2.3). Number within a tag restarts the counter.
  • Position: right or left; a number that doesn't fit moves to its own line.
  • References resolve forward too; unknown labels print (??). A reference prefix such as "Eq. " can be set.

Math Tab Settings

SettingValuesDefault
Math fontSTIX Two Math, Latin Modern Math (Classic: also uploaded math fonts)STIX Two Math
Letter styleTeX, ISO, French, UprightTeX
Size vs. text / Display sizemultipliers1.0
Numbering, Format, Number within, Positionsee aboveAuto, ({n}), none, Right
Alignment / Left indentCentred or Flush left (fleqn); indent in ptCentred, 24
$…$ syntaxon/offon
Colour, Reference prefix, Macrostextempty
Inline breaks / Display breakson/offon
Decimal marker, Units with "per", Group digitssiunitx outputpoint, power, on

Equation Editor

  • Open it with the ∑ toolbar button, Ctrl+M (inline) or Ctrl+Shift+M (display), or the Math tab buttons.
  • Inline / Display switch; for display equations, Layout picks single line, align, gather or multline.
  • A TeX source field, a symbol palette (Structures, Greek, Operators, Relations, Arrows, Fonts, Matrices, Spacing) and a live preview with error messages.
  • Ctrl+Enter or Insert puts the formula at the cursor; Esc closes.
  • Double-click any formula in the preview — also in a footnote — to edit it; Insert replaces exactly that formula.
  • In the text a formula behaves as one character, and spell check skips it.

Scientific Paper

Front Matter and Sections

<title>, <subtitle>, <authors>, <affiliation>, <date>, <abstract> and <keywords> come with default styles. Headings with a section level in their style are numbered; give a heading an id to refer to it.

Theorems and Proofs

<theorem> <lemma> <proposition> <corollary> <definition> <remark> <example> <conjecture> <claim> <exercise> <problem> <solution> <assumption> <axiom> <notation> <hypothesis> and <proof>. Attributes: id, name (text in parentheses), label (replaces the word), numbered="false". All share one counter. Theorem bodies are italic (plain style) or upright (Mode tab → Theorem body).

End of proof: every proof ends with a mark — the black square ∎ (the "tombstone" or QED sign). Mode tab → End of proof chooses ∎ solid (default), ▪ small solid, □ open (as LaTeX's amsthm) or none, and Placed puts it after the last word or at the end of the line as LaTeX does (on the left in a right-to-left paragraph).

Cross-references

See <xref ref="sec:method"/>, <xref ref="fig:plot"/> and Theorem <xref ref="thm:cs" fmt="num"/>.
fmtOutput
auto (default)Figure 3, Table 1, Section 2.1, Theorem 4, Eq. (5)
num3
labelFigure
pagethe target's page number
fullFigure 3 on page 7

<pageref ref="id"/> prints the page of any labelled element; <autoref> equals fmt="auto". Page numbers and forward references are exact — the document is laid out again until every number is stable, like LaTeX's .aux passes.

Algorithms and Code Listings

<algorithm id="alg:euclid" caption="Euclid's algorithm" linenumbers="true">
Input: integers $a, b$
while $b \ne 0$ do
  $t \gets b$
  $b \gets a \bmod b$   // remainder
  $a \gets t$
end while
return $a$
</algorithm>

Leading spaces set the indentation, keywords are bold, // starts an italic comment, and the block is numbered Algorithm 1 with rules like the LaTeX package. <codeblock caption="…" id="lst:x"> is numbered Listing 1.

Mode Settings

Citation style, include all entries, references title, the words Figure / Table / Eq. / Section, caption separator, numbering of figures and tables within a tag, theorem body style. The Insert buttons add an equation, figure, table, theorem, lemma, definition, proof, citation, cross-reference, reference list, abstract, subfigures, algorithm, list of figures or tables, or endnote.

Citations & Bibliography

<cite key="knuth1984"/>                 → [1]  or  (Knuth, 1984)
<cite key="knuth1984,lamport1994"/>     → [1, 2]
<cite key="knuth1984" page="p. 12"/>    → [1, p. 12]
<cite key="knuth1984" prefix="see"/>    → [see 1]
<citet key="knuth1984"/>                → Knuth [1]  or  Knuth (1984)
<cite key="knuth1984" mode="author"/>   → Knuth
<cite key="knuth1984" mode="year"/>     → 1984

Citation Styles

  • Built in: Numeric (IEEE), Vancouver, Numeric sorted A–Z, Author–year (APA), Author–date (Chicago), Alphabetic [Knu84]. Same-author same-year works get 1984a, 1984b; citations of one author merge.
  • Journal styles (CSL): ACS, AMA, APS, ASA, APA 7th, ACM, BMJ, Cell, Chicago, Elsevier, Harvard, IEEE, ISO-690, MLA, Nature, PLOS, Science, Springer, The Lancet — processed by citeproc-js, the engine of Zotero and Mendeley.
  • Upload .csl style adds any style from the Zotero Style Repository; it is saved with the project.
  • The citation language follows the document language (27 locales).
  • Sort list: as the style says, order of citation, name–year–title, name–title–year, year–name–title, newest first.
  • Back-references: entries can end with the pages that cite them (Cited on pages 2, 5.), as links.

Bibliography

  • Mode tab → Citations: paste BibTeX, add / edit / delete entries one by one, Export .bib. Every entry type is read; LaTeX accents become Unicode.
  • <references/> prints the list — only cited entries unless Include all. Attributes: title, notitle, titletag.
  • Entries can also be written in the document: <references><bibitem key="x">Formatted text.</bibitem></references>.
  • Numeric styles hang the text after the label; author–year styles use a hanging indent.

Figures, Tables & Floats

Figures and Subfigures

<figure id="fig:plot" layout="row" align="center" placement="tb">
  <img src="a.png" width="45%" alt="Before"/>
  <img src="b.png" width="45%"/>
  <caption>Two panels side by side.</caption>
</figure>

<figure id="fig:panels" cols="2">
  <subfigure id="fig:left"><img src="a.png"/><caption>Before.</caption></subfigure>
  <subfigure id="fig:right"><img src="b.png"/><caption>After.</caption></subfigure>
  <caption>Two states of the system.</caption>
</figure>

A figure with a caption is numbered (Figure 1:). layout is row or column; kind="table" numbers it as a table; short="…" gives a shorter list entry; alt describes the image in a tagged PDF. Subfigures are lettered (a), (b) and referenced as Figure 1b.

Tables

<table id="tab:res" style="booktabs" colalign="l d d" widths="2* 1* 1*">
  <caption>Results</caption>
  <thead><tr><th>Method</th><th>Mean</th><th>SD</th></tr></thead>
  <tr><td>Baseline</td><td>12.5</td><td>0.83</td></tr>
  <tr><td>Ours</td><td>9.25</td><td>1.2</td></tr>
  <midrule/>
  <tr><td colspan="3" align="center">n = 40 per group</td></tr>
</table>
Attribute / elementMeaning
<thead>, <tbody>, <tfoot>Header and body rows
style="booktabs"Heavy top and bottom rules, light rule under the header, no vertical lines
<midrule/>Extra light rule between rows
widthsLengths, % or shares such as 2*
colalignl, c, r, j, d (decimal-aligned)
colspan, align on a cellSpan and alignment per cell
repeatheader="false"Don't repeat the header on following pages

Long tables break between rows, repeat the header and print Table 3 (continued). Cells can contain formulas, citations, references and formatting.

Floats

Numbered figures, tables and algorithms float as in LaTeX, with placement (default htbp):

LetterMeaning
hHere, if it fits
t / bTop / bottom of a page
pA float page of its own
!Ignore the top and bottom shares
HExactly here, never floats

<floatbarrier/> places every waiting float; <clearpage/> also starts a new page. Floats stay in place inside columns, frames and slides.

Notes, Glossaries & Index

Endnotes

<endnote>…</endnote> prints a mark and collects the note; <endnotes/> prints the notes collected so far under Notes. Leftover notes are printed at the end. Endnote marks have their own counter and format.

Lists of Figures, Tables, Listings and Algorithms

<listoffigures/>, <listoftables/>, <listoflistings/>, <listofalgorithms/> print captions with page numbers and dot leaders (links in the PDF).

Glossaries and Acronyms

<glossarydefs>
  <acronym id="pdf" short="PDF" long="Portable Document Format"/>
  <glossentry id="kerning" name="kerning">adjusting the space between two letters</glossentry>
</glossarydefs>
<paragraph>Export as <ac ref="pdf"/>; later <ac ref="pdf"/> is short. Good <gls ref="kerning"/> matters.</paragraph>
<printacronyms/>
<printglossary/>

<ac> prints the full form the first time and the short form after; <acs> <acl> <acf> force short / long / full, <acp> etc. give plurals, <gls> <glspl> <glsdesc> print terms and descriptions. Lists show only used entries (unless all="true"), sorted, with the pages where each is used.

Index

<index term="…"/> or <index>word</index> with makeindex syntax: sort@Display, levels with !, |see{…}, |seealso{…}, |textbf. <autoindex/> prints the index with letter headings, sorted for the document language, merged page ranges, in two columns.

Magazine Editor

Frames

A frame is a box placed at an exact position; the text flows around it.

<frame page="1" x="0" y="0" w="50%" h="60mm" wrap="around" gap="4mm">
  <img src="photo.jpg"/>
</frame>
<frame x="55%" y="20mm" w="45%" bg="#f2f4f8" padding="4mm" border="0.5">
  <paragraph>Frame text.</paragraph>
</frame>
AttributeMeaningDefault
pagePage numbercurrent
x, yPosition (% of the content area or page)from align / current position
w, hSize; without h the height fits the content40%, content
alignleft, center, right when x is omittedleft
relativemargin or page (for bleed images)margin
wraparound, top-bottom, nonearound
gap, paddingSpace to the text; inner padding8 pt, 0
bg, border, bordercolorBackground, border width, border colournone

Drag a frame in the preview to move it and its corner handle to resize; the values are written back to the XML in millimetres, snapping to the layout grid when Snap is on.

Story Tags and Settings

The Story styles buttons insert <kicker>, <headline>, <deck>, <byline>, <subhead>, <pullquote> and <sidebar>; Column block inserts <columns2>. Settings: grid columns (6), gutter (12 pt), show grid, snap to grid, and facing-page spread view (pages in pairs as in print).

Label Creator

Label Sizes and Sheets

Label size sets the page to one label: 4 × 6 in and 100 × 150 mm shipping, 100 × 50 mm product, address sizes (70 × 37, L7160, 5160), L7165 parcel, 50 × 25 mm asset tag, L7166 food, 70 × 39 mm shelf strip, 100 × 24 mm tape, 25 × 38 mm cable wrap, L4761 spine, A5 pallet, or custom. Sheet layouts place labels on a printed page — one per page for thermal printers, A4 and Avery layouts, or a custom grid.

Barcodes

<barcode type="ean13" value="590123412345" height="18mm" align="center"/>
<barcode type="gs1-128" value="(01)09501101530003(17)261231(10)AB-123"/>
<qrcode value="https://example.com" size="25mm" ecl="Q"/>

Types: code128, gs1-128 (FNC1 added automatically), ean13 and ean8 (check digit calculated or verified), upca, code39, itf, itf14, qr. Attributes: height, width, module, size, ecl, text, fontsize, quiet, align, color. Barcodes can also sit inline in text. All symbologies were verified with standard readers.

Hazard and Handling Symbols

<hazard code="GHS02 GHS07" size="15mm" align="left"/>
<paragraph>Keep away from heat <icon code="keep-away-from-heat"/>.</paragraph>

GHS01–GHS09 pictograms, and this-way-up, fragile, keep-dry, keep-away-from-heat, recyclable, ce — vector paths in preview and PDF.

Data Merge

Mode tab → Data merge → Load .csv (or paste) and Apply CSV. Placeholders work in text, barcode values and attributes:

PlaceholderResult
{{Column name}} or <field name="Column name"/>That column of the current record
{{serial}}, {{serial:6}}Running number (padded: 000042)
{{row}}Record number
{{date}}Today, YYYY-MM-DD

Values may contain <b>, <i>, <u> (e.g. allergens in bold). Preview record shows any record; Copies per record repeats each one. In the preview a merged value is clicked and selected as one unit — what you edit is the template with its placeholders, so typing never breaks a placeholder.

Export

  • ↓ One label per page — a PDF with one page per label, for thermal and roll printers.
  • ↓ Print sheets (PDF) — the labels placed on the chosen sheet, with optional crop marks.

The templates follow the rules for each label type (EU CLP/GHS, EU 1169/2011, GS1 logistic label, EU unit prices) and include sample merge data. They are starting points: check the rules for your product and market before printing labels that must comply.

Technical Docs

Code

<codeblock lang="python" title="example.py" linenumbers="true">
def answer():
    return 42
</codeblock>

Syntax highlighting for JavaScript/TypeScript, Python, C, C++, C#, Java, Kotlin, Swift, Go, Rust, PHP, SQL, Bash, CSS, JSON, YAML and XML/HTML; themes Light, Dark and Print. caption numbers the block as a listing. Inline: <code>, <kbd>, <samp>, <tt>, <var> — skipped by spell check and hyphenation.

Callouts and API Endpoints

<warning title="Heads up">Back up your data first.</warning>

<endpoint method="POST" path="/v1/orders">
  Creates an order.
  <param name="items" type="array" in="body" required="true">Line items.</param>
</endpoint>

Callouts: <note> <tip> <important> <warning> <caution> <danger> <info> <success> or <callout type="…">. Endpoints show the method in colour, the path in monospace and a parameter list.

Markdown Import

Mode tab → Import Markdown, then Append or Replace document. Supported: YAML front matter, headings with {#id}, fenced code, $$ and $ math, bold/italic/strike/code, links and images, footnotes, GitHub callouts (> [!NOTE]), pipe tables, nested and task lists.

General-purpose Tags

TagMeaning
<spacer height="10mm"/>Vertical space
<spacer height="fill" reserve="20mm"/>Pushes what follows to the bottom of the page
<smallcaps>Small capitals
<nobr>Keeps words on one line
<icon code="…"/>Inline symbol
<slidenum/>Current page or slide number
<quote>, <blockquote>Indented quotation
<floatbarrier/>, <clearpage/>Place waiting floats (and start a new page)
<toc/>Table of contents at this point
numbered="false" on a headingUnnumbered heading, still in the TOC
lang="…" on any blockHyphenation language for that block
grid="false" on any blockThe block ignores the baseline grid

Justification & Hyphenation

Justification

Justified text is set the way TeX sets it, and glyphs are never stretched or squeezed:

  1. Whole-paragraph line breaking (Knuth–Plass): the set of breaks with the most even word spacing wins; uneven neighbouring lines, consecutive hyphens and a hyphen on the last full line are penalised.
  2. TeX's passes: first without hyphenation, then with it, then with emergency stretch. Most paragraphs need no hyphens at all.
  3. Word spaces stay between each style's Min %, Desired % and Max %.
  4. Letter spacing only as a last resort, at most Extra letter spacing when justifying (default 2 %; 0 turns it off).

Hyphenation

  • TeX hyphenation patterns for 81 languages (Liang's algorithm, as LaTeX), loaded when a language is first used.
  • Language: lang on a block, else the style's hyphenation language, else the document language.
  • Per style: minimum word length and characters before / after the hyphen.
  • Exceptions (Mode tab → Typography): ta-ble marks allowed breaks; a word without hyphens is never broken.
  • Formulas, code and URLs are never hyphenated.

Baseline Grid

Mode tab → Typography → Baseline grid puts every body line on a regular grid so facing columns and pages line up. Step (0 = body leading), offset, and grid lines in the preview. Headings, equations and figures keep their position; the text after them resumes on the next grid line. Styles can join with Align to grid; blocks can leave with grid="false".

Languages & Letters

Both editors know the languages written in Arabic script — Arabic, Persian, Urdu, Ottoman Turkish, Sorani Kurdish, Uyghur and Malay in Jawi — besides English and Hebrew. Each language brings its own words for the parts the editor writes for you, its digits, keyboard, letters and spelling. New languages can be added without updating the editor.

The Document's Language

In Classic 2, Doc → Default language lists these languages after Latin, French and German; the Arabic templates choose Arabic. The language sets:

  • The words the editor writes — Theorem, Proof, Figure, Table, References, Contents, the page word in the footer, the blank-page note and box titles (Note, Warning …), in that language.
  • Digits — Persian and Urdu start with ۰۱۲۳۴۵۶۷۸۹, Arabic with ٠١٢٣٤٥٦٧٨٩ (change it under Doc → Digits).
  • The keyboard — typing Arabic script on a Latin keyboard follows the Arabic 101, Persian ISIRI 9147 or a phonetic Urdu layout (Classic 2).
  • The font's language forms — for example Urdu digit shapes in Amiri (Classic 2).

A passage in another language takes a lang attribute: <span lang="fa">…</span>. A bibliography entry written in Arabic script is formatted in its language — Arabic with و، وآخرون، مج، ع، ص and «» quotes, Persian, Urdu and Ottoman with their own words. The entry's langid or language field chooses the language when it is not the document's.

Forms of the Same Letter

Unicode writes some letters in more than one way: ي ی ى, ك ک, ه ہ ە, ة ۃ, and a hamza letter or a letter followed by a separate hamza. Text pasted from different sources often mixes them, so a search for one form misses the others.

  • Find & Replace → Letters: Exactly as typed; Any form of a letter (ي ی ى · ك ک · ه ہ); or Any form, ignoring vowel signs and hamza (also أ إ آ ا · ة ه, and vowel signs, tatweel and the half space are skipped). Works in the XML source and in the document, for Find, Replace and Replace all.
  • Spell check: Persian is in the language list. Words are looked up without their vowel signs and in the language's own letters, so كتاب and کتاب find the same dictionary word.
  • Normalise letters (vowel-sign palette حَ): rewrites the letters the language writes another way — Arabic ک → ك and ی → ي inside a word; Persian ي → ی and ك → ک; Urdu also ه → ہ — in the selection or paragraph, or in the whole document. Tick also in pasted text to do it to everything you paste.

Letters of the Language

The palette shows the letters of the document's language that an Arabic keyboard lacks — Persian پ چ ژ گ and the half space, Urdu ٹ ڈ ڑ ں ے, Kurdish ڵ ڕ ۆ ێ ڤ ە, Uyghur ە ۇ ۆ ۈ ې ۋ ڭ — click one to type it at the caret.

Typing Arabic in Latin Letters

In the palette, Type in Latin letters turns a transcription with all its vowels into correctly spelled, fully vowelled Arabic. The preview shows the result; Enter inserts it; untick vowel signs for the letters only.

TypeForExample
b t th j H kh d dh r z s sh S D T Z ` gh f q k l m n h w yconsonants (capitals H S D T Z are ح ص ض ط ظ; ` is ع)kataba → كَتَبَ
'hamza — its seat (أ إ آ ؤ ئ ء) is chosen from the vowels around itsu'aalu → سُؤَالُ, qur'aanu → قُرْآنُ
aa ii uulong vowelskitaabu → كِتَابُ
doubled lettershaddaHattae → حَتَّى
-ntanweenkitaaba-n → كِتَابًا
ätāʾ marbūṭamadrasätu-n → مَدْرَسَةٌ
ae at the endalif maqṣūralaylae → لَيْلَى
al-, ash-sh…the article; sun letters assimilateash-shamsu → الشَّمْسُ
wa- fa- bi- li- ka-joined to the next wordli l-bayti → لِلْبَيْتِ

Skeleton Views

Mode tab → Arabic vowel signs → Show: Skeleton without dots draws each letter by its outline only, as early manuscripts did (ب ت ث ن ي inside a word become one tooth ٮ; ف ق become ڡ); Bare skeleton (rasm) also drops hamza and every sign. Only the drawing changes — the text, search and spell check keep the full letters.

Line Breaking

Arabic and Hebrew words are never hyphenated; lines break between words. Uyghur, which writes all its vowels, may break at syllables (Uyghur as the document's language, or lang="ug").

Adding a Language

Languages, scripts and calligraphic styles are modules. A new language is a small file placed in fonts/lang/ and listed in fonts/lang/modules.json — no change to the editor. Pashto is included as an example:

{ "modules": ["pashto.json"] }

A font names its calligraphic style in its main.json ("style": "naskh"), which sets where letters may be stretched, the ligature level and the style's spelling conventions. The full format — including the fields reserved for Indic, Chinese and Japanese scripts — is in docs/LANGUAGE-MODULES.md.

PDF Output Options

Links and Bookmarks

With Clickable cross-references (on by default) cross-references, equation and page references, citations, back-references, footnote and endnote marks, glossary and index page numbers and TOC entries are links; <a href> goes to the web address. The PDF outline lists every heading.

Tagged (Accessible) PDF

Adds a structure tree for screen readers and reflow: headings, paragraphs, captions, lists, tables (with header scope and column spans), formulas (TeX source as alternate text), figures (with alt), code, notes, bibliography entries, TOC and links. Headers, footers and decorations are marked as artifacts; the document language and title are set.

PDF/A-2 Archival

Writes a file for long-term archiving (ISO 19005-2): all fonts embedded (standard fonts replaced by metric-compatible Liberation fonts), sRGB output intent, XMP metadata, invisible text in render mode 3, printable link annotations. Conformance PDF/A-2b, or PDF/A-2a together with Tagged PDF.

The files are not validated with veraPDF inside the app — validate important files before archiving.

LaTeX Import

Scientific Paper → Mode tab → Import LaTeX: choose the .tex file with its .bib and images (PNG or JPG), or paste the source, then Replace document or Append.

  • Converted: title block and abstract; parts, chapters and sections (starred too); labels and all reference commands (\ref \eqref \autoref \cref \pageref …); natbib and biblatex citations and the bibliography style; all equation environments, inline math, tikzcd/CD, \ce and siunitx; figures and subfigures with widths and placement; tables including tabularx, longtable, \multicolumn, booktabs and decimal columns; lists; theorems and proofs; algorithmic/algpseudocode/algorithm2e; verbatim, lstlisting, minted; footnotes and endnotes; glossaries and acronyms; index; lists of figures/tables; macros (\newcommand, \def … expanded); babel/polyglossia language; inline formatting, accents and quotes.
  • Images are matched by file name and added to Assets; PDF and EPS images must be converted to PNG or JPG first.
  • Replace also replaces the bibliography; Append adds entries.
  • A report lists what could not be converted (unknown commands keep their text; \input files, TikZ pictures and missing images are named).

Saved Project Data

A project file stores, besides the XML and styles:

FieldContent
math_settingsEverything in the Math tab
editor_modeclassic, magazine, scientific, label, carousel or techdocs
mode_settingsSettings of each mode
bibliographyBibliography entries
pub_settingsShared settings: baseline grid, hyphenation exceptions, notes, floats, bibliography options and uploaded CSL style, glossary, index, PDF, tables, Arabic vowel signs (tashkeel) and microtypography (microtype)

Styles also save the hyphenation, justification and grid properties and their tashkeel settings. Older projects load unchanged and get the defaults.

Limitations

  • Font expansion and margin kerning are deliberately not used — glyph shapes are never distorted.
  • TikZ/PGF drawings (other than tikz-cd) and picture environments: export them as images.
  • LaTeX import: \input/\include (import each file and append it), \newenvironment definitions (their content is kept), and page-layout packages such as geometry and fancyhdr (set these in the Doc tab).
  • Floats inside columns, frames and carousel slides stay in place.
  • Boxed blocks beside frames (sidebars, callouts) start below the frame instead of wrapping around it.
  • Classic and Arabic: Classic lays out right-to-left and mixed text and shapes Arabic with the font's OpenType rules, so mark placement follows the font; smart placement, hand-moved marks, Qurʾān mode, microtypography, the Arabic keyboard layouts and the Arabic templates are Classic 2 features.
  • ل + hamza + ا in Qurʾānic text (لِءَابَآئِهِمْ) is drawn as the لا ligature, as in HarfBuzz.