OpenSite/Reference/Commands/Create an example document - Revision history

BathAfrica: Link adjacent OpenSite reference pages in reading order

2026-10-29T21:14:31Z

Link adjacent OpenSite reference pages in reading order

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

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

2026-10-29T20:59:12Z

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=cli.document.example		\|id=cli.document.example
	\|summary=Create a 0.30 m by 0.60 m rectangular section and save it.		\|summary=Create a 0.30 m by 0.60 m rectangular section and save it.
Line 14:		Line 14:
	}}		}}


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

	== Documentation basis ==		== Documentation basis ==
Line 25:		Line 28:
	[[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:26Z

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:46Z

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=cli.document.example
|summary=Create a 0.30 m by 0.60 m rectangular section and save it.
|milestone=Document-engine example, available in this development snapshot.
|units=Width and height are stored in metres. Area is square metres. Second moments are metres to the fourth.
|example=opensite-cli document example --output section.osdoc
|python=The CLI verb has no separate function. <code>opensite.execute('document.create_section', ...)</code> is [[OpenSite/Reference/Commands/Document commands|Document commands]].
|output=Stdout lists the object and properties, including area <code>si=0.18</code> and <code>unit=m2</code>. The saved <code>opensite-document</code> writer format is version 4; the loader accepts versions 1, 2 and 3 through its migration paths.
|errors=Exit 1 when the file cannot be saved, with the status message on stderr. Exit 2 when the arguments do not match the usage.
|limitations=The section is a document calculation. It is not a design-code check and not the section-design plugin. Local axes: x along the width, y along the height, z along the member.
|verification=Repository evidence references (not rerun for this publication): CTest <code>cli.document</code> and <code>document.section_reference</code>.
}}

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