Annexures & Reusable Content
Annexures & Reusable Content
Two features help you manage documents and content that live alongside — or
across — your articles: annexures and reusable content. Both are
referenced from article bodies with directives.
Annexures
An annexure attaches a supporting document to a manual — an electrical
drawing, a P&ID, a datasheet, a certificate, a sub-manual, or any other file.
Instead of pasting a file into a page, you upload it once as an annexure and
reference it wherever it's relevant.
Adding an annexure
In the Space workspace, open Annexures and add one. Each annexure has:
- A file — the uploaded PDF, drawing, Office document, or similar.
- A reference key — a short, stable identifier (for example
wiring-diagram)
that you use in article text. The key stays fixed even if you rename or reorder
things. - A title and optional description.
- A kind, which sets the label used on its cover sheet:
| Kind | Typical use |
|---|---|
drawing |
Engineering / assembly drawings |
pnid |
Piping & instrumentation diagrams |
datasheet |
Component or product datasheets |
certificate |
Compliance / calibration certificates |
manual |
A referenced sub-manual |
other |
Anything else |
An annexure can be manual-wide or scoped to a specific chapter. Its
sort order controls both its position and its display number.
Referencing an annexure
In any article, reference an annexure by its key:
Refer to Annexure — before powering on.
This renders as a live "Annexure N: Title" cross-reference. Numbering is
global across the manual and derived from sort order at render time, so if you
reorder your annexures every reference updates automatically — you never end up
with a stale "Annexure 3" pointing at the wrong document.
Annexures in PDF export
When you export a manual to PDF, each annexure gets its own cover sheet
showing its label, title, a QR code, and a download link. For PDF files, the
document's pages are then merged in right after the cover sheet, so the
exported manual is self-contained. You can exclude an individual annexure from
the PDF with its include in PDF toggle.
Reusable content
Reusable content lets you write a section once and embed it in many
articles — across all your manuals — with no copy-paste drift. When you edit the
source, every place that embeds it updates on the next publish.
Making a section reusable
Open the article (section) you want to share and tick Reusable in its
header, then publish it. Only sections marked reusable can be embedded, and they
become available across your whole account, not just their own manual.
Embedding it
In any other article, use the toolbar's reusable-content button or write the
directive directly:
<!-- zs:include unavailable -->
At render time the directive is replaced with the source section's latest
published content for the reader's language (falling back to the source
section's default language). Because the reference is stored — not a copy —
there is a single source of truth.
How it resolves
- Includes resolve recursively (an included section can itself include
others), with limits that prevent loops or excessive nesting. - If a source is unpublished, deleted, or not accessible to the reader, the
include simply renders nothing on the live site rather than showing a broken
token. The editor preview shows a visible placeholder so you notice while
authoring. - Access is respected: a restricted source will not leak into a more open page.
Governance
When you open a reusable section, the editor shows a "used in N sections"
panel listing every article that embeds it. This makes it easy to see the impact
of an edit before you publish, and it guards against deleting a section that
others still depend on.
When to use which
Use an annexure for a whole supporting file (a drawing or datasheet) you
want to reference and bundle into the PDF. Use reusable content for a block
of article text — a safety notice, a shared procedure, a boilerplate section —
that must stay identical everywhere it appears.