OpenSite/Reference/Commands/Inspect a document

OpenSite 0.0.1 · DevelopmentSource scope and availability

Print the objects and properties in a saved document.

Stable identifier

cli.document.inspect

Implementation milestone

Roadmap phase 1 (historical Phase 1).

Units

Quantity properties print the canonical SI value and, when a unit id is stored, the value in that unit.

Terminal example

opensite-cli document inspect section.osdoc

Python access

The CLI verb has no separate function. examples/python/document_edit.py reads a property with document.property(object, name) on the handle returned by document.create_section.

Output

One object line and one property line per property, on stdout. An opaque object prints opaque 1 and does not expand properties.

Errors

A missing file exits 1. The message is the load status on stderr.

Limitations

Inspect reads the saved file without recomputing or modifying it. The desktop also has an object tree and property inspector; this page describes the terminal inspection command.

Verification evidence

Repository evidence references (not rerun for this publication): CTest cli.document.

Try this workflow

First document — a worked lesson with expected results.

Documentation basis

Source-reviewed against development commit 77c3fee13944bcc4b5d487c77eb1f82fbe4c6ea7, branch feature/phase-13c-properties-python-expressions. This review inspected the implementation and repository evidence; it did not run the Windows application or repeat CTest.

• src/cli/main.cpp
• src/cli/document_commands.cpp
• src/cli/preference_commands.cpp
• src/application/builtins.cpp

OpenSite overview · Reference · Guides

Previous: OpenSite/Reference/Commands/Create an example document

Next: OpenSite/Reference/Commands/Recompute a document

All guides