docLink.setPathHead

Set or remove the folder relative document links start from, in red-ale's configuration.

Sets the folder relative document links start from, or removes it with null. Give a directory path or file:// URI; the stored form is a file:// URI ending in /. It changes red-ale's Configuration only, never the book.

Examples

Example: with no book.

JSON-RPC

Request:

{"jsonrpc":"2.0","id":1,"method":"docLink.setPathHead","params":{"pathHead":"/home/me/receipts"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "pathHead": "file:///home/me/receipts/",
    "configFile": null
  }
}

Command line

red-ale exec docLink.setPathHead '{"pathHead":"/home/me/receipts"}'

It prints:

{
  "pathHead": "file:///home/me/receipts/",
  "configFile": null
}

MCP tool call

Tool call:

{"name":"docLink.setPathHead","arguments":{"pathHead":"/home/me/receipts"}}

Result:

{
  "structuredContent": {
    "pathHead": "file:///home/me/receipts/",
    "configFile": null
  }
}

Effect: write, on the Configuration only.

Params

Params of docLink.setPathHead.

pathHead (string or null): An absolute path or a file:// URI; a trailing / is added. Absent or null removes the setting.

Result

The path head setting.

pathHead (string or null): The path head, a file:// URI ending in /, if configured.
configFile (string or null): The configuration file, if the setting is kept in one; otherwise it lasts as long as the server.