Deixis Documentation
Annotate a passage, share its explanation, or connect objects in your own drawing.
These guides describe Deixis 0.2.0 for Typst 0.15.0+.
Import @preview/deixis:0.2.0 from Typst Universe; Typst downloads it
automatically. See installation for editor setup.
Start Here
- Installation: import the package and configure your editor.
- Getting started: add a first note, share it, and choose its appearance.
Guide snippets continue a document with the package import and setup from getting started, unless they include their own. Most show their compiled output below the source, with a link to the complete preview document. Blocks labeled as fragments show configuration or excerpts that need surrounding code.
Notes, Marks, And Placement
- Footnotes and long bodies: native footer pagination and appearance, overlays, whitespace, breakable borders, and page/local ownership.
- Annotation identities: create with
id:, attach/reuse withof:, and declare components in either order. - Shared notes: many inline, region, or phantom marks with one marker and body.
- Body ownership: what a body declaration controls for each adapter.
- Rendering paths: immediate placement, overlays, and native collection.
- Regions and pins: highlight formulas/images and select spatial regions.
- References: native references, ranges, page links, and return links.
- Table and figure notes: local block ownership, floated collections, and repeated headers.
- Collected notes: endnote printers, typography, groups, and pagination.
- Margin overflow: optional checking after margin packing/spillover.
Appearance And Extensions
- Appearance and color: default styling, scoped palettes, and explicit overrides.
- Configuration: reusable defaults, adapter/component keys, resets, and capture timing.
- Containers: native/custom body wrappers and explicit container options.
- Custom renderers: live body helpers, navigation, measurement, and partial output.
- Drawing order: z-index, separate component priorities, and layer boundaries.
Connections And Drawings
Begin with Connectors for note shorthand, or Routing objects in place for your own objects.
- Connectors: routes, side/sliding/pin ports, exact waypoints, native arrowheads, and optional cuts/crossing gaps.
- Independent connections: connect pins, original/reused marks, frames, and live body points.
- Pin API: names, scopes, occurrence selection, padding, and attached anchors.
- Routing objects in place: immediate node registration and scoped manual/avoid/separate planning.
- Numeric routing: build and paint geometry from known coordinates, without document setup.
- Routing scenes: fixed obstacles, accepted document geometry, and avoid/ignore/cut/cross behavior.
- Routing groups: explicit orthogonal batches, repair budgets, and checked results.
Useful comparisons: curve families, Hobby curves, off-curve controls, native heads, custom ports, shared lanes, optional crossing gaps, and small portals.
Pages, Scopes, And Presentations
- Setup and page layers: initialization, safe reapplication, and host-owned composition.
- Scope names and targets: local owners, shared threads, relative and forward selection.
- Breakable blocks: per-page margins, block-end footnotes, and native geometry limits.
- Scopes inside notes: local numbering and collections in deferred bodies.
- Counters and resets: series, shared owners, strict updates, and heading/slide recipes.
- Annotation visibility: Touying reveals, native hiding, component ownership, and cover limits.
- Review comments: series-based omission for draft/final builds, preserved passages, and shared comments.
- Touying frame identities: frame-local IDs and references across repeated subslides.
Queries And Custom Views
- Selection and queries: collection boundaries, filtering, ordering, and adaptive page headers.
- Outlines and custom views: one entry per annotation, marked-page lists, and passage indexes.
- Annotation data: custom titles, tags, status, and catalogue fields.
- Editorial recipes: critical apparatus, independent source/editorial series, and first-use glossaries.
Find A Task
| I Want To… | Read | Try |
|---|---|---|
| Install Deixis or configure my editor | Installation | First Notes |
| Add my first notes | Getting started | First Notes |
| Remove editorial notes from a final copy | Review comments | Review Comments |
| Share one explanation among passages | Identities · Shared notes | Shared Notes |
| Annotate a presentation | Touying integration | Touying Reveals |
| Choose colors and containers | Appearance · Configuration | Automatic Palettes |
| Draw connections around objects | Routing objects in place | Routing In Place |
| Build a note index or custom view | Outlines · Queries | Note Catalogue |
| Annotate headings with outlines or running headers | Repeated headings | Footnotes |
Offline Reading And Compatibility
The downloadable manual combines a guided introduction, 23 worked examples with source beside compiled output, and a compact reference to all public APIs. Setup badges distinguish document APIs, independent numeric helpers, and conditional extension hooks. The API reference supplies source-derived defaults; the agent skill includes checked document recipes for coding agents.
Use Compatibility and migration for supported behavior, remaining native/routing limits, and changes from 0.1.1. Maintained editable sources live in examples.
Contributing
For dependencies, checks, artwork and local website commands, see CONTRIBUTING. The architecture explains runtime contracts; release preparation lists packaging and manual checks.