Compendium — Document Options

Documentation

Overview

Each document in Compendium has a toolbar in its header and a full Info Drawer that slides in from the right. Together they give you access to editing controls, attachments, version history, sharing, PDF export, and the complete activity audit trail.

Document toolbar

The toolbar sits in the document header, to the right of the metadata (created/updated info). Icons appear and disappear depending on the document's status and your permissions.

IconWhat it does
✏ EditEnters edit mode. Only active when the document is in Draft status.
💾 SaveSaves the current edits. Visible only while in edit mode.
✕ CancelDiscards unsaved edits and exits edit mode.
📎 Attach FilesOpens the attachment uploader to add files to the document.
🕐 Version HistoryOpens the version history dialog listing all saved versions.
ⓘ More InfoSlides open the right Info Drawer with full document metadata and actions.
↗ ShareCopies a shareable deep link to this document to your clipboard.

Attachments

Any file type can be attached to a document — images, PDFs, spreadsheets, ZIP archives, and so on. Attachments are displayed in the Info Drawer and can be downloaded or deleted individually.

1Click the 📎 Attach Files icon in the toolbar (or the same button in the Info Drawer)
2The file upload dialog opens — select one or more files from your device
3Click Upload — the files are attached immediately
4Open the Info Drawer (ⓘ) and scroll to Attachments to see the list
5Click the delete icon on an attachment row to remove it

Version history

Version history lets you create named snapshots of a document at key milestones and restore them later if needed.

Creating a version

1Open the Info Drawer (ⓘ icon)
2In the Actions section, click Create Version
3Enter a version name or label (e.g. "v1.0 — initial release")
4Click Save — the snapshot is stored in version history

Viewing and restoring versions

1Click the 🕐 Version History icon in the toolbar, or the same button in the Info Drawer
2The version history dialog lists all saved versions with dates and author information
3Click Restore on a version to revert the document content to that snapshot

Sharing a document

1Click the ↗ Share icon in the toolbar
2A deep link to the current document is copied to your clipboard
3Paste the link and send it — recipients with project access land directly on the document when they open it

The link encodes the project and document ID as a token. If the recipient does not have project access they will see an "Access Required" page.

Downloading as PDF

1Open the Info Drawer (ⓘ icon)
2In the Actions section, click Download PDF
3The document content is exported as a PDF and downloaded to your device

The Info Drawer

Click the ⓘ More Info icon to slide open the Info Drawer from the right. It contains four sections:

  • Details — Created by, creation date, last updated by, and last updated date
  • Settings — Toggle to show or hide archived documents in the tree and search. Preference is saved per browser
  • Actions — Quick access to all document actions (see table below)
  • Attachments — List of attached files with download and delete options
  • Activity — Filterable audit trail of all events for this document

Actions reference

ActionWhat it does
Attach FilesUpload files to attach to this document.
Create VersionSnapshot the current content as a named version for future reference.
Version HistoryView all versions of this document with the ability to restore an older one.
Change ParentMove this document to a different section in the tree.
Download PDFExport the document content as a PDF file.
Delete SectionPermanently delete this section and its content. Requires confirmation.

Activity audit trail

The Activity section in the Info Drawer shows every event recorded for the document. Use the filter dropdown to narrow the list:

FilterWhat it shows
AllEvery event in the audit trail — status changes, content edits, and attachment activity.
StatusOnly status transition events (Draft → In Review → Published, etc.).
ContentOnly content edits and attachment activity (created, updated, attachment added/deleted).

Troubleshooting

The Share icon copies an empty or broken link

Sharing requires an authenticated project member to access. Ensure you are on a valid document (not the project root) and that currentProduct is set. If the link is still broken, reload the page and try again.

Download PDF produces a blank or incomplete PDF

PDF generation uses the rendered HTML of the document content. Very large documents or those containing complex media may truncate. As a workaround, use your browser's built-in print to PDF (Ctrl+P / Cmd+P) from the content area.

Version History shows no entries

Version history entries are created when you explicitly click "Create Version" in the Info Drawer actions. Regular saves do not create named versions automatically.

Change Parent is not available

Change Parent appears only when the document has a valid entity ID and the user has edit access. If the option is missing, check that you are not in read-only mode and that the document is not in a locked status.

I attached a file but it does not appear

Attachments appear in the Info Drawer under "Attachments." Scroll down in the drawer to see them. If the list is empty after attaching, try closing and reopening the drawer.

I cannot delete the document

The Delete Section action requires edit access and appears in the Info Drawer Actions section. If it is missing, you do not have the necessary permissions. Read-only users cannot delete documents.