save
Write the open project over its existing file and wait until saving finishes, returning the path and confirming the file reads as a complete zip.
Instructions
Save the open project over its file and wait until the file is complete.
Returns:
Result dictionary with ``file`` (path, bytes, ``complete``) once Dorico has
finished writing and the file reads as a whole zip.
Note:
Dorico answers kOK before it writes: a 22 MB project was measured still being
written seconds later, and a copy taken then was a broken zip. So this waits
for Dorico's own finishing line in its application log, takes the path from
the log, and tests the zip. ``Notify=true`` sends no completion message
(Dorico Elements 6.2.40).
A project that has never been saved opens a Save As dialog here; use
project_file(action='save_as') for that. This overwrites the .dorico file in
place, and Dorico may also copy the previous version into its backup folder.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "save"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| timeout | No | Seconds to wait for the file to be written. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||