OpenSite/Reference/Commands/Extension commands - Revision history

BathAfrica: Link adjacent OpenSite reference pages in reading order

2026-10-29T21:14:41Z

Link adjacent OpenSite reference pages in reading order

← Older revision		Revision as of 14:14, 29 October 2026
Line 49:		Line 49:
	[[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/Document commands\|OpenSite/Reference/Commands/Language commands\|OpenSite/Guides\|All guides}}</div>

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

2026-10-29T20:59:22Z

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.extension		\|id=opensite.extension
	\|summary=Create an extension instance from a template, group it, relate it, and remove a member or an object.		\|summary=Create an extension instance from a template, group it, relate it, and remove a member or an object.
Line 34:		Line 34:
	: Required document handle and object id. Removing a group leaves its members. Removing a member takes it out of groups and drops relationships that name it.		: Required document handle and object id. Removing a group leaves its members. Removing a member takes it out of groups and drops relationships that name it.


			== Try this workflow ==
			[[OpenSite/Guides/Build a native plugin\|Build a native plugin]] — a worked lesson with expected results.

	== Documentation basis ==		== Documentation basis ==
Line 45:		Line 48:
	[[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:40Z

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:06:14Z

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.extension
|summary=Create an extension instance from a template, group it, relate it, and remove a member or an object.
|milestone=Roadmap phase 7A.
|units=A template quantity is copied in canonical SI with the unit id stored on the field. A group membership is an object id. It is not a calculation input.
|example=opensite-python --development-host --runtime <prefix>\runtime --plugins <plugins> examples\python\extension_platform.py
|python=opensite.execute('extension.instantiate', {'document': document, 'template': 'sample_native.starter'})
|output=<code>extension.instantiate</code> and <code>extension.create_group</code> return <code>object</code>. <code>extension.add_member</code> and <code>extension.remove_object</code> return no fields.
|errors=<code>command_unavailable</code> when the template or type is not registered. <code>duplicate_id</code> when the member is already in the group. <code>invalid_argument</code> when a group would contain itself. A later <code>document.save</code> keeps the object. Phase 7A refused that save with <code>extension_not_persistent</code>. Phase 9 preserves the payload.
|limitations=These commands mutate the open document; call <code>document.save</code> to persist it. Plugin provider/type/schema and payload are preserved, including a read-only placeholder when the provider is unavailable. Group membership is not a calculation dependency. These are service commands, not automatic GUI-menu contributions.
|verification=Repository evidence references (not rerun for this publication): CTest <code>application.extension</code> and <code>python.development</code>. The script is <code>examples/python/extension_platform.py</code>. <code>docs/verification/Phase-7A-Acceptance.md</code>.
}}

The provider is <code>opensite</code>. Each command uses <code>document.edit</code> and one document transaction. The handler does not commit that transaction.

; <code>extension.instantiate</code>
: Required document handle and <code>template</code> id. Copies the template's input values into a new instance. Returns the object id.

; <code>extension.create_group</code>
: Required document handle. Optional <code>label</code>, default <code>Group</code>. Returns the group id. The group type is <code>opensite.document.group</code>.

; <code>extension.add_member</code>
: Required document handle, <code>group</code> id, and <code>member</code> id. A repeated member is <code>duplicate_id</code>. A group that would contain itself is <code>invalid_argument</code>.

; <code>extension.remove_member</code>
: Required document handle, <code>group</code> id, and <code>member</code> id. The member object stays in the document. A missing member is <code>unknown_object</code>.

; <code>extension.relate</code>
: Required document handle, <code>source</code> id, and <code>target</code> id. Optional <code>label</code>, default <code>Relationship</code>. Returns the relationship id. The two ids must differ. A relationship is not a calculation dependency.

; <code>extension.remove_object</code>
: Required document handle and object id. Removing a group leaves its members. Removing a member takes it out of groups and drops relationships that name it.

== 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]]