OpenSite/Reference/Commands/Document commands - Revision history

BathAfrica: Link adjacent OpenSite reference pages in reading order

2026-10-29T21:14:39Z

Link adjacent OpenSite reference pages in reading order

← Older revision		Revision as of 14:14, 29 October 2026
Line 66:		Line 66:
	[[Category:OpenSite documentation]]		[[Category:OpenSite documentation]]

	<div class="os-page-nav">{{Docnav\|OpenSite/~~Getting started~~\|OpenSite/~~Guides~~\|OpenSite/Guides\|All guides}}</div>		<div class="os-page-nav">{{Docnav\|OpenSite/Reference/Commands/Set a quantity\|OpenSite/Reference/Commands/Extension commands\|OpenSite/Guides\|All guides}}</div>

BathAfrica: Reorganize OpenSite help: learning paths, examples and chapter navigation

2026-10-29T20:59:20Z

Reorganize OpenSite help: learning paths, examples and chapter navigation

← Older revision		Revision as of 13:59, 29 October 2026
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{OpenSite scope}}
	{{BathAfrica Command		{{BathAfrica Command
	\|review=Development documentation for OpenSite 0.0.1, source snapshot 77c3fee (Phase 13C). Reviewed against implementation on 29 October 2026. Tests and the Windows desktop were not rerun for this publication; this is not a released-product support claim.
	\|id=opensite.document		\|id=opensite.document
	\|summary=Create, open, save, close, edit, recompute, undo, and redo a document through the command registry.		\|summary=Create, open, save, close, edit, recompute, undo, and redo a document through the command registry.
Line 51:		Line 51:
	== Property expressions ==		== Property expressions ==
	<code>document.set_expression</code> accepts document, object, property, expression and optional language (<code>formula</code> or <code>python</code>). Python evaluation is opt-in; enabling it does not silently run a stored expression. The desktop provides Edit → Enable Python Expressions and Edit → Recalculate Python Expressions. See [[OpenSite/Reference/Features/Quantities and expressions]].		<code>document.set_expression</code> accepts document, object, property, expression and optional language (<code>formula</code> or <code>python</code>). Python evaluation is opt-in; enabling it does not silently run a stored expression. The desktop provides Edit → Enable Python Expressions and Edit → Recalculate Python Expressions. See [[OpenSite/Reference/Features/Quantities and expressions]].

			== Try this workflow ==
			[[OpenSite/Guides/First document\|First document]] — a worked lesson with expected results.

	== Documentation basis ==		== Documentation basis ==
Line 62:		Line 65:
	[[OpenSite\|OpenSite overview]] · [[OpenSite/Reference\|Reference]] · [[OpenSite/Guides\|Guides]]		[[OpenSite\|OpenSite overview]] · [[OpenSite/Reference\|Reference]] · [[OpenSite/Guides\|Guides]]
	[[Category:OpenSite documentation]]		[[Category:OpenSite documentation]]

			<div class="os-page-nav">{{Docnav\|OpenSite/Getting started\|OpenSite/Guides\|OpenSite/Guides\|All guides}}</div>

BathAfrica: Use BathAfrica sidebar contents without duplicate inline contents box

2026-10-29T20:10:37Z

Use BathAfrica sidebar contents without duplicate inline contents box

← Older revision		Revision as of 13:10, 29 October 2026
Line 1:		Line 1:
			__NOTOC__
	{{BathAfrica Command		{{BathAfrica Command
	\|review=Development documentation for OpenSite 0.0.1, source snapshot 77c3fee (Phase 13C). Reviewed against implementation on 29 October 2026. Tests and the Windows desktop were not rerun for this publication; this is not a released-product support claim.		\|review=Development documentation for OpenSite 0.0.1, source snapshot 77c3fee (Phase 13C). Reviewed against implementation on 29 October 2026. Tests and the Windows desktop were not rerun for this publication; this is not a released-product support claim.

BathAfrica: Publish Cursor documentation reconciled with OpenSite source 77c3fee; tests not rerun

2026-10-29T20:05:56Z

Publish Cursor documentation reconciled with OpenSite source 77c3fee; tests not rerun

New page

{{BathAfrica Command
|review=Development documentation for OpenSite 0.0.1, source snapshot 77c3fee (Phase 13C). Reviewed against implementation on 29 October 2026. Tests and the Windows desktop were not rerun for this publication; this is not a released-product support claim.
|id=opensite.document
|summary=Create, open, save, close, edit, recompute, undo, and redo a document through the command registry.
|milestone=Roadmap phases 1 and 4. The CLI wrappers are the <code>cli.document.*</code> pages.
|units=Quantity arguments store the canonical SI value. The unit id is the display unit already registered with the units engine. A content revision is a dimensionless integer.
|example=opensite-cli document example --output section.osdoc
|python=opensite.execute('document.create_section', {'width': opensite.QuantityArgument(opensite.parse_quantity('200 mm'), 'mm'), 'height': opensite.QuantityArgument(opensite.parse_quantity('200 mm'), 'mm')})
|output=The Python call returns <code>document</code>, <code>object</code>, and <code>content_revision</code>. The CLI example prints the saved section on stdout.
|errors=<code>invalid_argument</code> for rejected arguments; <code>stale_document</code> for a closed handle; <code>authorization_required</code> when no policy is installed. A protected engineering capability can return <code>account_unavailable</code> with the default production portal. Local <code>document.workspace</code> and recovery operations are permitted by that policy.
|limitations=Undo history is session state and is not saved. Closing with <code>discard=false</code> refuses unsaved edits. The Windows desktop has an object tree, property inspector and dockable Python console. Runtime console completion and current-file editor assistance are different features. Use the shared command registry for an authorized edit; direct C++ access is not an entitlement boundary.
|verification=Repository evidence references (not rerun for this publication): CTest <code>application.commands</code>, <code>cli.document</code>, and <code>python.development</code>. The development script is <code>examples/python/document_edit.py</code>. <code>docs/verification/Phase-4-Acceptance.md</code> and <code>docs/verification/Phase-6-Acceptance.md</code>.
}}

The provider is <code>opensite</code>. Headless hosts are <code>opensite-cli</code> and <code>opensite.execute</code>. Both finish in <code>CommandRegistry::execute</code>.

; <code>document.create_section</code>
: Optional <code>label</code> text. Required <code>width</code> and <code>height</code> quantities. Returns the new document handle, the object id, and the content revision. The default label is <code>Rectangle</code>.

; <code>document.open</code>
: Required <code>path</code>. Returns the document handle.

; <code>document.save</code>
: Required document handle and <code>path</code>.

; <code>document.close</code>
: Required document handle. Optional <code>discard</code> boolean. False requires a clean document.

; <code>document.set_quantity</code>
: Required document handle, object id, <code>property</code> name, and <code>value</code> quantity. Returns the content revision.

; <code>document.set_boolean</code>, <code>document.set_integer</code>, <code>document.set_real</code>, and <code>document.set_string</code>
: Required document handle, object id, <code>property</code> name, and <code>value</code>. The property must already have that type. Returns the content revision.

; <code>document.set_reference</code>
: Required document handle, object id, <code>property</code> name, and <code>target</code> object id. Returns the content revision.

; <code>document.set_label</code>
: Required document handle, object id, and <code>label</code>. Returns the content revision.

; <code>document.recompute</code>
: Required document handle. Recomputes in the command's transaction. Returns the content revision.

; <code>document.undo</code> and <code>document.redo</code>
: Required document handle. Returns the content revision.

<code>document.create_section</code> uses <code>document.edit</code>. Open, set, recompute, undo and redo use <code>document.workspace</code> in the reviewed registry. <code>document.save</code> covers save. <code>document.recover</code> covers close. The development CLI installs an allow-all policy. That policy is not a production entitlement.

== Property expressions ==
<code>document.set_expression</code> accepts document, object, property, expression and optional language (<code>formula</code> or <code>python</code>). Python evaluation is opt-in; enabling it does not silently run a stored expression. The desktop provides Edit → Enable Python Expressions and Edit → Recalculate Python Expressions. See [[OpenSite/Reference/Features/Quantities and expressions]].

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

* <code>src/cli/main.cpp</code>
* <code>src/cli/document_commands.cpp</code>
* <code>src/cli/preference_commands.cpp</code>
* <code>src/application/builtins.cpp</code>

[[OpenSite|OpenSite overview]] · [[OpenSite/Reference|Reference]] · [[OpenSite/Guides|Guides]]
[[Category:OpenSite documentation]]