DocsOpen IDOP Cloud

Docs

Documentation

Everything you need to open, understand and build IDOP documents. The specification is normative; these pages explain it in practice.

Start

Open a document, write one, and learn the vocabulary.

  • Getting startedOpen your first IDOP document, then write one — in about fifteen minutes.
  • Core conceptsDocuments, readers, sessions, revisions and capabilities — the vocabulary of IDOP.

The format

What is inside an .idop file, and the rules it follows.

  • The IDOP formatWhat the format specifies, which versions exist, and how they relate.
  • File structureThe roots of an IDOP package, path rules, limits and deterministic packing.
  • The manifestidop.json — identity, entry point, revisions, features and capabilities.

Running documents

How a reader runs a document: the Runtime API, storage, permissions and security.

  • The Runtime APIglobalThis.idop — every method a document can call, and how errors work.
  • Storage and savingThe working copy, durability states, transactions, saving and conflicts.
  • Permissions and network accessCapabilities, credential and environment bindings, consent, and the rules the reader applies to every request.
  • SecurityThe security properties a reader provides, and what IDOP does not promise.

Products

Using the reader and IDOP Cloud.

  • The readerUsing the IDOP reader in IDOP Cloud — opening files, prompts, saving, installing and the developer inspector.
  • IDOP CloudAccounts, storage, folders, sharing by link and account deletion in IDOP Cloud.

Building

Writing documents that validate and behave well, and the tools that help.

  • Building documentsPractical guidance for writing IDOP documents that validate, behave well and are pleasant to use.
  • SDK and CLIPreviewThe idop command-line tool, and the status of SDKs.
  • APIsPreviewThe Runtime API for documents, the assistant connector, and the planned public API.
  • ExamplesWhere to find complete, annotated IDOP examples.